summaryrefslogtreecommitdiff
path: root/Master/texmf/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-11-01 02:37:04 +0000
committerKarl Berry <karl@freefriends.org>2008-11-01 02:37:04 +0000
commit3e43b31b5a39866ebf91be8818fc93ff0992ca33 (patch)
tree3fdfc77d178f399d9710bd25c4050c043b091787 /Master/texmf/doc
parentec17d77243c8dbc40b036d9c801f697dd261fc8b (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@11147 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc')
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.1153
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.pdfbin24830 -> 24514 bytes
2 files changed, 74 insertions, 79 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
index f9ff4232371..b14b49d2cd2 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-10-29" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2008-11-01" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
tlmgr \- the TeX Live Manager
.SH "SYNOPSIS"
@@ -229,8 +229,8 @@ written to the terminal.
.RE
.RS 4
.RE
-.IP "\fBupdate\fR [\fIoption\fR] [\fIpkg\fR...]" 4
-.IX Item "update [option] [pkg...]"
+.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. Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \fIpkg\fR name
must be specified. Options:
@@ -262,24 +262,26 @@ disappeared on the server when called with \f(CW\*(C`\-\-all\*(C'\fR, as describ
above. This prevents any such removals.
.IP "\fB\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 8
.IX Item "--backup and --backupdir directory"
-These options control the creation of backups of packages before
-an update is started. If none of the two are given, no backup package
-will be saved. If \fB\-\-backupdir\fR is given specifying a (writable)
-directory then a back up will be made in that location. If only
-\&\fB\-\-backup\fR is given then the location for the backups has to be
-set in the tlpdb via the \fBoption\fR action (see below). If both are
-given then a backup will be made to the specified directory.
-.Sp
-By setting relevent options in the tlpdb via the \fBoption\fR action
-it is possible to automatically create backups for all packages, and
-keep only a certain number of backups. Please see the \fBoption\fR
-action for details. So if \fB\-\-backup\fR is not given, but the \fBautobackup\fR
-option is set in the tlpdb, a backup will be made.
-.Sp
-\&\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.
+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
+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.
+.Sp
+You can set options via the \f(CW\*(C`option\*(C'\fR action to automatically create
+backups for all packages, and/or keep only a certain number of
+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
+the actual \fIcontent\fR of the update causes problems, e.g., introduces an
+incompatibility.
+.Sp
+The \f(CW\*(C`restore\*(C'\fR action explains how to restore from a backup.
.IP "\fB\-\-no\-depends\fR" 8
.IX Item "--no-depends"
If you call for updating a package normally all depending packages
@@ -287,11 +289,12 @@ will also be checked for updates and updated if necessary. This switch
supresses this behaviour.
.IP "\fB\-\-no\-depends\-at\-all\fR" 8
.IX Item "--no-depends-at-all"
-When you update a package which ships binary files the respective binary
-package will also be updated. (So for package bin-foobar also the package
-bin\-foobar.i386\-linux will be updated 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 really sure what you are doing.
+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.
.RE
.RS 4
.Sp
@@ -299,20 +302,20 @@ 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 [\-\-clean[=\fIN\fR]] [\-\-backupdir \fIdir\fR] [\fB\-\-all\fR] [\fIpkg\fR...]" 4
-.IX Item "backup [--clean[=N]] [--backupdir dir] [--all] [pkg...]"
-The first mode without the \fB\-\-clean\fR switch is to make a backup of
-the given packages, or all packages with \f(CW\*(C`\-\-all\*(C'\fR. These backups are
-saved to the following place: If the \fB\-\-backupdir\fR option if given, to
-the directory \fIdir\fR, which must exist and be writable.
-If the \fB\-\-backupdir\fR option is not given, the option setting in the
-tlpdb is used, if present. If both are missing, no backups are made.
-.Sp
-The second mode is when the \fB\-\-clean\fR switch is given, either with
-or without argument. If the value for the \fB\-\-clean\fR switch is missing, the
-option \fBautobackup\fR from the tlpdb is used. If both are missing \fBtlmgr\fR
-will terminate. For the meaning of the different values of that switch
-see below the \fBoption\fR action.
+.IP "\fBbackup\fR [\-\-clean[=\fIN\fR]] [\-\-backupdir \fIdir\fR] [\fB\-\-all\fR] [\fIpkg\fR]..." 4
+.IX Item "backup [--clean[=N]] [--backupdir dir] [--all] [pkg]..."
+If the \fB\-\-clean\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
+option setting in the \s-1TLPDB\s0 is used, if present. If both are missing,
+no backups are made.
+.Sp
+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,
+the value of the \fBautobackup\fR option from 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.
.Sp
Options:
.RS 4
@@ -324,10 +327,9 @@ directory where backups are to be placed.
.IX Item "--all"
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" 8
-.IX Item "--clean"
-Instead of making backups cleans up the backup directory from old
-backups.
+.IP "\fB\-\-clean\fR[=\fIN\fR]" 8
+.IX Item "--clean[=N]"
+Instead of making backups, prune the backup directory of old backups.
.IP "\fB\-\-dry\-run\fR" 8
.IX Item "--dry-run"
Nothing is actually backed up or removed; instead, the actions to be
@@ -356,8 +358,7 @@ Nothing is actually restored; instead, the actions to be performed are
written to the terminal.
.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.
+Specify the directory where the backups are to be found.
.RE
.RS 4
.RE
@@ -373,11 +374,7 @@ package, dependencies are never removed. Options:
Do not remove dependent packages.
.IP "\fB\-\-no\-depends\-at\-all\fR" 8
.IX Item "--no-depends-at-all"
-When you remove a package which ships binary files the respective binary
-package will also be removed. (So for package bin-foobar also the package
-bin\-foobar.i386\-linux will be removed 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 really sure what you are doing.
+See above under \fBaction\fR (and beware).
.IP "\fB\-\-force\fR" 8
.IX Item "--force"
By default, removal of a package or collection that is a dependency of
@@ -403,14 +400,14 @@ 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:
-\&\f(CW\*(C`location\*(C'\fR (default installation location),
-\&\f(CW\*(C`formats\*(C'\fR (create formats at installation time),
-\&\f(CW\*(C`docfiles\*(C'\fR (install documentation files),
-\&\f(CW\*(C`srcfiles\*(C'\fR (install source files),
-\&\f(CW\*(C`autobackup\*(C'\fR (specify the number of backups to be kept),
-\&\f(CW\*(C`backupdir\*(C'\fR (specify the default location for backups).
-.Sp
-Perhaps the most common use for this is if you originally installed from
+ \f(CW\*(C`location\*(C'\fR (default installation location),
+ \f(CW\*(C`formats\*(C'\fR (create formats at installation time),
+ \f(CW\*(C`docfiles\*(C'\fR (install documentation files),
+ \f(CW\*(C`srcfiles\*(C'\fR (install source files),
+ \f(CW\*(C`autobackup\*(C'\fR (number of backups to be kept),
+ \f(CW\*(C`backupdir\*(C'\fR (default directory for backups).
+.Sp
+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
updates from the Internet. To do this, you can run
.Sp
@@ -420,22 +417,20 @@ updates from the Internet. To do this, you can run
.Sp
where \s-1YYYY\s0 is the TeX Live release year.
.Sp
-The two options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR can be used to specify
-defaults for the \fBupdate\fR, \fBbackup\fR and \fBrestore\fR actions. These
-three actions normally need a directory to write to or read from the
-backups. If nothing is specified on the command line, the default taken
-from the \f(CW\*(C`backupdir\*(C'\fR is taken.
-.Sp
-The \f(CW\*(C`autobackup\*(C'\fR option (de)activates the automatical generation of
-backups. This option can be an integer larger or equal then \-1. If
-\&\f(CW\*(C`autobackup\*(C'\fR is \-1, backups will not be removed (if you not ask for
-explicitely with \fBtlmgr backup \-\-clean=\f(BIN\fB ...\fR specifying for \fIN\fR
-something different then \-1. If it any other integer, i.e., larger or
-equal than 0, it specifies the number of backups to be kept. That also
-includes that backups are disabled with 0 as argument.
-.Sp
-In the \fB\-\-clean\fR mode of the \fBbackup\fR action this option also specifies
-the number to be kept.
+The two options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determine defaults for
+the \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR actions. These three actions
+need a directory to write to or read from the backups. If
+\&\f(CW\*(C`\-\-backupdir\*(C'\fR is not specified on the command line, the \f(CW\*(C`backupdir\*(C'\fR
+option value is used (if set).
+.Sp
+The \f(CW\*(C`autobackup\*(C'\fR option (de)activates the automatic generation of
+backups. Its value is an integer. If \f(CW\*(C`autobackup\*(C'\fR is \-1, backups will
+not be removed by default. If \f(CW\*(C`autobackup\*(C'\fR is 0 or positive, it
+specifies the number of backups to be kept. Thus, backups are disabled
+with 0 as the values.
+.Sp
+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.
.IP "\fBpaper a4\fR" 4
.IX Item "paper a4"
.PD 0
@@ -463,8 +458,8 @@ written to the terminal.
.RE
.RS 4
.RE
-.IP "\fBsearch [\f(BIoption\fB...] \f(BIwhat\fB\fR" 4
-.IX Item "search [option...] what"
+.IP "\fBsearch [\f(BIoption\fB]... \f(BIwhat\fB\fR" 4
+.IX Item "search [option]... what"
By default searches the names, short and long descriptions of all
locally installed packages for the given argument (interpreted as
regexp). Options:
@@ -490,8 +485,8 @@ With no argument, lists all packages available at the default install
location, prefixing those already installed with "\f(CW\*(C`i\*(C'\fR".
.Sp
With an argument lists only collections or schemes, as requested.
-.IP "\fBcheck [\f(BIoption\fB...] [files|collections|all]\fR" 4
-.IX Item "check [option...] [files|collections|all]"
+.IP "\fBcheck [\f(BIoption\fB]... [files|collections|all]\fR" 4
+.IX Item "check [option]... [files|collections|all]"
Executes one (or all) check(s) on the consistency of the installation.
.RS 4
.IP "\fBfiles\fR" 8
diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf
index 694c89d898a..5aed9732774 100644
--- a/Master/texmf/doc/man/man1/tlmgr.pdf
+++ b/Master/texmf/doc/man/man1/tlmgr.pdf
Binary files differ