summaryrefslogtreecommitdiff
path: root/Master/texmf/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-09-24 01:41:56 +0000
committerKarl Berry <karl@freefriends.org>2008-09-24 01:41:56 +0000
commit4d38cc845f7ba4d609d1ca186c743365b3292a15 (patch)
treee19620fdbe3a95048670c46f67ed119f5fd99ebd /Master/texmf/doc
parentb2aa34088dccd331a4aecc86bcea449751a82f92 (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@10710 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc')
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.1155
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.pdfbin17878 -> 18000 bytes
2 files changed, 76 insertions, 79 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
index 7f656e49126..b16e02f95ae 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-09-18" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2008-09-23" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
@@ -139,10 +139,10 @@ tlmgr [\fIoption\fR]... \fIaction\fR [\fIoption\fR]... [\fIoperand\fR]...
.IX Header "DESCRIPTION"
\&\fBtlmgr\fR manages an existing TeX Live installation, both packages and
configuration options. It performs many of the same actions as
-\&\fBtexconfig\fR(1), and more besides. (texconfig continues to be included
-and supported, but tlmgr is now preferred.)
+\&\fBtexconfig\fR(1), and more besides. (\f(CW\*(C`texconfig\*(C'\fR continues to be
+included and supported, but \f(CW\*(C`tlmgr\*(C'\fR is now preferred.)
.PP
-The most up-to-date version of this documentation is on the Internet at
+The most up-to-date version of this documentation is available at
<http://tug.org/texlive/tlmgr.html>.
.SH "OPTIONS"
.IX Header "OPTIONS"
@@ -164,38 +164,38 @@ into the respective screen of the \s-1GUI\s0. For example, running
starts you directly at the update screen.
.IP "\fB\-\-gui\-lang\fR \fIllcode\fR" 4
.IX Item "--gui-lang llcode"
-Normally the \s-1GUI\s0 tries to deduce your language from the environment
-(on Windows via the registry, on Unix via \s-1LC_MESSAGES\s0). If that fails
-you can select a different language by giving this option a two-letter
+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.
.PP
-The standard options are also accepted: \fB\-\-help/\-h/\-?\fR, \fB\-\-version\fR,
-\&\fB\-q\fR (no informational messages), \fB\-v\fR (debugging messages, can be
-repeated). For the details about the latter, see the
-TeXLive::TLUtils documentation.
+The standard options are also accepted: \f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR, \f(CW\*(C`\-\-version\*(C'\fR,
+\&\f(CW\*(C`\-q\*(C'\fR (no informational messages), \f(CW\*(C`\-v\*(C'\fR (debugging messages, can be
+repeated). For the details about the latter, see the TeXLive::TLUtils
+documentation.
.PP
-The \fB\-\-version\fR option shows version information about the TeX Live
-release as well as the \fBtlmgr\fR script itself.
+The \f(CW\*(C`\-\-version\*(C'\fR option shows version information about the TeX Live
+release as well as the \f(CW\*(C`tlmgr\*(C'\fR script itself.
.SH "ACTIONS"
.IX Header "ACTIONS"
.IP "\fBhelp\fR" 4
.IX Item "help"
-Gives this help information (same as \fB\-\-help\fR).
+Gives this help information (same as \f(CW\*(C`\-\-help\*(C'\fR).
.IP "\fBversion\fR" 4
.IX Item "version"
-Gives version information (same as \fB\-\-version\fR).
+Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR).
.IP "\fBgui\fR" 4
.IX Item "gui"
Start the graphical user interface.
.IP "\fBinstall\fR [\fIoption\fR]... \fIpkg\fR..." 4
.IX Item "install [option]... pkg..."
-Install all \fIpkg\fRs given on the command line. By default this installs
+Install each \fIpkg\fR given on the command line. By default this installs
all packages that the given \fIpkg\fRs are dependent on, also. Options:
.RS 4
.IP "\fB\-\-no\-depends\fR" 8
.IX Item "--no-depends"
-Do not install dependencies. By default, installing a package ensures
-that all dependencies of this package are fulfilled.
+Do not install dependencies. (By default, installing a package ensures
+that all dependencies of this package are fulfilled.)
.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
@@ -206,51 +206,55 @@ written to the terminal.
.IP "\fBupdate\fR [\fIoption\fR] [\fIpkg\fR...]" 4
.IX Item "update [option] [pkg...]"
Updates the packages given as arguments to the latest version available
-at the installation source. Options:
+at the installation source. Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \fIpkg\fR name
+must be specified. Options:
.RS 4
-.IP "\fB\-\-list\fR" 4
+.IP "\fB\-\-all\fR" 8
+.IX Item "--all"
+Update already-installed packages, and install new packages in installed
+collections. (Packages in uninstalled collections are not considered.)
+.IP "\fB\-\-list\fR" 8
.IX Item "--list"
List the packages which would be updated or newly installed.
-.IP "\fB\-\-all\fR" 4
-.IX Item "--all"
-Update all packages.
-.IP "\fB\-\-dry\-run\fR" 4
+.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal. (A more verbose report than \f(CW\*(C`\-\-list\*(C'\fR.)
-.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8
.IX Item "--backupdir directory"
-If this option is given it must specify an existing directory where a
-snapshot of the current package as installed will be saved before
-the packages is updated. This way one can go back in case an update
-turned out as not working. See the action \fBrestore\fR for details.
+\&\fIdirectory\fR specifies a directory where the package as installed will
+be saved before updates are performed. Then you can restore later if
+the update turns out to be problematic; see the \f(CW\*(C`restore\*(C'\fR action for
+details.
.RE
.RS 4
+.Sp
+If the package on the server is older than the package already installed
+(e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not
+downgrade. Also, packages for uninstalled platforms are not installed.
.RE
.IP "\fBbackup\fR \-\-backupdir \fIdir\fR [\fB\-\-all\fR] [\fIpkg\fR...]" 4
.IX Item "backup --backupdir dir [--all] [pkg...]"
-Makes a backup of the given packages (or all packages with \fB\-\-all\fR) to
-the directory specified with \fB\-\-backupdir\fR (must exist and be a writable).
-.Sp
-Warning: Making a backup of \fIall\fR packages will need quite some space and
-time.
-.Sp
-Options:
+Makes a backup of the given packages, or all packages with \f(CW\*(C`\-\-all\*(C'\fR, to
+\&\fIdir\fR, which must exist and be writable. Options:
.RS 4
-.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8
.IX Item "--backupdir directory"
-The \fIdirectory\fR is an obligatory argument and has to specify a
-directory where backups are to be found.
-.IP "\fB\-\-all\fR" 4
+The \fIdirectory\fR argument is required and must specify an existing
+directory where backups are to be placed.
+.IP "\fB\-\-all\fR" 8
.IX Item "--all"
-Make a backup of all packages in the TeX Live installation.
+Make a backup of all packages in the TeX Live installation. This will
+take quite a lot of space and time.
.RE
.RS 4
.RE
.IP "\fBrestore \-\-backupdir\fR \fIdir\fR [\fIpkg\fR [\fIrev\fR]]" 4
.IX Item "restore --backupdir dir [pkg [rev]]"
-If no \fIpkg\fR and \fIrev\fR is given, list the available
-backup revisions for all packages.
+Restore a package from a previously-made backup.
+.Sp
+If neither \fIpkg\fR nor \fIrev\fR are given, list the available backup
+revisions for all packages.
.Sp
With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of
\&\fIpkg\fR.
@@ -258,46 +262,37 @@ With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of
With both \fIpkg\fR and \fIrev\fR, tries to restore the package from the
specified backup.
.Sp
-The option \fB\-\-backupdir\fR \fIdir\fR is obligatory and has to specify a
-directory with backups.
-.Sp
Options:
.RS 4
-.IP "\fB\-\-dry\-run\fR" 4
+.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually restored; instead, the actions to be performed are
written to the terminal.
-.IP "\fB\-\-backupdir directory\fR" 4
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 8
.IX Item "--backupdir directory"
This is an obligatory argument and has to specify a directory where
backups are to be found.
.RE
.RS 4
.RE
-.IP "\fBremove [\f(BIoption\fB]... \f(BIpkg\fB...\fR" 4
+.IP "\fBremove\fR [\fIoption\fR]... \fIpkg\fR..." 4
.IX Item "remove [option]... pkg..."
-Remove all \fIpkg\fRs given on the command line. Removing a collection
-will remove all package dependencies (but not collection dependencies)
-in that collection, unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified. However, when
-removing a package, dependencies are never removed.
-.Sp
-Removing a package which is referenced as a dependency in another
-collection or scheme is disallowed, unless \f(CW\*(C`\-\-force\*(C'\fR is specified.
-.Sp
-Options:
+Remove each \fIpkg\fR specified. Removing a collection removes all package
+dependencies, but not collection dependencies, in that collection
+(unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified). However, when removing a
+package, dependencies are never removed. Options:
.RS 4
-.IP "\fB\-\-no\-depends\fR" 4
+.IP "\fB\-\-no\-depends\fR" 8
.IX Item "--no-depends"
Do not remove dependent packages.
-.IP "\fB\-\-force\fR" 4
+.IP "\fB\-\-force\fR" 8
.IX Item "--force"
-By default, when removing a package or collection would invalidate a
-dependency of another collection/scheme, the package will not be removed
-and a warning issued. With this option, the package will be removed
-unconditionally. Use with care.
-.IP "\fB\-\-dry\-run\fR" 4
+By default, removal of a package or collection that is a dependency of
+another collection or scheme is not allowed. With this option, the
+package will be removed unconditionally. Use with care.
+.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
-Nothing is actually installed; instead, the actions to be performed are
+Nothing is actually removed; instead, the actions to be performed are
written to the terminal.
.RE
.RS 4
@@ -308,9 +303,10 @@ written to the terminal.
.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 4
.IX Item "option key [value]"
.PD
-The first form shows the settings currently saved in the \s-1TLPDB\s0.
+The first form shows the global TeX Live settings currently saved in the
+\&\s-1TLPDB\s0.
.Sp
-In the second form, if \fIvalue\fR is missing the setting for \fIkey\fR is
+In the second form, if \fIvalue\fR is not given, the setting for \fIkey\fR is
displayed. If \fIvalue\fR is present, \fIkey\fR is set to \fIvalue\fR.
.Sp
Possible values for \fIkey\fR are:
@@ -348,7 +344,7 @@ the default install location.
Add executables for each given architecture \fIarch\fR to the installation.
Options:
.RS 4
-.IP "\fB\-\-dry\-run\fR" 4
+.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
written to the terminal.
@@ -361,10 +357,10 @@ By default searches the names, short and long descriptions of all
locally installed packages for the given argument (interpreted as
regexp). Options:
.RS 4
-.IP "\fB\-\-file\fR" 4
+.IP "\fB\-\-file\fR" 8
.IX Item "--file"
List all filenames containing \fIwhat\fR.
-.IP "\fB\-\-global\fR" 4
+.IP "\fB\-\-global\fR" 8
.IX Item "--global"
Search the TeX Live Database of the installation medium, instead of the
local installation.
@@ -386,7 +382,7 @@ With an argument lists only collections or schemes, as requested.
.IX Item "check [option...] [files|collections|all]"
Executes one (or all) check(s) on the consistency of the installation.
.RS 4
-.IP "\fBfiles\fR" 4
+.IP "\fBfiles\fR" 8
.IX Item "files"
Checks that all files listed in the TeX Live Database (texlive.tlpdb)
are actually present, and lists those missing.
@@ -394,7 +390,7 @@ are actually present, and lists those missing.
Note that on Windows that will not work currently, since Windows does not
ship find. Also MacOS seems to ship a strange find implementation that does
not support \-wholename, so that will break, too.
-.IP "\fBcollections\fR" 4
+.IP "\fBcollections\fR" 8
.IX Item "collections"
Lists those packages which occur as dependencies in an installed collections,
but are themselves not installed.
@@ -402,9 +398,10 @@ but are themselves not installed.
.RS 4
.Sp
Available options are:
-.IP "\fB\-use\-svn\fR" 4
-.IX Item "-use-svn"
-Use svn status instead of listing the files.
+.IP "\fB\-\-use\-svn\fR" 8
+.IX Item "--use-svn"
+Use svn status instead of listing the files, for checking the
+development repository.
.RE
.RS 4
.RE
@@ -412,7 +409,7 @@ Use svn status instead of listing the files.
.IX Item "uninstall"
Uninstalls the entire TeX Live installation. Options:
.RS 4
-.IP "\fB\-\-force\fR" 4
+.IP "\fB\-\-force\fR" 8
.IX Item "--force"
Do not ask for confirmation, remove immediately.
.RE
@@ -461,7 +458,7 @@ the given file.
.Sp
Options:
.RS 4
-.IP "\fB\-\-dest\fR \fIoutput file\fR" 4
+.IP "\fB\-\-dest\fR \fIoutput file\fR" 8
.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
@@ -469,7 +466,7 @@ value will be used for the \f(CW\*(C`language.dat\*(C'\fR output, and \f(CW\*(C`
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 really want a specific name
for each output file, we recommend invoking \f(CW\*(C`tlmgr\*(C'\fR twice.)
-.IP "\fB\-\-localcfg\fR \fIlocal conf file\fR" 4
+.IP "\fB\-\-localcfg\fR \fIlocal conf file\fR" 8
.IX Item "--localcfg local conf file"
specifies the (optional) local additions (defaults to the respective
location in \f(CW\*(C`TEXMFSYSVAR\*(C'\fR).
diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf
index d95f5209aa1..9185ddaadcf 100644
--- a/Master/texmf/doc/man/man1/tlmgr.pdf
+++ b/Master/texmf/doc/man/man1/tlmgr.pdf
Binary files differ