summaryrefslogtreecommitdiff
path: root/Master
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-09-11 18:17:28 +0000
committerKarl Berry <karl@freefriends.org>2009-09-11 18:17:28 +0000
commit9715c39d6a186e45445e0f5e500956861ece746c (patch)
tree497eb5611299736ecd76aca6cb0056be7bd6deb9 /Master
parentc74d5b3b40861395779da7583f4d67bfbc160088 (diff)
doc example section
git-svn-id: svn://tug.org/texlive/trunk@15224 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
-rwxr-xr-xMaster/texmf/scripts/texlive/tlmgr.pl55
1 files changed, 43 insertions, 12 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index 346e04ddecb..9b2672b1682 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -4106,17 +4106,47 @@ configuration options.
The most up-to-date version of this documentation is available at
L<http://tug.org/texlive/tlmgr.html>, along with procedures for updating
-C<tlmgr> itself, disaster recovery when it's broken, and test versions.
+C<tlmgr> itself and information about test versions.
+
+=head1 EXAMPLES
+
+After successfully installing TeX Live, here are a few common operations
+with C<tlmgr>:
+
+=over 4
+
+=item C<tlmgr update --all>
+
+Make your local TeX installation correspond to what is the package
+repository (typically on CTAN).
+
+=item C<tlmgr update --list>
+
+Report what would be updated without actually updating anything.
+
+=item C<tlmgr option repository http://mirror.ctan.org/systems/texlive/tlnet>
+
+Tell C<tlmgr> to use a nearby CTAN mirror for future updates; useful if
+you installed TeX Live from the DVD image.
+
+=item C<tlmgr show> I<pkgname>
+
+Display detailed information about I<pkgname>, such as the installation
+status and description.
+
+=back
+
+For all the capabilities and details of C<tlmgr>, please see the
+following voluminous information.
=head1 OPTIONS
-The following options to C<tlmgr> are global options not specific to
-any action. Although we present C<tlmgr> invocation in the above order,
-all options can be given at any place and in arbitrary order. The first
-non-option argument will be the main action.
-In all cases, C<-->I<option> and
-C<->I<option> are equivalent, and an C<=> is optional between an option
-name and its value.
+The following options to C<tlmgr> are global options not specific to any
+action. Although we present C<tlmgr> invocation in the above order, all
+options can be given at any place and in arbitrary order. The first
+non-option argument will be the main action. In all cases,
+C<-->I<option> and C<->I<option> are equivalent, and an C<=> is optional
+between an option name and its value.
=over 4
@@ -4163,13 +4193,14 @@ that, see the option C<-v> below, and TeXLive::TLUtils.
=item B<--pause>
-This option make B<tlmgr> wait for user input before exiting. Useful on
+This option makes B<tlmgr> wait for user input before exiting. Useful on
Windows to avoid command windows disappearing.
=item B<--debug-translation>
-This switch will make C<tlmgr> report any missing or probably
-untranslated messages in GUI mode to standard error.
+This switch makes C<tlmgr> report, in GUI mode, any missing, or more
+likely untranslated, messages to standard error. Helpful for
+translators to see what remains to be done.
=back
@@ -4692,7 +4723,7 @@ local installation.
=head2 show [--list] I<pkg>...
-Shows information about I<pkg>: the name, category, installation status,
+Display 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.