diff options
author | Karl Berry <karl@freefriends.org> | 2012-05-09 02:37:03 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2012-05-09 02:37:03 +0000 |
commit | d303e185c653d96831d1a4a89c0dc56ccfdee9c9 (patch) | |
tree | ea7ccbc212c3271561555aef194f30a2c127fba8 /Master/texmf/doc/man | |
parent | b0cb800a74d6e454f13f54922beeb6ae045d19be (diff) |
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@26270 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/man')
-rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.1 | 531 | ||||
-rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.man1.pdf | bin | 72816 -> 74282 bytes |
2 files changed, 276 insertions, 255 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index 68ed3441be3..af73abf13ae 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 "2012-04-25" "perl v5.14.2" "User Contributed Perl Documentation" +.TH TLMGR 1 "2012-05-09" "perl v5.14.2" "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 @@ -609,22 +609,24 @@ written to the terminal. .IP "\fBrepository set \f(BIpath\fB[#\f(BItag\fB] [\f(BIpath\fB[#\f(BItag\fB] ...]\fR" 4 .IX Item "repository set path[#tag] [path[#tag] ...]" .PD -This action manages the list of repositories. See \*(L"\s-1MULTIPLE\s0 \s-1REPOSITORIES\s0\*(R" -below for detailed explanations. +This action manages the list of repositories. See \*(L"\s-1MULTIPLE\s0 +\&\s-1REPOSITORIES\s0\*(R" below for detailed explanations. .Sp -The first form list all configured repositories and the respective tags -if set. The second form adds a repository (and optionally attaching a -tag) to the list of repositories. The third from removes a repository, -either by full path/url, or by tag. The last form sets the list -of repositories to the items given on the command line, not keeping -previous settings. Be reminded that one of the repositories has to -be tagged as \fBmain\fR, otherwise all operations will fail. +The first form (\f(CW\*(C`list\*(C'\fR) lists all configured repositories and the +respective tags if set. The second form (\f(CW\*(C`add\*(C'\fR) adds a repository +(optionally attaching a tag) to the list of repositories. The third +form (\f(CW\*(C`remove\*(C'\fR) removes a repository, either by full path/url, or by +tag. The last form (\f(CW\*(C`set\*(C'\fR) sets the list of repositories to the items +given on the command line, not keeping previous settings +.Sp +In all cases, one of the repositories must be tagged as \f(CW\*(C`main\*(C'\fR; +otherwise, all operations will fail! .SS "candidates" .IX Subsection "candidates" .IP "\fBcandidates \f(BIpkg\fB\fR" 4 .IX Item "candidates pkg" -Shows the list of available candidates for package \fIpkg\fR. See -\&\*(L"\s-1MULTIPLE\s0 \s-1REPOSITORIES\s0\*(R" below for details. +Shows the available candidate repositories for package \fIpkg\fR. +See \*(L"\s-1MULTIPLE\s0 \s-1REPOSITORIES\s0\*(R" below. .SS "option" .IX Subsection "option" .IP "\fBoption [show]\fR" 4 @@ -765,8 +767,8 @@ done, so any sort of breakage is possible. .IP "\fBpaper [a4|letter]\fR" 4 .IX Item "paper [a4|letter]" .PD 0 -.IP "\fBxdvi|pdftex|dvips|dvipdfmx|dvipdfm|context\ paper\ [\f(BIpapersize\fB|\-\-list]\fR" 4 -.IX Item "xdvi|pdftex|dvips|dvipdfmx|dvipdfm|contextpaper[papersize|--list]" +.IP "\fB[xdvi|pdftex|dvips|dvipdfmx|dvipdfm|context]\ paper\ [\f(BIpapersize\fB|\-\-list]\fR" 4 +.IX Item "[xdvi|pdftex|dvips|dvipdfmx|dvipdfm|context]paper[papersize|--list]" .PD .PP With no arguments (\f(CW\*(C`tlmgr paper\*(C'\fR), shows the default paper size setting @@ -817,6 +819,54 @@ written to the terminal. Print the TeX Live identifier for the detected platform (hardware/operating system) combination to standard output, and exit. \&\f(CW\*(C`\-\-print\-arch\*(C'\fR is a synonym. +.SS "info [\fIoption\fP...] [collections|schemes|\fIpkg\fP...]" +.IX Subsection "info [option...] [collections|schemes|pkg...]" +With no argument, lists all packages available at the package +repository, prefixing those already installed with \f(CW\*(C`i\*(C'\fR. +.PP +With the single word \f(CW\*(C`collections\*(C'\fR or \f(CW\*(C`schemes\*(C'\fR as the argument, lists +the request type instead of all packages. +.PP +With any other arguments, display information about \fIpkg\fR: the name, +category, short and long description, installation status, and TeX Live +revision number. If \fIpkg\fR is not locally installed, searches in the +remote installation source. +.PP +It also displays information taken from the TeX Catalogue, namely the +package version, date, and license. Consider these, especially the +package version, as approximations only, due to timing skew of the +updates of the different pieces. By contrast, the \f(CW\*(C`revision\*(C'\fR value +comes directly from \s-1TL\s0 and is reliable. +.PP +The former actions \f(CW\*(C`show\*(C'\fR and \f(CW\*(C`list\*(C'\fR are merged into this action, +but are still supported for backward compatibility. +.PP +Options: +.IP "\fB\-\-list\fR" 4 +.IX Item "--list" +If the option \f(CW\*(C`\-\-list\*(C'\fR is given with a package, the list of contained +files is also shown, including those for platform-specific dependencies. +When given with schemes and collections, \f(CW\*(C`\-\-list\*(C'\fR outputs their +dependencies in a similar way. +.IP "\fB\-\-only\-installed\fR" 4 +.IX Item "--only-installed" +If this options is given, the installation source will +not be used; only locally installed packages, collections, or schemes +are listed. +(Does not work for listing of packages for now) +.IP "\fB\-\-taxonomy\fR" 4 +.IX Item "--taxonomy" +.PD 0 +.IP "\fB\-\-keyword\fR" 4 +.IX Item "--keyword" +.IP "\fB\-\-functionality\fR" 4 +.IX Item "--functionality" +.IP "\fB\-\-characterization\fR" 4 +.IX Item "--characterization" +.PD +In addition to the normal data displayed, also display information for +given packages from the corresponding taxonomy (or all of them). See +\&\*(L"\s-1TAXONOMIES\s0\*(R" below for details. .SS "search [\fIoption\fP...] \fIwhat\fP" .IX Subsection "search [option...] what" \fIsearch [\fIoption\fI...] \-\-file \fIwhat\fI\fR @@ -877,54 +927,6 @@ descriptions. See \*(L"\s-1TAXONOMIES\s0\*(R" below. .IP "\fB\-\-all\fR" 4 .IX Item "--all" Search for package names, descriptions, and taxonomies, but not files. -.SS "info [\fIoption\fP...] [collections|schemes|\fIpkg\fP...]" -.IX Subsection "info [option...] [collections|schemes|pkg...]" -With no argument, lists all packages available at the package -repository, prefixing those already installed with \f(CW\*(C`i\*(C'\fR. -.PP -With the single word \f(CW\*(C`collections\*(C'\fR or \f(CW\*(C`schemes\*(C'\fR as the argument, lists -the request type instead of all packages. -.PP -With any other arguments, display information about \fIpkg\fR: the name, -category, short and long description, installation status, and TeX Live -revision number. If \fIpkg\fR is not locally installed, searches in the -remote installation source. -.PP -It also displays information taken from the TeX Catalogue, namely the -package version, date, and license. Consider these, especially the -package version, as approximations only, due to timing skew of the -updates of the different pieces. By contrast, the \f(CW\*(C`revision\*(C'\fR value -comes directly from \s-1TL\s0 and is reliable. -.PP -The former actions \f(CW\*(C`show\*(C'\fR and \f(CW\*(C`list\*(C'\fR are merged into this action, -but are still supported for backward compatibility. -.PP -Options: -.IP "\fB\-\-list\fR" 4 -.IX Item "--list" -If the option \f(CW\*(C`\-\-list\*(C'\fR is given with a package, the list of contained -files is also shown, including those for platform-specific dependencies. -When given with schemes and collections, \f(CW\*(C`\-\-list\*(C'\fR outputs their -dependencies in a similar way. -.IP "\fB\-\-only\-installed\fR" 4 -.IX Item "--only-installed" -If this options is given, the installation source will -not be used; only locally installed packages, collections, or schemes -are listed. -(Does not work for listing of packages for now) -.IP "\fB\-\-taxonomy\fR" 4 -.IX Item "--taxonomy" -.PD 0 -.IP "\fB\-\-keyword\fR" 4 -.IX Item "--keyword" -.IP "\fB\-\-functionality\fR" 4 -.IX Item "--functionality" -.IP "\fB\-\-characterization\fR" 4 -.IX Item "--characterization" -.PD -In addition to the normal data displayed, also display information for -given packages from the corresponding taxonomy (or all of them). See -\&\*(L"\s-1TAXONOMIES\s0\*(R" below for details. .SS "dump-tlpdb [\-\-local|\-\-remote]" .IX Subsection "dump-tlpdb [--local|--remote]" Dump complete local or remote \s-1TLPDB\s0 to standard output, as-is. The @@ -1177,8 +1179,8 @@ use of \f(CW\*(C`updmap\-local.cfg\*(C'\fR, you must run \f(CW\*(C`tlmgr generat and \f(CW\*(C`updmap\-sys\*(C'\fR yourself after making any local changes. If you make yourself responsible for rigorously using \f(CW\*(C`updmap\-local.cfg\*(C'\fR), set \&\f(CW\*(C`option generate_updmap\*(C'\fR). -.SH "CONFIGURATION FILE" -.IX Header "CONFIGURATION FILE" +.SH "TLMGR CONFIGURATION FILE" +.IX Header "TLMGR 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`TEXMFCONFIG/tlmgr/config\*(C'\fR. By default, the config file is in \f(CW\*(C`~/.texlive2010/texmf\-config/tlmgr/config\*(C'\fR. This is \fInot\fR @@ -1200,38 +1202,70 @@ respective command line options of the same name. \&\f(CW\*(C`gui\-expertmode\*(C'\fR switches between the full \&\s-1GUI\s0 and a simplified \s-1GUI\s0 with only the important and mostly used settings. +.SH "TAXONOMIES" +.IX Header "TAXONOMIES" +tlmgr allows searching and listing of various categorizations, which we +call \fItaxonomies\fR, as provided by an enhanced TeX Catalogue (available +for testing at <http://az.ctan.org>). This is useful when, for +example, you don't know a specific package name but have an idea of the +functionality you need; or when you want to see all packages relating to +a given area. +.PP +There are three different taxonomies, specified by the following +options: +.IP "\fB\-\-keyword\fR" 4 +.IX Item "--keyword" +The keywords, as specified at <http://az.ctan.org/keyword>. +.IP "\fB\-\-functionality\fR" 4 +.IX Item "--functionality" +The ``by\-topic'' categorization created by J\e"urgen Fenn, as specified +at http://az.ctan.org/characterization/by\-function <http://az.ctan.org/characterization/by-function>. +.IP "\fB\-\-characterization\fR" 4 +.IX Item "--characterization" +Both the primary and secondary functionalities, as specified at +<http://az.ctan.org/characterization/choose_dimen>. +.IP "\fB\-\-taxonomy\fR" 4 +.IX Item "--taxonomy" +Operate on all the taxonomies. +.PP +The taxonomies are updated nightly and stored within TeX Live, so +Internet access is not required to search them. +.PP +Examples: +.PP +.Vb 5 +\& tlmgr search \-\-taxonomy exercise # check all taxonomies for "exercise" +\& tlmgr search \-\-taxonomy \-\-word table # check for "table" on its own +\& tlmgr search \-\-list \-\-keyword # dump entire keyword taxonomy +\& tlmgr show \-\-taxonomy pdftex # show pdftex package information, +\& # including all taxonomy entries +.Ve .SH "MULTIPLE REPOSITORIES" .IX Header "MULTIPLE REPOSITORIES" Most packages are distributed via the main TeX Live repository, but -sometimes local repositories are used to provide local packages -(like commercial fonts, internal styles), as well as alternative -package repositories for packages that cannot be included in -proper TeX Live due to license or other reasons. -.PP -Without multiple repository support using these additional repositories -needed an extra invocation and temporarily setting the installation -source to this additional repository. By setting up all the -repositories as sources of packages one does not need to -use multiple invocations of tlmgr anymore. -.PP -\&\fBWarning:\fR Although support for multiple repositories has been -tested extensively, it does not guarantee proper operation. If you -want to be sure not to break anything, consider continuing -using multiple invocations of tlmgr. -.PP -When using multiple repositories, one has to be the main repository, -which distributes most of the TeX Live packages. If you convert -from a single repository installation to a multiple repository -installation (by calling tlmgr repository add), the previously -set repository will be set as the main repository. -.PP -By default, even if multiple repositories are configured, packages -are \fBonly\fR installed from the main repository, as long as -packages are not explicitely pinned to a different repository. -That also means by simply adding another repository you will -\&\fBnot\fR be able to install the packages from there, you first -have to specify which packages should be taken from a -different repository by specifying some pinning rules. +sometimes local repositories are used to provide local packages (e.g., +proprietary fonts, internal styles). There are also alternative package +repositories for packages that cannot or should not be included in TeX +Live, due to being under rapid development or for other reasons. +.PP +It's possible to tell \f(CW\*(C`tlmgr\*(C'\fR about additional repositories you want to +use. Although this support for multiple repositories has been tested +extensively, we cannot guarantee proper operation. If in doubt or if +problems, you can temporarily set the installation source to any +repository and perform your operations. +.PP +When using multiple repositories, one of them has to be set as the main +repository, which distributes most of the installed packages. If you +switch from a single repository installation to a multiple repository +installation (by calling \f(CW\*(C`tlmgr repository add\*(C'\fR), the previously set +repository will be set as the main repository. +.PP +By default, even if multiple repositories are configured, packages are +\&\fIonly\fR installed from the main repository. Thus, simply adding a +second repository does not enable installation of anything from there. +You first have to specify which packages should be taken from a +different repository by specifying some so-called ``pinning'' rules, +described next. .SS "Pinning" .IX Subsection "Pinning" Pinning a package is done by editing (adding) a file @@ -1240,31 +1274,30 @@ Pinning a package is done by editing (adding) a file \& TEXMFLOCAL/tlpkg/pinning.txt .Ve .PP -which contains lines +which contains lines of the form: .PP .Vb 1 \& repo:pkg[,pkg] .Ve .PP -In this line the \f(CW\*(C`repo\*(C'\fR is either the full \s-1URL\s0 saved in the -list or repositories, or one of the tags given. The \f(CW\*(C`pkg\*(C'\fR -are shell style globs for packages. +In this line, the \fIrepo\fR is either a full url or repository tag that +was added to the repository list. Each \fIpkg\fR is a shell-style glob for +package identifiers. .PP -By default everything is pinned to the main repository, so -you can imagine that at the end of the file pinning.txt there -is a line +By default, everything is pinned to the main repository, +as if at the end of \f(CW\*(C`pinning.txt\*(C'\fR there is a line .PP .Vb 1 \& main:* .Ve .PP -If a package \f(CW\*(C`foo\*(C'\fR is pinned to a repository, any package -\&\f(CW\*(C`foo\*(C'\fR in any other repository, even if it has a higher -revision number, will not be considered as installable -candidate. -.SS "Usage example with tlcontrib" -.IX Subsection "Usage example with tlcontrib" -\&\- check current repository: +Now, if a package \f(CW\*(C`foo\*(C'\fR is pinned to a repository, any package \f(CW\*(C`foo\*(C'\fR +in any other repository, even if it has a higher revision number, will +not be considered as an installable candidate. +.SS "Multiple repository example with tlcontrib" +.IX Subsection "Multiple repository example with tlcontrib" +First, check that we have support for multiple repositories, and only +one specified (as is the case by default): .PP .Vb 3 \& $ tlmgr repository list @@ -1272,13 +1305,14 @@ candidate. \& /var/www/norbert/tlnet .Ve .PP -\&\- add tlcontrib repository (and give it a short name) +Add the \f(CW\*(C`tlcontrib\*(C'\fR repository maintained by Taco Hoekwater et al., +with the tag \f(CW\*(C`tlcontrib\*(C'\fR: .PP .Vb 1 \& $ tlmgr repository add http://tlcontrib.metatex.org/2011 tlcontrib .Ve .PP -\&\- check repositories: +Check the repository list again: .PP .Vb 4 \& $ tlmgr repository list @@ -1287,14 +1321,15 @@ candidate. \& /var/www/norbert/tlnet (main) .Ve .PP -\&\- add a pinning to get cowfont from tlcontrib: +Specify a pinning entry to get the package \f(CW\*(C`cowfont\*(C'\fR from \f(CW\*(C`tlcontrib\*(C'\fR: .PP -.Vb 2 -\& $ mkdir \-p \`kpsewhich \-var\-value TEXMFLOCAL\`/tlpkg -\& $ echo "tlcontrib:cowfont" > \`kpsewhich \-var\-value TEXMFLOCAL\`/tlpkg/pinning.txt +.Vb 3 +\& $ tlocal=\`kpsewhich \-var\-value TEXMFLOCAL\` +\& $ mkdir \-p $tlocal/tlpkg +\& $ echo "tlcontrib:cowfont" > $tlocal/tlpkg/pinning.txt .Ve .PP -\&\- check that we can find cowfont: +Check that we can find \f(CW\*(C`cowfont\*(C'\fR: .PP .Vb 6 \& $ tlmgr show cowfont @@ -1327,183 +1362,169 @@ candidate. .PP In the last part you see that the cowfont is installed from the tlcontrib part (@tlcontrib). -.SH "TAXONOMIES" -.IX Header "TAXONOMIES" -tlmgr allows searching and listing of various categorizations, which we -call \fItaxonomies\fR, as provided by an enhanced TeX Catalogue (available -for testing at <http://az.ctan.org>). This is useful when, for -example, you don't know a specific package name but have an idea of the -functionality you need; or when you want to see all packages relating to -a given area. -.PP -There are three different taxonomies, specified by the following -options: -.IP "\fB\-\-keyword\fR" 4 -.IX Item "--keyword" -The keywords, as specified at <http://az.ctan.org/keyword>. -.IP "\fB\-\-functionality\fR" 4 -.IX Item "--functionality" -The ``by\-topic'' categorization created by J\e"urgen Fenn, as specified -at http://az.ctan.org/characterization/by\-function <http://az.ctan.org/characterization/by-function>. -.IP "\fB\-\-characterization\fR" 4 -.IX Item "--characterization" -Both the primary and secondary functionalities, as specified at -<http://az.ctan.org/characterization/choose_dimen>. -.IP "\fB\-\-taxonomy\fR" 4 -.IX Item "--taxonomy" -Operate on all the taxonomies. -.PP -The taxonomies are updated nightly and stored within TeX Live, so -Internet access is not required to search them. -.PP -Examples: -.PP -.Vb 5 -\& tlmgr search \-\-taxonomy exercise # check all taxonomies for "exercise" -\& tlmgr search \-\-taxonomy \-\-word table # check for "table" on its own -\& tlmgr search \-\-list \-\-keyword # dump entire keyword taxonomy -\& tlmgr show \-\-taxonomy pdftex # show pdftex package information, -\& # including all taxonomy entries -.Ve .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. +The graphical user interface for \f(CW\*(C`tlmgr\*(C'\fR needs Perl/Tk 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. +other (i.e., Unix-based) systems Perl/Tk (as well as Perl of course) has +to be installed. <http://tug.org/texlive/distro.html#perltk> has a +list of invocations for some distros. .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. -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. -.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 -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 -.IX Item "Actions" -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), -restoring backups of packages, as well as removal of the full TeX Live -installation (only Unix). -.IP "\fBHelp\fR" 4 -.IX Item "Help" -Provides access to the manual and other basic information on the -installed version, authors, license. +Within the main display there are three main parts: the \f(CW\*(C`Display +configuration\*(C'\fR area, the list of packages, and the action buttons. +.PP +Also, at the top right the currently loaded repository is shown; this +also acts as a button and when clicked will try to load the default +repository. To load a different repository, see the \f(CW\*(C`tlmgr\*(C'\fR menu item. +.PP +Finally, the status area at the bottom of the window gives additional +information about what is going on. .SS "Main display" .IX Subsection "Main display" -The main display lists all packages, installed and, if a repository is -loaded, also those that are available but not installed. +\fIDisplay configuration area\fR +.IX Subsection "Display configuration area" .PP -Each line of the package list contains of the following items: +The first part of the main display allows you to specify (filter) which +packages are shown. By default, all are shown. Changes here are +reflected right away. +.IP "Status" 4 +.IX Item "Status" +Select whether to show all packages (the default), only those installed, +only those \fInot\fR installed, or only those with update available. +.IP "Category" 4 +.IX Item "Category" +Select which categories are shown: packages, collections, and/or +schemes. These are briefly explained in the \s-1DESCRIPTION\s0 section +above. +.IP "Match" 4 +.IX Item "Match" +Select packages matching for a specific pattern. By default, this uses +the same algorithm as \f(CW\*(C`tlmgr search\*(C'\fR, i.e., searches everything: +descriptions, taxonomies, and/or filenames. You can also select any +subset for searching. +.IP "Selection" 4 +.IX Item "Selection" +Select packages to those selected, those not selected, or all. Here, +``selected'' means that the checkbox in the beginning of the line of a +package is ticked. +.IP "Display configuration buttons" 4 +.IX Item "Display configuration buttons" +To the right there are three buttons: select all packages, select none +(a.k.a. deselect all), and reset all these filters to the defaults, +i.e., show all available. +.PP +\fIPackage list area\fR +.IX Subsection "Package list area" +.PP +The second are of the main display lists all installed packages. If a +repository is loaded, those that are available but not installed are +also listed. +.PP +Double clicking on a package line pops up an informational window with +further details: the long description, included files, etc. +.PP +Each line of the package list consists of the following items: .IP "a checkbox" 4 .IX Item "a checkbox" -used for selecting packages, some of the action buttons (see below) will -work only on the selected packages. -.IP "the package name" 4 -.IX Item "the package name" -that is the name of the package as given in the database. +Used to select particular packages; some of the action buttons (see +below) work only on the selected packages. +.IP "package name" 4 +.IX Item "package name" +The name (identifier) of the package as given in the database. .IP "local revision (and version)" 4 .IX Item "local revision (and version)" -If the package is installed the revision of the installed package will -be shown. If there is a catalogue version given in the database for this -package, it will be shown in parenthesis. +If the package is installed the TeX Live revision number for the +installed package will be shown. If there is a catalogue version given +in the database for this package, it will be shown in parentheses. +However, the catalogue version, unlike the \s-1TL\s0 revision, is not +guaranteed to reflect what is actually installed. .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. +repository (if present) is shown. As with the local column, if a +catalogue version is provided it will be displayed. And also as with +the local column, the catalogue version may be stale. .IP "short description" 4 .IX Item "short description" -The short description (or title) is shown. +The short description of the package. .PP -Double clicking on one of the lines pops up an informational window with -further details, the long description, included files, etc. +\fIMain display action buttons\fR +.IX Subsection "Main display action buttons" .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: -.IP "Status" 4 -.IX Item "Status" -allows selecting to show all, only the installed, only those packages -that are not installed, or only those with packages available. -.IP "Category" 4 -.IX Item "Category" -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 -descriptions. -.IP "Selection" 4 -.IX Item "Selection" -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 -defaults, i.e., show all available. -.PP -Below the list of packages there are five buttons: +Below the list of packages are several 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 -available packages. -.Sp -Below this button there is a toggle that allows reinstallation of -previously removed packages. +This calls \f(CW\*(C`tlmgr update \-\-all\*(C'\fR, i.e., tries to update all available +packages. Below this button is a toggle to allow reinstallation of +previously removed packages as part of this action. .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 other four buttons only work on the selected packages, i.e., those +where the checkbox at the beginning of the package line is ticked. .IP "Update" 4 .IX Item "Update" -only update the selected packages. +Update only the selected packages. .IP "Install" 4 .IX Item "Install" -install the selected packages; acts like \f(CW\*(C`tlmgr install\*(C'\fR, i.e., also -installs dependencies. Thus, installing a collection will install -all its constituent packages. +Install the selected packages; acts like \f(CW\*(C`tlmgr install\*(C'\fR, i.e., also +installs dependencies. Thus, installing a collection installs all its +constituent packages. .IP "Remove" 4 .IX Item "Remove" -removes the selected packages; acts like \f(CW\*(C`tlmgr remove\*(C'\fR, i.e., it will +Removes the selected packages; acts like \f(CW\*(C`tlmgr remove\*(C'\fR, i.e., it will also remove dependencies of collections (but not dependencies of normal packages). .IP "Backup" 4 .IX Item "Backup" -makes a backup of the selected packages; acts like \f(CW\*(C`tlmgr backup\*(C'\fR. This +Makes a backup of the selected packages; acts like \f(CW\*(C`tlmgr backup\*(C'\fR. This action needs the option \f(CW\*(C`backupdir\*(C'\fR set (see \f(CW\*(C`Options \-\*(C'\fR General>). -.PP -Finally, the status area at the bottom of the window gives additional -information about what is going on. +.SS "Menu bar" +.IX Subsection "Menu bar" +The following entries can be found in the menu bar: +.IP "\fBtlmgr\fR menu" 4 +.IX Item "tlmgr menu" +The items here load various repositories: the default as specified in +the TeX Live database, the default network repository, the repository +specified on the command line (if any), and an arbitrarily +manually-entered one. Also has the so-necessary \f(CW\*(C`quit\*(C'\fR operation. +.IP "\fBOptions menu\fR" 4 +.IX Item "Options menu" +Provides access to several groups of options: \f(CW\*(C`Paper\*(C'\fR (configuration of +default paper sizes), \f(CW\*(C`Platforms\*(C'\fR (only on Unix, configuration of the +supported/installed platforms), \f(CW\*(C`GUI Language\*(C'\fR (select language used in +the \s-1GUI\s0 interface), and \f(CW\*(C`General\*(C'\fR (everything else). +.Sp +Several toggles are also here. The first is \f(CW\*(C`Expert options\*(C'\fR, which is +set by default. If you turn this off, the next time you start the \s-1GUI\s0 a +simplified screen will be shown that display only the most important +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. +.Sp +The other toggles are all off by default: for debugging output, to +disable the automatic installation of new packages, and to disable the +automatic removal of packages deleted from the server. Playing with the +choices of what is or isn't installed may lead to an inconsistent TeX Live +installation; e.g., when a package is renamed. +.IP "\fBActions menu\fR" 4 +.IX Item "Actions menu" +Provides access to several actions: update the filename database (aka +\&\f(CW\*(C`ls\-R\*(C'\fR, \f(CW\*(C`mktexlsr\*(C'\fR, \f(CW\*(C`texhash\*(C'\fR), rebuild all formats (\f(CW\*(C`fmtutil\-sys +\&\-\-all\*(C'\fR), update the font map database (\f(CW\*(C`updmap\-sys\*(C'\fR), restore from a backup +of a package, and use of symbolic links in system directories (not on +Windows). +.Sp +The final action is to remove the entire TeX Live installation (also not +on Windows). +.IP "\fBHelp menu\fR" 4 +.IX Item "Help menu" +Provides access to the TeX Live manual (also on the web at +<http://tug.org/texlive/doc.html>) and the usual ``About'' box. .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 +With the \f(CW\*(C`\-\-machine\-readable\*(C'\fR option, \f(CW\*(C`tlmgr\*(C'\fR writes to stdout in the fixed line-oriented format described here, and the usual informational messages for human consumption are written to stderr (normally they are written to stdout). The idea is that a program can get all the @@ -1513,8 +1534,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 diff --git a/Master/texmf/doc/man/man1/tlmgr.man1.pdf b/Master/texmf/doc/man/man1/tlmgr.man1.pdf Binary files differindex 54b213aafd1..4f9cbf2fa51 100644 --- a/Master/texmf/doc/man/man1/tlmgr.man1.pdf +++ b/Master/texmf/doc/man/man1/tlmgr.man1.pdf |