From 0aa04ee7d3e4699f6db1ccd0abf67d3212977cc1 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sun, 3 Dec 2006 01:48:15 +0000 Subject: minimal 2006 doc updates git-svn-id: svn://tug.org/texlive/trunk@2577 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-doc/doc/english/texlive-en/live.html | 1000 +++++++++++---------- Master/texmf-doc/doc/english/texlive-en/live.pdf | Bin 771118 -> 791781 bytes 2 files changed, 521 insertions(+), 479 deletions(-) (limited to 'Master/texmf-doc/doc/english/texlive-en') diff --git a/Master/texmf-doc/doc/english/texlive-en/live.html b/Master/texmf-doc/doc/english/texlive-en/live.html index d345b001196..f17e204d30c 100644 --- a/Master/texmf-doc/doc/english/texlive-en/live.html +++ b/Master/texmf-doc/doc/english/texlive-en/live.html @@ -2,13 +2,13 @@ "http://www.w3.org/TR/html4/loose.dtd"> - The TEX Live Guide TeX Collection 2005 + The TEX Live Guide TeX Collection 2006 - + @@ -23,15 +23,15 @@

The TEX Live Guide
TEX Collection 2005

-
Sebastian Rahtz & Karl Berry, editors -
EX Collection 2006 +
October 2005
+class="ec-lmr-12">December 2006

Contents

@@ -132,9 +132,9 @@ href="#x1-6400010" id="QQ2-1-69">Release history
 10.1 Past
 10.2 Present +href="#x1-6900010.2" id="QQ2-1-74">Present
 10.3 Future +href="#x1-7000010.3" id="QQ2-1-75">Future

List of Tables

@@ -411,7 +411,7 @@ href="http://tug.org/protext" class="url" >http://tug.org/protext.

