summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-05-04 23:39:21 +0000
committerKarl Berry <karl@freefriends.org>2011-05-04 23:39:21 +0000
commit16bfcc69400c93c3d779a104107606ae122a7dbe (patch)
treee2456232be21108418db974f47ea118eec770469 /Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex
parent9a8f00b89c2c1cd283f5fd0fb54959ef0690646f (diff)
FAQ-en 3.22 (4may11)
git-svn-id: svn://tug.org/texlive/trunk@22304 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex')
-rw-r--r--Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex133
1 files changed, 104 insertions, 29 deletions
diff --git a/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex b/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex
index 63656fccd22..e16460a7cb3 100644
--- a/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex
+++ b/Master/texmf-dist/doc/generic/FAQ-en/faq-install.tex
@@ -1,4 +1,4 @@
-% $Id: faq-install.tex,v 1.9 2011/02/15 20:56:41 rf10 Exp rf10 $
+% $Id: faq-install.tex,v 1.14 2011/04/13 09:45:46 rf10 Exp $
\section{Installing \AllTeX{} files}
@@ -286,7 +286,6 @@ you decided on.
The basic idea is to imitate the directory structure in your
existing tree(s). Here are some examples of where various sorts of
files should go:
-\begin{quote}
\begin{verbatim}
.sty, .cls or .fd: $TEXMF/tex/<format>/<package>/
.mf: $TEXMF/fonts/source/<supplier>/<font>/
@@ -298,17 +297,15 @@ files should go:
.otf: $TEXMF/fonts/opentype/<supplier>/<font>/
.pool, .fmt, .base or .mem: $TEXMF/web2c
\end{verbatim}
-\end{quote}
and for modern systems (those distributed in 2005 or later, using \acro{TDS}
v1.1 layouts):
-\begin{quote}
\begin{verbatim}
.map: $TEXMF/fonts/map/<syntax>/<bundle>/
.enc: $TEXMF/fonts/enc/<syntax>/<bundle>/
\end{verbatim}
-\end{quote}
(Map and encoding files went to directories under
-\File{$TEXMF/dvips/}, in earlier distributions.)
+\File{$TEXMF/dvips/}, %$
+in earlier distributions.)
In the lists above \meta{format} identifies the format the macros
are designed for~--- it can be things such as \texttt{plain},
@@ -372,20 +369,28 @@ directory that was created for the purpose, and then to delete that
directory and all its contents after you've finished installing.
\Question[Q-inst-scut]{Shortcuts to installing files}
-\AliasQuestion{Q-inst-miktex}
There are circumstances in which most of the fuss of installation can
be bypassed:
\begin{itemize}
\item If you are a \miktex{} user, the
-\begin{wideversion}
+\begin{hyperversion}
\Qref{\miktex{} package management system}{Q-inst-miktex*}
can usually help;
-\end{wideversion}
-\begin{narrowversion}
+\end{hyperversion}
+\begin{flatversion}
\miktex{} package management system can usually help
(\Qref{}{Q-inst-miktex*});
-\end{narrowversion}
+\end{flatversion}
+\item Similarly, if you are a \texlive{} user, the
+\begin{hyperversion}
+ \Qref{\texlive{} manager}{Q-inst-texlive}
+ can usually help;
+\end{hyperversion}
+\begin{flatversion}
+ \texlive{} package management system can usually help
+ (\Qref{}{Q-inst-texlive});
+\end{flatversion}
\item The package you want may already exist as a \acro{ZIP} file
\begin{wideversion}
formatted for \Qref{direct installation}{Q-inst-tds-zip}.
@@ -396,6 +401,7 @@ be bypassed:
\end{itemize}
\Question[Q-inst-miktex*]{Installation using \miktex{} package manager}
+\AliasQuestion{Q-inst-miktex}
Packages for use with \miktex{} are maintained very efficiently by the
project managers (new packages and updates on \acro{CTAN} ordinarily
@@ -434,6 +440,50 @@ mpm --install=<package>
(which of course assumes you know the name by which \miktex{} refers to
your package).
+\Question[Q-inst-texlive]{Installation using \texlive{} manager}
+
+\texlive{} manager (\ProgName{tlmgr}) is, by default, a shell (or
+Windows terminal window) command. There is voluminous documentation
+about it from the command
+\begin{quote}
+ \texttt{tldoc tlmgr}
+\end{quote}
+but basic operation is pretty straightforward. The manager needs to
+know where to download stuff from; the canonical setup is
+\begin{quote}
+\begin{narrowversion}
+\begin{verbatim}
+tlmgr option repository \
+ http://mirror.ctan.org/systems/texlive/tlnet
+\end{verbatim}
+(line wrapped to fit in the narrow column)
+\end{narrowversion}
+\begin{wideversion}
+\begin{verbatim}
+tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet
+\end{verbatim}
+\end{wideversion}
+\end{quote}
+which passes the decision to the mirror selector. You can (of course)
+specify a particular archive or mirror that you ``trust'', or even a
+local disc copy that you keep up-to-date (disc space and bandwidth are
+so cheap nowadays, that a ``home mirror'' of \acro{CTAN} is a feasible
+proposition).
+
+To update a single package, use:
+\begin{quote}
+\begin{verbatim}
+tlmgr update <package>
+\end{verbatim}
+\end{quote}
+
+To update everything you already have in your installation, use:
+\begin{quote}
+\begin{verbatim}
+tlmgr update --all
+\end{verbatim}
+\end{quote}
+
\Question[Q-inst-tds-zip]{Installing using ready-built \acro{ZIP} files}
Installing packages, as they (``traditionally'') appear on
@@ -504,13 +554,17 @@ filled' at the end of the environment variable. The syntax is simple
(though it depends which shell you're actually using): so on a
Unix-like system, using the \ProgName{bash} shell, the job might be
done like:
+\begin{quote}
\begin{verbatim}
- export TEXINPUTS=/tmp:
+export TEXINPUTS=/tmp:
\end{verbatim}
+\end{quote}
while in a Windows system, within a \MSDOS{} window, it would be:
+\begin{quote}
\begin{verbatim}
- set TEXINPUTS=C:/temp;
+set TEXINPUTS=C:/temp;
\end{verbatim}
+\end{quote}
In either case, we're asking \TeX{} to load files from the root disc
temporary files directory; in the Unix case, the ``empty slot'' is
designated by putting the path separator `|:|' on its own at the end
@@ -556,9 +610,11 @@ you to do it. The most modern distributions refer to the tree as
\texttt{\$TEXMFHOME}, but it used to be called \texttt{\$HOMETEXMF};
so to check that your \TeX{} system does indeed support the mechanism
you should start with
+\begin{quote}
\begin{verbatim}
kpsewhich -var-value TEXMFHOME
\end{verbatim}
+\end{quote}
(for example). This will almost invariably return a pointer to a
subdirectory \File{texmf} of your home directory; the commonest
exception is Macintoshes, using Mac\TeX{}, where the diretory is
@@ -566,8 +622,8 @@ conventionally \File{Library/texmf} in your home directory.
If you can confirm that the technique does indeed work, install your
new package (or whatever) in the \Qref*{correct place}{Q-install-where}
-in a tree based on \File{$HOME/texmf}, and generate an index of that
-tree
+in a tree based on \File{$HOME/texmf}, %$
+and generate an index of that tree
\begin{quote}
\begin{verbatim}
texhash $HOME/texmf
@@ -580,7 +636,8 @@ tree.
There are two wrinkles to this simple formula: first, the installation
you're using may \emph{not} define a home TEXMF directory, and second,
-there may be some obstruction to using \File{$HOME/texmf} as the
+there may be some obstruction to using \File{$HOME/texmf} %$
+as the
default name. In either case, a good solution is to have your own
\File{texmf.cnf}~--- an idea that sounds more frightening that it
actually is. The installation's existing file may be located with the
@@ -593,7 +650,8 @@ kpsewhich texmf.cnf
Take a copy of the file and put it into a directory of your own; this
could be any directory, but an obvious choice is the \File{web2c}
directory of the tree you want to create, i.e.,
-\File{$HOME/texmf/web2c} or the like. Make an environment variable to
+\File{$HOME/texmf/web2c} %$
+or the like. Make an environment variable to
point to this directory:
\begin{quote}
\begin{verbatim}
@@ -686,6 +744,7 @@ Having made all these changes, \AllTeX{} should ``just use'' files in
your new tree, in preference to anything in the main tree~--- you can
use it for updates to packages in the main tree, as well as for
installing new versions of things.
+\LastEdit{2011-04-13}
\Question[Q-instfont]{Installing a new font}
@@ -698,8 +757,9 @@ Font files may appear in any of a large number of different formats;
each format has a different function in a \TeX{} system, and each is
stored in a directory its own sub-tree in the installation's
\acro{TDS} tree; all these sub-trees have the directory
-\File{$TEXMF/fonts} as their root. A sequence of answers%
-\nothtml{, below,} describes the installation of fonts\latexhtml{.}{:}
+\File{$TEXMF/fonts} %$
+as their root. A sequence of answers\nothtml{, below,} describes the
+installation of fonts\latexhtml{.}{:}
\begin{htmlversion}
follow the list through the ``next question'' links at the bottom of
this answer to view them all.
@@ -843,6 +903,19 @@ much of what follows will be familiar:
about installing non-standard things applies here, too). The
following list gives reasonable destinations for the various files
related to a font family \meta{fname}:
+\begin{narrowversion}
+\begin{verbatim}
+.pfb,
+.pfa .../fonts/type1/<foundry>/<fname>
+.tfm .../fonts/tfm/<foundry>/<fname>
+.vf .../fonts/vf/<foundry>/<fname>
+.sty,
+.fd .../tex/latex/<fname>
+.map .../fonts/map/dvips/<foundry>
+\end{verbatim}
+\end{narrowversion}
+\begin{wideversion}
+\begin{quote}
\begin{verbatim}
.pfb,
.pfa .../fonts/type1/<foundry>/<fname>
@@ -852,6 +925,8 @@ much of what follows will be familiar:
.fd .../tex/latex/<fname>
.map .../fonts/map/dvips/<foundry>
\end{verbatim}
+\end{quote}
+\end{wideversion}
but if you are lucky, you will be starting from a distribution from
\acro{CTAN} and there is a corresponding \extension{tds.zip} file:
using this \acro{TDS}-file saves the bother of deciding where to put
@@ -862,11 +937,11 @@ much of what follows will be familiar:
\begin{itemize}
\item On any current \texlive{}-based system, or a te\TeX{} v3.0
system, execute the command
- \begin{quote}
+\begin{quote}
\begin{verbatim}
updmap-sys --enable Map <fname>.map
\end{verbatim}
- \end{quote}
+\end{quote}
as root. (If you \emph{can} use \ProgName{updmap-sys}~--- do; if
not~--- presumably because your \alltex{} system was set up by
someone else~--- you have to fall back on plain \ProgName{updmap},
@@ -874,24 +949,24 @@ updmap-sys --enable Map <fname>.map
map sets that might be changed behind your back.)
\item On a current \miktex{} system, update the system file
\File{updmap.cfg}, using the shell command
- \begin{quote}
+\begin{quote}
\begin{verbatim}
initexmf --edit-config-file updmap
\end{verbatim}
- \end{quote}
+\end{quote}
adding a line at the end:
- \begin{quote}
+\begin{quote}
\begin{verbatim}
Map <fname>.map
\end{verbatim}
- \end{quote}
+\end{quote}
for each font family \meta{fname} you are adding to the system.
Now generate revised maps with the shell command
- \begin{quote}
+\begin{quote}
\begin{verbatim}
initexmf --mkmaps
\end{verbatim}
- \end{quote}
+\end{quote}
This, and other matters, are described in \miktex{} % beware line break
\href{http://docs.miktex.org/manual/advanced.html}{``advanced'' documentation}.
\end{itemize}
@@ -914,8 +989,8 @@ fonts. On a system that uses \ProgName{dvips} (almost all do), try
the sequence:
\begin{quote}
\begin{verbatim}
- latex sample2e
- dvips -o sample2e.ps sample2e
+latex sample2e
+dvips -o sample2e.ps sample2e
\end{verbatim}
\end{quote}
at a ``command prompt'' (\ProgName{shell}, in a Unix-style system,