diff options
author | Karl Berry <karl@freefriends.org> | 2011-06-24 02:13:52 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2011-06-24 02:13:52 +0000 |
commit | 290f4d257b579455e8e81e1c19c82134ae240f4f (patch) | |
tree | e8eb7609dc9c962e981aa43bdb4e612ad960ff58 /Master/texmf/doc | |
parent | 4800d9d984c75dc7a0ae78f7b95add12a6f5a1d8 (diff) |
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@23121 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc')
-rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.1 | 141 | ||||
-rw-r--r-- | Master/texmf/doc/man/man1/tlmgr.man1.pdf | bin | 66817 -> 66719 bytes |
2 files changed, 67 insertions, 74 deletions
diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1 index 5068f41efcd..29969ab6de5 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 "2011-06-19" "perl v5.12.3" "User Contributed Perl Documentation" +.TH TLMGR 1 "2011-06-23" "perl v5.12.3" "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 @@ -607,13 +607,13 @@ The first form shows the global TeX Live settings currently saved in the \&\s-1TLPDB\s0 with a short description and the \f(CW\*(C`key\*(C'\fR used for changing it in parentheses. .PP -The second form acts like the first, but also shows options which can -be defined but are not currently set to any value. +The second form is similar, but also shows options which can be defined +but are not currently set to any value. .PP In the third form, if \fIvalue\fR is not given, the setting for \fIkey\fR is displayed. If \fIvalue\fR is present, \fIkey\fR is set to \fIvalue\fR. .PP -Possible values for \fIkey\fR are (but see \fBtlmgr option showall\fR for +Possible values for \fIkey\fR are (run \f(CW\*(C`tlmgr option showall\*(C'\fR for the definitive list): .PP .Vb 10 @@ -627,10 +627,10 @@ the definitive list): \& sys_bin (directory to which executables are linked by the path action) \& sys_man (directory to which man pages are linked by the path action) \& sys_info (directory to which Info files are linked by the path action) -\& generate_updmap (call the equivalent of tlmgr generate updmap on changes) -\& desktop_integration (create Start menu shortcuts on Windows) -\& fileassocs (change file associations on Windows) -\& multiuser (install for all users on Windows) +\& generate_updmap (run the equivalent of tlmgr generate updmap on changes) +\& desktop_integration (Windows\-only: create Start menu shortcuts) +\& fileassocs (Windows\-only: change file associations) +\& multiuser (Windows\-only: install for all users) .Ve .PP One common use of \f(CW\*(C`option\*(C'\fR is to permanently change the installation to @@ -642,26 +642,24 @@ get further updates from the Internet, after originally installing from .Ve .PP The \f(CW\*(C`install\-tl\*(C'\fR documentation has more information about the possible -values for repository. +values for \f(CW\*(C`repository\*(C'\fR. (For backward compatibility, \f(CW\*(C`location\*(C'\fR can +be used as alternative name for \f(CW\*(C`repository\*(C'\fR.) .PP -To keep backward compatibility \f(CW\*(C`location\*(C'\fR can be used as alternative -name for \f(CW\*(C`repository\*(C'\fR. +If \f(CW\*(C`formats\*(C'\fR is set (this is the default), then formats are regenerated +when either the engine or the format files have changed. Disable this +only when you know what you are doing. .PP -If the \f(CW\*(C`formats\*(C'\fR is set (this is the default), then formats are -regenerated when either the engine or the format files have changed. -Disable that only when you know what you are doing. +The \f(CW\*(C`postcode\*(C'\fR option controls execution of per-package +postinstallation action code. It is set by default, and again disabling +is not likely to be of interest except perhaps to developers. .PP -The \f(CW\*(C`postcode\*(C'\fR options controls execution of package shipped postinstallation -action code. By default enabled. +The \f(CW\*(C`docfiles\*(C'\fR and \f(CW\*(C`srcfiles\*(C'\fR options control the installation of +their respective files of a package. By default both are enabled. This +can be disabled if disk space is (very) limited. .PP -The \f(CW\*(C`docfiles\*(C'\fR and \f(CW\*(C`srcfiles\*(C'\fR options control the installations of -the respective files of a package. By default the source of packages as -well as the documentation is installed. This can be disabled in case -of disk space constraints. -.PP -The two options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determine defaults for -the \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR actions. These three actions -need a directory to write to or read from the backups. If +The options \f(CW\*(C`autobackup\*(C'\fR and \f(CW\*(C`backupdir\*(C'\fR determine the defaults for +the actions \f(CW\*(C`update\*(C'\fR, \f(CW\*(C`backup\*(C'\fR and \f(CW\*(C`restore\*(C'\fR. These three actions +need a directory in which to read or write the backups. If \&\f(CW\*(C`\-\-backupdir\*(C'\fR is not specified on the command line, the \f(CW\*(C`backupdir\*(C'\fR option value is used (if set). .PP @@ -672,50 +670,36 @@ number of backups to keep. Thus, backups are disabled if the value is 0. In the \f(CW\*(C`\-\-clean\*(C'\fR mode of the \f(CW\*(C`backup\*(C'\fR action this option also specifies the number to be kept. .PP -To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\*(C`\-1\*(C'\fR on the command line, use +To setup \f(CW\*(C`autobackup\*(C'\fR to \f(CW\*(C`\-1\*(C'\fR on the command line, use either: .PP .Vb 1 \& tlmgr option autobackup infty .Ve .PP -Or you can use: +or: .PP .Vb 1 \& tlmgr option \-\- autobackup \-1 .Ve .PP -The \f(CW\*(C`\-\-\*(C'\fR avoids having the \f(CW\*(C`\-1\*(C'\fR treated as an option. (For most -programs, \f(CW\*(C`\-\-\*(C'\fR stops parsing for arguments at the point where it -appears; this is a general feature of option parsing.) +The \f(CW\*(C`\-\-\*(C'\fR avoids having the \f(CW\*(C`\-1\*(C'\fR treated as an option. (\f(CW\*(C`\-\-\*(C'\fR stops +parsing for options at the point where it appears; this is a general +feature across most Unix programs.) .PP -The \f(CW\*(C`sys_*\*(C'\fR options are used on Unix like systems to control the -generation of links for binary files, info files and man pages. See -the action \f(CW\*(C`path\*(C'\fR for details. +The \f(CW\*(C`sys_bin\*(C'\fR, \f(CW\*(C`sys_man\*(C'\fR, and \f(CW\*(C`sys_info\*(C'\fR options are used on +Unix-like systems to control the generation of links for executables, +info files and man pages. See the \f(CW\*(C`path\*(C'\fR action for details. .PP -By default \f(CW\*(C`tlmgr\*(C'\fR does not call the equivalent of +For the <generate_updmap> option, see the \f(CW\*(C`updmap\*(C'\fR section in +generate. .PP -.Vb 1 -\& tlmgr generate updmap -.Ve -.PP -to allow for local modifications. But if you keep all your local -modifications in \f(CW\*(C`updmap\-local.cfg\*(C'\fR, then setting the option -\&\f(CW\*(C`generate_updmap\*(C'\fR will make \f(CW\*(C`tlmgr\*(C'\fR to recreate the \f(CW\*(C`updmap.cfg\*(C'\fR -file from the installed packages and \f(CW\*(C`updmap\-local.cfg\*(C'\fR every time -a change occurs. Of course, if you make manual changes to -\&\f(CW\*(C`updmap\-local.cfg\*(C'\fR you need to call \f(CW\*(C`tlmgr generate updmap\*(C'\fR manually. -This option is for those who strictly use only the \f(CW\*(C`updmap\-local.cfg\*(C'\fR -file for local adaptions, and not calls to \f(CW\*(C`updmap \-\-enableMap\*(C'\fR etc. -See \*(L"generate updmap\*(R" action's description for details. -.PP -The last three options control behaviour on Windows installations. -If \f(CW\*(C`desktop_integration\*(C'\fR is set, then some packages will install links -in a sub folder in the Start menu. These links are for the \f(CW\*(C`tlmgr gui\*(C'\fR, -documentation etc. If \f(CW\*(C`fileassocs\*(C'\fR is set then the default for -updating/adding file associations is set. Please see \f(CW\*(C`postaction\*(C'\fR action -for details on file associations handling. If \f(CW\*(C`multiuser\*(C'\fR is set, then -adaptions to the registry and the menus are done for all users on the -system. All three options are on by default. +The last three options control behaviour on Windows installations. If +\&\f(CW\*(C`desktop_integration\*(C'\fR is set, then some packages will install items in +a sub-folder of the Start menu for \f(CW\*(C`tlmgr gui\*(C'\fR, documentation, etc. If +\&\f(CW\*(C`fileassocs\*(C'\fR is set, Windows file associations are made (see also the +\&\f(CW\*(C`postaction\*(C'\fR action). Finally, if \f(CW\*(C`multiuser\*(C'\fR is set, then adaptions +to the registry and the menus are done for all users on the system +instead of only the current user. All three options are on by default. .SS "conf [texmf|tlmgr [\fIkey\fP [\fIvalue\fP]]]" .IX Subsection "conf [texmf|tlmgr [key [value]]]" With only the \f(CW\*(C`conf\*(C'\fR, show general configuration information for TeX @@ -995,15 +979,16 @@ 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. +If the option \f(CW\*(C`\-\-w32mode\*(C'\fR is given the value \f(CW\*(C`user\*(C'\fR, all actions will +only be carried out in the user-accessible parts of the +registry/filesystem, while the value \f(CW\*(C`admin\*(C'\fR selects the system-wide +parts of the registry for the file associations. 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 associations are added; -if it is set to 2, all associations are set to the TeX Live programs. +\&\f(CW\*(C`\-\-fileassocmode\*(C'\fR specifies the action for file associations. If it is +set to 1 (the default), only new associations are added; if it is set to +2, all associations are set to the TeX Live programs. (See also +\&\f(CW\*(C`option fileassocs\*(C'\fR.) .SS "uninstall" .IX Subsection "uninstall" Uninstalls the entire TeX Live installation. Options: @@ -1033,21 +1018,26 @@ respective files: it recreates them from scratch. For \f(CW\*(C`fmtutil\*(C'\fR and the language files, this is normal, and both the TeX Live installer and \f(CW\*(C`tlmgr\*(C'\fR routinely call \f(CW\*(C`generate\*(C'\fR for them. .PP -For \f(CW\*(C`updmap\*(C'\fR, however, \f(CW\*(C`tlmgr\*(C'\fR does \fInot\fR use -\&\f(CW\*(C`generate\*(C'\fR, because the result would 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. The \f(CW\*(C`generate\*(C'\fR action only incorporates -the changes in the \f(CW\*(C`\-\-localcfg\*(C'\fR file mentioned below. Furthermore, -\&\f(CW\*(C`tlmgr\*(C'\fR updates and maintains the final \f(CW\*(C`updmap.cfg\*(C'\fR in -\&\f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR (while the other files are in \f(CW\*(C`TEXMFSYSVAR\*(C'\fR), because -that is the location that \f(CW\*(C`updmap\-sys\*(C'\fR (via \f(CW\*(C`tcfmgr\*(C'\fR) uses. +For \f(CW\*(C`updmap\*(C'\fR, however, \f(CW\*(C`tlmgr\*(C'\fR does \fInot\fR use \f(CW\*(C`generate\*(C'\fR by default, +because the result would 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, which has been the standard method for adding fonts to TeX +installations for years. Rather, the \f(CW\*(C`generate\*(C'\fR action only +incorporates the changes in the \f(CW\*(C`\-\-localcfg\*(C'\fR file mentioned below. .PP Notwithstanding the above, if you only use the fonts and font packages within TeX Live, and rigorously maintain your local fonts (if any) using \&\f(CW\*(C`updmap\-local.cfg\*(C'\fR, there is nothing wrong with using \f(CW\*(C`generate updmap\*(C'\fR. It can be helpful in moving from release to release, especially. We use it ourselves to generate the \f(CW\*(C`updmap.cfg\*(C'\fR file in -the live source repository. +the live source repository. If you want to commit yourself to using +\&\f(CW\*(C`updmap\-local.cfg\*(C'\fR, you can set the \f(CW\*(C`generate_updmap\*(C'\fR option and +\&\f(CW\*(C`tlmgr\*(C'\fR will run \f(CW\*(C`generate updmap\*(C'\fR for you on update. +.PP +In any case, \f(CW\*(C`tlmgr\*(C'\fR updates and maintains the final \f(CW\*(C`updmap.cfg\*(C'\fR in +\&\f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR (while the other generated files are in +\&\f(CW\*(C`TEXMFSYSVAR\*(C'\fR), because that is the location that \f(CW\*(C`updmap\-sys\*(C'\fR (via +\&\f(CW\*(C`tcfmgr\*(C'\fR) historically uses. .PP In more detail: \f(CW\*(C`generate\*(C'\fR remakes any of the five config files \&\f(CW\*(C`language.dat\*(C'\fR, \f(CW\*(C`language.def\*(C'\fR, \f(CW\*(C`language.dat.lua\*(C'\fR, \f(CW\*(C`fmtutil.cnf\*(C'\fR, @@ -1061,7 +1051,8 @@ directories. If they are present, the final file is made by starting with the main file, omitting any entries that the local file specifies to be disabled, and finally appending the local file. .PP -Local files specify entries to be disabled with a comment line like this: +Local files specify entries to be disabled with a comment line, namely +one of these: .PP .Vb 3 \& #!NAME @@ -1149,7 +1140,9 @@ The respective locations are as follows: Final repetition: as explained above, \f(CW\*(C`tlmgr\*(C'\fR does \fInot\fR use \&\f(CW\*(C`generate updmap\*(C'\fR for font map files. Therefore, if you want to make use of \f(CW\*(C`updmap\-local.cfg\*(C'\fR, you must run \f(CW\*(C`tlmgr generate updmap\*(C'\fR -and \f(CW\*(C`updmap\-sys\*(C'\fR yourself after making any local changes. +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" A small subset of the command line options can be set in a config file diff --git a/Master/texmf/doc/man/man1/tlmgr.man1.pdf b/Master/texmf/doc/man/man1/tlmgr.man1.pdf Binary files differindex 553745671de..49ff2597c65 100644 --- a/Master/texmf/doc/man/man1/tlmgr.man1.pdf +++ b/Master/texmf/doc/man/man1/tlmgr.man1.pdf |