diff options
author | Karl Berry <karl@freefriends.org> | 2009-08-22 00:22:55 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2009-08-22 00:22:55 +0000 |
commit | 3a8f6028be82adc12492d21cf99876ae2c4c4471 (patch) | |
tree | d145b04eafa3037186d60a90fdba782d04a3b921 /Master | |
parent | 56a0defa6d17539b67ebcda3340bb2d32e1b6bb6 (diff) |
tlmgr doc tweaks continue; consistently use
C<--foo> for options, not B<--foo>.
git-svn-id: svn://tug.org/texlive/trunk@14806 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rwxr-xr-x | Master/texmf/scripts/texlive/tlmgr.pl | 81 |
1 files changed, 42 insertions, 39 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl index 8fbbb59674a..6b607b28307 100755 --- a/Master/texmf/scripts/texlive/tlmgr.pl +++ b/Master/texmf/scripts/texlive/tlmgr.pl @@ -3764,7 +3764,7 @@ Gives this help information (same as C<--help>). Gives version information (same as C<--version>). -If B<-v> has been given the revisions of the used modules are reported, too. +If C<-v> has been given the revisions of the used modules are reported, too. =head2 gui @@ -3827,28 +3827,29 @@ must be specified. Options: 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 B<--force> or B<--self> is given. (See below.) +the option C<--force> or C<--self> is given. (See below.) -Besides updating the installed packages, during the update of a -collection the contained packages are synchronized 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 B<auto-remove> and is announced as such -when using the option B<--list>. This auto-removal can be suppressed -using the option B<--no-auto-remove>. +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. + +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 C<--list>. This +auto-removal can be suppressed using the option C<--no-auto-remove>. 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 -B<auto-install> and is announced as such when using the option -B<--list>. This auto-installation can be suppressed using the option -B<--no-auto-install>. +the server, it will be added to the local installation. This is called +``auto-install'' and is announced as such when using the option +C<--list>. This auto-installation can be suppressed using the option +C<--no-auto-install>. 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 B<remove> action). To include, or more -precisely reinstall, those forcibly removed package use -B<--reinstall-forcibly-removed>. +forcibly removed by you (see the B<remove> action, C<--force> option). +To reinstall any such forcibly removed packages use +C<--reinstall-forcibly-removed>. =item B<--self> @@ -3856,7 +3857,7 @@ 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. -If this option is given together with B<--all> or a list of packages +If this option is given together with C<--all> 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. @@ -3873,9 +3874,10 @@ written to the terminal. This is a more detailed report than C<--list>. =item B<--force> Force update of normal packages even if updates to tlmgr itself are -present. Updates to tlmgr are not performed unless B<--self> option is -also given. Not recommended. (C<--list> is still performed regardless -of this option.) +present. Updates to tlmgr are not performed unless the C <--self> option is +also given. Not recommended. + +However, C<--list> is still performed regardless of this option. =item B<--no-auto-remove> @@ -3915,8 +3917,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 B<--backupdir> is given and specifies a writable directory -then a backup will be made in that location. If only B<--backup> is +saved. If C<--backupdir> is given and specifies a writable directory +then a backup will be made in that location. If only C<--backup> is given, then a backup will be made to the directory previously set via the C<option> action (see below). If both are given then a backup will be made to the specified I<directory>. @@ -3927,7 +3929,7 @@ backups. Please see the C<option> action for details. C<tlmgr> always makes a temporary backup when updating packages, in case of download or other failure during an update. The purpose of this -B<--backup> option is to allow you to save a persistent backup in case +C<--backup> option is to allow you to save a persistent backup in case the actual I<content> of the update causes problems, e.g., introduces an incompatibility. @@ -3952,15 +3954,15 @@ downgrade. Also, packages for uninstalled platforms are not installed. =head2 backup [--clean[=I<N>]] [--backupdir I<dir>] [--all] [I<pkg>]... -If the B<--clean> option is not specified, this action makes a backup of +If the C<--clean> option is not specified, this action makes a backup of the given packages, or all packages given C<--all>. These backups are -saved to the value of B<--backupdir> option if that is an existing and -writable directory; if B<--backupdir> is not given, the C<backupdir> +saved to the value of C<--backupdir> option if that is an existing and +writable directory; if C<--backupdir> is not given, the C<backupdir> option setting in the TLPDB is used, if present. If both are missing, no backups are made. -If the B<--clean> option is specified, backups are cleaned (pruned) -instead of made. If the value for the B<--clean> switch is not given, +If the C<--clean> option is specified, backups are cleaned (pruned) +instead of made. If the value for the C<--clean> switch is not given, the value of the C<autobackup> option is used. If both are missing, an error is issued. For the details of backup cleaning, see the C<option> action below. @@ -3981,7 +3983,8 @@ take quite a lot of space and time. =item B<--clean>[=I<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. =item B<--dry-run> @@ -4043,7 +4046,7 @@ 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. -A package that has been removed using the B<--force> option because it +A package that has been removed using the C<--force> option because it is still listed in an installed collection or scheme will not be updated, and will be mentioned as B<forcibly removed> in the output of B<tlmgr update --list>. @@ -4138,21 +4141,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: -If the user has admin rights, and the option B<--w32mode> is not given, +If the user has admin rights, and the option C<--w32mode> is not given, the setting I<w32_multi_user> determines the location (i.e., if it is on then the system path, otherwise the user path is changed). -If the user has admin rights, and the option B<--w32mode> is given, this +If the user has admin rights, and the option C<--w32mode> is given, this option determines the path to be adjusted. -If the user does not have admin rights, and the option B<--w32mode> +If the user does not have admin rights, and the option C<--w32mode> is not given, and the setting I<w32_multi_user> is off, the user path is changed, while if the setting I<w32_multi_user> is on, a warning is issued that the caller does not have enough privileges. -If the user does not have admin rights, and the option B<--w32mode> +If the user does not have admin rights, and the option C<--w32mode> is given, it must be B<user> and the user path will be adjusted. If a -user without admin rights uses the option B<--w32mode admin> a warning +user without admin rights uses the option C<--w32mode admin> a warning is issued that the caller does not have enough provileges. @@ -4263,9 +4266,9 @@ Shows information about I<pkg>: the name, category, installation status, short and long description. Searches in the remote installation source for the package if it is not locally installed. -If the option B<--list> is given with a package, the list of contained +If the option C<--list> 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, B<--list> +dependencies. When given with schemes and collections, C<--list> outputs their dependencies in a similar way. @@ -4421,7 +4424,7 @@ Options: specifies the output file (defaults to the respective location in C<TEXMFSYSVAR> for C<language*> and C<fmtutil>, and C<TEXMFSYSCONFIG> -for C<updmap>). If B<--dest> is given to C<generate language>, its +for C<updmap>). If C<--dest> is given to C<generate language>, its value will be used for the C<language.dat> output, and C<.def> will be appended to the value for the name of the C<language.def> output file. (This is just to avoid overwriting; if you want a specific name for each |