From 330a61ce67bb9cc531a2223d41d95ffc468d7a6f Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Tue, 3 Apr 2018 00:23:48 +0000 Subject: tl-update-auto git-svn-id: svn://tug.org/texlive/trunk@47257 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/man/man1/tlmgr.1 | 303 ++++---------------------- Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf | Bin 135398 -> 124277 bytes 2 files changed, 39 insertions(+), 264 deletions(-) (limited to 'Master/texmf-dist') diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1 index 4d5b5f174da..9ae836e6e1f 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-04-01" "perl v5.26.1" "User Contributed Perl Documentation" +.TH TLMGR 1 "2018-04-02" "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 @@ -293,12 +293,12 @@ Activates user mode for this run of \f(CW\*(C`tlmgr\*(C'\fR; see \*(L"\s-1USER M Uses \fIdir\fR for the tree in user mode; see \*(L"\s-1USER MODE\*(R"\s0 below. .IP "\fB\-\-verify\-repo=[none|main|all]\fR" 4 .IX Item "--verify-repo=[none|main|all]" -Defines the level of verification done: If \f(CW\*(C`none\*(C'\fR is passed, no -verification whatsoever is done. If \f(CW\*(C`main\*(C'\fR and a working GnuPG (\f(CW\*(C`gpg\*(C'\fR) -binary is available, all repositories are checked, but only the main -repository is required to be signed. If \f(CW\*(C`all\*(C'\fR then all repositories -need to be signed. -See \*(L"\s-1CRYPTOGRAPHIC VERIFICATION\*(R"\s0 below for details. +Defines the level of verification done: If \f(CW\*(C`none\*(C'\fR is specified, no +verification whatsoever is done. If \f(CW\*(C`main\*(C'\fR is given and a working GnuPG +(\f(CW\*(C`gpg\*(C'\fR) binary is available, all repositories are checked, but only the +main repository is required to be signed. If \f(CW\*(C`all\*(C'\fR is given, then all +repositories need to be signed. See \*(L"\s-1CRYPTOGRAPHIC VERIFICATION\*(R"\s0 below +for details. .PP The standard options for TeX Live programs 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 @@ -904,7 +904,7 @@ 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 \f(CW\*(C`\-\-w32mode\*(C'\fR -is given, it must be \fBuser\fR and the user path will be adjusted. If a +is given, it must be \f(CW\*(C`user\*(C'\fR and the user path will be adjusted. If a 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 privileges. .SS "pinning" @@ -1002,31 +1002,17 @@ also specified. .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. +These options behave just as with the update 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. +The restore 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). +See above under install (and beware). .IP "\fB\-\-force\fR" 4 .IX Item "--force" By default, removal of a package or collection that is a dependency of @@ -1035,8 +1021,8 @@ 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. +updated, and will be mentioned as \f(CW\*(C`forcibly removed\*(C'\fR in the output of +\&\f(CW\*(C`tlmgr update \-\-list\*(C'\fR. .IP "\fB\-\-dry\-run\fR" 4 .IX Item "--dry-run" Nothing is actually removed; instead, the actions to be performed are @@ -1055,219 +1041,8 @@ written to the terminal. .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. -.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. +This action manages the list of repositories. See \s-1MULTIPLE +REPOSITORIES\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 @@ -1554,14 +1329,14 @@ installation with the server's idea of what is available: .PD These two options control the creation of backups of packages \fIbefore\fR updating; that is, backup of packages as currently installed. If -neither options is given, no backup will made 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 \*(L"option\*(R" action (see +neither options is given, no backup will 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 \*(L"option\*(R" action (see below). If both are given then a backup will be made to the specified \&\fIdirectory\fR. .Sp -You can also set options via the \f(CW\*(C`/option\*(C'\fR action to automatically make +You can also set options via the \*(L"option\*(R" action to automatically make backups for all packages, and/or keep only a certain number of backups. .Sp \&\f(CW\*(C`tlmgr\*(C'\fR always makes a temporary backup when updating packages, in case @@ -1570,7 +1345,7 @@ of this \f(CW\*(C`\-\-backup\*(C'\fR option is to save a persistent backup in ca actual \fIcontent\fR of the update causes problems, e.g., introduces an TeX incompatibility. .Sp -The \*(L"restore\*(R" action explains how to restore from a backup. +The restore action explains how to restore from a backup. .IP "\fB\-\-no\-depends\fR" 4 .IX Item "--no-depends" If you call for updating a package normally all depending packages @@ -1578,7 +1353,7 @@ will also be checked for updates and updated if necessary. This switch suppresses this behavior. .IP "\fB\-\-no\-depends\-at\-all\fR" 4 .IX Item "--no-depends-at-all" -See above under \fBinstall\fR (and beware). +See above under install (and beware). .IP "\fB\-\-force\fR" 4 .IX Item "--force" Force update of normal packages, without updating \f(CW\*(C`tlmgr\*(C'\fR itself @@ -1677,22 +1452,22 @@ report \f(CW\*(C`(verified)\*(C'\fR after loading the \s-1TLPDB\s0; otherwise, t \&\f(CW\*(C`(not verified)\*(C'\fR. But either way, by default the installation and/or updates proceed normally. .PP -If a program named \f(CW\*(C`gpg\*(C'\fR is available (that is, found in \f(CW\*(C`PATH\*(C'\fR), -cryptographic signatures will be checked. In this case we require the -main repository be signed, but not any additional repositories. If -\&\f(CW\*(C`gpg\*(C'\fR is not available, signatures are not checked and no verification -is carried out, but \f(CW\*(C`tlmgr\*(C'\fR proceeds normally. +If a program named \f(CW\*(C`gpg\*(C'\fR is available (that is, found in \f(CW\*(C`PATH\*(C'\fR), by +default cryptographic signatures will be checked: we require the main +repository be signed, but not any additional repositories. If \f(CW\*(C`gpg\*(C'\fR is +not available, by default signatures are not checked and no verification +is carried out, but \f(CW\*(C`tlmgr\*(C'\fR still proceeds normally. .PP -The behaviour of the verification can be controlled by the command line +The behavior of the verification can be controlled by the command line and config file option \f(CW\*(C`verify\-repo\*(C'\fR which takes one of the following -values: \f(CW\*(C`none\*(C'\fR, \f(CW\*(C`main\*(C'\fR, or \f(CW\*(C`all\*(C'\fR. In case of \f(CW\*(C`none\*(C'\fR, no verification -whatsoever is attempted, similar to the case when not GnuPG can be found. -In case of \f(CW\*(C`main\*(C'\fR (the default) verification is required only for -the main repository, but attempted for all. Missing signatures of -subsidiary repositories will not result in an error. -Finally, in the case of \f(CW\*(C`all\*(C'\fR, all repositories need to be signed. -.PP -In all cases when a signature is checked and fails to verify, an error +values: \f(CW\*(C`none\*(C'\fR, \f(CW\*(C`main\*(C'\fR, or \f(CW\*(C`all\*(C'\fR. With \f(CW\*(C`none\*(C'\fR, no verification +whatsoever is attempted. With \f(CW\*(C`main\*(C'\fR (the default) verification is +required only for the main repository, and only if \f(CW\*(C`gpg\*(C'\fR is available; +though attempted for all, missing signatures of subsidiary repositories +will not result in an error. Finally, in the case of \f(CW\*(C`all\*(C'\fR, \f(CW\*(C`gpg\*(C'\fR +must be available and all repositories need to be signed. +.PP +In all cases, if a signature is checked and fails to verify, an error is raised. .PP Cryptographic verification requires checksum checking (described just @@ -2238,4 +2013,4 @@ This script and its documentation were written for the TeX Live distribution () and both are licensed under the \&\s-1GNU\s0 General Public License Version 2 or later. .PP -\&\f(CW$Id:\fR tlmgr.pl 47220 2018\-04\-01 03:20:33Z preining $ +\&\f(CW$Id:\fR tlmgr.pl 47254 2018\-04\-02 23:13:43Z karl $ diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf index ffcc47a78de..bb8fcd62ff9 100644 Binary files a/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf and b/Master/texmf-dist/doc/man/man1/tlmgr.man1.pdf differ -- cgit v1.2.3