diff options
author | Norbert Preining <preining@logic.at> | 2018-04-04 00:23:36 +0000 |
---|---|---|
committer | Norbert Preining <preining@logic.at> | 2018-04-04 00:23:36 +0000 |
commit | 7c68a9bacb7238c8358b12883fb9fdd5264a696a (patch) | |
tree | 16e99de702e61b7f709300e666e8e6d14bc8d41c | |
parent | bf1c045777a22ee70641a98738c7c93d9dcb9cb1 (diff) |
unify format of pod
git-svn-id: svn://tug.org/texlive/trunk@47276 c570f23f-e606-0410-a88d-b1316a301751
-rwxr-xr-x | Master/texmf-dist/scripts/texlive/tlmgr.pl | 134 |
1 files changed, 106 insertions, 28 deletions
diff --git a/Master/texmf-dist/scripts/texlive/tlmgr.pl b/Master/texmf-dist/scripts/texlive/tlmgr.pl index a634995c72b..cfc84414db2 100755 --- a/Master/texmf-dist/scripts/texlive/tlmgr.pl +++ b/Master/texmf-dist/scripts/texlive/tlmgr.pl @@ -7571,7 +7571,13 @@ Gives version information (same as C<--version>). If C<-v> has been given the revisions of the used modules are reported, too. -=head2 backup [--clean[=I<N>]] [--backupdir I<dir>] [--all | I<pkg>]... +=head2 backup + +=over 4 + +=item B<backup [I<option>...] --all> + +=item B<backup [I<option>...] I<pkg>...> 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 @@ -7617,18 +7623,14 @@ performed are written to the terminal. =back -=head2 candidates I<pkg> - -=over 4 +=back -=item B<candidates I<pkg>> +=head2 candidates I<pkg> Shows the available candidate repositories for package I<pkg>. See L<MULTIPLE REPOSITORIES> below. -=back - -=head2 check [I<option>]... [files|depends|executes|runfiles|all] +=head2 check [I<option>...] [files|depends|executes|runfiles|all] Executes one (or all) check(s) on the consistency of the installation. @@ -7671,9 +7673,13 @@ checking the TL development repository. =back -=head2 conf [texmf|tlmgr|updmap [--conffile I<file>] [--delete] [I<key> [I<value>]]] +=head2 conf + +=over 4 + +=item B<conf [texmf|tlmgr|updmap [--conffile I<file>] [--delete] [I<key> [I<value>]]]> -=head2 conf auxtrees [--conffile I<file>] [show|add|delete] [I<value>] +=item B<conf auxtrees [--conffile I<file>] [show|add|delete] [I<value>]> With only C<conf>, show general configuration information for TeX Live, including active configuration files, path settings, and more. This is @@ -7722,7 +7728,9 @@ but tinkering with settings in this way is strongly discouraged. Again, no error checking on either keys or values is done, so any sort of breakage is possible. -=head2 dump-tlpdb [--local|--remote] [--json] +=back + +=head2 dump-tlpdb [I<option>...] [--json] Dump complete local or remote TLPDB to standard output, as-is. The output is analogous to the C<--machine-readable> output; see @@ -7760,17 +7768,17 @@ I<location> is the file or url to the repository. Line endings may be either LF or CRLF depending on the current platform. -=head2 generate [I<option>]... I<what> +=head2 generate =over 4 -=item B<generate language> +=item B<generate [I<option>...] language> -=item B<generate language.dat> +=item B<generate [I<option>...] language.dat> -=item B<generate language.def> +=item B<generate [I<option>...] language.def> -=item B<generate language.dat.lua> +=item B<generate [I<option>...] language.dat.lua> =back @@ -7877,7 +7885,15 @@ The respective locations are as follows: Start the graphical user interface. See B<GUI> below. -=head2 info [I<option>...] [collections|schemes|I<pkg>...] +=head2 info + +=over 4 + +=item B<info [I<option>...] I<pkg>...> + +=item B<info [I<option>...] collections> + +=item B<info [I<option>...] schemes> With no argument, lists all packages available at the package repository, prefixing those already installed with C<i>. @@ -7946,13 +7962,15 @@ If both C<--json> and C<--data> are given, C<--json> takes precedence. =back +=back + =head2 init-usertree Sets up a texmf tree for so-called user mode management, either the default user tree (C<TEXMFHOME>), or one specified on the command line with C<--usertree>. See L<USER MODE> below. -=head2 install [I<option>]... I<pkg>... +=head2 install [I<option>...] I<pkg>... Install each I<pkg> given on the command line, if it is not already installed. (It does not touch existing packages; see the C<update> @@ -8018,7 +8036,15 @@ C<--reinstall>, as in (using the C<fontspec> package as the example): =back -=head2 key list|add I<file>|remove I<keyid> +=head2 key + +=over 4 + +=item B<key list> + +=item B<key add I<file>> + +=item B<key remove I<keyid>> The action C<key> allows listing, adding and removing additional GPG keys to the set of trusted keys, that is, those that are used to verify @@ -8034,6 +8060,8 @@ C<tlpkg/gpg/repository-keys.gpg>. The C<remove> argument requires a key id and removes the requested id from the local keyring. +=back + =head2 list Synonym for L<info|/info [I<option>...] [collections|schemes|I<pkg>...]>. @@ -8182,7 +8210,13 @@ C<texconfig> script, which supports other configuration settings for some programs, notably C<dvips>. C<tlmgr> does not support those extra settings. -=head2 path [--w32mode=user|admin] [add|remove] +=head2 path + +=over 4 + +=item B<path [--w32mode=user|admin] add> + +=item B<path [--w32mode=user|admin] remove> On Unix, merely adds or removes symlinks for binaries, man pages, and info pages in the system directories specified by the respective options @@ -8209,6 +8243,8 @@ is given, it must be C<user> and the user path will be adjusted. If a user without admin rights uses the option C<--w32mode admin> a warning is issued that the caller does not have enough privileges. +=back + =head2 pinning The C<pinning> action manages the pinning file, see L</Pinning> below. @@ -8235,11 +8271,15 @@ Remove all pinning data for repository I<repo>. =back -=head2 platform list|add|remove I<platform>... +=head2 platform + +=over 4 -=head2 platform set I<platform> +=item B<platform list|add|remove I<platform>...> -=head2 platform set auto +=item B<platform set I<platform>> + +=item B<platform set auto> C<platform list> lists the TeX Live names of all the platforms (a.k.a. architectures), (C<i386-linux>, ...) available at the package @@ -8273,6 +8313,8 @@ written to the terminal. =back +=back + =cut # keep the following on *ONE* line otherwise Losedows perldoc does @@ -8280,24 +8322,46 @@ written to the terminal. =pod -=head2 postaction [--w32mode=user|admin] [--fileassocmode=1|2] [--all] [install|remove] [shortcut|fileassoc|script] [I<pkg>]... +=head2 postaction + +=over 4 + +=item B<postaction [I<option>...] install [shortcut|fileassoc|script] [I<pkg>...]> + +=item B<postaction [I<option>...] remove [shortcut|fileassoc|script] [I<pkg>...]> Carry out the postaction C<shortcut>, C<fileassoc>, or C<script> given as the second required argument in install or remove mode (which is the first required argument), for either the packages given on the command line, or for all if C<--all> is given. +Options: + +=over 4 + +=item B<--w32mode=[user|admin]> + If the option C<--w32mode> is given the value C<user>, all actions will only be carried out in the user-accessible parts of the registry/filesystem, while the value C<admin> selects the system-wide parts of the registry for the file associations. If you do not have enough permissions, using C<--w32mode=admin> will not succeed. +=item B<--fileassocmode=[1|2]> + C<--fileassocmode> specifies the action for file associations. If it is set to 1 (the default), only new associations are added; if it is set to 2, all associations are set to the TeX Live programs. (See also C<option fileassocs>.) +=item B<--all> + +Carry out the postactions for all packages + +=back + +=back + =head2 print-platform Print the TeX Live identifier for the detected platform @@ -8397,7 +8461,13 @@ otherwise, all operations will fail! =back -=head2 restore [--json] [--backupdir I<dir>] [--all | I<pkg> [I<rev>]] +=head2 restore + +=over 4 + +=item B<restore [I<option>...] I<pkg> [I<rev>]> + +=item B<restore [I<option>...] --all> Restore a package from a previously-made backup. @@ -8447,11 +8517,17 @@ If both C<--json> and C<--data> are given, C<--json> takes precedence. =back -=head2 search [I<option>...] I<what> +=back + +=head2 search + +=over 4 + +=item B<search [I<option>...] I<what>> -=head3 search [I<option>...] --file I<what> +=item B<search [I<option>...] --file I<what>> -=head3 search [I<option>...] --all I<what> +=item B<search [I<option>...] --all I<what>> By default, search the names, short descriptions, and long descriptions of all locally installed packages for the argument I<what>, interpreted @@ -8483,6 +8559,8 @@ C<tables> (unless they also contain the word C<table> on its own). =back +=back + =head2 shell Starts an interactive mode, where tlmgr prompts for commands. This can |