From 0996fea9badefbc36e55df0c8a2a768333a539b7 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 6 Sep 2008 17:11:52 +0000 Subject: doc tweaks, including =over 4 consistently git-svn-id: svn://tug.org/texlive/trunk@10439 c570f23f-e606-0410-a88d-b1316a301751 --- Master/install-tl | 2 +- Master/texmf/scripts/texlive/tlmgr.pl | 32 +++++++++++++++++--------------- Master/tlpkg/TeXLive/TLConfig.pm | 2 +- Master/tlpkg/TeXLive/TLPDB.pm | 4 ++-- Master/tlpkg/TeXLive/TLPOBJ.pm | 4 ++-- Master/tlpkg/TeXLive/TLPSRC.pm | 16 ++++++++-------- Master/tlpkg/TeXLive/TLUtils.pm | 12 ++++++------ Master/tlpkg/TeXLive/TLWinGoo.pm | 8 ++++---- Master/tlpkg/bin/check-file-coverage | 2 +- Master/tlpkg/bin/tl-update-containers | 6 +++--- Master/tlpkg/bin/tlpdb2container | 2 +- Master/tlpkg/bin/tlpdb2list | 2 +- Master/tlpkg/bin/tlpfiles | 2 +- Master/tlpkg/bin/tlprm | 2 +- Master/tlpkg/bin/tlpsrc2container | 2 +- Master/tlpkg/bin/tlpsrc2tlpdb | 2 +- Master/tlpkg/bin/tlpsrc2tlpobj | 2 +- 17 files changed, 52 insertions(+), 50 deletions(-) (limited to 'Master') diff --git a/Master/install-tl b/Master/install-tl index 58556426397..6775f4481a4 100755 --- a/Master/install-tl +++ b/Master/install-tl @@ -1380,7 +1380,7 @@ L. =head1 OPTIONS -=over 8 +=over 4 =item B<-gui> diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl index aad5f6e9d8d..b69fc25e8dc 100755 --- a/Master/texmf/scripts/texlive/tlmgr.pl +++ b/Master/texmf/scripts/texlive/tlmgr.pl @@ -1280,7 +1280,7 @@ L. The following options have to be given I you specify the action. -=over 8 +=over 4 =item B<--location> I @@ -1316,7 +1316,7 @@ release as well as the B script itself. =head1 ACTIONS -=over 8 +=over 4 =item B @@ -1335,7 +1335,7 @@ Start the graphical user interface. Install all Is given on the command line. By default this installs all packages that the given Is are dependent on, also. Options: -=over 16 +=over 8 =item B<--no-depends> @@ -1355,7 +1355,7 @@ written to the terminal. Updates the packages given as arguments to the latest version available at the installation source. Options: -=over 8 +=over 4 =item B<--list> @@ -1389,7 +1389,7 @@ time. Options: -=over 8 +=over 4 =item B<--backupdir> I @@ -1419,7 +1419,7 @@ directory with backups. Options: -=over 8 +=over 4 =item B<--dry-run> @@ -1446,7 +1446,7 @@ collection or scheme is disallowed, unless C<--force> is specified. Options: -=over 8 +=over 4 =item B<--no-depends> @@ -1486,9 +1486,10 @@ Perhaps the most common use for this is if you originally installed from DVD, and want to permanently change the installation to get further updates from the Internet. To do this, you can run - tlmgr option location http://mirror.ctan.org/systems/texlive/tlnet/YYYY + tlmgr option loc http://mirror.ctan.org/systems/texlive/tlnet/YYYY -(where YYYY is the TeX Live release year). +where YYYY is the TeX Live release year. (This example also shows that +you can abbreviate options and arguments; abbreviations must be unambiguous.) =item B @@ -1503,14 +1504,15 @@ outputs all known papersizes for the specified program. =item B -Prints the names of the systems available at the default install location. +Prints the names of the architectures (C, ...) available at +the default install location. =item B...> -Add executables for the specified Ies to the installation. +Add executables for each given architecture I to the installation. Options: -=over 8 +=over 4 =item B<--dry-run> @@ -1526,7 +1528,7 @@ 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> @@ -1557,7 +1559,7 @@ With an argument lists only collections or schemes, as requested. Uninstalls the entire TeX Live installation. Options: -=over 8 +=over 4 =item B<--force> @@ -1607,7 +1609,7 @@ the given file. Options: -=over 8 +=over 4 =item B<--dest> I diff --git a/Master/tlpkg/TeXLive/TLConfig.pm b/Master/tlpkg/TeXLive/TLConfig.pm index 887a9537034..c3329fac362 100644 --- a/Master/tlpkg/TeXLive/TLConfig.pm +++ b/Master/tlpkg/TeXLive/TLConfig.pm @@ -78,7 +78,7 @@ C -- TeX Live Configurations The L module contains definitions of variables configuring all of TeX Live. -=over 6 +=over 4 =head1 EXPORTED VARIABLES diff --git a/Master/tlpkg/TeXLive/TLPDB.pm b/Master/tlpkg/TeXLive/TLPDB.pm index 4f1aebaf247..32c29e10713 100644 --- a/Master/tlpkg/TeXLive/TLPDB.pm +++ b/Master/tlpkg/TeXLive/TLPDB.pm @@ -64,7 +64,7 @@ my $_listdir; =pod -=over 6 +=over 4 =item C<< TeXLive::TLPDB->new >> @@ -1096,7 +1096,7 @@ in a package C<00texlive.config> as values of C lines. This special package C<00texlive.config> does not contain any files, only depend lines which set one or more of the following options: -=over 6 +=over 4 =item C diff --git a/Master/tlpkg/TeXLive/TLPOBJ.pm b/Master/tlpkg/TeXLive/TLPOBJ.pm index 176c9f29068..beb12649cea 100644 --- a/Master/tlpkg/TeXLive/TLPOBJ.pm +++ b/Master/tlpkg/TeXLive/TLPOBJ.pm @@ -1097,7 +1097,7 @@ All these keys have in common that they are followed by a list of files I by one space. They differ only in the first line itself (described below). -=over +=over 4 =item C, C, C, C each of these items contains addition the sum of sizes of the @@ -1221,7 +1221,7 @@ if src/doc file container splitting is activated for that install medium. The following functions can be called for an C object: -=over +=over 4 =item C diff --git a/Master/tlpkg/TeXLive/TLPSRC.pm b/Master/tlpkg/TeXLive/TLPSRC.pm index 76f72be8c3e..640db804533 100644 --- a/Master/tlpkg/TeXLive/TLPSRC.pm +++ b/Master/tlpkg/TeXLive/TLPSRC.pm @@ -531,7 +531,7 @@ C, or C. The interpretation of the respective I are: -=over 6 +=over 4 =item C @@ -540,7 +540,7 @@ i.e., with what Perl considers a C<\w>. There are 3 exceptions to this rule: -=over 12 +=over 8 =item B @@ -605,7 +605,7 @@ All the depend lines contribute to the dependencies of the package. gives a free form entry of install time jobs to be executed. Currently the following possible values are understood by the installers: -=over 6 +=over 4 =item C IC<.map> @@ -652,7 +652,7 @@ where Simple patterns without PREFIX and ARCHSPEC specification are explained first, see below for these extensions. -=over +=over 4 =item CI @@ -691,7 +691,7 @@ includes all files matching the regexp C =head2 Special patterns -=over 6 +=over 4 =item PREFIX @@ -719,7 +719,7 @@ the prefix C<+> (e.g., C<+f ...>), then the following patterns, listed by type are I added at expansion time (but never written to the textual representation): -=over 6 +=over 4 =item C @@ -764,7 +764,7 @@ The binpatterns have to deal with all the different architectures. To ease the writing of patterns several extensions to the above pattern language are allowed: -=over 6 +=over 4 =item arch expansion @@ -837,7 +837,7 @@ C object, if set (normally by C). The following functions can be called for an C object: -=over +=over 4 =item C diff --git a/Master/tlpkg/TeXLive/TLUtils.pm b/Master/tlpkg/TeXLive/TLUtils.pm index d06457c44dc..46f50c41b8d 100644 --- a/Master/tlpkg/TeXLive/TLUtils.pm +++ b/Master/tlpkg/TeXLive/TLUtils.pm @@ -132,7 +132,7 @@ $::opt_verbosity = 0; =head2 Platform Detection -=over 6 +=over 4 =item C @@ -278,7 +278,7 @@ sub unix { =head2 System Tools -=over 6 +=over 4 =item C @@ -375,7 +375,7 @@ sub get_system_tmpdir { =head2 File Utulities -=over 6 +=over 4 =item C @@ -1152,7 +1152,7 @@ sub _download_file { =head2 Installer Functions -=over 6 +=over 4 =item C @@ -1289,7 +1289,7 @@ sub _create_config_files { Ideas from Fabrice Popineau's C. -=over 6 +=over 4 =item C @@ -1507,7 +1507,7 @@ L script. These are the options handled here: -=over 8 +=over 4 =item B<-q> diff --git a/Master/tlpkg/TeXLive/TLWinGoo.pm b/Master/tlpkg/TeXLive/TLWinGoo.pm index 53c6da426ca..76d7acfb184 100644 --- a/Master/tlpkg/TeXLive/TLWinGoo.pm +++ b/Master/tlpkg/TeXLive/TLWinGoo.pm @@ -70,7 +70,7 @@ All exported functions return forward slashes. =head2 DESCRIPTION -=over 6 +=over 4 =cut @@ -139,7 +139,7 @@ my $is_win = $^O=~/^MSWin(32|64)$/i; =head2 DIAGNOSTICS -=over 6 +=over 4 =item C @@ -259,7 +259,7 @@ sub reg_country { =head2 ENVIRONMENT AND REGISTRY -=over 6 +=over 4 Most settings can be made for a user and for the system. User settings override system settings. @@ -741,7 +741,7 @@ sub unregister_file_type { =head2 ACTIVATING CHANGES IMMEDIATELY -=over 6 +=over 4 =item C diff --git a/Master/tlpkg/bin/check-file-coverage b/Master/tlpkg/bin/check-file-coverage index 4aa8b07b5d6..89cf8ebb617 100755 --- a/Master/tlpkg/bin/check-file-coverage +++ b/Master/tlpkg/bin/check-file-coverage @@ -140,7 +140,7 @@ check-file-coverage [OPTION]... =head1 OPTIONS -=over 8 +=over 4 =item B<-master> I The location given by B<-master> must point to a valid svn repository diff --git a/Master/tlpkg/bin/tl-update-containers b/Master/tlpkg/bin/tl-update-containers index 6d84d9005e3..f99f7b5b2d3 100755 --- a/Master/tlpkg/bin/tl-update-containers +++ b/Master/tlpkg/bin/tl-update-containers @@ -160,10 +160,10 @@ sub main # .arch packages are skipped, too if ($pkg =~ m/^$manualpkgre/) { if ($opt_all || $opt_recreate) { - tlwarn ("updating container for $pkg due to -all option!\n"); + tlwarn ("$0: updating critical $pkg due to -all\n"); last; # of the manualpkgre checks } else { - tlwarn ("not updating $pkg since it it in the manual update list!\n"); + tlwarn ("$0: skipping critical $pkg"); # we assume that the packages in @critical_pkg_list always # exist, so if they are there then the number of updated packages # should be reduced. @@ -270,7 +270,7 @@ tl-update-containers [I