summaryrefslogtreecommitdiff
path: root/Master/texmf
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-01-20 02:38:37 +0000
committerKarl Berry <karl@freefriends.org>2009-01-20 02:38:37 +0000
commitf9a670f548cca3ff8a7ffd984cd5d2bb8c46fe98 (patch)
treeddf773596a8e7cf6944f32167e948239e375fc39 /Master/texmf
parent2549354825ab48210e908a4ab9e07c409bde5a45 (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@11923 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf')
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.1191
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.pdfbin25943 -> 30959 bytes
2 files changed, 156 insertions, 35 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
index 56c3b8997f8..86c35c110b2 100644
--- a/Master/texmf/doc/man/man1/tlmgr.1
+++ b/Master/texmf/doc/man/man1/tlmgr.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "TLMGR 1"
-.TH TLMGR 1 "2008-12-25" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2009-01-19" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
@@ -172,6 +172,11 @@ Normally the \s-1GUI\s0 tries to deduce your language from the environment (on
Windows via the registry, on Unix via \f(CW\*(C`LC_MESSAGES\*(C'\fR). If that fails you
can select a different language by giving this option a two-letter
language code.
+.IP "\fB\-\-machine\-readable\fR" 4
+.IX Item "--machine-readable"
+In lieu of the normal output intended for human consumption, write to
+standard output in a fixed format more suitable for machine parsing.
+See the \*(L"\s-1MACHINE\-READABLE\s0 \s-1OUTPUT\s0\*(R" section below for details.
.IP "\fB\-\-package\-logfile\fR \fIfile\fR" 4
.IX Item "--package-logfile file"
\&\fBtlmgr\fR logs all package actions (install, remove, update, failed
@@ -262,8 +267,8 @@ written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
If updates to tlmgr itself (that is, the infrastructure packages) are
-present, tlmgr will not perform the update unless this option (or
-\&\f(CW\*(C`\-\-list\*(C'\fR) is given.
+present, tlmgr will not perform the update unless this option is given.
+(\f(CW\*(C`\-\-list\*(C'\fR is still performed regardless of this option.)
.IP "\fB\-\-no\-remove\fR" 4
.IX Item "--no-remove"
Under normal circumstances tlmgr tries to remove packages which have
@@ -403,6 +408,9 @@ Possible values for \fIkey\fR are:
\f(CW\*(C`srcfiles\*(C'\fR (install source files),
\f(CW\*(C`backupdir\*(C'\fR (default directory for backups),
\f(CW\*(C`autobackup\*(C'\fR (number of backups to keep).
+ \f(CW\*(C`sys_bin\*(C'\fR (location where binaries are linked to by action symlinks)
+ \f(CW\*(C`sys_man\*(C'\fR (location where man pages are linked to by action symlinks)
+ \f(CW\*(C`sys_info\*(C'\fR (location where info pages are linked to by action symlinks)
.PP
Perhaps the most common use of \f(CW\*(C`option\*(C'\fR is if you originally installed from
\&\s-1DVD\s0, and want to permanently change the installation to get further
@@ -428,21 +436,42 @@ with 0 as the values.
.PP
In the \f(CW\*(C`\-\-clean\*(C'\fR mode of the \f(CW\*(C`backup\*(C'\fR action this option also
specifies the number to be kept.
+.Sh "symlinks [add|remove]"
+.IX Subsection "symlinks [add|remove]"
+Adds or removes symlinks for binaries, man pages, and info pages in the
+directories specified by the respective options (see above).
.Sh "paper"
.IX Subsection "paper"
-.IP "\fBpaper a4\fR" 4
-.IX Item "paper a4"
+.IP "\fBpaper [a4|letter]\fR" 4
+.IX Item "paper [a4|letter]"
.PD 0
-.IP "\fBpaper letter\fR" 4
-.IX Item "paper letter"
-.IP "\fB[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|\f(BIpapersize\fB|\-\-list]\fR" 4
-.IX Item "[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|papersize|--list]"
+.IP "\fBxdvi|pdftex|dvips|dvipdfmx|dvipdfm|context\ paper\ [\f(BIpapersize\fB|\-\-list]\fR" 4
+.IX Item "xdvi|pdftex|dvips|dvipdfmx|dvipdfm|contextpaper[papersize|--list]"
.PD
.PP
-Configures the system wide paper settings, either for all programs at
-once (first two forms), or just for the specified program (third
-form). The third form with \f(CW\*(C`\-\-list\*(C'\fR outputs all known papersizes for the
-specified program.
+With no arguments (\f(CW\*(C`tlmgr paper\*(C'\fR), shows the default paper size setting
+for all known programs.
+.PP
+With one argument (e.g., \f(CW\*(C`tlmgr paper a4\*(C'\fR), sets the default for all
+known programs to that paper size.
+.PP
+With a program given as the first argument and no paper size specified
+(e.g., \f(CW\*(C`tlmgr dvips paper\*(C'\fR), shows the default paper size for that
+program.
+.PP
+With a program given as the first argument and a paper size as the last
+argument (e.g., \f(CW\*(C`tlmgr dvips paper a4\*(C'\fR), set the default for that
+program to that paper size.
+.PP
+With a program given as the first argument and \f(CW\*(C`\-\-list\*(C'\fR given as the
+last argument (e.g., \f(CW\*(C`tlmgr dvips paper \-\-list\*(C'\fR), shows all valid paper
+sizes for that program. The first size shown is the default.
+.PP
+Incidentally, this syntax of having a specific program name before the
+\&\f(CW\*(C`paper\*(C'\fR keyword may seem strange. It is inherited from the
+longstanding \f(CW\*(C`texconfig\*(C'\fR script, which supports other configuration
+settings for some programs, notably \f(CW\*(C`dvips\*(C'\fR. \f(CW\*(C`tlmgr\*(C'\fR does not support
+those extra settings at present.
.Sh "arch list|add \fIarch\fP..."
.IX Subsection "arch list|add arch..."
\&\f(CW\*(C`arch list\*(C'\fR lists the TeX Live names of all the architectures
@@ -504,8 +533,8 @@ Uninstalls the entire TeX Live installation. Options:
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
Do not ask for confirmation, remove immediately.
-.Sh "generate"
-.IX Subsection "generate"
+.Sh "generate [\fIoption\fP]... \fIwhat\fP"
+.IX Subsection "generate [option]... what"
.IP "\fBgenerate language\fR" 4
.IX Item "generate language"
.PD 0
@@ -519,24 +548,28 @@ Do not ask for confirmation, remove immediately.
.IX Item "generate updmap"
.PD
.PP
-The \fIgenerate\fR action overwrites any manual changes made in the
+The \f(CW\*(C`generate\*(C'\fR action overwrites any manual changes made in the
respective files: it recreates them from scratch.
.PP
-For fmtutil and the language files, this is normal, and both the TeX
+For \f(CW\*(C`fmtutil\*(C'\fR and the language files, this is normal, and both the TeX
Live installer and \f(CW\*(C`tlmgr\*(C'\fR routinely call \fIgenerate\fR for them.
.PP
-For updmap, however, neither the installer nor \f(CW\*(C`tlmgr\*(C'\fR use \fIgenerate\fR,
-because the result would be to disable all maps which have been manually
-installed via \f(CW\*(C`updmap\-sys \-\-enable\*(C'\fR, e.g., for proprietary or local
-fonts. Only the changes in the \f(CW\*(C`\-\-localcfg\*(C'\fR file mentioned below are
-incorporated by \fIgenerate\fR.
-.PP
-On the other hand, if you only use the fonts and font packages within
-TeX Live, there is nothing wrong with using \fIgenerate updmap\fR. Indeed,
-we use it to generate the \f(CW\*(C`updmap.cfg\*(C'\fR file that is maintained in the
-live source repository.
-.PP
-In more detail: \fIgenerate\fR remakes any of the four config files
+For \f(CW\*(C`updmap\*(C'\fR, however, neither the installer nor \f(CW\*(C`tlmgr\*(C'\fR use
+\&\f(CW\*(C`generate\*(C'\fR, because the result would be to disable all maps which have
+been manually installed via \f(CW\*(C`updmap\-sys\ \-\-enable\*(C'\fR, e.g., for
+proprietary or local fonts. Only the changes in the \f(CW\*(C`\-\-localcfg\*(C'\fR file
+mentioned below are incorporated by \fIgenerate\fR. Furthermore, \f(CW\*(C`tlmgr\*(C'\fR
+updates and maintains the final \f(CW\*(C`updmap.cfg\*(C'\fR in \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR (the
+others use \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) because that is the location that
+\&\f(CW\*(C`updmap\-sys\*(C'\fR (via \f(CW\*(C`tcfmgr\*(C'\fR) uses.
+.PP
+Notwithstanding the above, if you only use the fonts and font packages
+within TeX Live, and maintain your local fonts (if any) with the local
+config file, there is nothing wrong with using \f(CW\*(C`generate updmap\*(C'\fR.
+Indeed, we use it ourselves to generate the \f(CW\*(C`updmap.cfg\*(C'\fR file that is
+maintained in the live source repository.
+.PP
+In more detail: \f(CW\*(C`generate\*(C'\fR remakes any of the four config files
\&\f(CW\*(C`language.dat\*(C'\fR, \f(CW\*(C`language.def\*(C'\fR, \f(CW\*(C`fmtutil.cnf\*(C'\fR, and \f(CW\*(C`updmap.cfg\*(C'\fR from
the information present in the local \s-1TLPDB\s0. If the files
\&\f(CW\*(C`language\-local.dat\*(C'\fR, \f(CW\*(C`language\-local.def\*(C'\fR, \f(CW\*(C`fmtutil\-local.cnf\*(C'\fR, or
@@ -552,7 +585,8 @@ Options:
.IP "\fB\-\-dest\fR \fIoutput file\fR" 4
.IX Item "--dest output file"
specifies the output file (defaults to the respective location in
-\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR). If \fB\-\-dest\fR is given to \f(CW\*(C`generate language\*(C'\fR, its
+\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR for \f(CW\*(C`language*\*(C'\fR and \f(CW\*(C`fmtutil\*(C'\fR, and \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR
+for \f(CW\*(C`updmap\*(C'\fR). If \fB\-\-dest\fR is given to \f(CW\*(C`generate language\*(C'\fR, its
value will be used for the \f(CW\*(C`language.dat\*(C'\fR output, and \f(CW\*(C`.def\*(C'\fR will be
appended to the value for the name of the \f(CW\*(C`language.def\*(C'\fR output file.
(This is just to avoid overwriting; if you want a specific name for each
@@ -560,13 +594,100 @@ output file, we recommend invoking \f(CW\*(C`tlmgr\*(C'\fR twice.)
.IP "\fB\-\-localcfg\fR \fIlocal conf file\fR" 4
.IX Item "--localcfg local conf file"
specifies the (optional) local additions (defaults to the respective
-location in \f(CW\*(C`TEXMFSYSVAR\*(C'\fR).
+location in \f(CW\*(C`TEXMFLOCAL\*(C'\fR).
.PP
The respective locations are as follows:
- \f(CW\*(C`tex/generic/config/language.dat\*(C'\fR (and \f(CW\*(C`language\-local.dat\*(C'\fR)
- \f(CW\*(C`tex/generic/config/language.def\*(C'\fR (and \f(CW\*(C`language\-local.def\*(C'\fR)
- \f(CW\*(C`web2c/fmtutil.cnf\*(C'\fR (and \f(CW\*(C`fmtutil\-local.cnf\*(C'\fR)
- \f(CW\*(C`web2c/updmap.cfg\*(C'\fR (and \f(CW\*(C`updmap\-local.cfg\*(C'\fR)
+.PP
+.Vb 4
+\& tex/generic/config/language.dat (and language-local.dat);
+\& tex/generic/config/language.def (and language-local.def);
+\& web2c/fmtutil.cnf (and fmtutil-local.cnf);
+\& web2c/updmap.cfg (and updmap-local.cfg).
+.Ve
+.SH "MACHINE-READABLE OUTPUT"
+.IX Header "MACHINE-READABLE OUTPUT"
+Given the \f(CW\*(C`\-\-machine\-readable\*(C'\fR option, \f(CW\*(C`tlmgr\*(C'\fR writes to stdout in the
+fixed line-oriented format described here, and the usual informational
+messages for human consumption are written to stderr (normally they are
+written to stdout). The idea is that a program can get all the
+information it needs by reading stdout.
+.PP
+Currently this option only applies to the update action. The output format is as follows:
+.PP
+.Vb 5
+\& fieldname "\et" value
+\& ...
+\& "end-of-header"
+\& pkgname status localrev serverrev size
+\& ...
+.Ve
+.PP
+Currently the header section contains two fields. The field name and
+value are separated by a tab. Line endings may be \s-1LF\s0 or \s-1CRLF\s0 depending
+on the current platform.
+.ie n .IP """location\-url""\fR \fIlocation" 4
+.el .IP "\f(CWlocation\-url\fR \fIlocation\fR" 4
+.IX Item "location-url location"
+The \fIlocation\fR may be a url (including \f(CW\*(C`file:///foo/bar/...\*(C'\fR), or a
+directory name (\f(CW\*(C`/foo/bar\*(C'\fR). It is the server repository from which
+the new package information was drawn.
+.ie n .IP """total\-bytes""\fR \fIcount" 4
+.el .IP "\f(CWtotal\-bytes\fR \fIcount\fR" 4
+.IX Item "total-bytes count"
+The \fIcount\fR is simply a decimal number, the sum of all the packages
+given subsequently that need updating or installing.
+.PP
+Then comes a line with only the literal string \f(CW\*(C`end\-of\-header\*(C'\fR.
+.PP
+Each following line until \s-1EOF\s0 reports on one package. The fields on
+each line are separated by a tab. Here are the fields.
+.IP "\fIpkgname\fR" 4
+.IX Item "pkgname"
+The TeX Live package identifier, with a possible architecture suffix for
+executables. For instance, \f(CW\*(C`pdftex\*(C'\fR and \f(CW\*(C`pdftex.i386\-linux\*(C'\fR are
+given as two separate packages, one on each line.
+.IP "\fIstatus\fR" 4
+.IX Item "status"
+The status of the package update. One character, as follows:
+.RS 4
+.ie n .IP """d""" 8
+.el .IP "\f(CWd\fR" 8
+.IX Item "d"
+The package was removed on the server.
+.ie n .IP """f""" 8
+.el .IP "\f(CWf\fR" 8
+.IX Item "f"
+The package was removed on the server even though a collection depended
+on it. (E.g., the user ran \f(CW\*(C`tlmgr remove \-\-force\*(C'\fR.)
+.ie n .IP """u""" 8
+.el .IP "\f(CWu\fR" 8
+.IX Item "u"
+Normal update is needed.
+.ie n .IP """r""" 8
+.el .IP "\f(CWr\fR" 8
+.IX Item "r"
+Reversed non\-update: the locally-installed version is newer than the
+version on the server.
+.ie n .IP """a""" 8
+.el .IP "\f(CWa\fR" 8
+.IX Item "a"
+Automatically-determined need for installation, the package is new on
+the server and is (most probably) part of an installed collection.
+.RE
+.RS 4
+.RE
+.IP "\fIlocalrev\fR" 4
+.IX Item "localrev"
+The revision number of the installed package.
+.IP "\fIserverrev\fR" 4
+.IX Item "serverrev"
+The revision number of the package on the server.
+.IP "\fIsize\fR" 4
+.IX Item "size"
+The size in bytes of the package on the server.
+.PP
+If you are developing a program that uses this output, and find that
+changes would be helpful, do not hesitate to write the mailing list.
.SH "AUTHORS AND COPYRIGHT"
.IX Header "AUTHORS AND COPYRIGHT"
This script and its documentation were written for the TeX Live
diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf
index c8c7fb1ecb2..84c215c1b28 100644
--- a/Master/texmf/doc/man/man1/tlmgr.pdf
+++ b/Master/texmf/doc/man/man1/tlmgr.pdf
Binary files differ