diff options
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/doc.html | 26 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.1 | 190 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.pdf | bin | 44207 -> 44517 bytes |
3 files changed, 101 insertions, 115 deletions
diff --git a/Master/doc.html b/Master/doc.html index 09576dc305a..0c77416c0d9 100644 --- a/Master/doc.html +++ b/Master/doc.html @@ -1,15 +1,10 @@ <html> <body> -<h1>TeX Live documentation</h2> +<h1>TeX Live documentation</h1> -<a name="packagedoc"></a> -<h2>1. Package documentation</h2> - -<p>This section lists links to all HTML and PDF files for packages (in -the <a href="texmf/">texmf</a> and <a href="texmf-dist/">texmf-dist</a> -directories), sorted by package name. - -<p><a href="#guidedoc">Jump to guide documentation</a>. +<p>This document lists links to all HTML and PDF files for packages and guides +contained in TeX Live (in the <a href="texmf/">texmf</a> and <a +href="texmf-dist/">texmf-dist</a> directories), sorted by package name.</p> <ol> <li><b><a href="texmf-dist/doc/amstex/base">amstex/base</a>:</b><small> @@ -4402,6 +4397,7 @@ directories), sorted by package name. <a href="texmf-dist/doc/latex/oberdiek/kvsetkeys.pdf">kvsetkeys.pdf</a> <a href="texmf-dist/doc/latex/oberdiek/letltxmacro.pdf">letltxmacro.pdf</a> <a href="texmf-dist/doc/latex/oberdiek/listingsutf8.pdf">listingsutf8.pdf</a> + <a href="texmf-dist/doc/latex/oberdiek/ltxcmds.pdf">ltxcmds.pdf</a> <a href="texmf-dist/doc/latex/oberdiek/luacolor.pdf">luacolor.pdf</a> <a href="texmf-dist/doc/latex/oberdiek/luatex.pdf">luatex.pdf</a> <a href="texmf-dist/doc/latex/oberdiek/magicnum.pdf">magicnum.pdf</a> @@ -6729,17 +6725,5 @@ directories), sorted by package name. </ol> -<a name="guidedoc"></a> -<h2>2. Guide documentation</h2> - -<p>This section lists links to all guides, that is, packages consisting -only of documentation (in the <a href="texmf-doc/">texmf-doc</a> -directory), sorted by language. - -<p><a href="#packagedoc">Jump to package documentation</a>. - -<p>Languages: -<ul> -</ul> <hr> </body></html> diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index 5501feaa3eb..7d6f8bee2b9 100644 --- a/Master/texmf/doc/man/man1/tlmgr.1 +++ b/Master/texmf/doc/man/man1/tlmgr.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "TLMGR 1" -.TH TLMGR 1 "2009-09-05" "perl v5.8.8" "User Contributed Perl Documentation" +.TH TLMGR 1 "2009-09-06" "perl v5.8.8" "User Contributed Perl Documentation" .SH "NAME" tlmgr \- the TeX Live Manager .SH "SYNOPSIS" @@ -138,9 +138,7 @@ tlmgr [\fIoption\fR]... \fIaction\fR [\fIoption\fR]... [\fIoperand\fR]... .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBtlmgr\fR manages an existing TeX Live installation, both packages and -configuration options. It performs many of the same actions as -\&\fBtexconfig\fR(1), and more besides. (\f(CW\*(C`texconfig\*(C'\fR continues to be -included and supported, but \f(CW\*(C`tlmgr\*(C'\fR is now preferred.) +configuration options. .PP The most up-to-date version of this documentation is available at <http://tug.org/texlive/tlmgr.html>, along with procedures for updating @@ -262,34 +260,35 @@ at the installation source. Either \f(CW\*(C`\-\-all\*(C'\fR or at least one \f must be specified. Options: .IP "\fB\-\-all\fR" 4 .IX Item "--all" -Update all installed packages except for \f(CW\*(C`tlmgr\*(C'\fR itself. Thus, if updates -to \f(CW\*(C`tlmgr\*(C'\fR itself are present, this will simply give an error, unless also -the option \f(CW\*(C`\-\-force\*(C'\fR or \f(CW\*(C`\-\-self\*(C'\fR is given. (See below.) +Update all installed packages except for \f(CW\*(C`tlmgr\*(C'\fR itself. Thus, if +updates to \f(CW\*(C`tlmgr\*(C'\fR itself are present, this will simply give an error, +unless also the option \f(CW\*(C`\-\-force\*(C'\fR or \f(CW\*(C`\-\-self\*(C'\fR is given. (See below.) .Sp In addition to updating the installed packages, during the update of a collection the local installation is (by default) synchronized to the status of the collection on the server, for both additions and removals. .Sp -Specifically, if a package has been removed on the server (and thus has -also been removed from the respective collection), \f(CW\*(C`tlmgr\*(C'\fR will remove the -package also on the local installation. This is called ``auto\-remove'' -and is announced as such when using the option \f(CW\*(C`\-\-list\*(C'\fR. This -auto-removal can be suppressed using the option \f(CW\*(C`\-\-no\-auto\-remove\*(C'\fR. +This means that if a package has been removed on the server (and thus +has also been removed from the respective collection), \f(CW\*(C`tlmgr\*(C'\fR will +remove the package in the local installation. This is called +``auto\-remove'' and is announced as such when using the option +\&\f(CW\*(C`\-\-list\*(C'\fR. This auto-removal can be suppressed using the option +\&\f(CW\*(C`\-\-no\-auto\-remove\*(C'\fR. .Sp -Analogously, if a package has been added to an installed collection on -the server, it will be added to the local installation. This is called -``auto\-install'' and is announced as such when using the option -\&\f(CW\*(C`\-\-list\*(C'\fR. This auto-installation can be suppressed using the option -\&\f(CW\*(C`\-\-no\-auto\-install\*(C'\fR. +Analogously, if a package has been added to a collection on the server +that is also installed locally, it will be added to the local +installation. This is called ``auto\-install'' and is announced as such +when using the option \f(CW\*(C`\-\-list\*(C'\fR. This auto-installation can be +suppressed using the option \f(CW\*(C`\-\-no\-auto\-install\*(C'\fR. .Sp An exception to the collection dependency checks (including the auto-installation of packages just mentioned) are those that have been -forcibly removed by you (see the \fBremove\fR action, \f(CW\*(C`\-\-force\*(C'\fR option). -To reinstall any such forcibly removed packages use -\&\f(CW\*(C`\-\-reinstall\-forcibly\-removed\*(C'\fR. +``forcibly removed'' by you, that is, you called \f(CW\*(C`tlmgr remove \-\-force\*(C'\fR +on them. (See the \f(CW\*(C`remove\*(C'\fR action documentation.) To reinstall any +such forcibly removed packages use \f(CW\*(C`\-\-reinstall\-forcibly\-removed\*(C'\fR. .Sp -If you want to exclude some packages from being updated (e.g., due to a slow -link), see the \f(CW\*(C`\-\-exclude\*(C'\fR option below. +If you want to exclude some packages from the current update run (e.g., +due to a slow link), see the \f(CW\*(C`\-\-exclude\*(C'\fR option below. .IP "\fB\-\-self\fR" 4 .IX Item "--self" Update \f(CW\*(C`tlmgr\*(C'\fR itself (that is, the infrastructure packages) if updates @@ -303,17 +302,22 @@ updates. .Sp In short: .Sp -.Vb 3 +.Vb 4 \& tlmgr update --self # update infrastructure only \& tlmgr update --self --all # update infrastructure and all packages \& tlmgr update --force --all # update all packages but *not* infrastructure +\& # ... this last at your own risk, not recommended! .Ve +.IP "\fB\-\-dry\-run\fR" 4 +.IX Item "--dry-run" +Nothing is actually installed; instead, the actions to be performed are +written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR. .IP "\fB\-\-list\fR [\fIpkg\fR]" 4 .IX Item "--list [pkg]" Concisely list the packages which would be updated, newly installed, or -removed, without actually changing anything. If no package is given -acts like \f(CW\*(C`\-\-list \-\-all\*(C'\fR, otherwise lists only updates to the packages -given as arguments (and its dependencies). +removed, without actually changing anything. If no package is given, +this acts like \f(CW\*(C`\-\-list \-\-all\*(C'\fR, otherwise it lists only updates to the +packages given as arguments (and its dependencies). .IP "\fB\-\-exclude\fR \fIpkg\fR" 4 .IX Item "--exclude pkg" Exclude \fIpkg\fR from the update process. If this option is given more @@ -327,34 +331,28 @@ its related architecture-specific packages \fIpkg.ARCH\fR. For example, .Ve .Sp will not update \f(CW\*(C`a2ping\*(C'\fR, \f(CW\*(C`a2ping.i386\-linux\*(C'\fR, or -any other \f(CW\*(C`a2ping.\*(C'\fR\fI\s-1ARCH\s0\fRpackage. +any other \f(CW\*(C`a2ping.\*(C'\fR\fI\s-1ARCH\s0\fR package. .Sp If this option specifies a package that would otherwise be a candidate for auto\-installation, auto\-removal, or reinstallation of a forcibly removed package, \f(CW\*(C`tlmgr\*(C'\fR quits with an error message. Excludes are not supported in these circumstances. -.IP "\fB\-\-dry\-run\fR" 4 -.IX Item "--dry-run" -Nothing is actually installed; instead, the actions to be performed are -written to the terminal. This is a more detailed report than \f(CW\*(C`\-\-list\*(C'\fR. -.IP "\fB\-\-force\fR" 4 -.IX Item "--force" -Force update of normal packages, without updating \f(CW\*(C`tlmgr\*(C'\fR itself -(unless the \f(CW\*(C`\-\-self\*(C'\fR option is also given). Not recommended. -.Sp -Also, \f(CW\*(C`update \-\-list\*(C'\fR is still performed regardless of this option. -.IP "\fB\-\-no\-auto\-remove\fR" 4 -.IX Item "--no-auto-remove" +.IP "\fB\-\-no\-auto\-remove\fR [\fIpkg\fR]..." 4 +.IX Item "--no-auto-remove [pkg]..." Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR tries to remove packages which have -disappeared on the server when called with \f(CW\*(C`\-\-all\*(C'\fR, as described -above. This prevents any such removals. -.IP "\fB\-\-no\-auto\-install\fR" 4 -.IX Item "--no-auto-install" -Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR will install packages which are -new on the server when called with \f(CW\*(C`\-\-all\*(C'\fR. This prevents any such -automatic installation. Note that after this the packages that -would have been auto-installed will be considered as -forcibly removed. Actually, if `foobar' is the only new package on +disappeared on the server, as described above under \f(CW\*(C`\-\-all\*(C'\fR. This +option prevents any such removals, either for all packages (with +\&\f(CW\*(C`\-\-all\*(C'\fR), or the given \fIpkg\fR names. +.IP "\fB\-\-no\-auto\-install\fR [\fIpkg\fR]..." 4 +.IX Item "--no-auto-install [pkg]..." +Under normal circumstances \f(CW\*(C`tlmgr\*(C'\fR will install packages which are new +on the server, as descrbed above under \f(CW\*(C`\-\-all\*(C'\fR. This option prevents +any such automatic installation, either for all packages (with +\&\f(CW\*(C`\-\-all\*(C'\fR), or the given \fIpkg\fR names. +.Sp +Furthermore, after the \f(CW\*(C`tlmgr\*(C'\fR run using this has finished, the +packages that would have been auto-installed \fIwill be considered as +forcibly removed\fR. So, if \f(CW\*(C`foobar\*(C'\fR is the only new package on the server, then .Sp .Vb 1 @@ -375,14 +373,12 @@ been forcibly removed by the user; that is, removed with \f(CW\*(C`remove during an earlier update. .Sp This option makes \f(CW\*(C`tlmgr\*(C'\fR ignore the forcible removals and re-install -all such packages. This can be used to synchronize an installation with -the server's idea of what is available by calling +all such packages. This can be used to completely synchronize an +installation with the server's idea of what is available: .Sp .Vb 1 \& tlmgr update --reinstall-forcibly-removed --all .Ve -.Sp -This option only works in conjunction with \f(CW\*(C`\-\-all\*(C'\fR. .IP "\fB\-\-backup\fR and \fB\-\-backupdir\fR \fIdirectory\fR" 4 .IX Item "--backup and --backupdir directory" These two options control the creation of backups of packages \fIbefore\fR @@ -413,6 +409,12 @@ suppresses this behavior. .IP "\fB\-\-no\-depends\-at\-all\fR" 4 .IX Item "--no-depends-at-all" See above under \fBinstall\fR (and beware). +.IP "\fB\-\-force\fR" 4 +.IX Item "--force" +Force update of normal packages, without updating \f(CW\*(C`tlmgr\*(C'\fR itself +(unless the \f(CW\*(C`\-\-self\*(C'\fR option is also given). Not recommended. +.Sp +Also, \f(CW\*(C`update \-\-list\*(C'\fR is still performed regardless of this option. .PP If the package on the server is older than the package already installed (e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not @@ -581,46 +583,6 @@ configuration files, path settings, and more. .PP This option to \f(CW\*(C`tlmgr\*(C'\fR mimics the \f(CW\*(C`texconfig conf\*(C'\fR call, but works on all supported platforms. -.Sh "path [\-\-w32mode=user|admin] [add|remove]" -.IX Subsection "path [--w32mode=user|admin] [add|remove]" -On Unix adds or removes symlinks for binaries, man pages, and info pages -in the directories specified by the respective options (see above). -.PP -On Windows, the registry part where the binary directory is -added or removed is determined in the following way: -.PP -If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is not given, -the setting \fIw32_multi_user\fR determines the location (i.e., if it is -on then the system path, otherwise the user path is changed). -.PP -If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given, this -option determines the path to be adjusted. -.PP -If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR -is not given, and the setting \fIw32_multi_user\fR is off, the user path -is changed, while if the setting \fIw32_multi_user\fR is on, a warning is -issued that the caller does not have enough privileges. -.PP -If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR -is given, it must be \fBuser\fR and the user path will be adjusted. If a -user without admin rights uses the option \f(CW\*(C`\-\-w32mode admin\*(C'\fR a warning -is issued that the caller does not have enough provileges. -.Sh "postaction [\-\-w32mode=user|admin] [\-\-fileassocmode=1|2] [\-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]" -.IX Subsection "postaction [--w32mode=user|admin] [--fileassocmode=1|2] [-all] [install|remove] [shortcut|fileassoc|script] [<package> <package> ...]" -Carry out the postaction \f(CW\*(C`shortcut\*(C'\fR, \f(CW\*(C`fileassoc\*(C'\fR, or \f(CW\*(C`script\*(C'\fR as -given as second obligatory argument in install or remove mode (first -obligatory argument), for either the packages given on the command line, -or for all if \f(CW\*(C`\-all\*(C'\fR is given. -.PP -The option \f(CW\*(C`\-\-w32mode\*(C'\fR is \f(CW\*(C`user\*(C'\fR all actions will only carried out in -the user accessible parts of the registry/filesystem, while the \f(CW\*(C`admin\*(C'\fR -mode selects the system wide parts of the registry for the file associations. -Note that if you do not have enough permissions using \f(CW\*(C`\-\-w32mode=admin\*(C'\fR -will not succeed. -.PP -For the postaction \f(CW\*(C`fileassoc\*(C'\fR the mode can be set with \f(CW\*(C`\-\-fileassocmode\*(C'\fR. -If it is set to 1, only new assocations are added, if it is set to 2, -all associations are set to the TeX Live programs. .Sh "paper" .IX Subsection "paper" .IP "\fBpaper [a4|letter]\fR" 4 @@ -736,6 +698,46 @@ Options: .IX Item "--use-svn" Use the output of \f(CW\*(C`svn status\*(C'\fR instead of listing the files; for checking the \s-1TL\s0 development repository. +.Sh "path [\-\-w32mode=user|admin] [add|remove]" +.IX Subsection "path [--w32mode=user|admin] [add|remove]" +On Unix adds or removes symlinks for binaries, man pages, and info pages +in the directories specified by the respective options (see above). +.PP +On Windows, the registry part where the binary directory is +added or removed is determined in the following way: +.PP +If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is not given, +the setting \fIw32_multi_user\fR determines the location (i.e., if it is +on then the system path, otherwise the user path is changed). +.PP +If the user has admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given, this +option determines the path to be adjusted. +.PP +If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR +is not given, and the setting \fIw32_multi_user\fR is off, the user path +is changed, while if the setting \fIw32_multi_user\fR is on, a warning is +issued that the caller does not have enough privileges. +.PP +If the user does not have admin rights, and the option \f(CW\*(C`\-\-w32mode\*(C'\fR +is given, it must be \fBuser\fR and the user path will be adjusted. If a +user without admin rights uses the option \f(CW\*(C`\-\-w32mode admin\*(C'\fR a warning +is issued that the caller does not have enough provileges. +.Sh "postaction [\-\-w32mode=user|admin] [\-\-fileassocmode=1|2] [\-\-all] [install|remove] [shortcut|fileassoc|script] [\fIpkg\fP]..." +.IX Subsection "postaction [--w32mode=user|admin] [--fileassocmode=1|2] [--all] [install|remove] [shortcut|fileassoc|script] [pkg]..." +Carry out the postaction \f(CW\*(C`shortcut\*(C'\fR, \f(CW\*(C`fileassoc\*(C'\fR, or \f(CW\*(C`script\*(C'\fR given +as the second required argument in install or remove mode (which is the +first required argument), for either the packages given on the command +line, or for all if \f(CW\*(C`\-\-all\*(C'\fR is given. +.PP +The option \f(CW\*(C`\-\-w32mode\*(C'\fR is \f(CW\*(C`user\*(C'\fR all actions will only carried out in +the user accessible parts of the registry/filesystem, while the \f(CW\*(C`admin\*(C'\fR +mode selects the system wide parts of the registry for the file +associations. Note that if you do not have enough permissions using +\&\f(CW\*(C`\-\-w32mode=admin\*(C'\fR will not succeed. +.PP +For the postaction \f(CW\*(C`fileassoc\*(C'\fR the mode can be set with +\&\f(CW\*(C`\-\-fileassocmode\*(C'\fR. If it is set to 1, only new assocations are added, +if it is set to 2, all associations are set to the TeX Live programs. .Sh "uninstall" .IX Subsection "uninstall" Uninstalls the entire TeX Live installation. Options: @@ -966,8 +968,8 @@ The estimated remaining time. .IP "\fIesttot\fR" 4 .IX Item "esttot" The estimated total time. -.Sh "option action:" -.IX Subsection "option action:" +.Sh "option action" +.IX Subsection "option action" The output format is as follows: .PP .Vb 1 diff --git a/Master/texmf/doc/man/man1/tlmgr.pdf b/Master/texmf/doc/man/man1/tlmgr.pdf Binary files differindex 365f60b532d..8456d4eebd5 100644 --- a/Master/texmf/doc/man/man1/tlmgr.pdf +++ b/Master/texmf/doc/man/man1/tlmgr.pdf |