texlive[47276] Master/texmf-dist/scripts/texlive/tlmgr.pl: unify
commits+preining at tug.org
commits+preining at tug.org
Wed Apr 4 02:23:37 CEST 2018
Revision: 47276
http://tug.org/svn/texlive?view=revision&revision=47276
Author: preining
Date: 2018-04-04 02:23:36 +0200 (Wed, 04 Apr 2018)
Log Message:
-----------
unify format of pod
Modified Paths:
--------------
trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
Modified: trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2018-04-04 00:18:41 UTC (rev 47275)
+++ trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2018-04-04 00:23:36 UTC (rev 47276)
@@ -7571,8 +7571,14 @@
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
saved to the value of the C<--backupdir> option, if that is an existing and
@@ -7617,19 +7623,15 @@
=back
+=back
+
=head2 candidates I<pkg>
-=over 4
-
-=item B<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.
=over 4
@@ -7671,10 +7673,14 @@
=back
-=head2 conf [texmf|tlmgr|updmap [--conffile I<file>] [--delete] [I<key> [I<value>]]]
+=head2 conf
-=head2 conf auxtrees [--conffile I<file>] [show|add|delete] [I<value>]
+=over 4
+=item B<conf [texmf|tlmgr|updmap [--conffile I<file>] [--delete] [I<key> [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
like running C<texconfig conf>, but works on all supported platforms.
@@ -7722,8 +7728,10 @@
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
L<MACHINE-READABLE OUTPUT> section.
@@ -7760,17 +7768,17 @@
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,8 +7885,16 @@
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,6 +7962,8 @@
=back
+=back
+
=head2 init-usertree
Sets up a texmf tree for so-called user mode management, either the
@@ -7952,7 +7970,7 @@
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,8 +8036,16 @@
=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
the TeX Live databases.
@@ -8034,6 +8060,8 @@
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,8 +8210,14 @@
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
(see the L</option> description above). Does not change any
@@ -8209,6 +8243,8 @@
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,12 +8271,16 @@
=back
-=head2 platform list|add|remove I<platform>...
+=head2 platform
-=head2 platform set I<platform>
+=over 4
-=head2 platform set auto
+=item B<platform list|add|remove I<platform>...>
+=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
repository.
@@ -8273,6 +8313,8 @@
=back
+=back
+
=cut
# keep the following on *ONE* line otherwise Losedows perldoc does
@@ -8280,13 +8322,25 @@
=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
@@ -8293,11 +8347,21 @@
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,8 +8461,14 @@
=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.
If C<--all> is given, try to restore the latest revision of all
@@ -8447,12 +8517,18 @@
=back
-=head2 search [I<option>...] I<what>
+=back
-=head3 search [I<option>...] --file I<what>
+=head2 search
-=head3 search [I<option>...] --all I<what>
+=over 4
+=item B<search [I<option>...] I<what>>
+
+=item B<search [I<option>...] --file 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
as a (Perl) regular expression.
@@ -8483,6 +8559,8 @@
=back
+=back
+
=head2 shell
Starts an interactive mode, where tlmgr prompts for commands. This can
More information about the tex-live-commits
mailing list