diff options
author | Norbert Preining <preining@logic.at> | 2009-12-30 04:38:19 +0000 |
---|---|---|
committer | Norbert Preining <preining@logic.at> | 2009-12-30 04:38:19 +0000 |
commit | d08fb106fe619ae01a5b9b17e5c84f70a15ed1e6 (patch) | |
tree | 0c08dc7ffec889bda19dcdce94d3f5c4f60e0639 /Master/texmf/scripts | |
parent | 5664d6ec4cf4fbb0fae9f4b01622d282528427d1 (diff) |
add POD documentation for GUI
git-svn-id: svn://tug.org/texlive/trunk@16529 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/scripts')
-rwxr-xr-x | Master/texmf/scripts/texlive/tlmgr.pl | 175 |
1 files changed, 174 insertions, 1 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl index 32d364cb4ca..4f084582bfb 100755 --- a/Master/texmf/scripts/texlive/tlmgr.pl +++ b/Master/texmf/scripts/texlive/tlmgr.pl @@ -4330,7 +4330,7 @@ If C<-v> has been given the revisions of the used modules are reported, too. =head2 gui -Start the graphical user interface. +Start the graphical user interface. See L<GUI> below. =head2 install [I<option>]... I<pkg>... @@ -5063,6 +5063,179 @@ updmap> yourself. After that, network updates and your local changes should be merged. +=head1 GUI + +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. + +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). + +=head2 Menu bar + +The following entries can be found in the menu bar: + +=over 4 + +=item B<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 C<tlmgr>. + +=item B<Options> + +Provides access to three groups of options, B<General> (for almost all +options), B<Paper> (configuration of default paper sizes), +B<Architectures> (only on Unix, configuration of the supported/installed +architectures), as well as a toggle to turn on and off Debug mode. + +=item B<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). + +=item B<Help> + +Currently only gives basic information on the installed version, authors, +license. + +=back + +=head2 Main display + +The main display lists all packages, installed and - if a repository is +loaded - also those that are available but not installed. + +Each line of the package list contains of the following items: + +=over 4 + +=item a checkbox + +used for selecting packages, some of the action buttons (see below) will +work only on the selected packages. + +=item the package name + +that is the name of the package as given in the database. + +=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. + +=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. + +=item short description + +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. + +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 + +=item Status + +allows selecting to show all, only the installed, only those packages +that are not installed, or only those with packages available. + +=item Category + +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 +descriptions. + +=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). + +=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. + +=back + +Below the list of packages there are five buttons: + +=over 4 + +=item Update all installed + +this calls C<tlmgr update --all> internally, i.e., tries to update all +available 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. + +=item Update + +only update the selcted packages + +=item Install + +install the selected packages, acts like C<tlmgr install>, i.e., also +installs dependencies. This installing a collection will install +all depending packages, too. + +=item Remove + +removes the selected packages, acts like C<tlmgr remove>, i.e., it will +also remove dependencies of collections (but not dependencies of normal +packages). + +=item Backup + +makes a backup of the selected packages, acts like C<tlmgr backup>. This +action needs the options B<backupdir> set (see Options -> General). + +=back + +Finally, the status area at the bottom of the window gives additional +information what is going on. + + +=head2 the old (v1) GUI + +For the time being the first GUI written for C<tlmgr> is still included +and available via <tlmgr gui-old>. Note that there is no development +of this GUI anymore, so at some point it might stop to actually work, +or even get removed from the packages. + =head1 MACHINE-READABLE OUTPUT Given the C<--machine-readable> option, C<tlmgr> writes to stdout in the |