diff options
author | Karl Berry <karl@freefriends.org> | 2008-05-06 19:00:30 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2008-05-06 19:00:30 +0000 |
commit | 918d1c47f0e8024fce013fd627b5e327c24e5390 (patch) | |
tree | da14c131d73ee32eaeccfbd52275562c9be4f13d /Master | |
parent | 3b325db87a41e8e7e09517c3ab0c742260f1112e (diff) |
more pod updates, pod2usage(2).
git-svn-id: svn://tug.org/texlive/trunk@7898 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rwxr-xr-x | Master/texmf/scripts/texlive/tlmgr.pl | 126 |
1 files changed, 65 insertions, 61 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl index b33a8dfb32c..2cbd2aa0d41 100755 --- a/Master/texmf/scripts/texlive/tlmgr.pl +++ b/Master/texmf/scripts/texlive/tlmgr.pl @@ -71,7 +71,7 @@ GetOptions("location=s" => \$opt_location, "netarchive=s" => \$opt_netarchive, "diskarchive=s" => \$opt_diskarchive, "gui" => \$opt_gui, - "debug!", "h|help|?" => \$opt_help) or pod2usage(1); + "debug!", "h|help|?" => \$opt_help) or pod2usage(2); my $action; if ($opt_gui) { @@ -315,7 +315,7 @@ sub action_remove { Getopt::Long::Configure(qw(no_pass_through)); GetOptions("no-depends" => \$opt_nodepends, "force" => \$opt_force, - "dry-run" => \$opt_dry) or pod2usage(1); + "dry-run" => \$opt_dry) or pod2usage(2); my %already_removed; my @more_removal; init_local_db(); @@ -423,7 +423,7 @@ sub action_search { my $opt_file = 0; Getopt::Long::Configure(qw(no_pass_through)); GetOptions("global" => \$opt_global, - "file" => \$opt_file) or pod2usage(1); + "file" => \$opt_file) or pod2usage(2); my $r = shift @ARGV; my $ret = ""; my $tlpdb; @@ -465,7 +465,7 @@ sub action_update { my $opt_dry = 0; Getopt::Long::Configure(qw(no_pass_through)); GetOptions("no-depends" => \$opt_nodepends, - "dry-run" => \$opt_dry) or pod2usage(1); + "dry-run" => \$opt_dry) or pod2usage(2); my %ret; $tlmediasrc = TeXLive::TLMedia->new($location); my $mediatlpdb = $tlmediasrc->tlpdb; @@ -504,7 +504,7 @@ sub action_install { my $opt_dry = 0; Getopt::Long::Configure(qw(no_pass_through)); GetOptions("no-depends" => \$opt_nodepends, - "dry-run" => \$opt_dry) or pod2usage(1); + "dry-run" => \$opt_dry) or pod2usage(2); my %ret; $tlmediasrc = TeXLive::TLMedia->new($location); foreach my $pkg (@ARGV) { @@ -607,7 +607,7 @@ sub action_arch { my %ret; my $opt_dry = 0; Getopt::Long::Configure(qw(no_pass_through)); - GetOptions("dry-run" => \$opt_dry) or pod2usage(1); + GetOptions("dry-run" => \$opt_dry) or pod2usage(2); init_local_db(); if ($what =~ m/^list$/i) { # list the available architectures @@ -676,7 +676,7 @@ sub action_generate { my $localconf = ""; my $dest = ""; Getopt::Long::Configure(qw(no_pass_through)); - GetOptions("localcfg=s" => \$localconf, "dest=s" > \$dest,) or pod2usage(1); + GetOptions("localcfg=s" => \$localconf, "dest=s" > \$dest,) or pod2usage(2); init_local_db(); if ($what =~ m/^language$/i) { $dest || ($dest = kpsewhich ("TEXMFSYSVAR") . "/tex/generic/config/language.dat"); @@ -718,11 +718,11 @@ sub init_local_db { sub action_uninstall { if (win32()) { printf STDERR "Please use \"Add/Remove Programs\" from the Control Panel to removing TeX Live!\n"; - exit(1); + exit 1; } my $force = 0; Getopt::Long::Configure(qw(no_pass_through)); - GetOptions("force" => \$force) or pod2usage(1); + GetOptions("force" => \$force) or pod2usage(2); if (!$force) { print("If you answer yes here the whole TeX Live installation will be removed!\n"); print "Remove TeX Live (y/N): "; @@ -921,7 +921,7 @@ tlmgr - the TeX Live Manager =head1 SYNOPSIS -tlmgr ACTION [OPTION]... [OPERAND]... +tlmgr I<option> I<action> [I<option>]... [I<operand>]... =head1 ACTION @@ -931,17 +931,21 @@ tlmgr ACTION [OPTION]... [OPERAND]... Gives this help page. -=item B<install [OPTION]... PKG...]> +=item B<gui> -Install all packages given on the command line. By default this installs -all packages that the given PKGs are dependent on, too. Options: +Run using a graphical interface. -=over 16 +=item B<install [I<option>]... I<pkg>...> + +Install all I<pkg>s given on the command line. By default this installs +all packages that the given I<pkg>s are dependent on, also. Options: + +=over 8 =item B<--no-depends> -Do not install dependencies. If this option is not given installing -a package will ensure that all dependencies of this package are fulfilled. +Do not install dependencies. Bydefault, installing a package ensures +that all dependencies of this package are fulfilled. =item B<--dry-run> @@ -951,11 +955,11 @@ written to the terminal. =back -=item B<update [OPTION]...> +=item B<update [I<option>]...> Update all packages to the latest available. Options: -=over 16 +=over 8 =item B<--dry-run> @@ -965,17 +969,19 @@ written to the terminal. =back -=item B<remove [OPTION]... PKG... ]> +=item B<remove [I<option>]... I<pkg>...> -Remove all packages given on the command line. Removing a collection -will remove all dependencies, too, unless C<--no-depends> is specified. +Remove all I<pkg>s given on the command line. Removing a collection +will remove 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. Removing a package which is referenced as a dependency in another -collection or scheme fails unless the C<--force> option is specified. +collection or scheme is disallowed, unless C<--force> is specified. Options: -=over 16 +=over 8 =item B<--no-depends> @@ -983,10 +989,10 @@ Do not remove dependent packages. =item B<--force> -When removing a package or collection would invalidate a dependency of -another collection/scheme, the package will not be removed and a warning -issued. With this option, the package will be removed unconditionally. -Use with care. +By default, when removing a package or collection would invalidate a +dependency of another collection/scheme, the package will not be removed +and a warning issued. With this option, the package will be removed +unconditionally. Use with care. =item B<--dry-run> @@ -1018,19 +1024,19 @@ C<srcfiles> (install source files). =item B<[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]> Configures the system wide paper settings, either for all programs in -one go, or for the given program on the command line. +one go, or just for the specified program. =item B<arch list> -Prints the list of systems available at the default install location. +Prints the names of the systems available at the default install location. -=item B<arch add I<ARCH>...> +=item B<arch add I<arch>...> Add executables for the specified I<arch>es to the installation. Options: -=over 16 +=over 8 =item B<--dry-run> @@ -1040,47 +1046,44 @@ written to the terminal. =back -=item B<search [OPTIONS] what> +=item B<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). +By default searches the names, short and long descriptions of all +locally installed packages for the given argument (interpreted as +regexp). Options: +=over 8 -Options: - -=over 16 - -=item B<--filename> +=item B<--file> -Searches filenames containing B<what> and returns for each package all files -containing B<what>. +List all filenames containing I<what>. =item B<--global> -Search the TeX Live Database of the installation medium and not the local -installation. +Search the TeX Live Database of the installation medium, instead of the +local installation. =back =item B<show I<pkg>...> -Shows for I<pkg> the name, category, installation status, short and long -description. Does search in the remote installation source for finding -the package if it is not installed. +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. =item B<list [collections|schemes]> -Without argument lists all packages available at the default install -location, prefixing those already installed with "i ". +With no argument, lists all packages available at the default install +location, prefixing those already installed with C<i >. -With arguments lists only collections or schemes. +With an argument lists only collections or schemes, as requested. =item B<uninstall> -Uninstalls the TeX Live installation. Options: +Uninstalls the entire TeX Live installation. Options: -=over 16 +=over 8 =item B<--force> @@ -1098,20 +1101,21 @@ Do not ask for confirmation, remove immediately. B<WARNING:> This action overwrites any user changes made in the respective files, by regenerating them from scratch. -In particular, this is especially question with updmap, because the -result will be to remove all maps which have been manually enabled (via -updmap-sys --enable). +This is especially questionable with updmap, because the result will be +to disable all maps which have been manually installed (via C<updmap-sys +--enable>), e.g., for proprietary or local fonts. Be sure that's what +you want to do. -This action regenerates any of the three config files language.dat, -fmtutil.cnf, and updmap.cfg from the information present in the local -TLPDB. If the files language-local.dat, fmtutil-local.cnf, or -updmap-local.cfg are present under TEMXFLOCAL in the respective -directories, their contents will be simply merged into the final -files, with no error checking of any kind. +This action regenerates any of the three config files C<language.dat>, +C<fmtutil.cnf>, and C<updmap.cfg> from the information present in the +local TLPDB. If the files C<language-local.dat>, C<fmtutil-local.cnf>, +or C<updmap-local.cfg> are present under C<TEXMFLOCAL> in the respective +directories, their contents will be simply merged into the final files, +with no error checking of any kind. Options: -=over 16 +=over 8 =item C<--dest> I<output file> |