diff options
| -rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.1 | 286 |
1 files changed, 150 insertions, 136 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index 747fed1eead..2e85b96eccd 100644 --- a/Master/texmf/doc/man/man1/tlmgr.1 +++ b/Master/texmf/doc/man/man1/tlmgr.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05) .\" .\" Standard preamble: .\" ======================================================================== @@ -48,22 +48,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,94 +132,126 @@ .\" ======================================================================== .\" .IX Title "TLMGR 1" -.TH TLMGR 1 "2008-05-05" "perl v5.8.8" "User Contributed Perl Documentation" +.TH TLMGR 1 "2008-05-07" "perl v5.10.0" "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 +.nh .SH "NAME" tlmgr \- the TeX Live Manager .SH "SYNOPSIS" .IX Header "SYNOPSIS" -tlmgr [\s-1OPTIONS\s0] \s-1ACTION\s0 ... -.SH "ACTION" -.IX Header "ACTION" +tlmgr [\fIoptions\fR] \fIaction\fR [\fIoption\fR]... [\fIoperand\fR]... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBtlmgr\fR manages an existing TeX Live installation, both packages and +options. +.SH "OPTIONS" +.IX Header "OPTIONS" +The following options have to be given \fIbefore\fR you specify the action. +.IP "\fB\-\-location\fR \fIlocation\fR" 8 +.IX Item "--location location" +Specifies the location from which packages should be installed or +updated, overriding the location found in the installation's \s-1TLPDB\s0. +.IP "\fB\-\-gui\fR" 8 +.IX Item "--gui" +Instead of starting the \s-1GUI\s0 via the \fBgui\fR action, you can also give this +option together with an action from above and will be brought directly +into the respective screen of the \s-1GUI\s0. So calling +.Sp +.Vb 1 +\& tlmgr \-\-gui update +.Ve +.Sp +will bring you directly into the update screen. +.IP "\fB\-\-netarchive\fR \fIdir\fR" 8 +.IX Item "--netarchive dir" +Overrides the default settings for netarchive. Should be used with care. +.IP "\fB\-\-diskarchive\fR \fIdir\fR" 8 +.IX Item "--diskarchive dir" +Overrides the default settings for diskarchive. Should be used with care. +.PP +The standard options \fB\-\-help/\-h/\-?\fR and \fB\-\-debug\fR are also accepted. +.SH "ACTIONS" +.IX Header "ACTIONS" .IP "\fBhelp\fR" 8 .IX Item "help" Gives this help page. .IP "\fBgui\fR" 8 .IX Item "gui" -Starts the \s-1GUI\s0. Currently not all options of the cmd line version are -supported in the \s-1GUI\s0. -.IP "\fBinstall [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8 -.IX Item "install [options] pkg1 [pkg2 [pkg3 ...]]" -Install all packages given on the cmdline. By default this installs all -dependencies, too. See below for the option \fB\-\-no\-depends\fR. -.Sp -\&\fBSupported options\fR +Run using a graphical interface. +.IP "\fBinstall [\f(BIoption\fB]... \f(BIpkg\fB...\fR" 8 +.IX Item "install [option]... pkg..." +Install all \fIpkg\fRs given on the command line. By default this installs +all packages that the given \fIpkg\fRs are dependent on, also. Options: .RS 8 -.IP "\fB\-\-no\-depends\fR" 16 +.IP "\fB\-\-no\-depends\fR" 8 .IX Item "--no-depends" -Do not install dependencies. If this option is not given installing -a package will check that all dependencies of this package are fulfilled. -.IP "\fB\-\-dry\-run\fR" 16 +Do not install dependencies. Bydefault, installing a package ensures +that all dependencies of this package are fulfilled. +.IP "\fB\-\-dry\-run\fR" 8 .IX Item "--dry-run" -Enables the chicken -mode, i.e., nothing is actually installed but the actions to be performed -are written to the terminal. +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. .RE .RS 8 .RE -.IP "\fBupdate [options]\fR" 8 -.IX Item "update [options]" -Update all packages if newer ones are available -.Sp -\&\fBSupported options\fR +.IP "\fBupdate [\f(BIoption\fB] [pkg [pkg ...]]\fR" 8 +.IX Item "update [option] [pkg [pkg ...]]" +Updates the packages given as arguments to the latest version available +at the installation source. Options: .RS 8 -.IP "\fB\-\-dry\-run\fR" 16 +.IP "\fB\-\-all\fR" 8 +.IX Item "--all" +Update all package. +.IP "\fB\-\-dry\-run\fR" 8 .IX Item "--dry-run" -Enables the chicken -mode, i.e., nothing is actually installed but the actions to be performed -are written to the terminal. +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. .RE .RS 8 .RE -.IP "\fBremove [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8 -.IX Item "remove [options] pkg1 [pkg2 [pkg3 ...]]" -Remove all packages given on the cmdline. Removing a collection will -remove all dependencies, too, unless with option \fB\-\-no\-depends\fR. +.IP "\fBremove [\f(BIoption\fB]... \f(BIpkg\fB...\fR" 8 +.IX Item "remove [option]... pkg..." +Remove all \fIpkg\fRs given on the command line. Removing a collection +will remove all package dependencies (but not collection dependencies) +in that collection, unless \f(CW\*(C`\-\-no\-depends\*(C'\fR is specified. However, when +removing a package, dependencies are never removed. .Sp Removing a package which is referenced as a dependency in another -collection or scheme will not succeed unless the \fB\-\-force\fR option is given. +collection or scheme is disallowed, unless \f(CW\*(C`\-\-force\*(C'\fR is specified. .Sp -\&\fBSupported options\fR +Options: .RS 8 -.IP "\fB\-\-no\-depends\fR" 16 +.IP "\fB\-\-no\-depends\fR" 8 .IX Item "--no-depends" -Do not remove depending packages. -.IP "\fB\-\-force\fR" 16 +Do not remove dependent packages. +.IP "\fB\-\-force\fR" 8 .IX Item "--force" -When removing a package or collection would invalidate a dependency -of another collection/scheme, the package will not be removed and -a warning issued. With this options the package will be removed -unconditionally. Use with care. -.IP "\fB\-\-dry\-run\fR" 16 +By default, when removing a package or collection would invalidate a +dependency of another collection/scheme, the package will not be removed +and a warning issued. With this option, the package will be removed +unconditionally. Use with care. +.IP "\fB\-\-dry\-run\fR" 8 .IX Item "--dry-run" -Enables the chicken -mode, i.e., nothing is actually removed but the actions to be performed -are written to the terminal. +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. .RE .RS 8 .RE -.IP "\fBdefault show\fR" 8 -.IX Item "default show" +.IP "\fBoption [show]\fR" 8 +.IX Item "option [show]" .PD 0 -.ie n .IP "\fBdefault \fB""key""\fB [\f(BI""value""\fB]\fR" 8 -.el .IP "\fBdefault \f(CBkey\fB [\f(CBvalue\fB]\fR" 8 -.IX Item "default key [value]" +.IP "\fBoption \f(BIkey\fB [\f(BIvalue\fB]\fR" 8 +.IX Item "option key [value]" .PD -The first form shows the default settings as saved in the TeX Live Database. +The first form shows the settings currently saved in the \s-1TLPDB\s0. .Sp -In the second form if the \f(CW\*(C`value\*(C'\fR is missing the setting is showed, while -with \f(CW\*(C`value\*(C'\fR present the setting is set to \f(CW\*(C`value\*(C'\fR. +In the second form, if \fIvalue\fR is missing the setting for \fIkey\fR is +displayed. If \fIvalue\fR is present, \fIkey\fR is set to \fIvalue\fR. .Sp -Possible values for \f(CW\*(C`key\*(C'\fR are: \f(CW\*(C`location\*(C'\fR (default installation source), +Possible values for \fIkey\fR are: +\&\f(CW\*(C`location\*(C'\fR (default installation source), \&\f(CW\*(C`formats\*(C'\fR (create formats at installation time), \&\f(CW\*(C`docfiles\*(C'\fR (install documentation files), \&\f(CW\*(C`srcfiles\*(C'\fR (install source files). @@ -229,59 +264,54 @@ Possible values for \f(CW\*(C`key\*(C'\fR are: \f(CW\*(C`location\*(C'\fR (defau .IX Item "[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]" .PD Configures the system wide paper settings, either for all programs in -one go, or for the given program on the command line. +one go, or just for the specified program. .IP "\fBarch list\fR" 8 .IX Item "arch list" -Prints the list of arch-os available at the default install location. -.IP "\fBarch add [arch [arch [...]]]\fR" 8 -.IX Item "arch add [arch [arch [...]]]" -Adds binaries for the given architectures to the installtion. -.Sp -\&\fBSupported options\fR +Prints the names of the systems available at the default install location. +.IP "\fBarch add \f(BIarch\fB...\fR" 8 +.IX Item "arch add arch..." +Add executables for the specified \fIarch\fRes to the installation. +Options: .RS 8 -.IP "\fB\-\-dry\-run\fR" 16 +.IP "\fB\-\-dry\-run\fR" 8 .IX Item "--dry-run" -For installation and removal of packages, this options enables the chicken -mode, i.e., nothing is actually installed but the actions to be performed -are written to the terminal. -.Sp -Note that for all other type of options but package installation and removal -this options does \fB\s-1NOT\s0\fR work! +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. .RE .RS 8 .RE -.IP "\fBsearch [\-\-file] what\fR" 8 -.IX Item "search [--file] what" -Search the names, short and long descriptions of all locally installed packages -for the given argument (interpreted as regexp). -.Sp -With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere -in the path, and returning each package with the respective hit. -.IP "\fBglobalsearch [\-\-file] what\fR" 8 -.IX Item "globalsearch [--file] what" -Search the names, short and long descriptions of all packages available on -the install media. -.Sp -With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere -in the path, and returning each package with the respective hit. -.IP "\fBshow [pkg [pkg [...]]]\fR" 8 -.IX Item "show [pkg [pkg [...]]]" -Shows for each given package the name, category, installation status, -short and long description. Does search in the remote installation -source for finding the package if it is not installed. +.IP "\fBsearch [\f(BIoption\fB...] \f(BIwhat\fB\fR" 8 +.IX Item "search [option...] what" +By default searches the names, short and long descriptions of all +locally installed packages for the given argument (interpreted as +regexp). Options: +.RS 8 +.IP "\fB\-\-file\fR" 8 +.IX Item "--file" +List all filenames containing \fIwhat\fR. +.IP "\fB\-\-global\fR" 8 +.IX Item "--global" +Search the TeX Live Database of the installation medium, instead of the +local installation. +.RE +.RS 8 +.RE +.IP "\fBshow \f(BIpkg\fB...\fR" 8 +.IX Item "show pkg..." +Shows information about \fIpkg\fR: the name, category, installation status, +short and long description. Searches in the remote installation source +for the package if it is not locally installed. .IP "\fBlist [collections|schemes]\fR" 8 .IX Item "list [collections|schemes]" -Without argument lists all packages available at the default install -location, prefixing those already installed with \*(L"i \*(R". +With no argument, lists all packages available at the default install +location, prefixing those already installed with \f(CW\*(C`i \*(C'\fR. .Sp -With arguments lists only collections or schemes. +With an argument lists only collections or schemes, as requested. .IP "\fBuninstall\fR" 8 .IX Item "uninstall" -Uninstalls the TeX Live installation. -.Sp -\&\fBSupported options\fR +Uninstalls the entire TeX Live installation. Options: .RS 8 -.IP "\fB\-\-force\fR" 16 +.IP "\fB\-\-force\fR" 8 .IX Item "--force" Do not ask for confirmation, remove immediately. .RE @@ -295,50 +325,34 @@ Do not ask for confirmation, remove immediately. .IP "\fBgenerate updmap\fR" 8 .IX Item "generate updmap" .PD -\&\fB\s-1WARNING\s0\fR Using these option will overwrite any user changes done in -the respective files. Please think twice before using it. +\&\fB\s-1WARNING:\s0\fR This action overwrites any user changes made in +the respective files, by regenerating them from scratch. .Sp -These function regenerate the three config files language.dat, fmtutil.cnf, -and updmap.cfg from the information present in the local \s-1TLPDB\s0. If files -language\-local.dat, fmtutil\-local.cnf, or updmap\-local.cfg are present -under \s-1TEMXFLOCAL\s0 in the respective directories stuff there will be -simply merged into the final files. So be careful what to put there. +This is especially questionable with updmap, because the result will be +to disable all maps which have been manually installed (via \f(CW\*(C`updmap\-sys +\&\-\-enable\*(C'\fR), e.g., for proprietary or local fonts. Be sure that's what +you want to do. .Sp -Especially with updmap.cfg this function is dangerous because it will -remove all maps which have been manually enabled (via updmap-sys \-\-enable), -so be careful. +This action regenerates any of the three config files \f(CW\*(C`language.dat\*(C'\fR, +\&\f(CW\*(C`fmtutil.cnf\*(C'\fR, and \f(CW\*(C`updmap.cfg\*(C'\fR from the information present in the +local \s-1TLPDB\s0. If the files \f(CW\*(C`language\-local.dat\*(C'\fR, \f(CW\*(C`fmtutil\-local.cnf\*(C'\fR, +or \f(CW\*(C`updmap\-local.cfg\*(C'\fR are present under \f(CW\*(C`TEXMFLOCAL\*(C'\fR in the respective +directories, their contents will be simply merged into the final files, +with no error checking of any kind. .Sp -\&\fBSupported options\fR +Options: .RS 8 -.ie n .IP """\-\-dest""\fR \fIoutput file" 16 -.el .IP "\f(CW\-\-dest\fR \fIoutput file\fR" 16 +.IP "\fB\-\-dest\fR \fIoutput file\fR" 8 .IX Item "--dest output file" -specifies the output file (defaults to the respective location in \s-1TEXMFSYSVAR\s0). -.ie n .IP """\-\-localcfg""\fR \fIlocal conf file" 16 -.el .IP "\f(CW\-\-localcfg\fR \fIlocal conf file\fR" 16 +specifies the output file (defaults to the respective location in +\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR). +.IP "\fB\-\-localcfg\fR \fIlocal conf file\fR" 8 .IX Item "--localcfg local conf file" -specifies the (optional) local additions (defaults to the respective location -in \s-1TEXMFSYSVAR\s0). +specifies the (optional) local additions (defaults to the respective +location in \f(CW\*(C`TEXMFSYSVAR\*(C'\fR). .RE .RS 8 .RE -.SH "OPTIONS" -.IX Header "OPTIONS" -.IP "\fB\-\-location\fR \fIlocation\fR" 8 -.IX Item "--location location" -Overrides the location as found in the tlpdb of the installation. Specifies -the location from which packages should be installed or updated. -.IP "\fB\-\-netarchive\fR \fIdir\fR" 8 -.IX Item "--netarchive dir" -Overrides the default settings for netarchive. Should be used with care. -.IP "\fB\-\-diskarchive\fR \fIdir\fR" 8 -.IX Item "--diskarchive dir" -Overrides the default settings for diskarchive. Should be used with care. -.PP -The standard options \f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR and \f(CW\*(C`\-\-debug\*(C'\fR are also accepted. -.SH "DESCRIPTION" -.IX Header "DESCRIPTION" -The \fBtlmgr\fR manages an existing TeX Live installation. .SH "AUTHORS AND COPYRIGHT" .IX Header "AUTHORS AND COPYRIGHT" This script and its documentation were written for the TeX Live |