tl-update-auto

git-svn-id: svn://tug.org/texlive/trunk@47144 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 222 insertions, 4 deletions

diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1
index cd612119d6b..3bb62d22138 100644
--- a/Master/texmf-dist/doc/man/man1/tlmgr.1
+++ b/Master/texmf-dist/doc/man/man1/tlmgr.1
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title "TLMGR 1"
-.TH TLMGR 1 "2018-03-23" "perl v5.26.1" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2018-03-26" "perl v5.26.1" "User Contributed Perl Documentation"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -746,6 +746,9 @@ local keyring \f(CW\*(C`GNUPGHOME/repository\-keys.gpg\*(C'\fR, which is normall
 .PP
 The \f(CW\*(C`remove\*(C'\fR argument requires a key id and removes the requested id
 from the local keyring.
+.SS "list"
+.IX Subsection "list"
+Synonym for info.
 .SS "option"
 .IX Subsection "option"
 .IP "\fBoption [\-\-json] [show]\fR" 4
@@ -1005,7 +1008,8 @@ collection dependencies of that collection.  However, when removing a
 package, dependencies are never removed.  Options:
 .IP "\fB\-\-all\fR" 4
 .IX Item "--all"
-Uninstalls all of TeX Live.
+Uninstalls all of TeX Live, asking for confirmation unless \f(CW\*(C`\-\-force\*(C'\fR is
+also specified.
 .IP "\fB\-\-backup\fR" 4
 .IX Item "--backup"
 .PD 0
@@ -1201,9 +1205,223 @@ repository location. The \f(CW\*(C`prompt\*(C'\fR variable takes a string, and s
 current default prompt.
 .Sp
 If \fIvar\fR or then \fIval\fR is not specified, it is prompted for.
+.PP
+ym.
+.SS "print-platform-info"
+.IX Subsection "print-platform-info"
+Print the TeX Live platform identifier, \s-1TL\s0 platform long name, and
+original output from guess.
+.SS "remove [\fIoption\fP]... \fIpkg\fP..."
+.IX Subsection "remove [option]... pkg..."
+Remove each \fIpkg\fR specified.  Removing a collection removes all package
+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\-\-all\fR" 4
+.IX Item "--all"
+Uninstalls all of TeX Live, asking for confirmation unless \f(CW\*(C`\-\-force\*(C'\fR is
+also specified.
+.IP "\fB\-\-backup\fR" 4
+.IX Item "--backup"
+.PD 0
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
+.IX Item "--backupdir directory"
+.PD
+These options behave just as with the \*(L"update\*(R" action (q.v.), except
+they apply to making backups of packages before they are removed.  The
+default is to make such a backup, that is, to save a copy of packages
+before removal.
+.Sp
+See \*(L"update\*(R" action for more.
+.Sp
+neither option is given, no backup will be made. 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.
+.Sp
+You can set options via the \f(CW\*(C`option\*(C'\fR action to automatically make
+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. The default is to make one
+backup.
+.Sp
+The \f(CW\*(C`restore\*(C'\fR action explains how to restore from a backup.
+.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 \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 \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"
+Nothing is actually removed; instead, the actions to be performed are
+written to the terminal.
+.SS "repository"
+.IX Subsection "repository"
+.IP "\fBrepository list\fR" 4
+.IX Item "repository list"
+.PD 0
+.IP "\fBrepository list \f(BIpath|tag\fB\fR" 4
+.IX Item "repository list path|tag"
+.IP "\fBrepository add \f(BIpath\fB [\f(BItag\fB]\fR" 4
+.IX Item "repository add path [tag]"
+.IP "\fBrepository remove \f(BIpath|tag\fB\fR" 4
+.IX Item "repository remove path|tag"
+.IP "\fBrepository set \f(BIpath\fB[#\f(BItag\fB] [\f(BIpath\fB[#\f(BItag\fB] ...]\fR" 4
+.IX Item "repository set path[#tag] [path[#tag] ...]"
+.PD
+This action manages the list of repositories.  See \*(L"\s-1MULTIPLE
+REPOSITORIES\*(R"\s0 below for detailed explanations.
+.Sp
+The first form (\f(CW\*(C`list\*(C'\fR) lists all configured repositories and the
+respective tags if set. If a path, url, or tag is given after the
+\&\f(CW\*(C`list\*(C'\fR keyword, it is interpreted as source from where to 
+initialize a TeX Live Database and lists the contained packages.
+This can also be an up-to-now not used repository, both locally
+and remote. If one pass in addition \f(CW\*(C`\-\-with\-platforms\*(C'\fR, for each
+package the available platforms (if any) are listed, too.
+.Sp
+The third form (\f(CW\*(C`add\*(C'\fR) adds a repository
+(optionally attaching a tag) to the list of repositories.  The forth
+form (\f(CW\*(C`remove\*(C'\fR) removes a repository, either by full path/url, or by
+tag.  The last form (\f(CW\*(C`set\*(C'\fR) sets the list of repositories to the items
+given on the command line, not keeping previous settings
+.Sp
+In all cases, one of the repositories must be tagged as \f(CW\*(C`main\*(C'\fR;
+otherwise, all operations will fail!
+.SS "restore [\-\-json] [\-\-backupdir \fIdir\fP] [\-\-all | \fIpkg\fP [\fIrev\fP]]"
+.IX Subsection "restore [--json] [--backupdir dir] [--all | pkg [rev]]"
+Restore a package from a previously-made backup.
+.PP
+If \f(CW\*(C`\-\-all\*(C'\fR is given, try to restore the latest revision of all 
+package backups found in the backup directory.
+.PP
+Otherwise, if neither \fIpkg\fR nor \fIrev\fR are given, list the available
+backup revisions for all packages.  With \fIpkg\fR given but no \fIrev\fR,
+list all available backup revisions of \fIpkg\fR.
+.PP
+When listing available packages, \f(CW\*(C`tlmgr\*(C'\fR shows the revision, and in
+parenthesis the creation time if available (in format yyyy-mm-dd hh:mm).
+.PP
+If (and only if) both \fIpkg\fR and a valid revision number \fIrev\fR are
+specified, try to restore the package from the specified backup.
+.PP
+Options:
+.IP "\fB\-\-all\fR" 4
+.IX Item "--all"
+Try to restore the latest revision of all package backups found in the
+backup directory. Additional non-option arguments (like \fIpkg\fR) are not
+allowed.
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
+.IX Item "--backupdir directory"
+Specify the directory where the backups are to be found. If not given it
+will be taken from the configuration setting in the \s-1TLPDB.\s0
+.IP "\fB\-\-dry\-run\fR" 4
+.IX Item "--dry-run"
+Nothing is actually restored; instead, the actions to be performed are
+written to the terminal.
+.IP "\fB\-\-force\fR" 4
+.IX Item "--force"
+Don't ask questions.
+.IP "\fB\-\-json\fR" 4
+.IX Item "--json"
+When listing backups, the option \f(CW\*(C`\-\-json\*(C'\fR turn on \s-1JSON\s0 output.
+The format is an array of \s-1JSON\s0 objects (\f(CW\*(C`name\*(C'\fR, \f(CW\*(C`rev\*(C'\fR, \f(CW\*(C`date\*(C'\fR).
+For details see \f(CW\*(C`tlpkg/doc/JSON\-formats.txt\*(C'\fR, format definition: \f(CW\*(C`TLBACKUPS\*(C'\fR.
+If both \f(CW\*(C`\-\-json\*(C'\fR and \f(CW\*(C`\-\-data\*(C'\fR are given, \f(CW\*(C`\-\-json\*(C'\fR takes precedence.
+.SS "search [\fIoption\fP...] \fIwhat\fP"
+.IX Subsection "search [option...] what"
+\fIsearch [\fIoption\fI...] \-\-file \fIwhat\fI\fR
+.IX Subsection "search [option...] --file what"
+.PP
+\fIsearch [\fIoption\fI...] \-\-all \fIwhat\fI\fR
+.IX Subsection "search [option...] --all what"
+.PP
+By default, search the names, short descriptions, and long descriptions
+of all locally installed packages for the argument \fIwhat\fR, interpreted
+as a (Perl) regular expression.
+.PP
+Options:
+.IP "\fB\-\-file\fR" 4
+.IX Item "--file"
+List all filenames containing \fIwhat\fR.
+.IP "\fB\-\-all\fR" 4
+.IX Item "--all"
+Search everything: package names, descriptions and filenames.
+.IP "\fB\-\-global\fR" 4
+.IX Item "--global"
+Search the TeX Live Database of the installation medium, instead of the
+local installation.
+.IP "\fB\-\-word\fR" 4
+.IX Item "--word"
+Restrict the search of package names and descriptions (but not
+filenames) to match only full words.  For example, searching for
+\&\f(CW\*(C`table\*(C'\fR with this option will not output packages containing the word
+\&\f(CW\*(C`tables\*(C'\fR (unless they also contain the word \f(CW\*(C`table\*(C'\fR on its own).
+.SS "shell"
+.IX Subsection "shell"
+Starts an interactive mode, where tlmgr prompts for commands. This can
+be used directly, or for scripting. The first line of output is
+\&\f(CW\*(C`protocol\*(C'\fR \fIn\fR, where \fIn\fR is an unsigned number identifying the
+protocol version (currently 1).
+.PP
+In general, tlmgr actions that can be given on the command line
+translate to commands in this shell mode.  For example, you can say
+\&\f(CW\*(C`update \-\-list\*(C'\fR to see what would be updated. The \s-1TLPDB\s0 is loaded the
+first time it is needed (not at the beginning), and used for the rest of
+the session.
+.PP
+Besides these actions, a few commands are specific to shell mode:
+.IP "protocol" 4
+.IX Item "protocol"
+Print \f(CW\*(C`protocol \f(CIn\f(CW\*(C'\fR, the current protocol version.
+.IP "help" 4
+.IX Item "help"
+Print pointers to this documentation.
+.IP "version" 4
+.IX Item "version"
+Print tlmgr version information.
+.IP "quit, end, bye, byebye, \s-1EOF\s0" 4
+.IX Item "quit, end, bye, byebye, EOF"
+Exit.
+.IP "restart" 4
+.IX Item "restart"
+Restart \f(CW\*(C`tlmgr shell\*(C'\fR with the original command line; most useful when
+developing \f(CW\*(C`tlmgr\*(C'\fR.
+.IP "load [local|remote]" 4
+.IX Item "load [local|remote]"
+Explicitly load the local or remote, respectively, \s-1TLPDB.\s0
+.IP "save" 4
+.IX Item "save"
+Save the local \s-1TLPDB,\s0 presumably after other operations have changed it.
+.IP "get [\fIvar\fR] =item set [\fIvar\fR [\fIval\fR]]" 4
+.IX Item "get [var] =item set [var [val]]"
+Get the value of \fIvar\fR, or set it to \fIval\fR.  Possible \fIvar\fR names:
+\&\f(CW\*(C`debug\-translation\*(C'\fR, \f(CW\*(C`machine\-readable\*(C'\fR, \f(CW\*(C`no\-execute\-actions\*(C'\fR,
+\&\f(CW\*(C`require\-verification\*(C'\fR, \f(CW\*(C`verify\-downloads\*(C'\fR, \f(CW\*(C`repository\*(C'\fR, and
+\&\f(CW\*(C`prompt\*(C'\fR. All except \f(CW\*(C`repository\*(C'\fR and \f(CW\*(C`prompt\*(C'\fR are booleans, taking
+values 0 and 1, and behave like the corresponding command line option.
+The \f(CW\*(C`repository\*(C'\fR variable takes a string, and sets the remote
+repository location. The \f(CW\*(C`prompt\*(C'\fR variable takes a string, and sets the
+current default prompt.
+.Sp
+If \fIvar\fR or then \fIval\fR is not specified, it is prompted for.
+.SS "show"
+.IX Subsection "show"
+Synonym for info.
 .SS "uninstall"
 .IX Subsection "uninstall"
-Synonym for \f(CW\*(C`remove\*(C'\fR.
+Synonym for remove.
 .SS "update [\fIoption\fP]... [\fIpkg\fP]..."
 .IX Subsection "update [option]... [pkg]..."
 Updates the packages given as arguments to the latest version available
@@ -2030,4 +2248,4 @@ This script and its documentation were written for the TeX Live
 distribution (<http://tug.org/texlive>) and both are licensed under the
 \&\s-1GNU\s0 General Public License Version 2 or later.
 .PP
-\&\f(CW$Id:\fR tlmgr.pl 47092 2018\-03\-23 22:22:46Z preining $
+\&\f(CW$Id:\fR tlmgr.pl 47132 2018\-03\-26 17:19:25Z karl $
diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf
index 94fd055b10a..2dc9db82489 100644
--- a/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf