summaryrefslogtreecommitdiff
path: root/Master/texmf
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-10-26 15:50:38 +0000
committerKarl Berry <karl@freefriends.org>2010-10-26 15:50:38 +0000
commit46cc0f2198d079f628f1112ee5edbacdee5d2ba3 (patch)
tree328f497e7257218489fd3181b26684a310f2bb2f /Master/texmf
parent2e705ed787d0fb2a82992cf9de4234316e8e538f (diff)
doc tweaks
git-svn-id: svn://tug.org/texlive/trunk@20214 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf')
-rwxr-xr-xMaster/texmf/scripts/texlive/tlmgr.pl134
1 files changed, 65 insertions, 69 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index 973c0a608b6..953fa2af3b2 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -5548,9 +5548,9 @@ C<--print-arch> is a synonym.
=head2 search [I<options>] --characterization 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, search the names, short descriptions, and long descriptions
+of all locally installed packages for the argument I<what>,
+interpreted as a regular expression.
Options:
@@ -5569,15 +5569,14 @@ the the word C<tables> unless they also contain the word C<table>.
=item B<--list>
-If a search for any (or all) taxonomies is done by given either
-B<--taxonomy>, B<--keyword>, B<--functionality>, or B<--characterization>,
-then instead of actually searching for packages, simply lists the
-keywords, functionalities, characterizations, or all of them.
+If a search for any (or all) taxonomies is done, by specifying
+B<--taxonomy>, B<--keyword>, B<--functionality>, or
+B<--characterization>, then instead of searching for packages, list the
+entire corresponding taxonomy. See L</"TAXONOMIES"> below.
=back
-Other search options are selected by adding either B<--file>, B<--taxonomy>,
-B<--keyword>, B<--functionality>, or B<--characterization>.
+Other search options are selected by specifying one of the following:
=over 4
@@ -5593,16 +5592,12 @@ List all filenames containing I<what>.
=item B<--characterization>
-Searches in the list of keywords, and its characterization and functional
-specifications instead of the package descriptions.
-See L</"TAXONOMIES"> below for details.
-
-=item B<--extended>
-
-Not implemented yet.
+Search in the given taxonomy instead of the package descriptions. See
+L</"TAXONOMIES"> below.
=back
+
=head2 show [I<options>] I<pkg>...
Display information about I<pkg>: the name, category, installation status,
@@ -5636,7 +5631,6 @@ In addition to the normal data displayed, also display the various
taxonomies.
See L</"TAXONOMIES"> below for details.
-
=back
@@ -5894,28 +5888,28 @@ The respective locations are as follows:
Final repetition: as explained above, C<tlmgr> does I<not> use
C<generate updmap> for map files. Therefore, if you want to make use of
-C<updmap-local.cfg>, you need to run C<tlmgr generate updmap> yourself.
-After that, network updates and your local changes should be merged.
+C<updmap-local.cfg>, you need to run C<tlmgr generate updmap> yourself
+after making any local changes.
=head1 CONFIGURATION FILE
-A small subset of the command line options can be set in a config
-file for C<tlmgr> which resides in C<TEXMFVAR/tlmgr/config>. Note
-that it is B<not> C<TEXMFSYSVAR> so the file is specific to a single
-user. By default thus the config file is in C<~/.texlive2010/tlmgr/config>.
+A small subset of the command line options can be set in a config file
+for C<tlmgr> which resides in C<TEXMFVAR/tlmgr/config>. By default, the
+config file is in C<~/.texlive2010/tlmgr/config>. This is I<not>
+C<TEXMFSYSVAR>, so that the file is specific to a single user.
-Format of this file is: empty lines and lines starting with # are ignored.
-All other lines must look like
+In this file, empty lines and lines starting with # are ignored. All
+other lines must look like
key = value
-where the allowed keys are C<gui_expertmode> and C<persistent-downloads>.
-The values can only be 0 or 1 for those settings.
-C<persistent-downloads> corresponds to the respective
-command line options of C<tlmgr>. C<gui_expertmode> switches between
-the full GUI and a simplified with only the important and mostly used
-settings.
+where the allowed keys are C<gui_expertmode> and
+C<persistent-downloads>. The values can only be 0 or 1 for those
+settings. C<persistent-downloads> corresponds to the respective command
+line options of C<tlmgr>. C<gui_expertmode> switches between the full
+GUI and a simplified with only the important and mostly used settings.
+
=head1 TAXONOMIES
@@ -5924,22 +5918,23 @@ by newer version of the TeX Catalogue.
MORE INFORMATION NEEDED.
-=head1 GUI
+
+=head1 GUI FOR TLMGR
The graphical user interface for C<tlmgr> needs Perl/TK being installed.
-For Windows the necessary modules are shipped within TeX Live, for
-all other (i.e., Unix-based) systems Perl/Tk (as well as perl of course)
-has to be installed.
+For Windows the necessary modules are shipped within TeX Live, for all
+other (i.e., Unix-based) systems Perl/Tk (as well as perl of course) has
+to be installed.
-When started with C<tlmgr gui> the graphical user interface will be shown.
-The main window contains a menu bar, the main display, and a status area
-where messages normally shown on the console are displayed.
+When started with C<tlmgr gui> the graphical user interface will be
+shown. The main window contains a menu bar, the main display, and a
+status area where messages normally shown on the console are displayed.
-Within the main display there are three main parts: The
-I<Display configuration>, the list of packages, and the buttons for actions.
-In addition to these three on the top right there is some text showing
-the currently loaded repository (this text also acts as button and will
-load the default repository).
+Within the main display there are three main parts: The I<Display
+configuration>, the list of packages, and the buttons for actions. In
+addition to these three on the top right there is some text showing the
+currently loaded repository (this text also acts as button and will load
+the default repository).
=head2 Menu bar
@@ -5950,21 +5945,20 @@ The following entries can be found in the menu bar:
=item B<tlmgr>
Provides access to load various repositories (the default as specified
-in the texlive database, the default network repository, if given
-the repository specified on the command line, and an arbitrary other one.
+in the texlive database, the default network repository, if given the
+repository specified on the command line, and an arbitrary other one.
Furthermore is allows to quit C<tlmgr>.
=item B<Options>
Provides access to three groups of options, I<General> (for almost all
-options), I<Paper> (configuration of default paper sizes),
-I<Platforms> (only on Unix, configuration of the supported/installed
-platforms), as well as some toggles to turn on and off various
-options.
+options), I<Paper> (configuration of default paper sizes), I<Platforms>
+(only on Unix, configuration of the supported/installed platforms), as
+well as some toggles to turn on and off various options.
There is also a toggle for C<Expert options> which defaults to on. If
you turn this off the next time you start the GUI a simplified screen
-will be shown that exhibits only the most important and necessary
+will be shown that exhibits only the most important and necessary
functionality. This setting is saved in the configuration file of
C<tlmgr>, see L<CONFIGURATION FILE> for details.
@@ -5973,7 +5967,7 @@ C<tlmgr>, see L<CONFIGURATION FILE> for details.
Provides access to a variety of items, such as updating the filename
database (aka ls-R, mktexlsr, texhash), rebuilding of all formats
(C<fmtutil-sys --all>), updating the font map database (C<updmap-sys>),
-and handling of symbolic links in system directories (only Unix),
+and handling of symbolic links in system directories (only Unix),
restoring backups of packages, as well as removal of the full TeX Live
installation (only Unix).
@@ -6010,9 +6004,9 @@ package, it will be shown in parenthesis.
=item remote revision (and version)
-If a repository has been loaded the revision of the package in the repository
-(if present) is shown. As with the local variant, if a catalogue version
-is provided it will be displayed.
+If a repository has been loaded the revision of the package in the
+repository (if present) is shown. As with the local variant, if a
+catalogue version is provided it will be displayed.
=item short description
@@ -6020,12 +6014,12 @@ The short description (or title) is shown.
=back
-Double clicking on one of the lines pops up an informational window
-with further details, the long description, included files, etc.
+Double clicking on one of the lines pops up an informational window with
+further details, the long description, included files, etc.
-Above the list of package there are options to configure the list
-of packages to be shown. Changing any of them will automatically
-update the list of packages. The different display configurations are:
+Above the list of package there are options to configure the list of
+packages to be shown. Changing any of them will automatically update the
+list of packages. The different display configurations are:
=over 4
@@ -6040,20 +6034,20 @@ allows to select which categories are shown.
=item Match
-allows searching for a specific pattern. This uses the same algorithm
-as C<tlmgr search>, i.e., searches in the title, short and long
+allows searching for a specific pattern. This uses the same algorithm as
+C<tlmgr search>, i.e., searches in the title, short and long
descriptions.
=item Selection
-this allows to restrict the list of packages to those selected, not selected,
+allows restricting the list of packages to those selected, not selected,
or all (selected means that the checkbox in the beginning of the line of
a package is selected).
=item buttons
-to the right there are three buttons, one to select all packages, one
-to select none (deselect all), and one to reset all filters to the
+To the right there are three buttons, one to select all packages, one to
+select none (deselect all), and one to reset all filters to the
defaults, i.e., show all available.
=back
@@ -6064,14 +6058,14 @@ Below the list of packages there are five buttons:
=item Update all installed
-this calls C<tlmgr update --all> internally, i.e., tries to update all
+This calls C<tlmgr update --all> internally, i.e., tries to update all
available packages.
Below this button there is a toggle that allows reinstallation of
previously removed packages.
-The following four buttons only work on the I<selected> packages, i.e., those
-where the checkbutton at the beginning of the line is ticked.
+The following four buttons only work on the I<selected> packages, i.e.,
+those where the checkbutton at the beginning of the line is ticked.
=item Update
@@ -6097,7 +6091,8 @@ action needs the option C<backupdir> set (see Options -> General).
=back
Finally, the status area at the bottom of the window gives additional
-information what is going on.
+information about what is going on.
+
=head1 MACHINE-READABLE OUTPUT
@@ -6112,7 +6107,8 @@ L<update|/"update [I<option>]... [I<pkg>]...">, the
L<install|"install [I<option>]... I<pkg>...">, and the
L<option|"option"> actions.
-=head2 update and install actions
+
+=head2 Update and install actions
The output format is as follows: