From 5a39a1f18fd8c801bd77cb29aec666a0ac22bdd6 Mon Sep 17 00:00:00 2001
From: Karl Berry <karl@freefriends.org>
Date: Thu, 18 Dec 2008 01:50:16 +0000
Subject: use head2 instead of a long list for the actions

git-svn-id: svn://tug.org/texlive/trunk@11637 c570f23f-e606-0410-a88d-b1316a301751
---
 Master/texmf/scripts/texlive/tlmgr.pl  | 85 ++++++++++++++++++++--------------
 Master/texmf/scripts/texlive/tlmgr2.pl | 85 ++++++++++++++++++++--------------
 2 files changed, 102 insertions(+), 68 deletions(-)

(limited to 'Master/texmf')

diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index f2077f77716..a65667f91e0 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -2426,7 +2426,8 @@ tlmgr itself, disaster recovery when it's broken, and test versions.
 
 The following options to C<tlmgr> have to be given I<before> you specify
 the main action to perform.  In all cases, C<-->I<option> and
-C<->I<option> are equivalent.
+C<->I<option> are equivalent, and an C<=> is optional between an option
+name and its value.
 
 =over 4
 
@@ -2477,26 +2478,25 @@ release as well as the C<tlmgr> script itself.
 
 =head1 ACTIONS
 
-=over 4
-
-=item B<help>
+=head2 help
 
 Gives this help information (same as C<--help>).
 
-=item B<version>
+=head2 version
 
 Gives version information (same as C<--version>).
 
-=item B<gui>
+=head2 gui
 
 Start the graphical user interface.
 
-=item B<install> [I<option>]... I<pkg>...
+
+=head2 install [I<option>]... I<pkg>...
 
 Install each I<pkg> given on the command line. By default this installs
 all packages on which the given I<pkg>s are dependent, also.  Options:
 
-=over 8
+=over 4
 
 =item B<--reinstall>
 
@@ -2534,13 +2534,13 @@ is given.
 =back
 
 
-=item B<update> [I<option>] [I<pkg>]...
+=head2 update [I<option>]... [I<pkg>]...
 
 Updates the packages given as arguments to the latest version available
 at the installation source.  Either C<--all> or at least one I<pkg> name
 must be specified.  Options:
 
-=over 8
+=over 4
 
 =item B<--all>
 
@@ -2622,7 +2622,7 @@ If the package on the server is older than the package already installed
 downgrade.  Also, packages for uninstalled platforms are not installed.
 
 
-=item B<backup> [--clean[=I<N>]] [--backupdir I<dir>] [B<--all>] [I<pkg>]...
+=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
 the given packages, or all packages given C<--all>. These backups are
@@ -2633,13 +2633,13 @@ 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,
-the value of the B<autobackup> option from is used. If both are missing,
+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.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--backupdir> I<directory>
 
@@ -2663,7 +2663,7 @@ performed are written to the terminal.
 =back
 
 
