From e74ff40d44bf615144f5c7941ac735d94a365c40 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 31 Dec 2009 02:23:35 +0000 Subject: /home/texlive/karl/Master/tlpkg/bin/tl-update-auto git-svn-id: svn://tug.org/texlive/trunk@16551 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/man/man1/tlmgr.1 | 136 ++++++++++++++++++++++++++++++- Master/texmf/doc/man/man1/tlmgr.man1.pdf | Bin 45672 -> 51648 bytes 2 files changed, 134 insertions(+), 2 deletions(-) (limited to 'Master/texmf') diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index 8ba0dfdb631..0ecaf581f59 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 "2009-12-18" "perl v5.10.1" "User Contributed Perl Documentation" +.TH TLMGR 1 "2009-12-30" "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 @@ -266,7 +266,7 @@ Gives version information (same as \f(CW\*(C`\-\-version\*(C'\fR). If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too. .SS "gui" .IX Subsection "gui" -Start the graphical user interface. +Start the graphical user interface. See \s-1GUI\s0 below. .SS "install [\fIoption\fP]... \fIpkg\fP..." .IX Subsection "install [option]... pkg..." Install each \fIpkg\fR given on the command line. By default this installs @@ -900,6 +900,138 @@ equivalent of \f(CW\*(C`generate updmap\*(C'\fR for map files. Therefore, if yo 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. +.SH "GUI" +.IX Header "GUI" +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). +.SS "Menu bar" +.IX Subsection "Menu bar" +The following entries can be found in the menu bar: +.IP "\fBFile\fR" 4 +.IX Item "File" +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, \fBGeneral\fR (for almost all +options), \fBPaper\fR (configuration of default paper sizes), +\&\fBArchitectures\fR (only on Unix, configuration of the supported/installed +architectures), as well as a toggle to turn on and off Debug mode. +.IP "\fBActions\fR" 4 +.IX Item "Actions" +Provides access to some useful items, like updating the filename database +(ls-R, mktexlsr, texhash), rebuilding of all formats (fmtutil-sys \-\-all), +updating the font map database (updmap-sys), and handling of symbolic +links in system directories (only Unix), as well as removal of the +full TeX Live installation (only Unix). +.IP "\fBHelp\fR" 4 +.IX Item "Help" +Currently only gives basic information on the installed version, authors, +license. +.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. +.PP +Each line of the package list contains 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. +.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. +.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. +.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. +.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" +this allows to restrict 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: +.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 +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 +.IP "Install" 4 +.IX Item "Install" +install the selected packages, acts like \f(CW\*(C`tlmgr install\*(C'\fR, i.e., also +installs dependencies. This installing a collection will install +all depending packages, too. +.IP "Remove" 4 +.IX Item "Remove" +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 +action needs the options \fBbackupdir\fR set (see Options \-> General). +.PP +Finally, the status area at the bottom of the window gives additional +information what is going on. +.SS "the old (v1) \s-1GUI\s0" +.IX Subsection "the old (v1) GUI" +For the time being the first \s-1GUI\s0 written for \f(CW\*(C`tlmgr\*(C'\fR is still included +and available via . Note that there is no development +of this \s-1GUI\s0 anymore, so at some point it might stop to actually work, +or even get removed from the packages. .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 diff --git a/Master/texmf/doc/man/man1/tlmgr.man1.pdf b/Master/texmf/doc/man/man1/tlmgr.man1.pdf index f4d32aa01af..263ad0eb657 100644 Binary files a/Master/texmf/doc/man/man1/tlmgr.man1.pdf and b/Master/texmf/doc/man/man1/tlmgr.man1.pdf differ -- cgit v1.2.3