summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-02-05 01:04:42 +0000
committerKarl Berry <karl@freefriends.org>2009-02-05 01:04:42 +0000
commitad23c1c436c3e031cc4b81849d0fa2b892851467 (patch)
treed04be182dbf5cdb14c1728b8f2edddc84f77df03 /Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
parent4041df693bc0b66ecdf77e891e5ff1a60f1497fc (diff)
pgfplots update (4feb09)
git-svn-id: svn://tug.org/texlive/trunk@12087 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex61
1 files changed, 48 insertions, 13 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
index b94fa632f7b..e87dd0f8bd0 100644
--- a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
@@ -1,7 +1,7 @@
% main=manual.tex
-\section{Installation}
-\subsection{Licensing}
+\subsection{Installation and Prerequisites}
+\subsubsection{Licensing}
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
@@ -18,17 +18,23 @@ doc/latex/pgfplots/gpl-3.0.txt
\end{verbatim}
You may also visit~\url{http://www.gnu.org/licenses}.
-\subsection{Prerequisites}
+\subsubsection{Prerequisites}
\PGFPlots\ requires \PGF\ with \textbf{at least version~$2.0$}. It is used with
\begin{verbatim}
\usepackage{pgfplots}
\end{verbatim}
-in your preamble (see section~\ref{sec:tex:dialects} for information about how to use it with Con{\TeX}t and plain \TeX). There are several ways how to teach \TeX\ where to find the files. Choose the option which fits your needs best.
+in your preamble (see section~\ref{sec:tex:dialects} for information about how to use it with Con{\TeX}t and plain \TeX).
-\subsection{Installation in Windows}
-Windows users often use Mik\TeX\ which downloads the latest stable package versions automatically. As far as I know, you do not need to install anything manually here.
-\subsection{Assigning the \texttt{TEXINPUTS} Variable}
+%\subsubsection{Installation}
+There are several ways how to teach \TeX\ where to find the files. Choose the option which fits your needs best.
+
+\subsubsection{Installation in Windows}
+Windows users often use Mik\TeX\ which downloads the latest stable package versions automatically. As far as I know, you do not need to install anything manually here. However, Mik\TeX\ provides a feature to install packages locally in its own \TeX-Directory-Structure (TDS). This is the preferred way if you like to install newer version than those of Mik\TeX. The basic idea is to unzip \PGFPlots\ in a directory of your choice and use configure the Mik\TeX\ Package Manager to use this specific directory with higher priority than its default paths.
+
+See also section~\ref{pgfplots:tds} for more information about separate TDS directories.
+
+\subsubsection{Installation in Any Directory - the \texttt{TEXINPUTS} Variable}
You can simply install \PGFPlots\ anywhere on your disc, for example into
\begin{verbatim}
/foo/bar/pgfplots.
@@ -49,22 +55,45 @@ so that the \TeX-documentation system finds the files |pgfplots.pdf| and |pgfplo
Please refer to your operating systems manual for how to set environment variables.
-\subsection{Installation into a local \texttt{texmf}-directory}
+\subsubsection{Installation Into a Local \texttt{texmf}-Directory}
Copy \PGFPlots\ to a local \texttt{texmf} directory like \lstinline!~/texmf! in your home directory. Then, install \PGFPlots\ into the subdirectory \lstinline!texmf/tex/generic/pgfplots! and run \lstinline!texhash!.
-\subsection{Installation into a local TDS compliant \texttt{texmf}-directory}
-A TDS conforming installation will use the same base directory as in the last section, but it requires to merge the contents of `\texttt{latex}' into `\texttt{texmf/tex/latex}'; the contents of `\texttt{generic}' to `\texttt{texmf/tex/generic}' and the contents of `\texttt{doc}' to `\texttt{texmf/doc}'.
+\subsubsection{Installation Into a Local TDS Compliant \texttt{texmf}-Directory}
+\label{pgfplots:tds}
+A TDS conforming installation will use the same base directory as in the last section. Since \PGFPlots\ comes in TDS conforming directory structure, you can simply unpack the files into a directory of your choice and configure \TeX\ to use this directory as further include path.
Do not forget to run \lstinline!texhash!.
-\subsection{If everything else fails...}
-If \TeX\ still doesn't find your files, you can copy all \lstinline!.sty! and all |.tex|-files into your current project's working directory.
+\subsubsection{Installation If Everything Else Fails...}
+If \TeX\ still doesn't find your files, you can copy all \lstinline!.sty! and all |.code.tex|-files into your current project's working directory.
Please refer to \url{http://www.ctan.org/installationadvice/} for more information about package installation.
-\subsection{Restrictions for DVI-Viewers and \texttt{dvipdfm}}
+\subsection{Troubleshooting -- Error Messages}
+This section discusses some problems which may occur when using \PGFPlots.
+Some of the error messages are shown in the index, take a look at the end of this manual (under ``Errors'').
+
+
+\subsubsection{Problems with available Dimen-registers}
+To avoid problems with the many required \TeX-registers for \PGF\ and \PGFPlots, you may want to include
+\begin{verbatim}
+\usepackage{etex}
+\end{verbatim}
+as first package. This avoids problems with ``no room for a new dimen''
+\index{Error Messages!No room for a new dimen}%
+in most cases. It should work with any modern installation of \TeX\ (it activates the e-\TeX\ extensions).
+
+\subsubsection{Dimension Too Large Errors}
+The core mathematical engine of \PGF\ relies on \TeX\ registers to perform fast arithmetics. To compute $50+299$, it actually computes |50pt+299pt| and strips the |pt| suffix of the result. Since \TeX\ registers can only contain numbers up to $\pm 16384$, overflow error messages like ``Dimension too large'' occur if the result leaves the allowed range. Normally, this should never happen -- \PGFPlots\ uses a floating point unit with data range $\pm 10^{324}$ and performs all mappings automatically. However, there are some cases where this fails. Some of these cases are:
+\begin{enumerate}
+ \item The axis range (for example, for $x$) becomes \emph{relatively} small. It's no matter if you have absolutely small ranges like $[10^{-17},10^{-16}]$. But if you have an axis range like $[1.99999999,2]$, where a lot of significant digits are necessary, this may be problematic.
+ \item The |axis equal| key will be confused if $x$ and $y$ have a very different scale.
+ \item You may have found a bug -- please contact the developers.
+\end{enumerate}
+
+\subsubsection{Restrictions for DVI-Viewers and \texttt{dvipdfm}}
\label{sec:drivers}%
\PGF\ is compatible with
\begin{itemize}
@@ -91,3 +120,9 @@ Furthermore, \PGF\ needs to know a \emph{driver} so that the DVI file can be con
Please read the corresponding sections in~\cite[Section 7.2.1 and 7.2.2]{tikz} if you have further questions. These sections also contain limitations of particular drivers.
The choice which won't produce any problems at all is |pdflatex|.
+
+\subsubsection{Problems with \TeX's Memory Capacities}
+\PGFPlots\ can handle small up to medium sized plots. However, \TeX\ has never been designed for data plots -- you will eventually face the problem of small memory capacities. See section~\ref{sec:pgfplots:optimization} for how to enlarge them.
+
+\subsubsection{Other Problems}
+Please contact the authors (preferrably by mail). Visit the webpages shown above to get contact information.