-=item B<restore --backupdir> I<dir> [I<pkg> [I<rev>]]
+=head2 restore --backupdir I<dir> [I<pkg> [I<rev>]
 
 Restore a package from a previously-made backup.
 
@@ -2678,7 +2678,7 @@ specified backup.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--dry-run>
 
@@ -2692,14 +2692,14 @@ Specify the directory where the backups are to be found.
 =back
 
 
-=item B<remove> [I<option>]... I<pkg>...
+=head2 remove [I<option>]... I<pkg>...
 
 Remove each I<pkg> specified.  Removing a collection removes all package
 dependencies, but not collection dependencies, in that collection
 (unless C<--no-depends> is specified).  However, when removing a
 package, dependencies are never removed.  Options:
 
-=over 8
+=over 4
 
 =item B<--no-depends>
 
@@ -2723,10 +2723,16 @@ written to the terminal.
 =back
 
 
+=head2 option
+
+=over 4
+
 =item B<option [show]>
 
 =item B<option I<key> [I<value>]>
 
+=back
+
 The first form shows the global TeX Live settings currently saved in the
 TLPDB.
 
@@ -2764,19 +2770,26 @@ with 0 as the values.
 In the C<--clean> mode of the C<backup> action this option also
 specifies the number to be kept.
 
+
+=head2 paper
+
+=over 4
+
 =item B<paper a4>
 
 =item B<paper letter>
 
 =item B<[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|I<papersize>|--list]>
 
+=back
+
 Configures the system wide paper settings, either for all programs at
 once (first two forms), or just for the specified program (third
 form). The third form with C<--list> outputs all known papersizes for the
 specified program.
 
 
-=item B<arch list|add> I<arch>...
+=head2 arch list|add I<arch>...
 
 C<arch list> lists the TeX Live names of all the architectures
 (C<i386-linux>, ...) available at the default install location.
@@ -2784,7 +2797,7 @@ C<arch list> lists the TeX Live names of all the architectures
 C<arch add> I<arch> adds the executables for each given architecture
 I<arch> to the installation.  Options:
 
-=over 8
+=over 4
 
 =item B<--dry-run>
 
@@ -2794,13 +2807,13 @@ written to the terminal.
 =back
 
 
-=item B<search [I<option>]... I<what>>
+=head2 search [I<option>]... I<what>
 
 By default searches the names, short and long descriptions of all
 locally installed packages for the given argument (interpreted as
 regexp).  Options:
 
-=over 8
+=over 4
 
 =item B<--file>
 
@@ -2814,7 +2827,7 @@ local installation.
 =back
 
 
-=item B<show [--list] I<pkg>...>
+=head2 show [--list] I<pkg>...
 
 Shows information about I<pkg>: the name, category, installation status,
 short and long description.  Searches in the remote installation source
@@ -2824,7 +2837,7 @@ If the option B<--list> is given the list of contained files is also
 shown, including those for architecture specific dependencies.
 
 
-=item B<list [collections|schemes|I<pkg>...]>
+=head2 list [collections|schemes|I<pkg>...]
 
 With no argument, lists all packages available at the default install
 location, prefixing those already installed with C<i>.
@@ -2835,11 +2848,11 @@ the request type.
 With anything else as arguments, operates as the C<show> action.
 
 
-=item B<check [I<option>]... [files|collections|all]>
+=head2 check [I<option>]... [files|collections|all]
 
 Executes one (or all) check(s) on the consistency of the installation.
 
-=over 8
+=over 4
 
 =item B<files>
 
@@ -2849,13 +2862,11 @@ are actually present, and lists those missing.
 =item B<collections>
 
 Lists those packages which occur as dependencies in an installed collections,
-but are themselves not installed.
+but are themselves not installed.  Options:
 
 =back
 
-Available options are:
-
-=over 8
+=over 4
 
 =item B<--use-svn>
 
@@ -2865,11 +2876,11 @@ development repository.
 =back
 
 
-=item B<uninstall>
+=head2 uninstall
 
 Uninstalls the entire TeX Live installation.  Options:
 
-=over 8
+=over 4
 
 =item B<--force>
 
@@ -2878,6 +2889,10 @@ Do not ask for confirmation, remove immediately.
 =back
 
 
+=head2 generate
+
+=over 4
+
 =item B<generate language>
 
 =item B<generate language.dat>
@@ -2888,6 +2903,8 @@ Do not ask for confirmation, remove immediately.
 
 =item B<generate updmap>
 
+=back
+
 The I<generate> action overwrites any manual changes made in the
 respective files: it recreates them from scratch.
 
@@ -2919,7 +2936,7 @@ the given file.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--dest> I<output file>
 
@@ -2943,8 +2960,6 @@ The respective locations are as follows:
   C<web2c/fmtutil.cnf> (and C<fmtutil-local.cnf>)
   C<web2c/updmap.cfg> (and C<updmap-local.cfg>)
 
-=back
-
 
 =head1 AUTHORS AND COPYRIGHT
 
@@ -2954,6 +2969,8 @@ GNU General Public License Version 2 or later.
 
 =cut
 
+# to remake HTML version: pod2html --cachedir=/tmp tlmgr.pl >/foo/tlmgr.html.
+
 ### Local Variables:
 ### perl-indent-level: 2
 ### tab-width: 2
diff --git a/Master/texmf/scripts/texlive/tlmgr2.pl b/Master/texmf/scripts/texlive/tlmgr2.pl
index 336b15a5174..df39974bdb6 100755
--- a/Master/texmf/scripts/texlive/tlmgr2.pl
+++ b/Master/texmf/scripts/texlive/tlmgr2.pl
@@ -2622,7 +2622,8 @@ tlmgr itself, disaster recovery when it's broken, and test versions.
 
 The following options to C<tlmgr> have to be given I<before> you specify
 the main action to perform.  In all cases, C<-->I<option> and
-C<->I<option> are equivalent.
+C<->I<option> are equivalent, and an C<=> is optional between an option
+name and its value.
 
 =over 4
 
@@ -2673,26 +2674,25 @@ release as well as the C<tlmgr> script itself.
 
 =head1 ACTIONS
 
-=over 4
-
-=item B<help>
+=head2 help
 
 Gives this help information (same as C<--help>).
 
-=item B<version>
+=head2 version
 
 Gives version information (same as C<--version>).
 
-=item B<gui>
+=head2 gui
 
 Start the graphical user interface.
 
-=item B<install> [I<option>]... I<pkg>...
+
+=head2 install [I<option>]... I<pkg>...
 
 Install each I<pkg> given on the command line. By default this installs
 all packages on which the given I<pkg>s are dependent, also.  Options:
 
-=over 8
+=over 4
 
 =item B<--reinstall>
 
@@ -2730,13 +2730,13 @@ is given.
 =back
 
 
-=item B<update> [I<option>] [I<pkg>]...
+=head2 update [I<option>]... [I<pkg>]...
 
 Updates the packages given as arguments to the latest version available
 at the installation source.  Either C<--all> or at least one I<pkg> name
 must be specified.  Options:
 
-=over 8
+=over 4
 
 =item B<--all>
 
@@ -2818,7 +2818,7 @@ If the package on the server is older than the package already installed
 downgrade.  Also, packages for uninstalled platforms are not installed.
 
 
-=item B<backup> [--clean[=I<N>]] [--backupdir I<dir>] [B<--all>] [I<pkg>]...
+=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
 the given packages, or all packages given C<--all>. These backups are
@@ -2829,13 +2829,13 @@ 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,
-the value of the B<autobackup> option from is used. If both are missing,
+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.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--backupdir> I<directory>
 
@@ -2859,7 +2859,7 @@ performed are written to the terminal.
 =back
 
 
-=item B<restore --backupdir> I<dir> [I<pkg> [I<rev>]]
+=head2 restore --backupdir I<dir> [I<pkg> [I<rev>]
 
 Restore a package from a previously-made backup.
 
@@ -2874,7 +2874,7 @@ specified backup.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--dry-run>
 
@@ -2888,14 +2888,14 @@ Specify the directory where the backups are to be found.
 =back
 
 
-=item B<remove> [I<option>]... I<pkg>...
+=head2 remove [I<option>]... I<pkg>...
 
 Remove each I<pkg> specified.  Removing a collection removes all package
 dependencies, but not collection dependencies, in that collection
 (unless C<--no-depends> is specified).  However, when removing a
 package, dependencies are never removed.  Options:
 
-=over 8
+=over 4
 
 =item B<--no-depends>
 
@@ -2919,10 +2919,16 @@ written to the terminal.
 =back
 
 
+=head2 option
+
+=over 4
+
 =item B<option [show]>
 
 =item B<option I<key> [I<value>]>
 
+=back
+
 The first form shows the global TeX Live settings currently saved in the
 TLPDB.
 
@@ -2960,19 +2966,26 @@ with 0 as the values.
 In the C<--clean> mode of the C<backup> action this option also
 specifies the number to be kept.
 
+
+=head2 paper
+
+=over 4
+
 =item B<paper a4>
 
 =item B<paper letter>
 
 =item B<[xdvi|dvips|pdftex|dvipdfm|dvipdfmx|context] paper [help|I<papersize>|--list]>
 
+=back
+
 Configures the system wide paper settings, either for all programs at
 once (first two forms), or just for the specified program (third
 form). The third form with C<--list> outputs all known papersizes for the
 specified program.
 
 
-=item B<arch list|add> I<arch>...
+=head2 arch list|add I<arch>...
 
 C<arch list> lists the TeX Live names of all the architectures
 (C<i386-linux>, ...) available at the default install location.
@@ -2980,7 +2993,7 @@ C<arch list> lists the TeX Live names of all the architectures
 C<arch add> I<arch> adds the executables for each given architecture
 I<arch> to the installation.  Options:
 
-=over 8
+=over 4
 
 =item B<--dry-run>
 
@@ -2990,13 +3003,13 @@ written to the terminal.
 =back
 
 
-=item B<search [I<option>]... I<what>>
+=head2 search [I<option>]... I<what>
 
 By default searches the names, short and long descriptions of all
 locally installed packages for the given argument (interpreted as
 regexp).  Options:
 
-=over 8
+=over 4
 
 =item B<--file>
 
@@ -3010,7 +3023,7 @@ local installation.
 =back
 
 
-=item B<show [--list] I<pkg>...>
+=head2 show [--list] I<pkg>...
 
 Shows information about I<pkg>: the name, category, installation status,
 short and long description.  Searches in the remote installation source
@@ -3020,7 +3033,7 @@ If the option B<--list> is given the list of contained files is also
 shown, including those for architecture specific dependencies.
 
 
-=item B<list [collections|schemes|I<pkg>...]>
+=head2 list [collections|schemes|I<pkg>...]
 
 With no argument, lists all packages available at the default install
 location, prefixing those already installed with C<i>.
@@ -3031,11 +3044,11 @@ the request type.
 With anything else as arguments, operates as the C<show> action.
 
 
-=item B<check [I<option>]... [files|collections|all]>
+=head2 check [I<option>]... [files|collections|all]
 
 Executes one (or all) check(s) on the consistency of the installation.
 
-=over 8
+=over 4
 
 =item B<files>
 
@@ -3045,13 +3058,11 @@ are actually present, and lists those missing.
 =item B<collections>
 
 Lists those packages which occur as dependencies in an installed collections,
-but are themselves not installed.
+but are themselves not installed.  Options:
 
 =back
 
-Available options are:
-
-=over 8
+=over 4
 
 =item B<--use-svn>
 
@@ -3061,11 +3072,11 @@ development repository.
 =back
 
 
-=item B<uninstall>
+=head2 uninstall
 
 Uninstalls the entire TeX Live installation.  Options:
 
-=over 8
+=over 4
 
 =item B<--force>
 
@@ -3074,6 +3085,10 @@ Do not ask for confirmation, remove immediately.
 =back
 
 
+=head2 generate
+
+=over 4
+
 =item B<generate language>
 
 =item B<generate language.dat>
@@ -3084,6 +3099,8 @@ Do not ask for confirmation, remove immediately.
 
 =item B<generate updmap>
 
+=back
+
 The I<generate> action overwrites any manual changes made in the
 respective files: it recreates them from scratch.
 
@@ -3115,7 +3132,7 @@ the given file.
 
 Options:
 
-=over 8
+=over 4
 
 =item B<--dest> I<output file>
 
@@ -3139,8 +3156,6 @@ The respective locations are as follows:
   C<web2c/fmtutil.cnf> (and C<fmtutil-local.cnf>)
   C<web2c/updmap.cfg> (and C<updmap-local.cfg>)
 
-=back
-
 
 =head1 AUTHORS AND COPYRIGHT
 
@@ -3150,6 +3165,8 @@ GNU General Public License Version 2 or later.
 
 =cut
 
+# to remake HTML version: pod2html --cachedir=/tmp tlmgr.pl >/foo/tlmgr.html.
+
 ### Local Variables:
 ### perl-indent-level: 2
 ### tab-width: 2
-- 
cgit v1.2.3