summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-08-22 02:03:50 +0000
committerKarl Berry <karl@freefriends.org>2009-08-22 02:03:50 +0000
commit07ca684250b0d177ec5fe37ea7825e83af9013bb (patch)
treecea56417e97c1997fe9c03149a211b19b29710c3 /Master/texmf/doc/man
parent8d51eae46fb20c6d41d528e1736ae27d03304228 (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@14809 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/man')
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.1133
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.pdfbin40794 -> 40961 bytes
2 files changed, 66 insertions, 67 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
index a8ee4cf0b2d..6b6fa9ab05b 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 "2009-08-19" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2009-08-22" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
@@ -214,7 +214,7 @@ Gives this help information (same as \f(CW\*(C`\-\-help\*(C'\fR).
.IX Subsection "version"
Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR).
.PP
-If \fB\-v\fR has been given the revisions of the used modules are reported, too.
+If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too.
.Sh "gui"
.IX Subsection "gui"
Start the graphical user interface.
@@ -236,11 +236,12 @@ Do not install dependencies. (By default, installing a package ensures
that all dependencies of this package are fulfilled.)
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
-When you install a package which ships binary files the respective binary
-package will also be installed. (So for package bin-foobar also the package
-bin\-foobar.i386\-linux will be installed on an i386\-linux system.)
-This switch supresses this behaviour, and also implies \f(CW\*(C`\-\-no\-depends\*(C'\fR.
-Don't use it unless you are sure of what you are doing.
+When you install a package which ships binary files the respective
+binary package will also be installed. That is, for a package \f(CW\*(C`foo\*(C'\fR,
+the package \f(CW\*(C`foo.i386\-linux\*(C'\fR will also be installed on an \f(CW\*(C`i386\-linux\*(C'\fR
+system. This switch suppresses this behavior, and also implies
+\&\f(CW\*(C`\-\-no\-depends\*(C'\fR. Don't use it unless you are sure of what you are
+doing.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually installed; instead, the actions to be performed are
@@ -257,40 +258,40 @@ at the installation source. Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \f
must be specified. Options:
.IP "\fB\-\-all\fR" 4
.IX Item "--all"
-Update all installed packages except for tlmgr itself.
+Update all installed packages except for tlmgr itself. Thus, if updates
+to tlmgr itself are present, this will simply give an error, unless also
+the option \f(CW\*(C`\-\-force\*(C'\fR or \f(CW\*(C`\-\-self\*(C'\fR is given. (See below.)
.Sp
-In case that updates to tlmgr itself are present this will not work
-unless also the option \fB\-\-force\fR or \fB\-\-self\fR is given.
+In addition to updating the installed packages, during the update of a
+collection the local installation is (by default) synchronized to the
+status of the collection on the server, for both additions and removals.
.Sp
-Besides updating the installed packages, during the update of a
-collection the contained packages are syncronized to the status
-of the new version of the collection. That means that if a package
-has been removed on the server (and thus has also been removed from
-the respective collection), tlmgr will remove the package also on
-the local installation. This is called \fBauto-remove\fR and is announced
-as such when using the option \fB\-\-list\fR. The auto-removal can be
-suppressed using the option \fB\-\-no\-auto\-remove\fR.
+Specifically, if a package has been removed on the server (and thus has
+also been removed from the respective collection), tlmgr will remove the
+package also on the local installation. This is called ``auto\-remove''
+and is announced as such when using the option \f(CW\*(C`\-\-list\*(C'\fR. This
+auto-removal can be suppressed using the option \f(CW\*(C`\-\-no\-auto\-remove\*(C'\fR.
.Sp
-On the other hand, if a package has been added to an installed
-collection, it will be added to the local installation. This is called
-\&\fBauto-install\fR and is announced as such when using the option
-\&\fB\-\-list\fR. The auto-installation can be suppressed using the option
-\&\fB\-\-no\-auto\-install\fR.
+Analogously, if a package has been added to an installed collection on
+the server, it will be added to the local installation. This is called
+``auto\-install'' and is announced as such when using the option
+\&\f(CW\*(C`\-\-list\*(C'\fR. This auto-installation can be suppressed using the option
+\&\f(CW\*(C`\-\-no\-auto\-install\*(C'\fR.
.Sp
-An exception to the collection dependency checks (including
-auto-installation of packages as mentionned above) are those that have
-been forcibly removed (see the action \fBremove\fR for details). To
-include, or better reinstall, those forcibly removed package use
-\&\fB\-\-reinstall\-forcibly\-removed\fR.
+An exception to the collection dependency checks (including the
+auto-installation of packages just mentioned) are those that have been
+forcibly removed by you (see the \fBremove\fR action, \f(CW\*(C`\-\-force\*(C'\fR option).
+To reinstall any such forcibly removed packages use
+\&\f(CW\*(C`\-\-reinstall\-forcibly\-removed\*(C'\fR.
.IP "\fB\-\-self\fR" 4
.IX Item "--self"
-Update tlmgr itself (that is, the infrastructure packages) if updates
-are present. On Windows this includes updates to the perl interpreter
-shipped by TeX Live.
+Update tlmgr itself (that is, the infrastructure packages) if updates to
+it are present. On Windows this includes updates to the private Perl
+interpreter shipped inside TeX Live.
.Sp
-If this option is given together with \fB\-\-all\fR or a list of packages
-then tlmgr will be updated first and, if this update succeeds, it will
-be restarted to complete the rest of the updates.
+If this option is given together with \f(CW\*(C`\-\-all\*(C'\fR or a list of packages
+then tlmgr will be updated first and, if this update the new version
+will be restarted to complete the rest of the updates.
.IP "\fB\-\-list\fR" 4
.IX Item "--list"
Concisely list the packages which would be updated, newly installed, or
@@ -301,9 +302,11 @@ Nothing is actually installed; instead, the actions to be performed are
written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR.
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
-Force update of packages even if updates to tlmgr itself are present.
-Updates to tlmgr are not performed unless \fB\-\-self\fR option is also given.
-(\f(CW\*(C`\-\-list\*(C'\fR is still performed regardless of this option.)
+Force update of normal packages even if updates to tlmgr itself are
+present. Updates to tlmgr are not performed unless the C <\-\-self> option is
+also given. Not recommended.
+.Sp
+However, \f(CW\*(C`\-\-list\*(C'\fR is still performed regardless of this option.
.IP "\fB\-\-no\-auto\-remove\fR" 4
.IX Item "--no-auto-remove"
Under normal circumstances tlmgr tries to remove packages which have
@@ -345,8 +348,8 @@ installation with the server's idea of what is available by calling
These two options control the creation of backups of packages before an
update is started; that is, the backup is of the package as it's
installed. If neither of the two are given, no backup package will be
-saved. If \fB\-\-backupdir\fR is given and specifies a writable directory
-then a backup will be made in that location. If only \fB\-\-backup\fR is
+saved. If \f(CW\*(C`\-\-backupdir\*(C'\fR is given and specifies a writable directory
+then a backup will be made in that location. If only \f(CW\*(C`\-\-backup\*(C'\fR is
given, then a backup will be made to the directory previously set via
the \f(CW\*(C`option\*(C'\fR action (see below). If both are given then a backup will
be made to the specified \fIdirectory\fR.
@@ -357,7 +360,7 @@ backups. Please see the \f(CW\*(C`option\*(C'\fR action for details.
.Sp
\&\f(CW\*(C`tlmgr\*(C'\fR always makes a temporary backup when updating packages, in case
of download or other failure during an update. The purpose of this
-\&\fB\-\-backup\fR option is to allow you to save a persistent backup in case
+\&\f(CW\*(C`\-\-backup\*(C'\fR option is to allow you to save a persistent backup in case
the actual \fIcontent\fR of the update causes problems, e.g., introduces an
incompatibility.
.Sp
@@ -366,30 +369,25 @@ The \f(CW\*(C`restore\*(C'\fR action explains how to restore from a backup.
.IX Item "--no-depends"
If you call for updating a package normally all depending packages
will also be checked for updates and updated if necessary. This switch
-supresses this behaviour.
+suppresses this behavior.
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
-By default, when you update a package which ships binary files the
-respective binary package will also be updated. That is, for an update
-of a package \f(CW\*(C`foo\*(C'\fR, the package \f(CW\*(C`foobar.i386\-linux\*(C'\fR will also be
-updated if the i386\-linux platform is installed. This option suppresses
-this behaviour, and implies \f(CW\*(C`\-\-no\-depends\*(C'\fR. Don't use it unless you
-are sure of what you are doing.
+See above under \fBinstall\fR (and beware).
.PP
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.
.Sh "backup [\-\-clean[=\fIN\fP]] [\-\-backupdir \fIdir\fP] [\-\-all] [\fIpkg\fP]..."
.IX Subsection "backup [--clean[=N]] [--backupdir dir] [--all] [pkg]..."
-If the \fB\-\-clean\fR option is not specified, this action makes a backup of
+If the \f(CW\*(C`\-\-clean\*(C'\fR option is not specified, this action makes a backup of
the given packages, or all packages given \f(CW\*(C`\-\-all\*(C'\fR. These backups are
-saved to the value of \fB\-\-backupdir\fR option if that is an existing and
-writable directory; if \fB\-\-backupdir\fR is not given, the \f(CW\*(C`backupdir\*(C'\fR
+saved to the value of \f(CW\*(C`\-\-backupdir\*(C'\fR option if that is an existing and
+writable directory; if \f(CW\*(C`\-\-backupdir\*(C'\fR is not given, the \f(CW\*(C`backupdir\*(C'\fR
option setting in the \s-1TLPDB\s0 is used, if present. If both are missing,
no backups are made.
.PP
-If the \fB\-\-clean\fR option is specified, backups are cleaned (pruned)
-instead of made. If the value for the \fB\-\-clean\fR switch is not given,
+If the \f(CW\*(C`\-\-clean\*(C'\fR option is specified, backups are cleaned (pruned)
+instead of made. If the value for the \f(CW\*(C`\-\-clean\*(C'\fR switch is not given,
the value of the \f(CW\*(C`autobackup\*(C'\fR option is used. If both are missing,
an error is issued. For the details of backup cleaning, see the
\&\f(CW\*(C`option\*(C'\fR action below.
@@ -405,7 +403,8 @@ Make a backup of all packages in the TeX Live installation. This will
take quite a lot of space and time.
.IP "\fB\-\-clean\fR[=\fIN\fR]" 4
.IX Item "--clean[=N]"
-Instead of making backups, prune the backup directory of old backups.
+Instead of making backups, prune the backup directory of old backups, as
+explained above.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
Nothing is actually backed up or removed; instead, the actions to be
@@ -434,24 +433,24 @@ Specify the directory where the backups are to be found.
.Sh "remove [\fIoption\fP]... \fIpkg\fP..."
.IX Subsection "remove [option]... pkg..."
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
+dependencies (unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified), but not any
+collection dependencies of that collection. However, when removing a
package, dependencies are never removed. Options:
.IP "\fB\-\-no\-depends\fR" 4
.IX Item "--no-depends"
Do not remove dependent packages.
.IP "\fB\-\-no\-depends\-at\-all\fR" 4
.IX Item "--no-depends-at-all"
-See above under \fBaction\fR (and beware).
+See above under \fBinstall\fR (and beware).
.IP "\fB\-\-force\fR" 4
.IX Item "--force"
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.
.Sp
-A package that has been removed using the \fB\-\-force\fR switch because
-it is still listed in an installed collection or scheme will not be
-update and mentioned as \fBforcibly removed\fR in the output of
+A package that has been removed using the \f(CW\*(C`\-\-force\*(C'\fR option because it
+is still listed in an installed collection or scheme will not be
+updated, and will be mentioned as \fBforcibly removed\fR in the output of
\&\fBtlmgr update \-\-list\fR.
.IP "\fB\-\-dry\-run\fR" 4
.IX Item "--dry-run"
@@ -544,21 +543,21 @@ in the directories specified by the respective options (see above).
On W32 based systems the registry part where the binary directory is
added or removed is determined in the following way:
.PP
-If the user has admin rights, and the option \fB\-\-w32mode\fR is not given,
+If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is not given,
the setting \fIw32_multi_user\fR determines the location (i.e., if it is
on then the system path, otherwise the user path is changed).
.PP
-If the user has admin rights, and the option \fB\-\-w32mode\fR is given, this
+If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given, this
option determines the path to be adjusted.
.PP
-If the user does not have admin rights, and the option \fB\-\-w32mode\fR
+If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR
is not given, and the setting \fIw32_multi_user\fR is off, the user path
is changed, while if the setting \fIw32_multi_user\fR is on, a warning is
issued that the caller does not have enough privileges.
.PP
-If the user does not have admin rights, and the option \fB\-\-w32mode\fR
+If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR
is given, it must be \fBuser\fR and the user path will be adjusted. If a
-user without admin rights uses the option \fB\-\-w32mode admin\fR a warning
+user without admin rights uses the option \f(CW\*(C`\-\-w32mode admin\*(C'\fR a warning
is issued that the caller does not have enough provileges.
.Sh "postaction [\-\-w32mode=user|admin] [\-\-fileassocmode=1|2] [\-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]"
.IX Subsection "postaction [--w32mode=user|admin] [--fileassocmode=1|2] [-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]"
@@ -646,9 +645,9 @@ Shows information about \fIpkg\fR: the name, category, installation status,
short and long description. Searches in the remote installation source
for the package if it is not locally installed.
.PP
-If the option \fB\-\-list\fR is given with a package, the list of contained
+If the option \f(CW\*(C`\-\-list\*(C'\fR is given with a package, the list of contained
files is also shown, including those for architecture specific
-dependencies. When given with schemes and collections, \fB\-\-list\fR
+dependencies. When given with schemes and collections, \f(CW\*(C`\-\-list\*(C'\fR
outputs their dependencies in a similar way.
.Sh "list [\-\-only\-installed] [collections|schemes|\fIpkg\fP...]"
.IX Subsection "list [--only-installed] [collections|schemes|pkg...]"
@@ -778,7 +777,7 @@ Options:
.IX Item "--dest output file"
specifies the output file (defaults to the respective location in
\&\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
+for \f(CW\*(C`updmap\*(C'\fR). If \f(CW\*(C`\-\-dest\*(C'\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
diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf
index ade9877d786..681cc992e66 100644
--- a/Master/texmf/doc/man/man1/tlmgr.pdf
+++ b/Master/texmf/doc/man/man1/tlmgr.pdf
Binary files differ