ProTEXt is provided as both the top level of the live DVD  and on its own CD (for those +class="ec-lmss-10">live DVD and on its own CD (for those who cannot use the DVD).

You can tell which type of distribution you’re in by looking for a EX Live distribution. On the live DVD, the entire TEX Live hierarchy is in a subdirectory texlive2005, not at the top level of the +class="ec-lmtt-10">texliveYYYY, not at the top level of the disc.

TEX
writes Acrobat PDF format as well as DVI. The LATEX hyperref package has an option - ‘pdftex’ which turns on all the program features. See texmf/doc/pdftex/manual/ for the - manual, and texmf/doc/pdftex/manual/samplepdf/samplepdf.tex. +class="description">builds on the e-TEX extensions, + adding support for writing PDF output as well as DVI. See texmf/doc/pdftex/manual/ for + the manual, and texmf/doc/pdftex/manual/samplepdf/samplepdf.tex. This is the default + program for all formats except plain TEX.
pdfeXeTEX
combines the pdfTEX and e-TEX extensions. This is the default program for all - formats except plain TEX. See above for documentation. +class="description">adds support for Unicode input and OpenType fonts, using third-party libraries. See http://scripts.sil.org/xetex.
OmegaEX extensions. See texmf-dist/doc/aleph/base for some minimal documentation. -

+

2.5 Other notable programs in TEX Live

-

Here are a few other commonly-used programs included in T

Here are a few other commonly-used programs included in TEX Live: -

+

bibtex
EX to HTML converter.
-

+

3 Unix installation

-

As introduced in section 

As introduced in section 1.1 (p. 4), TEX Live has three principal uses: -

+

  1. EX Live has three principal uses: >Integrate a particular package or collection into your existing TEX installation.
-

The following sections describes the Unix-specific procedures for each of these. -


The following sections describes the Unix-specific procedures for each of these. +


-

Warning: The Tmount command to see how to do this. If you have several different machines on a local network, you may be able to mount the discs on one which does support Rock Ridge, and use this with the others. -

Modern systems should be able to use the discs without problems. If troubles, let us know. The +

Modern systems should be able to use the discs without problems. If troubles, let us know. The discussion below assumes you have been able to mount the CDs with full Rock Ridge compatibility. -


+


3.1 Running TEX Live directly from media (Unix)

-

It is possible to use the T

It is possible to use the TEX system directly from the live DVD, without installing the distribution to disk. (Thus the name T/dev/cdrom, here) may vary. (All our examples will use class="ec-lmtt-10">> as the shell prompt; user input is underlined.)

-

> mount -t /dev/cdrom /mnt/cdrom
-

Change the current directory to the mount point:

-

Change the current directory to the mount point:

+

> cd /mnt/cdrom
-

Under Mac OS X, the directory is typically under

Under Mac OS X, the directory is typically under /Volumes, and the media will be mounted automatically. Run the installation script install-tl.sh:

-

> sh install-tl.sh @@ -820,24 +818,24 @@ class="ec-lmtt-10">install-tl.sh class="ec-lmtt-10">Welcome to TeX Live...
-

After various greeting messages and a list of the main menu options, the installation will ask you to +

After various greeting messages and a list of the main menu options, the installation will ask you to enter a command. Do this by typing the desired character and hitting return; don’t type the angle brackets shown. Either uppercase or lowercase is ok; we’ll use lowercase in our examples. -

For running live, our first command will be

For running live, our first command will be d and then the subcommand 1 to set directories. Even in this case, we must choose a directory on the local disk to place files that the TEX system itself generates, such as fonts and formats, and also to provide a place for updated configuration files, if need be. -

We’ll use /opt/texlive2005 in this example. It’s good to include the year in the name, -as these generated files are not compatible from release to release. (If the default value of +

We’ll use /opt/texlive2006 in this example. It’s good to include the year in the name, as these +generated files are not in general compatible from release to release. (If the default value of /usr/local/texlive/2005 works for you, then you can skip this step.) +class="ec-lmtt-10">/usr/local/texlive/2006 works for you, then you can skip this step.)

-

+

Enter command:     /usr/local/texlive/2005 +class="ec-lmtt-10"> /usr/local/texlive/2006
...
 for TEXDIR [/usr/local/texlive/TeX]: /opt/texlive2005 +class="ec-lmtt-10">/opt/texlive2006
...
r
-

Back at the main menu, our second and last command is

Back at the main menu, our second and last command is r, to set up for running live off the media without installing to disk:

-

+

Enter command: Live! class="ec-lmtt-10">>
-

And we are back at the system prompt, as shown. -

Next, it is necessary to alter two environment variables:

And we are back at the system prompt, as shown. +

Next, it is necessary to alter two environment variables: PATH, to an architecture-dependent value (so that we can run the programs), and TEXMFSYSVAR, to the value specified above. See table 1 for a list of the architecture names for the different systems. -

After the main installation has completed, and environment variables have been set, the last step is to +

After the main installation has completed, and environment variables have been set, the last step is to run texconfig or texconfig-sys to customize your installation to your needs. This is explained in @@ -921,7 +919,7 @@ href="#x1-170004.1">4.1, p. 26. -


@@ -997,14 +995,14 @@ class="td11">

-

The syntax for setting the environment variables, and the initialization file to put them in, depends +

The syntax for setting the environment variables, and the initialization file to put them in, depends on the shell you use. If you use a Bourne-compatible shell (sh, bash, ksh, et al.), put the following into your $HOME/.profile file:

-

+

PATH=/mnt/cdrom/bin/archname:$PATH; export PATH
TEXMFSYSVAR=/opt/texlive2005/texmf-var;TEXMFSYSVAR=/opt/texlive2006/texmf-var; export TEXMFVAR
-

For C shell-compatible shells (

For C shell-compatible shells (csh, tcsh), put the following into your $HOME/.cshrc file:

-

+

setenv PATH:$PATH
setenv TEXMFSYSVAR /opt/texlive2005/texmf-var +class="ec-lmtt-10"> /opt/texlive2006/texmf-var
-

Then log out, log back in, and test your installation (see section 

Then log out, log back in, and test your installation (see section 4.2, p. 27). -

If in doubt, please ask any local system gurus to help you with problems; for example, the way to +

If in doubt, please ask any local system gurus to help you with problems; for example, the way to mount the TEX Live media, which directory or directories to use, and precise details of the changes to your personal initialization files can and do vary from site to site.

3.2 Installing TEX Live to disk

-

It is possible, indeed typical, to install the T

It is possible, indeed typical, to install the TEX Live distribution to hard disk. This can be done from either the live or inst distributions. (See section 2.1, p. 6, for an explanation of the different distributions.) -

To start, you mount the CD or DVD, with Rock Ridge extensions enabled. The exact command to do +

To start, you mount the CD or DVD, with Rock Ridge extensions enabled. The exact command to do this varies from system to system; the following works under Linux, except the name of the device (/dev/cdrom, here) may vary. (All our examples will use > as the shell prompt; user input is underlined.)

-

> mount -t /dev/cdrom /mnt/cdrom
-

Change the current directory to the mount point:

-

Change the current directory to the mount point:

+

> cd /mnt/cdrom
-

Under Mac OS X, the directory is typically under

Under Mac OS X, the directory is typically under /Volumes, and the media will be mounted automatically. Run the installation script install-tl.sh:

-

> sh install-tl.sh @@ -1088,11 +1086,11 @@ class="ec-lmtt-10">Welcome to TeX Live...
-

After various greeting messages and a list of the main menu options, the installation will ask you to +

After various greeting messages and a list of the main menu options, the installation will ask you to enter a command. Do this by typing the desired character and hitting return; don’t type the angle brackets shown. Either uppercase or lowercase is ok; we’ll use lowercase in our examples. -

Table 

Table 2 briefly lists the options in the main menu. The order in which you select the options makes little difference, except that i must be last. It’s reasonable to go through them in the order presented @@ -1100,7 +1098,7 @@ here.

-


@@ -1161,13 +1159,13 @@ class="td11">

-

Here are further details on each option. -

Here are further details on each option. +

p – Current platform. Since the installation script automatically guesses which platform you’re running on, it is usually unnecessary to use this option. It’s there in case you need to override the automatic detection. -

b – Binary architectures. By default, only the binaries for your current platform will be installed. From this menu, you can select installation of binaries for other architectures as well (or omit @@ -1177,7 +1175,7 @@ network of heterogenous machines. For a list of the supported architectures, see href="#x1-13001r1">1, p. 16. -

s – Base installation scheme. From this menu, you can choose an overall set of package collections, called a “scheme”. The default basic scheme for a minimal system, or medium to get something in between. There are also specific sets for Omega and XML. -

c – Individual collections. From this menu, you can override the scheme’s set of collections to install. Collections are one level more detailed than schemes — collections consist of one or more @@ -1194,7 +1192,7 @@ packages, where packages (the lowest level grouping in TEX Live) contain the actual TEX macro files, font families, and so on. In this menu, selection letters are case-sensitive. -

l – Language collections. This menu has the same basic purpose as c, to override the collection set @@ -1211,7 +1209,7 @@ class="tabbing">Arabic Armenian Chinese Japanese Korean -

Croatian Cyrillic Czech/Slovak Danish
-

Dutch Finnish French German
-

Greek Hebrew Hungarian Indic
-

Italian Latin Manju Mongolian
-

Norwegian Polish Portuguese Spanish
-

Swedish Tibetan UK English Vietnamese
-

-

-

Language collections typically include fonts, macros, hyphenation patterns, and other support files. (For +

+

Language collections typically include fonts, macros, hyphenation patterns, and other support files. (For instance, frenchle.sty is installed if you select the French collection.) In addition, installing a language collection will alter the language.dat configuration file controlling which hyphenation patterns are loaded. -

d – Installation directories. Three directories can be changed here:

@@ -1280,13 +1278,13 @@ class="ec-lmbx-10">– Installation directories. Three directories ca class="ec-lmtt-10">TEXDIR
The top-level directory under which everything else will be installed. The default value is /usr/local/texlive/2005, and is often changed. We recommend including the year +class="ec-lmtt-10">/usr/local/texlive/2006, and is often changed. We recommend including the year in the name, to keep different releases of TEX Live separate. (You may wish to make a version-independent name such /usr/local/texlive via a symbolic link, which you can then update after testing the new release.) -

Under Mac OS X, the usual frontends look for T

Under Mac OS X, the usual frontends look for TEX in /usr/local/teTeX, so you may wish to install Ttexconfig looks for modified configuration data. href="#x1-170004.1">4.1, p. 26 for more information.

-

o – Other options. From this menu, you can select the following general options:

@@ -1337,7 +1335,7 @@ class="ec-lmtt-10">/usr/local/man and the Info files available under /usr/local/info. (Of course you need appropriate privileges to write in the specified directories.) -

It is not advisable to overwrite a T

It is not advisable to overwrite a TEX system that came with your system with this option. It’s intended primarily for creating the links in standard directories that are known to users, such as s

Skip installation of the main font/macro source tree. This is useful if you are arranging to share that tree between machines and/or architectures in some other way, such as NFS.
-

i – Perform installation. When you’re satisfied with your configuration options, enter i to actually do the installation from the media to your chosen locations. -

After the installation completes, your next step is to include the architecture-specific subdirectory of +

After the installation completes, your next step is to include the architecture-specific subdirectory of TEXDIR/bin in your PATH, so the newly-installed programs can be found. The architecture names are @@ -1366,7 +1364,7 @@ listed in table 1, p. 16, or you can simply list the directory TEXDIR/bin. -

The syntax for doing this, and the initialization file to use, depends on your shell. If you use a +

The syntax for doing this, and the initialization file to use, depends on your shell. If you use a Bourne-compatible shell (sh, bash, ksh, et al.), put the following into your $HOME/.profile file:

-

+

PATH=/usr/local/texlive/2005/bin/PATH=/usr/local/texlive/2006/bin/archname:$PATH; export PATH
-

For C shell-compatible shells (

For C shell-compatible shells (csh, tcsh), put the following into your $HOME/.cshrc file:

-

+

setenv PATH /usr/local/texlive/2005/bin/ /usr/local/texlive/2006/bin/archname:$PATH
-

After the main installation has completed, and environment variables have been set, the last step is to +

After the main installation has completed, and environment variables have been set, the last step is to run texconfig or texconfig-sys to customize your installation to your needs. This is explained in section 4.1, p. 26. -

Here is a minimal annotated example which accepts the default directories and installs binaries for +

Here is a minimal annotated example which accepts the default directories and installs binaries for the current system only. Thus, only one command is needed, i for install. The > is the shell prompt as usual.

-

+

>  example:
> PATH=/usr/local/texlive/2005/bin/i386-linux:$PATH; PATH=/usr/local/texlive/2006/bin/i386-linux:$PATH; export PATH
-

If in doubt, please ask any local system gurus to help you with problems; for example, the way to +

If in doubt, please ask any local system gurus to help you with problems; for example, the way to mount the TEX Live media, which directory or directories to use, and precise details of the changes to your personal initialization files can and do vary from site to site.

3.3 Installing individual packages to disk

-

You can add individual packages or collections from the current distribution to an existing non-T

You can add individual packages or collections from the current distribution to an existing non-TEX Live setup, or an earlier TEX Live installation. -

To start, you mount the CD or DVD, with Rock Ridge extensions enabled. The exact command to do +

To start, you mount the CD or DVD, with Rock Ridge extensions enabled. The exact command to do this varies from system to system; the following works under Linux, except the name of the device (/dev/cdrom, here) may vary. (All our examples will use > as the shell prompt; user input is underlined.)

-

> mount -t /dev/cdrom /mnt/cdrom
-

Change the current directory to the mount point:

-

Change the current directory to the mount point:

+

> cd /mnt/cdrom
-

Under Mac OS X, the directory is typically under

Under Mac OS X, the directory is typically under /Volumes, and the media will be mounted automatically. -

Run the installation script

Run the installation script install-pkg.sh (not install-tl.sh, which is intended for complete installations only):

-

+

> install-pkg.sh options
-

The first set of options controls what gets read: -

+

The first set of options controls what gets read: +

--package=cddir from which to read the package class="E">EX Live yourself.
-

What actually happens is controlled by the following options. If neither of these are specified, the +

What actually happens is controlled by the following options. If neither of these are specified, the default action is to install the selected files. The main destination tree is found by expanding $TEXMFMAIN with kpsewhich. You can override it by setting either the e class="ec-lmtt-10">TEXMFMAIN or TEXMF. -

+

--listonly
Instead of installing the files into the TEX system, make a tar archive.
-

Additional options: -

+

Additional options: +

--config
mktexlsr to rebuild the filename database. class="ec-lmtt-10">--verbose
Give more information as the script runs.
-

Here are some usage examples: -

+

Here are some usage examples: +

  1. Give more information as the script runs. id="x1-15002x1">To see the files in the package fancyhdr without installing it:
    -

    +

    > ... id="x1-15004x2">Install the LATEX package natbib:
    -

    +

    > --package=natbib id="x1-15006x3">Install the LATEX package alg without source files or documentation:
    -

    +

    > --nodoc >Install all the packages in the collection of additional plain TEX macros:
    -

    +

    > --collection=tex-plainextra class="ec-lmss-10">pstricks package to a tar file in /tmp:
    -

    +

    > --archive=/tmp/pstricks.tar
-

If in doubt, please ask any local system gurus to help you with problems; for example, the way to +

If in doubt, please ask any local system gurus to help you with problems; for example, the way to mount the TEX Live media, which directory or directories to use, and precise details of the changes to your personal initialization files can and do vary from site to site. -

+

4 Post-installation

-

After the main installation is done, for any operating system, the remaining steps are to configure the +

After the main installation is done, for any operating system, the remaining steps are to configure the system for your local needs, and perform some basic tests. -

Another sort of post-installation is to acquire packages, fonts, or programs that were not included in +

Another sort of post-installation is to acquire packages, fonts, or programs that were not included in TEX Live. The basic idea is to install such additions in the TEXMFLOCAL tree (if you installed to @@ -1717,7 +1715,7 @@ disk), or TEXMFSYSVAR (if you are running live). See the “Installation directories” option on p. 21. -

Unfortunately, the details can and do vary widely, and so we do not attempt to address them here. +

Unfortunately, the details can and do vary widely, and so we do not attempt to address them here. Here are some external links to descriptions:

-

+

4.1 The texconfig program

-

At any time after installation, you can and should use the program

At any time after installation, you can and should use the program texconfig to configure the system to fit your local needs. It is installed in the architecture-specific subdirectory TEXDIR/bin/arch along with everything else. -

If you run it without arguments, it will enter full-screen mode and allow you to view and change +

If you run it without arguments, it will enter full-screen mode and allow you to view and change options interactively. -

You can also run it with various command-line options. Here are some of the most common (T

You can also run it with various command-line options. Here are some of the most common (TEX Live is configured for the A4 paper size by default): -

+

texconfig paper letter
texconfig help
Output help information for texconfig.
-

Of course,

Of course, texconfig can only support changing a few of the many options and configuration parameters in a TEX system. The main configuration file for the base Web2C programs is named @@ -1791,56 +1789,56 @@ class="E">EX system. The main configuration file for the base Web2 class="ec-lmtt-10">texmf.cnf. You can find its location by running ‘kpsewhich texmf.cnf’; it contains many comments explaining the default settings and useful alternatives. -

As of 2005, texconfig alters files in a user-specific directory, namely $HOME/.texlive2005. If you -install T

As of 2005, texconfig alters files in a user-specific directory, as in $HOME/.texlive2005. If you install +TEX just for yourself, that is unlikely to make a difference. But if you install TEX on a -multi-user system, you will want to change the configuration for the whole system. In this case, run -texconfig-sys instead of EX on a multi-user +system, you will want to change the configuration for the whole system. In this case, run texconfig-sys +instead of texconfig. -

Likewise, the

Likewise, the updmap and fmtutil scripts were changed, to work under $HOME/.texlive2005. To alter +class="ec-lmtt-10">$HOME/.texliveYYYY. To alter system directories, use updmap-sys and fmtutil-sys. -

In particular, for multi-user systems, you will probably want to pregenerate the standard formats +

In particular, for multi-user systems, you will probably want to pregenerate the standard formats with fmtutil-sys –missing. Otherwise, each user will end up with their own formats. -

Also, if you have a personally-modified copy of

Also, if you have a personally-modified copy of fmtutil.cnf or updmap.cfg, instead of using the ones generated by installation, they must be installed in the tree referenced by the variable TEXMFSYSCONFIG. -

The variables specifying the directories altered by these commands are listed in section 

The variables specifying the directories altered by these commands are listed in section 2.3, p. 7. You can see the actual directories by running texconfig conf, and you can change them by editing texmf.cnf. -

+

4.2 Testing the installation

-

After installing T

After installing TEX Live as best you can, you naturally want to test it out, so you can start creating beautiful documents and/or fonts. -

This section gives some basic procedures for testing that the new system is functional. We give Unix +

This section gives some basic procedures for testing that the new system is functional. We give Unix commands; under Mac OS X and Windows, you’re more likely to run the tests through a graphical interface, but the principles are the same. -

+

  1. Make sure that you can run the tex program in the first place:
    -

    +

    > 17. class="E">EX file:
    -

    +

    > 59.
  2. Preview the result online:
    -

    +

    > display’.
  3. Create a PostScript file for printing or display:
    -

    +

    > sample2e.ps id="x1-18010x5">Create a PDF file instead of DVI; this processes the .tex file and writes PDF directly:
    -

    +

    > sample2e.tex id="x1-18012x6">Preview the PDF file:
    -

    +

    > http://www.foolabs.com/xpdf,
  4. Other standard test files you may find useful: -

    +

    small2e.tex
    \bye’ to the * prompt after ‘tex story.tex’.
    -

    You can process these in the same way as we did with

    You can process these in the same way as we did with sample2e.tex.

-

If you are new to T

If you are new to TEX, or otherwise need help with actually constructing TEX or LATEX documents, please visit http://tug.org/begin.html for some introductory resources. -

+

5 Mac OS X installation

-

The recommended way to install T

The recommended way to install TEX on Mac OS X is from the MacTEX distribution, new in 2005. This is provided on the EX Live, along with many additional applications and documentation. The project web page is http://tug.org/mactex. -

If you prefer, installation of T

If you prefer, installation of TEX under Mac OS X can also be done directly from TEX Live, using the install* scripts, as follows. -

In order to run the installation scripts under Mac OS X, you need to have the

In order to run the installation scripts under Mac OS X, you need to have the bash shell installed. If you are running Mac OS X 10.2 or later, you have bash, and can proceed. If you’re running an earlier @@ -2058,23 +2056,23 @@ Mac OS X version, however, the default shell is zsh, which won’t work; you’ll need to get bash from the Internet, or more likely upgrade your system. -

Once you have

Once you have bash, the Unix installation documentation in the previous section can be followed. See section 3 on p. 10; Mac OS X-specific notes are included there where needed. -

+

6 Windows installation

-

In this release of T

In this release of TEX Live, happily, the distribution once again has a native Windows installer, named tlpmgui.exe. (See section 2.1, p. 6, for an explanation of the different distributions.) -

tlpmgui has essentially the same options as the Unix installer, only done through a GUI interface: selecting schemes, individual collections, installation directories, and so on. Section 3.2 on p. tlpmgui can setup the system for running programs directly from the DVD. -

For those who like to look underneath the hood,

For those who like to look underneath the hood, tlpmgui uses as its “engine” a command-line Windows program named tlpm. -

The Windows T

The Windows TEX system included in TEX Live is based on new binaries borrowed from the XEmTEX @@ -2102,10 +2100,10 @@ is similar in usage to the established Unix xdvi. The documentation can be found in texmf/doc/html/windvi/windvi.html. -

T

TEX Live can be installed on systems running Windows 98, ME, NT, 2K or XP. Older versions of Windows (3.1x) and MS-DOS are not supported. -

Warning: Win9.x users must ensure they have enough environment space before undertaking installation. The tlpmgui.exe program won’t change the environment size for them. A few @@ -2113,11 +2111,11 @@ environment variables will be created and it is possible you run out of environm SHELL=<path>COMMAND.COM /E:4096 /P in the config.sys file in order to increase your environment size. -

+

6.1 Installing TEX Live to disk

-

After inserting the T

After inserting the TEX Live CD into the CD drive, autostart should activate tlpmgui. If it does not, click <drive letter> is the drive letter with the TeX Live CD (or TeX Collection DVD), and then click OK. -

The installation window titled

The installation window titled TeX Live installation and maintenance utility should open. It contains the following sections: Main customization, Select systems, Directories and Options. -

In the

In the Directories section the installation drive (directory) next to the CD/DVD button should be displayed (e.g., F:/texlive/ for the DVD), but if it is not, then click class="ec-lmss-10">CD/DVD button and select the CD/DVD drive, with the TEX Live CD (or TeX Collection DVD). -

The directory in which you wish to install the software can be set by clicking the

The directory in which you wish to install the software can be set by clicking the TLroot button. This directory will be set as TLroot environment variable for later usage. The TEXMFTEMP and TEXMFCNF buttons will be adjusted automatically and set during installation, but they can also be adjusted manually now to suit special needs. -

In the

In the Select a scheme section the desired TEX Live installation scheme should be chosen by clicking the radio button labelled with the installation scheme name (e.g., scheme-gust). Each scheme is accompanied by an Info button which, when clicked, displays a short description of the relevant scheme. -

A scheme is a large set of files targeted at some kind of usage. There are generic schemes for +

A scheme is a large set of files targeted at some kind of usage. There are generic schemes for basic, medium and full installations. The remaining ones are either targeted at certain LUGs (i.e., what GUST or GUTenberg propose for their members) or application targeted (e.g., @@ -2188,7 +2186,7 @@ class="ec-lmss-10">Select button labelled Standard collections, additional collections like Metapost, Omega or documentation in different languages can be selected. -

Note: The Ghostscript, Perl and PERL5LIB and GS_LIB environment variables will be set too. -

Next, clicking the

Next, clicking the Select button labelled Language Collections in the Main customization section opens the Language collections window in which the installation language can be chosen by ticking the box next to the language. -

Next, click the

Next, click the Install button in the Install section to start the installation proper process. -

The T

The TEX Live system needs some post-processing steps (format files generation, ls-R databases generation, environment variables, etc.). All these operations are done there, some of them can be lengthy. So please wait until you see a statement about the successfully finished installation. -

The shortcut for

The shortcut for tlpmgui will be added to the StartProgramsTeXLive2005 menu. -

If it is needed (Win9x/WinME), you will be asked to reboot your computer. -

+class="ec-lmss-10">TeXLive2006 menu. +

If it is needed (Win9x/WinME), you will be asked to reboot your computer. +

6.2 Support packages for Windows

-

To be complete, a T

To be complete, a TEX Live installation needs support packages that are not commonly found on a Windows machine. Many scripts are written using the Perl language. Some important tools require the Ghostscript PostScript interpreter to render or to convert files. A graphic file toolbox is also needed in @@ -2232,7 +2230,7 @@ some cases. Last but not least, a TEX-oriented editor makes it easy to type in your TEX files. -

All these tools are quite easy to find for Windows, but in order to try to make your life even easier, +

All these tools are quite easy to find for Windows, but in order to try to make your life even easier, we have put such a set of tools on TEX Live:

    @@ -2244,15 +2242,15 @@ class="ec-lmss-10">Perl 5.8, sufficient to run all the class="E">EX Live Perl scripts.
  • win-tools is a set of small programs (bzip2, gzip, jpeg2ps and tiff2png)
-

These packages are borrowed from the XEmT

These packages are borrowed from the XEmTEX distribution (the successor of fpTEX). -

Perl and Ghostscript are installed by default; you may explicitly deselect them during installation if +

Perl and Ghostscript are installed by default; you may explicitly deselect them during installation if you already have them. -

If you don’t want to install this bundle, then you are on your own to install the required tools to +

If you don’t want to install this bundle, then you are on your own to install the required tools to complete your TEX Live system. Here is a list of places to get those tools: -

+

Ghostscript
SciTE is available from http://www.scintilla.org/SciTE.html
-

You might want to install other tools that are not +

You might want to install other tools that are not free1 @@ -2349,22 +2347,22 @@ class="ec-lmss-10">GSView is available from http://www.cs.wisc.edu/~ghost/gsview/ or any CTAN site. -

+

7 Maintenance of the installation in Windows

-

If you have TeX Live installed, you can use tlpmgui again for modyfying and maintaining your +

If you have TeX Live installed, you can use tlpmgui again for modifying and maintaining your installation. -

+

7.1 Adding/removing packages

-

As the

As the tlpmgui shortcut is available in the StartProgramsTeXLive2005 menu, start it from here. The +class="ec-lmss-10">TeXLive2006 menu, start it from here. The maintenance window titled TeX Live installation and maintenance utility shows. It contains several tabs: Add Packages, Remove packages, Manage installation, Remove installation. -

Click the tab labelled

Click the tab labelled Add packages or Remove packages to enter the relevant functionality and then: @@ -2390,11 +2388,11 @@ class="ec-lmss-10">Buttons section to display or refresh in the Select packages to... section the list of packages to install or remove. -

When adding packages, the list of installed packages is compared to the list of packages +

When adding packages, the list of installed packages is compared to the list of packages available from your CD/DVD. Only packages not already installed are displayed. It is up to you to select which packages you want to install. -

When removing individual packages, only a list of installed packages will be displayed. -

Please note that for both

When removing individual packages, only a list of installed packages will be displayed. +

Please note that for both Add packages and Remove packages the collections are listed first. @@ -2411,15 +2409,15 @@ class="ec-lmss-10">Info about the selected item section. To select severa class="ec-lmss-10">Install or Remove button in the Buttons section to perform the appropriate action. -

+

7.2 Configuring and other management tasks

-

The functions available in the tab labelled

The functions available in the tab labelled Manage the installation are helpful in performing actions needed when you want to add support for a language which was not selected during the installation, or add/regenerate a format which was not selected during the installation or was modified after the installation. -

The following actions can be performed: +

The following actions can be performed:

  • Refresh the ls-R database @@ -2434,36 +2432,36 @@ class="ec-lmtt-10">fmtutil.cnf
  • Edit updmap.cfg
-

Note: you can close the Edit... window with the

Note: you can close the Edit... window with the Cancel or Done button; the latter will start rebuilding the format files (or the fontmap files if you have edited updmap.cfg), followed by a ls-R database files refresh. -

For more information about the configuration see section 

For more information about the configuration see section 7.8, p. 36. -

+

7.3 Uninstalling TEX Live

-

The tab labelled

The tab labelled Remove the TeX Live installation opens a window which contains functionality not worth describing and we do not know who would need it and what it is for...:-) -

Anyway, if you have the

Anyway, if you have the texmf-local directory for your local additions, the removal procedure will not wipe it out or delete things in it. The setup-win32 directory containing tlpmgui and related files will not be deleted. You will have to do some manual cleanup to actually remove them. -

+

7.4 Adding your own packages to the installation

-

First, whatever changes you make,

First, whatever changes you make, do not forget to rebuild the ls-R database files. Otherwise, your new files will not be found. You can do this either via the tlpmgui run and selection of the @@ -2471,26 +2469,26 @@ appropriate action from the Manage the installation tab, or manually running the mktexlsr command. -

If you want to add files that are not provided by the T

If you want to add files that are not provided by the TEX Live distribution, it is recommended to put them in the $TEXMFLOCAL directory. This way, you will be safe against upgrades of the TEX Live software. -

The directory pointed to by

The directory pointed to by $TEXMFLOCAL is initially empty. If, for example, you want to add the support file for the Maple symbolic computation program, you will have to put the style files in:
c:\TeXLive2005\texmf-local\tex\latex\maple\ +class="ec-lmtt-10">c:\TeXLive2006\texmf-local\tex\latex\maple\
and the documentation files in:
c:\TeXLive2005\texmf-local\doc\latex\maple\ -

+class="ec-lmtt-10">c:\TeXLive2006\texmf-local\doc\latex\maple\ +

7.5 Running tlmp.exe from the command line

-

The

The tlpm.exe program which is used as engine by tlpmgui has a number of other useful options. You can get the list by running: @@ -2505,13 +2503,13 @@ class="verbatim">

-

-

More information and examples of use can be found in

+

More information and examples of use can be found in tlpm.readme. -

+

7.6 Network installation

-

Kpathsea knows about UNC names, so you can use them to get your TEXMF tree from the network. +

Kpathsea knows about UNC names, so you can use them to get your TEXMF tree from the network. But there is better than this. All the support files and configuration files, everything except the files in the bin/win32 are shareable with a teT$TEXMFMAIN to the class="ec-lmtt-10">texmf tree that will be accessed remotely. Set $TEXMFVAR to be a local directory which will hold local configuration files and on-the-fly generated files. -

+

7.7 What’s different in Windows?

-

The Windows version of Web2C has some specific features that should be pointed out. -

+

The Windows version of Web2C has some specific features that should be pointed out. +

Kpathsea
README files). class="ec-lmtt-10">-multiple-occurrences with 2 other options for including or excluding any filename that match some pattern (you can request for several patterns). -

The

The kpsecheck command will also report the status of shared memory: in use or not used. That might be useful to know because if the status reported is ‘in use’, that means one or several processes are working, and the effect of any mktexlsr command will be delayed until the next time where no Kpathsea linked process will be running. -

Last, this same command will report about the location it thinks Ghostscript can be found. +

Last, this same command will report about the location it thinks Ghostscript can be found. Under Win32, for many programs, it is easier to use the Ghostscript dll, and find it by using the Ghostscript registry key than to change the PATH, which has a limited length anyway. @@ -2605,17 +2603,17 @@ class="ec-lmtt-10">-time-statistics print statistics about the job the time command is not usually available to Windows users.

-

+

7.8 Personal configurations

-

+

7.8.1 Dvips
-

The configuration file for dvips can be found in +

The configuration file for dvips can be found in
C:\TeXLive2005\texmf-var\dvips\config\config.ps +class="ec-lmtt-10">C:\TeXLive2006\texmf-var\dvips\config\config.ps
You may open it with any editor and change some parameters: -

+

fonts
-

+

paper
@. Move the appropriate lines so that this section beg
  @+ %%BeginPaperSize: Letter
  @+ letter
  @+ %%EndPaperSize
-

The current T

The current TEX Live distribution implements the procedure of making always up-to-date fontmaps files for Dvips and Pdftex. This is done by the updmap program during installation, as well as during any font package addition. If you add new packages by hand, edit the file updmap.cfg in $TEXMFVAR/web2c. -

+

7.8.2 PdfTeX
-

If you use the program pdflatex to write PDF format directly, and you are using US letter-size paper, +

If you use the program pdflatex to write PDF format directly, and you are using US letter-size paper, edit the file C:\TeXLive2005\texmf-var\tex\generic\config\pdftexconfig.tex and change +class="ec-lmtt-10">C:\TeXLive2006\texmf-var\tex\generic\config\pdftexconfig.tex and change ‘\pdfpagewidth’ and ‘\pdfpageheight’. These entries should read:

-

+

\pdfpagewidth=8.5 true true in
Save the file and exit the editor. -

+

7.8.3 GSView
-

GSView is now distributed under the Aladdin License, and therefore is no longer included in T

GSView is now distributed under the Aladdin License, and therefore is no longer included in TEX Live. -

If you may want to change the page size to US letter size. If so, open GSView from the

If you may want to change the page size to US letter size. If so, open GSView from the Start menu, and select MediaLetter. -

Also, there are menu settings that are supposed to give you the most readable screen image. On +

Also, there are menu settings that are supposed to give you the most readable screen image. On MediaDisplay Settings, set both Text Alpha and Graphics Alpha to 4 bits. -

Note that the installation process has set all

Note that the installation process has set all .ps and .eps files to automatically open with GSView. -

For printing instructions, see section 

For printing instructions, see section 7.10 below. -

+

7.8.4 WinDvi
-

The

The tlpmgui.exe program takes care of associating the files with the .dvi extension with Windvi, but it doesn’t make an icon on the desktop, so please do it yourself. -

Open

Open windvi by clicking an icon or from the command line. -

You can set it for US letter-size paper by going to

You can set it for US letter-size paper by going to ViewOptions" x class="ec-lmtt-10">") (and then OK. Exit windvi. -

You can change other parameters from there as well, such as the ability to execute system commands +

You can change other parameters from there as well, such as the ability to execute system commands specified by the document (disabled by default for security reasons). Also, the first time you view any .dvi file, you may find the magnification too large. Zoom out until you get an appropriate size. -

All configuration settings for

All configuration settings for windvi are stored in a file named windvi.cnf file. You can find it by running this command at the prompt: @@ -2755,20 +2753,20 @@ class="verbatim">

-

-

Should you have problems with

+

Should you have problems with windvi, please remove the configuration file and test your problem against a vanilla configuration. -

+

7.9 Testing

-

For generic verification procedures, see section 

For generic verification procedures, see section 4.2 (p. 27). This section describes Windows-specific tests. -

Open the file

Open the file sample2e.tex in your editor (Xemacs, WinShell), found in C:\TeXLive2005\texmf-dist\tex\latex\base. The LATC:\TeXLive2006\texmf-dist\tex\latex\base. The LATEX source should appear on the screen. Process it by clicking on the CommandCommandView DVI menu (XEmacs) or Preview (Windvi) icon (WinShell). -

At first, when you preview files with Windvi, it will create fonts because screen fonts were not +

At first, when you preview files with Windvi, it will create fonts because screen fonts were not installed. After a while, you will have created most of the fonts you use, and you will rarely see the font-creation window. -

Hint for the future: If a LATEX run stops because LATEX cannot find a file, you can press Ctrl-z to quit. -

+

7.10 Printing

-

It is possible to print from Windvi. In this case, printing will be done using the Windows unified printer +

It is possible to print from Windvi. In this case, printing will be done using the Windows unified printer driver. By definition, it is compatible with all printers. However, there is some drawback: it can generate some huge spool files, and some (older) versions of Windows just don’t like them. The advantage is that you can use features like embedding BMP or WMF images. You also need to make @@ -2799,7 +2797,7 @@ sure that the printer parameters are correctly set (subsection 7.8.4), else you will get scaled printing (printing at 600dpi on a 300dpi printer will give you only one quadrant of your page). -

Printing is faster and more reliable if you run

Printing is faster and more reliable if you run dvips to make a .ps file and then print from GSView. In @@ -2809,7 +2807,7 @@ class="ec-lmss-10">FilePrint.... A Print window will appear. -

If you are using a PostScript printer,

If you are using a PostScript printer, be sure to select PostScript Printer. This is done in the Print @@ -2819,7 +2817,7 @@ class="ec-lmss-10">Print window. You can then select any of the printers previously installed. If you fail to check the box for PostScript Printer, printing will not work. -

If you will be using your own non-PostScript printer, select

If you will be using your own non-PostScript printer, select Ghostscript device in the Print Method box, then click on the button to the right labelled PostScript Printer is not selected, then select your printer type from the Device list.) -

+

7.11 Tips and tricks for Win32

-

+

7.11.1 Different flavors of Win32
-

What we call Win32 is not an operating system by itself. It is a large set of functions (around 12,000 in +

What we call Win32 is not an operating system by itself. It is a large set of functions (around 12,000 in the header files of the Microsoft SDK) that you can use to write programs for different operating systems of the Windows family. -

Windows comes in different flavors: +

Windows comes in different flavors:

  • Win95, Win98 and WinME, which are not true multitasking, multithreading environments. @@ -2859,7 +2857,7 @@ class="ec-lmtt-10">MS-DOS 7.0’ (at least for the old versions of Wi
  • Windows XP, which comes with Personal and Pro flavors. This is the last step in merging both lines of products (Win9x based and NT based). XP is based on NT.
-

Win9x are able to run 32 bits programs and 16 bits programs concurrently. But the operating +

Win9x are able to run 32 bits programs and 16 bits programs concurrently. But the operating system by itself is not entirely written in 32 bits mode, and does not support memory protection: 16bits applications can overwrite parts of the operating system memory! Some parts of the system like the GDI (Graphical Device Interface) manage limited resources like bitmaps, fonts, pens and so on for the @@ -2867,24 +2865,24 @@ set of all programs that run concurrently. All the bitmaps headers available at time can’t amount for more than 64kB. This explains the performance tool and the fact that you can put your system on his knees by making intensive use of graphic objects for example. -

NT, 2K and XP do not suffer from these limitations, and neither from other Win9x limitations. They +

NT, 2K and XP do not suffer from these limitations, and neither from other Win9x limitations. They are true multitasking environments, with protected memory. They are much more responsive than Win9x because of better memory management, better file system and so on. -

+

7.11.2 Command line prompt
-

You may wonder, “Why would I need to use a command line prompt when I have Windows?” -

Good question. The problem is of very general nature. Not all operations can be done easily using +

You may wonder, “Why would I need to use a command line prompt when I have Windows?” +

Good question. The problem is of very general nature. Not all operations can be done easily using only a GUI. Command line gives you programming power — assuming a clever command interpreter. -

But the problem here is more fundamental: T

But the problem here is more fundamental: TEX is a batch tool. Not an interactive one. TEX needs to compute the best layout for each page, resolve cross-references and so on. This can be done only by a global processing of the document. It is not (yet) a task that can be done interactively. -

This means that you should use T

This means that you should use TEX from a command line. In fact the situation is not so bad. There is an advantage to write command line tools for complex processing: they are better debugged, because they are independent of any GUI problems, and GUI tools can be designed to interface to the command @@ -2893,9 +2891,9 @@ class="E">EX, where you will mostly interact with it through a GUI editor. -

However, you may need to use the command line prompt in a number of situations. One is when you +

However, you may need to use the command line prompt in a number of situations. One is when you are having difficulties and want to debug your setup. -

+

Win9x
cmd.exe, which is the name of the brand new command interpreter for NT (thus, it is untrue to call this a DOS box!).
-

These locations may change across different Windows versions. -

+

These locations may change across different Windows versions. +

7.11.3 Path separators
-

The Win32 API understands both

The Win32 API understands both / and \ characters as PATH separators. But the command interpreters do not! So whenever a path name is used programmatically, you can use both separators, @@ -2938,14 +2936,14 @@ class="ec-lmtt-10">\ as path separator. The reason is compatibility: the command processor used ‘/’ to introduce arguments to commands. -

All this to say: do not be surprised to read path names written using the Unix convention; fpT

All this to say: do not be surprised to read path names written using the Unix convention; fpTEX is a port of Web2C, and aims to be compatible across platforms. For this reason, all the configuration files that need to specify path names use the Unix convention. -

+

7.11.4 File systems
-

The worst feature of Win9x with regard to T

The worst feature of Win9x with regard to TEX is probably the so-called FAT file system. TEX uses very many small files, with size around 1–3kB. The FAT file system is old, and predates by decades the @@ -2957,19 +2955,19 @@ class="ec-lmri-10">any file on a huge partition. It means that TEX will use much more disk space than it actually needs. -

The other, more modern, file systems available, FAT32 and NTFS, do not have this drawback. They +

The other, more modern, file systems available, FAT32 and NTFS, do not have this drawback. They manage clusters of 4kB only. (You can lower the limit to 512 bytes on NTFS.) -

+

7.11.5 How to add some directory to your PATH
-

There are pairs of variables and values which behave much like global variables inside your programs. +

There are pairs of variables and values which behave much like global variables inside your programs. The set of those variables is called the environment. Each program is initialized with a copy of the environment when it is run. It can request and change the value of any variable. The changes happen in the copy of the environment, and is not at all propagated to the other running programs. -

Your PATH is a special environment variable used to search for programs you want to run. There is a +

Your PATH is a special environment variable used to search for programs you want to run. There is a different procedure to change it for Win9x, WinME and NT/2K/XP: -

+

@@ -2988,11 +2986,11 @@ class="verbatim">
  PATH=c:\windows;c:\windows\system;c:\TeXLive2005\bin\win32 + id="x1-43002r1">  PATH=c:\windows;c:\windows\system;c:\TeXLive2006\bin\win32
-

+

Windows ME
Environment Variables among the dialog boxes. Now class="ec-lmtt-10">PATH for all users, you will have to contact your system administrator or be the system administrator yourself — in the latter case you should know what you are doing. -

If there is already a

If there is already a PATH setting for your user account, left click on PATH. In the field PATH while the field Value shows the current setting o class="ec-lmtt-10">PATH as a list of directories separated by ;. Add the directory where the executables are located (e.g. c:\TeXLive2005\bin\win32). If there isn’t a c:\TeXLive2006\bin\win32). If there isn’t a PATH variable for your user account, simply click in the field Variable and type in PATH, click in the field Ok, otherwise the changes to PATH won’t apply to your system. Be careful when changing the environment settings.

-

The best way to be sure that a variable has been properly set is to open a console and +

The best way to be sure that a variable has been properly set is to open a console and type: @@ -3054,27 +3052,27 @@ class="verbatim">

-

which should return the corresponding value. -

+

which should return the corresponding value. +

7.11.6 TEX engines
-

If you have a look at the Web2C documentation, you will read that all the various T

If you have a look at the Web2C documentation, you will read that all the various TEX derived programs use the same base engine. For example, tex.exe and latex.exe are exact copies of the same program, but each one will use a different format file, based on its calling name. -

Under Unix, this feature is implemented through

Under Unix, this feature is implemented through symbolic links. It saves up a bit of disk space, because some engines are used with many different format files. -

The Win32 API does not know about file links. So to save up almost the same amount of memory, all +

The Win32 API does not know about file links. So to save up almost the same amount of memory, all the TEX base engines have been put in DLLs (Dynamic Linked Library). This means that you will have the following layout:

-

+

18/09/2005 tl90pdfetex.dll. The same trick has been used f class="ec-lmtt-10">mktex*.exe family of programs which are linked to the mktex.dll library. -

In fact, a generic tool called

In fact, a generic tool called irun.exe is provided to build the equivalent of Unix hard links for executable files only under Win32. -

+

7.12 In case of problems

-

+

7.12.1 What to do if latex does not find your files?
@@ -3176,7 +3174,7 @@ class="verbatim">
-

You can also set the debug level: +

You can also set the debug level:
-

-

If you want to redirect stderr to stdout, which is not possible Windows, then do: +

+

If you want to redirect stderr to stdout, which is not possible Windows, then do:
-

This way you can capture both stdout and stderr in the same file. +

This way you can capture both stdout and stderr in the same file.

  • Assuming the installation has been done in c:/TeX, check the following values: @@ -3264,11 +3262,11 @@ class="E">EX and friends should work. If it is not the case, you w class="ec-lmtt-10">-debug=n option from kpsewhich, and check back all the values. Try to identify and report the problem.
  • -

    +

    7.12.2 What to do if your setup still does not work as expected?
    -

    Here are several questions to investigate: -

    +

    Here are several questions to investigate: +

    1. PATH? >Is the TEXMFCNF variable correctly set to c:/TeXLive2005/texmf-var/web2c (default +class="ec-lmtt-10">c:/TeXLive2006/texmf-var/web2c (default value)?
    2. http://tug.org/texlive/? (Unlikely, but it hurt to check.)
    -

    The T

    The TEX Live software consists of hundreds of programs and tens of thousands of files, all from varying sources. So it is quite difficult to predict all possible causes for problems. Nevertheless, we will do our best to help you. (See section 1.2, p. 5.) -

    +

    8 A user’s guide to Web2C

    -

    Web2C is an integrated collection of T

    Web2C is an integrated collection of TEX-related programs: TEX itself, Metafont, MetaPost, BibTeX, etc. It is the heart of TEX Live. -

    A bit of history: The original implementation was by Tomas Rokicki who, in 1987, developed a first +

    A bit of history: The original implementation was by Tomas Rokicki who, in 1987, developed a first TEX-to-C system based on change files under Unix, which were primarily the original work of Howard Trickey and Pavel Curtis. Tim Morgan became the maintainer of the system, and during this period the name changed to Web-to-C. In 1990, Karl Berry took over the work, assisted by dozens of additional contributors, and in 1997 he handed the baton to Olaf Weber. -

    The Web2C system runs on Unix, 32-bit Windows systems, Mac OS X, and other operating systems. +

    The Web2C system runs on Unix, 32-bit Windows systems, Mac OS X, and other operating systems. It uses Knuth’s original sources for TEX and other basic programs written in web and translates them into C source code. The core TEX programs are: -

    +

    bibtex
    weave
    web to TEX.
    -

    The precise functions and syntax of these programs are described in the documentation of the individual +

    The precise functions and syntax of these programs are described in the documentation of the individual packages and of Web2C itself. However, knowing a few principles governing the whole family of programs will help you take advantage of your Web2C installation. -

    All programs honor these standard GNU options: +

    All programs honor these standard GNU options:

    --help
    print detailed progress report. --version
    print version information, then exit.
    -

    For locating files the Web2C programs use the path searching library Kpathsea. This +

    For locating files the Web2C programs use the path searching library Kpathsea. This library uses a combination of environment variables and a configuration files to optimize searching the (huge) collection of TEX files. Web2C can look at more than one directory @@ -3462,13 +3460,13 @@ extensions in two distinct trees. To speed up file searches the root of each tre ls-R, containing an entry showing the name and relative pathname for all files under that root. -

    +

    8.1 Kpathsea path searching

    -

    Let us first describe the generic path searching mechanism of the Kpathsea library. +

    Let us first describe the generic path searching mechanism of the Kpathsea library. -

    We call a

    We call a search path a colon- or semicolon-separated list of path elements, which are basically directory names. A search path can come from (a combination of) many sources. To look up a file @@ -3478,23 +3476,23 @@ class="ec-lmtt-10">.:/dir’, Kpathsea checks each element of the pat class="ec-lmtt-10">./my-file, then /dir/my-file, returning the first match (or possibly all matches). -

    In order to adapt optimally to all operating systems’ conventions, on non-Unix systems Kpathsea can +

    In order to adapt optimally to all operating systems’ conventions, on non-Unix systems Kpathsea can use filename separators different from colon (‘:’) and slash (‘/’). -

    To check a particular path element

    To check a particular path element p, Kpathsea first checks if a prebuilt database (see “Filename database” on page 55) applies to p, i.e., if the database is in a directory that is a prefix of p. If so, the path specification is matched against the contents of the database. -

    If the database does not exist, or does not apply to this path element, or contains no matches, the +

    If the database does not exist, or does not apply to this path element, or contains no matches, the filesystem is searched (if this was not forbidden by a specification starting with ‘!!’ and if the file being searched for must exist). Kpathsea constructs the list of directories that correspond to this path element, and then checks in each for the file being sought. -

    The “file must exist” condition comes into play with ‘

    The “file must exist” condition comes into play with ‘.vf’ files and input files read by TEX’s \openin @@ -3505,23 +3503,23 @@ class="ec-lmtt-10">ls-R when you install a new ‘.vf’ file, it will never be found. Each path element is checked in turn: first the database, then the disk. If a match is found, the search stops and the result is returned. -

    Although the simplest and most common path element is a directory name, Kpathsea supports +

    Although the simplest and most common path element is a directory name, Kpathsea supports additional features in search paths: layered default values, environment variable names, config file values, users’ home directories, and recursive subdirectory searching. Thus, we say that Kpathsea expands a path element, meaning it transforms all the specifications into basic directory name or names. This is described in the following sections in the same order as it takes place. -

    Note that if the filename being searched for is absolute or explicitly relative, i.e., starts with ‘

    Note that if the filename being searched for is absolute or explicitly relative, i.e., starts with ‘/’ or ‘./’ or ‘../’, Kpathsea simply checks if that file exists. -

    +

    8.1.1 Path sources
    -

    A search path can come from many sources. In the order in which Kpathsea uses them: -

    +

    A search path can come from many sources. In the order in which Kpathsea uses them: +

    1. TEXINPUTS=/c:/d’ (see
    2. The compile-time default.
    -

    You can see each of these values for a given search path by using the debugging options (see “Debugging +

    You can see each of these values for a given search path by using the debugging options (see “Debugging actions” on page 59). -

    +

    8.1.2 Config files
    -

    Kpathsea reads

    Kpathsea reads runtime configuration files named texmf.cnf for search path and other definitions. The search path used to look for these files is named \ at the end of a line acts as a continuation characte Whitespace at the beginning of continuation lines is not ignored.

  • Each remaining line has the form:
    -

    +

      texmf.cnf for Unix, MS-DOS and
  • All definitions are read before anything is expanded, so variables can be referenced before they are defined.
  • -

    A configuration file fragment illustrating most of these points is shown below: -

    +

    A configuration file fragment illustrating most of these points is shown below: +

     .;$TEXMF/{etex,tex}/{eplain,plain,generic;}// -

    +

    8.1.3 Path expansion
    -

    Kpathsea recognizes certain special characters and constructions in search paths, similar to those +

    Kpathsea recognizes certain special characters and constructions in search paths, similar to those available in Unix shells. As a general example, the complex path, ~$USER/{foo,bar}//baz, expands to all subdirectories under directories $USER’s home directory that contain a directory class="ec-lmtt-10">baz. These expansions are explained in the sections below.

    8.1.4 Default expansion
    -

    If the highest-priority search path (see “Path sources” on page 

    If the highest-priority search path (see “Path sources” on page 50) contains an extra colon (i.e., leading, trailing, or doubled), Kpathsea inserts at that point the next-highest-priority search path that is defined. If that inserted path has an extra colon, the same happens with the next highest. For example, given an environment variable setting

    -

    +

    > /home/karl: class="ec-lmtt-10">TEXINPUTS value from texmf.cnf of
    -

    +

      .:$TEXMF//tex
    then the final value used for searching will be:
    -

    +

      /home/karl:.:$TEXMF//tex
    -

    Since it would be useless to insert the default value in more than one place, Kpathsea changes only +

    Since it would be useless to insert the default value in more than one place, Kpathsea changes only one extra ‘:’ and leaves any others in place. It checks first for a leading ‘:’, then a trailing ‘:’, then a doubled ‘:’. -

    +

    8.1.5 Brace expansion
    -

    A useful feature is brace expansion, which means that, for instance,

    A useful feature is brace expansion, which means that, for instance, v{a,b}w expands to vaw:vbw. Nesting is allowed. This is used to implement multiple T

    -

    Using this you can then write something like +

    Using this you can then write something like
    -

    which means that, after looking in the current directory, the

    which means that, after looking in the current directory, the $TEXMFHOME/tex, $TEXMFLOCAL/tex, $TEXMF variable in all definitions, one is sure to always search the up-to-date tree first. -

    +

    8.1.6 Subdirectory expansion
    -

    Two or more consecutive slashes in a path element following a directory

    Two or more consecutive slashes in a path element following a directory d is replaced by all subdirectories of d: first those subdirectories directly under d, then the subsubdirectories under those, and so on. At each level, the order in which the directories are searched is unspecified. -

    If you specify any filename components after the ‘

    If you specify any filename components after the ‘//’, only subdirectories with matching components are included. For example, ‘/a//b’ expands into directories /a/1/1/b, and so on, but not /a/b/c or /a/1. -

    Multiple ‘

    Multiple ‘//’ constructs in a path are possible, but ‘//’ at the beginning of a path is ignored. -

    +

    8.1.7 List of special characters and their meaning: a summary
    -

    The following list summarizes the special characters in Kpathsea configuration files. -

    +

    The following list summarizes the special characters in Kpathsea configuration files. +

    :
    !!
    Search only database to locate file, do not search the disk.
    -

    +

    8.2 Filename databases

    -

    Kpathsea goes to some lengths to minimize disk accesses for searches. Nevertheless, at installations with +

    Kpathsea goes to some lengths to minimize disk accesses for searches. Nevertheless, at installations with enough directories, searching each possible directory for a given file can take an excessively long time (this is especially true if many hundreds of font directories have to be traversed.) Therefore, Kpathsea can use an externally-built plain text “database” file named ls-R that maps files to directories, thus avoiding the need to exhaustively search the disk. -

    A second database file

    A second database file aliases allows you to give additional names to the files listed in ls-R. This can be helpful to confirm to DOS 8.3 filename conventions in source files. -

    +

    8.2.1 The filename database
    -

    As explained above, the name of the main filename database must be

    As explained above, the name of the main filename database must be ls-R. You can put one at the root of each TEX hierarchy in your installation that you wish to be searched (ls-R files along the TEXMFDBS path. -

    The recommended way to create and maintain ‘

    The recommended way to create and maintain ‘ls-R’ is to run the mktexlsr script included with the distribution. It is invoked by the various ‘mktex’... scripts. In principle, this script just runs the command

    -

    +

    cd cron, so that it is automatically updated when the installed files change, such as after installing or updating a LATEX package. -

    If a file is not found in the database, by default Kpathsea goes ahead and searches the disk. If a +

    If a file is not found in the database, by default Kpathsea goes ahead and searches the disk. If a particular path element begins with ‘!!’, however, only the database will be searched for that element, never the disk. -

    +

    8.2.2 kpsewhich: Standalone path searching
    -

    The

    The kpsewhich program exercises path searching independent of any particular application. This can be useful as a sort of find program to locate files in TEX hierarchies (this is used heavily in the distributed ‘mktex’... scripts).

    -

    +

    > option start with either ‘-’ or ‘--’, and any unambiguous abbreviation is accepted. -

    Kpathsea looks up each non-option argument on the command line as a filename, and returns the +

    Kpathsea looks up each non-option argument on the command line as a filename, and returns the first file found. There is no option to return all the files with a particular name (you can run the Unix ‘find’ utility for that). -

    The more important options are described next. -

    +

    The more important options are described next. +

    --dpi=num

    sets the debugging options to num.
    -

    +

    8.2.3 Examples of use
    -

    Let us now have a look at Kpathsea in action. Here’s a straightforward search: +

    Let us now have a look at Kpathsea in action. Here’s a straightforward search:

    -

    +

    > EX source file directories). We find it in the subdirectory tex/latex/base below the ‘texmf-distTEX Live  directory. +class="E">EX Live directory. Similarly, all of the following are found without problems thanks to their unambiguous suffix.
    -

    +

    >   /usr/local/texmf-dist/bibtex/bib/beebe/tugboat.bib
    -

    That last is a BibTeX bibliography database for

    That last is a BibTeX bibliography database for TUGBoat articles.

    -

    +

    > .pk’ files in TEX Live — the Type 1 variants are used by default.
    -

    +

    >   /usr/local/texmf-var/fonts/pk/ljfour/public/wsuipa/wsuipa10.600pk
    -

    For these fonts (a phonetic alphabet from the University of Washington) we had to generate ‘

    For these fonts (a phonetic alphabet from the University of Washington) we had to generate ‘.pk’ files, and since the default Metafont mode on our installation is ljfour with a base resolution of 600dpi (dots per inch), this instantiation is returned.

    -

    +

    > .pk files using the script mktexpk. -

    Next we turn our attention to

    Next we turn our attention to dvips’s header and configuration files. We first look at one of the commonly used files, the general prolog tex.pro for Tdvips config) for the file config.ps.

    -

    +

    >   /usr/local/texmf/fonts/map/dvips/updmap/psfonts.map
    -

    We now take a closer look at the URW Times PostScript support files. The prefix for these in the +

    We now take a closer look at the URW Times PostScript support files. The prefix for these in the standard font naming scheme is ‘utm’. The first file we look at is the configuration file, which contains the name of the map file:

    -

    +

    >   /usr/local/texmf-dist/dvips/psnfss/config.utm
    The contents of that file is
    -

    +

      p +utm.map
    which points to the file utm.map, which we want to locate next.
    -

    +

    >  /usr/local/texmf-dist/fonts/map/dvips/times/utm.map
    This map file defines the file names of the Type 1 PostScript fonts in the URW collection. Its contents look like (we only show part of the lines):
    -

    +

    utmb8r  <utmr8a.pfb class="ec-lmtt-10">utmr8a.pfb and find its position in the texmf directory tree with a search for Type 1 font files:
    -

    +

    >   /usr/local/texmf-dist/fonts/type1/urw/times/utmr8a.pfb
    -

    It should be evident from these examples how you can easily locate the whereabouts of a given file. +

    It should be evident from these examples how you can easily locate the whereabouts of a given file. This is especially important if you suspect that the wrong version of a file is picked up somehow, since kpsewhich will show you the first file encountered. -

    +

    8.2.4 Debugging actions
    -

    Sometimes it is necessary to investigate how a program resolves file references. To make this practical, +

    Sometimes it is necessary to investigate how a program resolves file references. To make this practical, Kpathsea offers various levels of debugging output: -

    +

     1
    Directory list for each path element (only relevant for searches on 32
    File searches.
    -

    A value of

    A value of -1 will set all the above options; in practice, this is usually the most convenient. -

    Similarly, with the

    Similarly, with the dvips program, by setting a combination of debug switches, one can follow in detail where files are being picked up from. Alternatively, when a file is not found, the debug trace shows in which directories the program looks for the given file, so that one can get an indication what the problem is. -

    Generally speaking, as most programs call the Kpathsea library internally, one can select a debug +

    Generally speaking, as most programs call the Kpathsea library internally, one can select a debug option by using the KPATHSEA_DEBUG environment variable, and setting it to (a combination of) values as described in the above list. -

    (Note for Windows users: it is not easy to redirect all messages to a file in this system. For diagnostic +

    (Note for Windows users: it is not easy to redirect all messages to a file in this system. For diagnostic purposes you can temporarily SET KPATHSEA_DEBUG_OUTPUT=err.log). -

    Let us consider, as an example, a small LAT

    Let us consider, as an example, a small LATEX source file, hello-world.tex, which contains the following input. @@ -4396,13 +4394,13 @@ class="verbatim">

    -

    This little file only uses the font

    This little file only uses the font cmr10, so let us look at how dvips prepares the PostScript file (we want to use the Type 1 version of the Computer Modern fonts, hence the option -Pcms).

    -

    +

    > dvips Reference Manual, texmf/doc/html/dvips/dvips_toc.html). The output (slightly rearranged) appears in Figure 1. -


    Finding the font file

    dvips starts by locating its working files. First, texmf.cnf is found, which gives the definitions of the search paths for the other files, then the file database dvips command). This file contains the list of the map which define the relation between the TEX, PostScript and file system names of the fonts.

    -

    +

    > psfonts.map, which is always loaded (it contains declarations for commonly used PostScript fonts; see the last part of Section 8.2.3 for more details about PostScript map file handling). -

    At this point

    At this point dvips identifies itself to the user:

    -

    +

    This is (www.radicaleye.com)
    Then it goes on to look for the prolog file texc.pro:
    -

    +


    kdebug:start search(file=texc.pro, => /usr/local/texmf/dvips/base/texc.pro
    -

    After having found the file in question,

    After having found the file in question, dvips outputs date and time, and informs us that it will generate the file hello-world.ps, then that it needs the font file cmr10, and that the latter is declared as “resident” (no bitmaps needed):

    -

    +


    TeX outputcmr10.pfb of the font is located and included in the o file (see last line).
    -

    +


    kdebug:start search(file=cmr10.tfm,<cmr10.pfb>[1]

    8.3 Runtime options

    -

    Another useful feature of Web2C is its possibility to control a number of memory parameters +

    Another useful feature of Web2C is its possibility to control a number of memory parameters (in particular, array sizes) via the runtime file texmf.cnf read by Kpathsea. The memory settings can be found in Part 3 of that file in the TEX Live distribution. The more important are: -

    +

    main_memory
    Additional space for the hash table of control sequence names. Appr class="ec-lmtt-10">hash_extra is 50000.
    -

    Of course, this facility is no substitute for truly dynamic arrays and memory allocation, but since these +

    Of course, this facility is no substitute for truly dynamic arrays and memory allocation, but since these are extremely difficult to implement in the present TEX source, these runtime parameters provide a practical compromise allowing some flexibility. -

    +

    9 Acknowledgements

    -

    T

    TEX Live is a joint effort by virtually all of the TEX user groups. This edition of TEX Live was overseen by Sebastian Rahtz and Karl Berry. The other principal contributors are listed below.

      -
    • The German-speaking TEX Users (DANTE e.V.), who provide the hardware for the - TEX Live source repository; and Rainer Schöpf and Reinhard Zierke who look after it. - DANTE officers Volker Schaa and Klaus Höppner coordinate production with the Lehmann’s - Bookstore (http://www.lob.de). +
    • The English, German, Dutch, and Polish TEX user groups (TUG, DANTE e.V., NTG, + and GUST, respectively), which together provide the necessary technical and administrative + infrastructure. Please join your local user group!
    • -
    • The Perforce corporation (http://www.perforce.com), for providing a free copy of their - excellent change management system, which we use to manage the TEX Live sources. +
    • The CTAN team, which distributes the TEX Live images and provides the common + infrastructure for package updates, upon which TEX Live depends.
    • Peter Breitenlohner and the e-TEX team for the stable foundation of future TEX4ht was used to create the HTML version of this docume class="E">EXt format conform to TEX Live’s needs. -
    • -
    • Paweł Jackowski, for the Windows installer tlpm, and Tomasz Łuczak, for tlpmgui.
    • Hàn Thê´ Thành, Martin Schröder, and the pdfTEX team for continuing enhancements of TEX’s abilities. +
    • +
    • Taco Hoekwater, for renewed development efforts on MetaPost and TEX itself. +
    • +
    • Paweł Jackowski, for the Windows installer tlpm, and Tomasz Łuczak, for tlpmgui. +
    • +
    • Akira Kakuto, for updated Windows binaries as part of his W32TEX distribution effort (http://www.fsci.fuk.kindai.ac.jp/kakuto/win32-ptex/). +
    • +
    • Jonathan Kew and his employer SIL, for the major new development of XeTEX and taking + the time and trouble to integrate it in TEX Live. +
    • +
    • Reinhard Kotucha, for helping with the massive task of updating packages in TEX Live, as + well as Windows research efforts, the getnonfreefonts script, and more.
    • Petr Olsak, who coordinated and checked all the Czech and Slovak material very carefully.
    • -
    • Fabrice Popineau, for the Windows binaries in TFabrice Popineau, for the original Windows support in TEX Live. +
    • +
    • Norbert Preining, for helping with the TEX Live infrastructure and package updates, and + coordinating the Debian version of TEX Live (together with Frank Küster), making many + suggestions for improvement along the way.
    • Staszek Wawrykiewicz, the principal tester for all of TEX Live, and coordinator of the many major Polish contributions: fonts, Windows installation, and more. + +
    • Olaf Weber, for his patient assembly and maintenance of Web2C, upon which all else depends. @@ -4913,7 +4931,7 @@ class="E">EX Live, and coordinator of the many
    • Graham Williams, on whose work the catalogue of packages depends.
    -

    Builders of the binaries: Tigran Aivazian (

    Builders of the binaries: Tigran Aivazian (x86_64-linux), Manfred Lotz (i386-freebsd), Fabrice Popineau (mips-irix), Gerben Wierda (i386-darwin, powerpc-darwin). -

    Documentation and translation updates: Karl Berry (English), Daniel Flipo & Fabrice Popineau - +

    Documentation and translation updates: Karl Berry (English), Daniel Flipo & Fabrice Popineau (French), Günter Partosch & Hartmut Henkel (German), Petr Sojka & Jan Busa (Czech/Slovak), Boris Veytsman (Russian), Staszek Wawrykiewicz (Polish). -

    Of course the most important acknowledgement must go to Donald Knuth, first for inventing T

    Of course the most important acknowledgement must go to Donald Knuth, first for inventing TEX, and then for giving it to the world. -

    +

    10 Release history

    -

    +

    10.1 Past

    -

    Discussion began in late 1993 when the Dutch T

    Discussion began in late 1993 when the Dutch TEX Users Group was starting work on its 4AllTEX CD for MS-DOS users, and it was hoped at that time to issue a single, rational, CD for all systems. This was @@ -4965,7 +4982,7 @@ class="E">EX CD showed that Unix users would benefit from a similarly easy system, and this is the other main strand of TEX Live. -

    We first undertook to make a new Unix-based TDS CD in the autumn of 1995, and quickly identified +

    We first undertook to make a new Unix-based TDS CD in the autumn of 1995, and quickly identified Thomas Esser’s teTEX as the ideal setup, as it already had multi-platform support and was built with portability across file systems in mind. Thomas agreed to help, and work began seriously at the start of @@ -4983,9 +5000,11 @@ almost all of its features. The 4th edition followed the same pattern, using a n teTEX, and a new release of Web2C (7.3). The system now included a complete Windows setup. -

    For the 5th edition (March 2000) many parts of the CD were revised and checked, updating hundreds +

    For the 5th edition (March 2000) many parts of the CD were revised and checked, updating hundreds of packages. Package details were stored in XML files. But the major change for TEX Live 5 was that all + + non-free software was removed. Everything in TEX Live is now intended to be compatible with the Debian Free Software Guidelines (http://www.debian.org/intro/free); we have done our best to check the license conditions of all packages, but we would very much appreciate hearing of any mistakes. -

    The 6th edition (July 2001) had much more material updated. The major change was a new install +

    The 6th edition (July 2001) had much more material updated. The major change was a new install concept: the user could select a more exact set of needed collections. Language-related collections were completely reorganized, so selecting any of them installs not only macros, fonts, etc., but also prepares an appropriate language.dat. -

    The 7th edition of 2002 had the notable addition of Mac OS X support, and the usual myriad of +

    The 7th edition of 2002 had the notable addition of Mac OS X support, and the usual myriad of updates to all sorts of packages and programs. An important goal was integration of the source back with teTEX, to correct the drift apart in versions 5 and 6. -

    - - +

    10.1.1 2003
    -

    In 2003, with the continuing flood of updates and additions, we found that T

    In 2003, with the continuing flood of updates and additions, we found that TEX Live had grown so large it could no longer be contained on a single CD, so we split it into three different distributions (see section texmf/web2c/cp8bit.tcx. (Future releases

  • Finally, since the edition numbers had grown unwieldy, the version is now simply identified by the year: TEX Live 2003.
  • -

    + + +

    10.1.2 2004
    -

    2004 saw many changes: +

    2004 saw many changes:

    -

    See the Web2C manual for more:

    See the Web2C manual for more: texmf/doc/web2c.

  • encTmips-irix, the MIPSpro 7.4 runtimes are
  • -

    -

    10.2 Present

    -

    2005 saw the usual huge number of updates to packages and programs. The infrastructure stayed +

    +

    10.1.3 2005
    +

    2005 saw the usual huge number of updates to packages and programs. The infrastructure stayed relatively stable from 2004, but inevitably there were some changes there as well:

    • New scripts
    -

    +

  • The new program dvipdfmx is included for translation of DVI to PDF; this is an actively @@ -5391,36 +5409,60 @@ class="ec-lmtt-10">TEXMFSYSVAR, respectively. There is also TEXMFVAR, which is by default user-specific. See the first point above.
  • -

    +

    +

    10.2 Present

    +

    In 2006, the major new addition to TEX Live was the XeTEX program, available as the xetex and +xelatex programs; see http://scripts.sil.org/xetex. +

    MetaPost also received a notable update, with more planned for the future (http://tug.org/metapost/articles), likewise pdfTEX (http://tug.org/applications/pdftex) +

    Of course the year also saw (the usual) hundreds of other updates to packages and programs. As +usual, please check CTAN (http://www.ctan.org) for updates. +

    Internally, the source tree is now stored in Subversion, with a standard web interface for viewing the +tree, as linked from our home page. Although not visible in the final distribution, we expect this will +provide a stable development foundation for future years. +

    10.3 Future

    -

    Future +

    TEX Live is not perfect! (And never will be.) We intend to continue to release new versions yearly, and -would like to provide more help material, more utilities, more installation programs, and (of course) an +class="ec-lmri-10">Live is not perfect! (And never will be.) We intend to continue to release new versions, and would +like to provide more help material, more utilities, more installation programs, and (of course) an ever-improved and checked tree of macros and fonts. This work is all done by hard-pressed volunteers in their limited spare time, and a great deal remains to be done. If you can help, don’t hesitate to put your name forward! -

    Please send corrections, suggestions, and offers of help to: +

    Please send corrections, suggestions, and offers of help to:

    -

    Sebastian Rahtz  /  7 Stratfield Road  /  Oxford OX2 7BG  /  UK -

    tex-live@tug.org
    http://tug.org/texlive

    -

    http://tug.org/texlive

    + +

    Happy TEXing! -

    1Not free, that is, in the sense of freedom to modify and redistribute, following free software guidelines. This does