summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2010-10-27 02:09:58 +0000
committerKarl Berry <karl@freefriends.org>2010-10-27 02:09:58 +0000
commitc4a916200e8ccca797ea1a55f983cd3565268bba (patch)
tree83d5fc1cc7233bc7cda89e5da50496f957c0835f /Master/texmf/doc/man/man1
parentcf218e6db4b7a3c24beca76caab0cae91cc52bfd (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@20223 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/man/man1')
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.1145
-rw-r--r--Master/texmf/doc/man/man1/tlmgr.man1.pdfbin61168 -> 61046 bytes
2 files changed, 69 insertions, 76 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
index 29161d19723..f9966060505 100644
--- a/Master/texmf/doc/man/man1/tlmgr.1
+++ b/Master/texmf/doc/man/man1/tlmgr.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "TLMGR 1"
-.TH TLMGR 1 "2010-10-25" "perl v5.10.1" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2010-10-26" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -760,9 +760,9 @@ Print the TeX Live identifier for the detected platform
.IX Subsection "search [options] --functionality what"
.SS "search [\fIoptions\fP] \-\-characterization \fIwhat\fP"
.IX Subsection "search [options] --characterization 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 \fIwhat\fR,
+interpreted as a regular expression.
.PP
Options:
.IP "\fB\-\-global\fR" 4
@@ -776,13 +776,12 @@ for \f(CW\*(C`table\*(C'\fR with this option will not output packages containing
the the word \f(CW\*(C`tables\*(C'\fR unless they also contain the word \f(CW\*(C`table\*(C'\fR.
.IP "\fB\-\-list\fR" 4
.IX Item "--list"
-If a search for any (or all) taxonomies is done by given either
-\&\fB\-\-taxonomy\fR, \fB\-\-keyword\fR, \fB\-\-functionality\fR, or \fB\-\-characterization\fR,
-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
+\&\fB\-\-taxonomy\fR, \fB\-\-keyword\fR, \fB\-\-functionality\fR, or
+\&\fB\-\-characterization\fR, then instead of searching for packages, list the
+entire corresponding taxonomy. See \*(L"\s-1TAXONOMIES\s0\*(R" below.
.PP
-Other search options are selected by adding either \fB\-\-file\fR, \fB\-\-taxonomy\fR,
-\&\fB\-\-keyword\fR, \fB\-\-functionality\fR, or \fB\-\-characterization\fR.
+Other search options are selected by specifying one of the following:
.IP "\fB\-\-file\fR" 4
.IX Item "--file"
List all filenames containing \fIwhat\fR.
@@ -796,12 +795,8 @@ List all filenames containing \fIwhat\fR.
.IP "\fB\-\-characterization\fR" 4
.IX Item "--characterization"
.PD
-Searches in the list of keywords, and its characterization and functional
-specifications instead of the package descriptions.
-See \*(L"\s-1TAXONOMIES\s0\*(R" below for details.
-.IP "\fB\-\-extended\fR" 4
-.IX Item "--extended"
-Not implemented yet.
+Search in the given taxonomy instead of the package descriptions. See
+\&\*(L"\s-1TAXONOMIES\s0\*(R" below.
.SS "show [\fIoptions\fP] \fIpkg\fP..."
.IX Subsection "show [options] pkg..."
Display information about \fIpkg\fR: the name, category, installation status,
@@ -1057,70 +1052,68 @@ The respective locations are as follows:
.PP
Final repetition: as explained above, \f(CW\*(C`tlmgr\*(C'\fR does \fInot\fR use
\&\f(CW\*(C`generate updmap\*(C'\fR for map files. Therefore, if you want to make use of
-\&\f(CW\*(C`updmap\-local.cfg\*(C'\fR, you need to run \f(CW\*(C`tlmgr generate updmap\*(C'\fR yourself.
-After that, network updates and your local changes should be merged.
+\&\f(CW\*(C`updmap\-local.cfg\*(C'\fR, you need to run \f(CW\*(C`tlmgr generate updmap\*(C'\fR yourself
+after making any local changes.
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
-A small subset of the command line options can be set in a config
-file for \f(CW\*(C`tlmgr\*(C'\fR which resides in \f(CW\*(C`TEXMFVAR/tlmgr/config\*(C'\fR. Note
-that it is \fBnot\fR \f(CW\*(C`TEXMFSYSVAR\*(C'\fR so the file is specific to a single
-user. By default thus the config file is in \f(CW\*(C`~/.texlive2010/tlmgr/config\*(C'\fR.
+A small subset of the command line options can be set in a config file
+for \f(CW\*(C`tlmgr\*(C'\fR which resides in \f(CW\*(C`TEXMFVAR/tlmgr/config\*(C'\fR. By default, the
+config file is in \f(CW\*(C`~/.texlive2010/tlmgr/config\*(C'\fR. This is \fInot\fR
+\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR, so that the file is specific to a single user.
.PP
-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
.PP
.Vb 1
\& key = value
.Ve
.PP
-where the allowed keys are \f(CW\*(C`gui_expertmode\*(C'\fR and \f(CW\*(C`persistent\-downloads\*(C'\fR.
-The values can only be 0 or 1 for those settings.
-\&\f(CW\*(C`persistent\-downloads\*(C'\fR corresponds to the respective
-command line options of \f(CW\*(C`tlmgr\*(C'\fR. \f(CW\*(C`gui_expertmode\*(C'\fR switches between
-the full \s-1GUI\s0 and a simplified with only the important and mostly used
-settings.
+where the allowed keys are \f(CW\*(C`gui\-expertmode\*(C'\fR and
+\&\f(CW\*(C`persistent\-downloads\*(C'\fR. The values can only be 0 or 1 for those
+settings. \f(CW\*(C`persistent\-downloads\*(C'\fR corresponds to the respective command
+line options of \f(CW\*(C`tlmgr\*(C'\fR. \f(CW\*(C`gui\-expertmode\*(C'\fR switches between the full
+\&\s-1GUI\s0 and a simplified with only the important and mostly used settings.
.SH "TAXONOMIES"
.IX Header "TAXONOMIES"
tlmgr allows searching and listing of various taxonomies as provided
by newer version of the TeX Catalogue.
.PP
\&\s-1MORE\s0 \s-1INFORMATION\s0 \s-1NEEDED\s0.
-.SH "GUI"
-.IX Header "GUI"
+.SH "GUI FOR TLMGR"
+.IX Header "GUI FOR TLMGR"
The graphical user interface for \f(CW\*(C`tlmgr\*(C'\fR 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.
-.PP
-When started with \f(CW\*(C`tlmgr gui\*(C'\fR 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.
-.PP
-Within the main display there are three main parts: The
-\&\fIDisplay configuration\fR, 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).
+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.
+.PP
+When started with \f(CW\*(C`tlmgr gui\*(C'\fR 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.
+.PP
+Within the main display there are three main parts: The \fIDisplay
+configuration\fR, 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).
.SS "Menu bar"
.IX Subsection "Menu bar"
The following entries can be found in the menu bar:
.IP "\fBtlmgr\fR" 4
.IX Item "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 \f(CW\*(C`tlmgr\*(C'\fR.
.IP "\fBOptions\fR" 4
.IX Item "Options"
Provides access to three groups of options, \fIGeneral\fR (for almost all
-options), \fIPaper\fR (configuration of default paper sizes),
-\&\fIPlatforms\fR (only on Unix, configuration of the supported/installed
-platforms), as well as some toggles to turn on and off various
-options.
+options), \fIPaper\fR (configuration of default paper sizes), \fIPlatforms\fR
+(only on Unix, configuration of the supported/installed platforms), as
+well as some toggles to turn on and off various options.
.Sp
There is also a toggle for \f(CW\*(C`Expert options\*(C'\fR which defaults to on. If
you turn this off the next time you start the \s-1GUI\s0 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
\&\f(CW\*(C`tlmgr\*(C'\fR, see \*(L"\s-1CONFIGURATION\s0 \s-1FILE\s0\*(R" for details.
.IP "\fBActions\fR" 4
@@ -1128,7 +1121,7 @@ functionality. This setting is saved in the configuration file of
Provides access to a variety of items, such as updating the filename
database (aka ls-R, mktexlsr, texhash), rebuilding of all formats
(\f(CW\*(C`fmtutil\-sys \-\-all\*(C'\fR), updating the font map database (\f(CW\*(C`updmap\-sys\*(C'\fR),
-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).
.IP "\fBHelp\fR" 4
@@ -1155,19 +1148,19 @@ be shown. If there is a catalogue version given in the database for this
package, it will be shown in parenthesis.
.IP "remote revision (and version)" 4
.IX 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.
.IP "short description" 4
.IX Item "short description"
The short description (or title) is shown.
.PP
-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.
.PP
-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:
.IP "Status" 4
.IX Item "Status"
allows selecting to show all, only the installed, only those packages
@@ -1177,31 +1170,31 @@ that are not installed, or only those with packages available.
allows to select which categories are shown.
.IP "Match" 4
.IX Item "Match"
-allows searching for a specific pattern. This uses the same algorithm
-as \f(CW\*(C`tlmgr search\*(C'\fR, i.e., searches in the title, short and long
+allows searching for a specific pattern. This uses the same algorithm as
+\&\f(CW\*(C`tlmgr search\*(C'\fR, i.e., searches in the title, short and long
descriptions.
.IP "Selection" 4
.IX 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).
.IP "buttons" 4
.IX 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.
.PP
Below the list of packages there are five buttons:
.IP "Update all installed" 4
.IX Item "Update all installed"
-this calls \f(CW\*(C`tlmgr update \-\-all\*(C'\fR internally, i.e., tries to update all
+This calls \f(CW\*(C`tlmgr update \-\-all\*(C'\fR internally, i.e., tries to update all
available packages.
.Sp
Below this button there is a toggle that allows reinstallation of
previously removed packages.
.Sp
-The following four buttons only work on the \fIselected\fR packages, i.e., those
-where the checkbutton at the beginning of the line is ticked.
+The following four buttons only work on the \fIselected\fR packages, i.e.,
+those where the checkbutton at the beginning of the line is ticked.
.IP "Update" 4
.IX Item "Update"
only update the selcted packages
@@ -1221,7 +1214,7 @@ makes a backup of the selected packages, acts like \f(CW\*(C`tlmgr backup\*(C'\f
action needs the option \f(CW\*(C`backupdir\*(C'\fR set (see Options \-> General).
.PP
Finally, the status area at the bottom of the window gives additional
-information what is going on.
+information about what is going on.
.SH "MACHINE-READABLE OUTPUT"
.IX Header "MACHINE-READABLE OUTPUT"
Given the \f(CW\*(C`\-\-machine\-readable\*(C'\fR option, \f(CW\*(C`tlmgr\*(C'\fR writes to stdout in the
@@ -1234,8 +1227,8 @@ Currently this option only applies to the
update, the
install, and the
option actions.
-.SS "update and install actions"
-.IX Subsection "update and install actions"
+.SS "Update and install actions"
+.IX Subsection "Update and install actions"
The output format is as follows:
.PP
.Vb 7
@@ -1362,9 +1355,9 @@ distribution (<http://tug.org/texlive>) and both are licensed under the
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
-.IP "Around line 5612:" 4
-.IX Item "Around line 5612:"
+.IP "Around line 5616:" 4
+.IX Item "Around line 5616:"
Unknown directive: =over4
-.IP "Around line 5614:" 4
-.IX Item "Around line 5614:"
+.IP "Around line 5618:" 4
+.IX Item "Around line 5618:"
\&'=item' outside of any '=over'
diff --git a/Master/texmf/doc/man/man1/tlmgr.man1.pdf b/Master/texmf/doc/man/man1/tlmgr.man1.pdf
index a1cbd0b4d5e..7ef376786ec 100644
--- a/Master/texmf/doc/man/man1/tlmgr.man1.pdf
+++ b/Master/texmf/doc/man/man1/tlmgr.man1.pdf
Binary files differ