summaryrefslogtreecommitdiff
path: root/Master/texmf/scripts
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2008-09-23 16:21:07 +0000
committerKarl Berry <karl@freefriends.org>2008-09-23 16:21:07 +0000
commit37642080ba8cc32489b8493aeb81da7686a5267b (patch)
tree4d0bdfc0d771a99c2bce36260d365b4d869c3bbd /Master/texmf/scripts
parentaa809c48a763b777a666d1266d9ebbd208e593e9 (diff)
doc updates
git-svn-id: svn://tug.org/texlive/trunk@10702 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/scripts')
-rwxr-xr-xMaster/texmf/scripts/texlive/tlmgr.pl141
1 files changed, 69 insertions, 72 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index 402b2b0cd58..e4e39dde8e6 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -666,7 +666,7 @@ sub action_update {
}
}
if (!@todo) {
- printf "tlmgr update: please specify list of packages or --all\n";
+ tlwarn ("tlmgr update: please specify a list of packages or --all.\n");
}
my $updater_started = 0;
my $nrupdated = 0;
@@ -1501,10 +1501,10 @@ tlmgr [I<option>]... I<action> [I<option>]... [I<operand>]...
B<tlmgr> manages an existing TeX Live installation, both packages and
configuration options. It performs many of the same actions as
-B<texconfig>(1), and more besides. (texconfig continues to be included
-and supported, but tlmgr is now preferred.)
+B<texconfig>(1), and more besides. (C<texconfig> continues to be
+included and supported, but C<tlmgr> is now preferred.)
-The most up-to-date version of this documentation is on the Internet at
+The most up-to-date version of this documentation is available at
L<http://tug.org/texlive/tlmgr.html>.
=head1 OPTIONS
@@ -1530,20 +1530,20 @@ starts you directly at the update screen.
=item B<--gui-lang> I<llcode>
-Normally the GUI tries to deduce your language from the environment
-(on Windows via the registry, on Unix via LC_MESSAGES). If that fails
-you can select a different language by giving this option a two-letter
+Normally the GUI tries to deduce your language from the environment (on
+Windows via the registry, on Unix via C<LC_MESSAGES>). If that fails you
+can select a different language by giving this option a two-letter
language code.
=back
-The standard options are also accepted: B<--help/-h/-?>, B<--version>,
-B<-q> (no informational messages), B<-v> (debugging messages, can be
-repeated). For the details about the latter, see the
-TeXLive::TLUtils documentation.
+The standard options are also accepted: C<--help/-h/-?>, C<--version>,
+C<-q> (no informational messages), C<-v> (debugging messages, can be
+repeated). For the details about the latter, see the TeXLive::TLUtils
+documentation.
-The B<--version> option shows version information about the TeX Live
-release as well as the B<tlmgr> script itself.
+The C<--version> option shows version information about the TeX Live
+release as well as the C<tlmgr> script itself.
=head1 ACTIONS
@@ -1551,11 +1551,11 @@ release as well as the B<tlmgr> script itself.
=item B<help>
-Gives this help information (same as B<--help>).
+Gives this help information (same as C<--help>).
=item B<version>
-Gives version information (same as B<--version>).
+Gives version information (same as C<--version>).
=item B<gui>
@@ -1563,15 +1563,15 @@ Start the graphical user interface.
=item B<install> [I<option>]... I<pkg>...
-Install all I<pkg>s given on the command line. By default this installs
+Install each I<pkg> 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. By default, installing a package ensures
-that all dependencies of this package are fulfilled.
+Do not install dependencies. (By default, installing a package ensures
+that all dependencies of this package are fulfilled.)
=item B<--dry-run>
@@ -1584,17 +1584,18 @@ written to the terminal.
=item B<update> [I<option>] [I<pkg>...]
Updates the packages given as arguments to the latest version available
-at the installation source. Options:
+at the installation source. Options:
-=over 4
+=over 8
-=item B<--list>
+=item B<--all>
-List the packages which would be updated or newly installed.
+Update already-installed packages, and install new packages in installed
+collections. (Packages in uninstalled collections are not considered.)
-=item B<--all>
+=item B<--list>
-Update all packages.
+List the packages which would be updated or newly installed.
=item B<--dry-run>
@@ -1603,41 +1604,40 @@ written to the terminal. (A more verbose report than C<--list>.)
=item B<--backupdir> I<directory>
-If this option is given it must specify an existing directory where a
-snapshot of the current package as installed will be saved before
-the packages is updated. This way one can go back in case an update
-turned out as not working. See the action B<restore> for details.
+I<directory> specifies a directory where the package as installed will
+be saved before updates are performed. Then you can restore later if
+the update turns out to be problematic; see the C<restore> action for
+details.
=back
-=item B<backup> --backupdir I<dir> [B<--all>] [I<pkg>...]
-Makes a backup of the given packages (or all packages with B<--all>) to
-the directory specified with B<--backupdir> (must exist and be a writable).
+=item B<backup> --backupdir I<dir> [B<--all>] [I<pkg>...]
-Warning: Making a backup of I<all> packages will need quite some space and
-time.
+Makes a backup of the given packages, or all packages with C<--all>, to
+I<dir>, which must exist and be writable. Options:
-Options:
-
-=over 4
+=over 8
=item B<--backupdir> I<directory>
-The I<directory> is an obligatory argument and has to specify a
-directory where backups are to be found.
+The I<directory> argument is required and must specify an existing
+directory where backups are to be placed.
=item B<--all>
-Make a backup of all packages in the TeX Live installation.
+Make a backup of all packages in the TeX Live installation. This will
+take quite a lot of space and time.
=back
=item B<restore --backupdir> I<dir> [I<pkg> [I<rev>]]
-If no I<pkg> and I<rev> is given, list the available
-backup revisions for all packages.
+Restore a package from a previously-made backup.
+
+If neither I<pkg> nor I<rev> are given, list the available backup
+revisions for all packages.
With I<pkg> given but no I<rev>, list all available backup revisions of
I<pkg>.
@@ -1645,19 +1645,16 @@ I<pkg>.
With both I<pkg> and I<rev>, tries to restore the package from the
specified backup.
-The option B<--backupdir> I<dir> is obligatory and has to specify a
-directory with backups.
-
Options:
-=over 4
+=over 8
=item B<--dry-run>
Nothing is actually restored; instead, the actions to be performed are
written to the terminal.
-=item B<--backupdir directory>
+=item B<--backupdir> I<directory>
This is an obligatory argument and has to specify a directory where
backups are to be found.
@@ -1665,19 +1662,14 @@ backups are to be found.
=back
-=item B<remove [I<option>]... I<pkg>...>
+=item B<remove> [I<option>]... I<pkg>...
-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.
+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:
-Removing a package which is referenced as a dependency in another
-collection or scheme is disallowed, unless C<--force> is specified.
-
-Options:
-
-=over 4
+=over 8
=item B<--no-depends>
@@ -1685,14 +1677,13 @@ Do not remove dependent packages.
=item B<--force>
-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.
+By default, removal of a package or collection that is a dependency of
+another collection or scheme is not allowed. With this option, the
+package will be removed unconditionally. Use with care.
=item B<--dry-run>
-Nothing is actually installed; instead, the actions to be performed are
+Nothing is actually removed; instead, the actions to be performed are
written to the terminal.
=back
@@ -1702,9 +1693,10 @@ written to the terminal.
=item B<option I<key> [I<value>]>
-The first form shows the settings currently saved in the TLPDB.
+The first form shows the global TeX Live settings currently saved in the
+TLPDB.
-In the second form, if I<value> is missing the setting for I<key> is
+In the second form, if I<value> is not given, the setting for I<key> is
displayed. If I<value> is present, I<key> is set to I<value>.
Possible values for I<key> are:
@@ -1721,6 +1713,7 @@ updates from the Internet. To do this, you can run
where YYYY is the TeX Live release year.
+
=item B<paper a4>
=item B<paper letter>
@@ -1742,7 +1735,7 @@ the default install location.
Add executables for each given architecture I<arch> to the installation.
Options:
-=over 4
+=over 8
=item B<--dry-run>
@@ -1758,7 +1751,7 @@ By default searches the names, short and long descriptions of all
locally installed packages for the given argument (interpreted as
regexp). Options:
-=over 4
+=over 8
=item B<--file>
@@ -1771,6 +1764,7 @@ local installation.
=back
+
=item B<show I<pkg>...>
Shows information about I<pkg>: the name, category, installation status,
@@ -1785,11 +1779,12 @@ location, prefixing those already installed with C<i >.
With an argument lists only collections or schemes, as requested.
+
=item B<check [I<option>...] [files|collections|all]>
Executes one (or all) check(s) on the consistency of the installation.
-=over 4
+=over 8
=item B<files>
@@ -1809,19 +1804,21 @@ but are themselves not installed.
Available options are:
-=over 4
+=over 8
-=item B<-use-svn>
+=item B<--use-svn>
-Use svn status instead of listing the files.
+Use svn status instead of listing the files, for checking the
+development repository.
=back
+
=item B<uninstall>
Uninstalls the entire TeX Live installation. Options:
-=over 4
+=over 8
=item B<--force>
@@ -1871,7 +1868,7 @@ the given file.
Options:
-=over 4
+=over 8
=item B<--dest> I<output file>