summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex')
-rw-r--r--Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex103
1 files changed, 103 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
new file mode 100644
index 00000000000..0761f12be9c
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/pgfplots/pgfplots.install.tex
@@ -0,0 +1,103 @@
+% main=manual.tex
+
+\section{Installation}
+\subsection{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
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+A copy of the GNU General Public License can be found in the package file
+\begin{lstlisting}
+doc/latex/pgfplots/gpl-3.0.txt
+\end{lstlisting}
+You may also visit~\url{http://www.gnu.org/licenses}.
+
+\subsection{Prerequisites}
+\PGFPlots\ requires \PGF\ version $\ge 1.18$ and package \texttt{xkeyval}.
+
+\subsection{Files in the \PGFPlots-Bundle}
+The \PGFPlots\ package consists of the files
+\begin{lstlisting}
+latex/pgfplots/pgfplots.sty
+generic/pgfmathlog/pgfmathlog.sty
+generic/liststructure/liststructure.sty
+generic/sciformat/sciformat.sty
+generic/pgfplotshelpers/pgfplotshelpers.sty
+doc/latex/pgfplots/pgfplots.bib
+doc/latex/pgfplots/pgfplots.*tex
+doc/latex/pgfplots/pgfplots.pdf
+doc/latex/pgfplots/todo.txt
+doc/latex/pgfplots/changelog.txt
+test/liststructuretest/liststructuretest.tex
+test/pgfplotstest/pgfplotstest.tex
+test/pgfmathlogtest/pgfmathlogtest.tex
+ext_scripts/pgf2pdf.sh
+ext_scripts/matlab2pgfplots.m
+ext_scripts/matlab2pgfplots.sh
+\end{lstlisting}
+If is used with
+\begin{lstlisting}
+\usepackage{pgfplots}
+\end{lstlisting}
+in your preamble. There are several ways how to teach \LaTeX\ where to find the files. Choose the option which fits your needs best.
+
+\subsection{Assigning the \texttt{TEXINPUTS} Variable}
+You can simply install \PGFPlots\ anywhere on your disc, for example into
+\begin{lstlisting}
+/foo/bar/pgfplots.
+\end{lstlisting}
+Then, you set the \texttt{TEXINPUTS} variable to
+\begin{lstlisting}
+TEXINPUTS=/foo/bar/pgfplots//:
+\end{lstlisting}
+The trailing~`\texttt{:}' tells \LaTeX\ to check the default search paths after \lstinline!/foo/bar/pgfplots!. The double slash~`\texttt{//}' tells \LaTeX\ to search all subdirectories.
+
+If the \texttt{TEXINPUTS} variable already contains something, you can append the line above to the existing \texttt{TEXINPUTS} content.
+
+Please refer to your operating systems manual for how to set environment variables.
+
+\subsection{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}'.
+
+Do not forget to run \lstinline!texhash!.
+
+\subsection{If everything else fails...}
+If \LaTeX\ still doesn't find your files, you can copy all \lstinline!.sty!-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}}
+\PGF\ is compatible with
+\begin{itemize}
+ \item \lstinline!latex!/\lstinline!dvips!,
+ \item \lstinline!latex!/\lstinline!dvipdfm!,
+ \item \lstinline!pdflatex!,
+ \item $\vdots$
+\end{itemize}
+However, there are some restrictions: I don't know any DVI viewer which is capable of viewing the output of \PGF\ (and therefor \PGFPlots\ as well). After all, DVI has never been designed to draw something different than text and horizontal/vertical lines. You will need to view the postscript file or the pdf-file.
+
+Furthermore, \PGF\ needs to know a \emph{driver} so that the DVI file can be converted to the desired output. Depending on your system, you need the following options:
+\begin{itemize}
+ \item \lstinline!latex!/\lstinline!dvips! does not need anything special because \lstinline!dvips! is the default driver if you invoke \lstinline!latex!.
+ \item \lstinline!pdflatex! will also work directly because \lstinline!pdflatex! will be detected automatically.
+ \item \lstinline!latex!/\lstinline!dvipdfm! requires to use
+\begin{lstlisting}
+\def\pgfsysdriver{pgfsys-dvipdfm.def}
+%\def\pgfsysdriver{pgfsys-pdftex.def}
+%\def\pgfsysdriver{pgfsys-dvips.def}
+\usepackage{pgfplots}.
+\end{lstlisting}
+ The uncommented commands could be used to set other drivers explictly.
+\end{itemize}
+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.