diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.1 | 244 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.man1.pdf | bin | 27485 -> 29946 bytes |
2 files changed, 157 insertions, 87 deletions
diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1 index 55974b03100..7ba623b1159 100644 --- a/Master/texmf-dist/doc/man/man1/install-tl.1 +++ b/Master/texmf-dist/doc/man/man1/install-tl.1 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "INSTALL-TL 1" -.TH INSTALL-TL 1 "2017-04-23" "perl v5.24.1" "User Contributed Perl Documentation" +.TH INSTALL-TL 1 "2017-04-24" "perl v5.24.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 @@ -157,9 +157,9 @@ top-level \fIschemes\fR, each of which is defined as a different set of and a package is what contains actual files. .PP Within the installer, you can choose a scheme, and further customize the -set of collections to install, but not the set of the packages. To do -that, use \f(CW\*(C`tlmgr\*(C'\fR (reference below) after the initial installation is -complete. +set of collections to install, but not the set of the packages. To work +at the package level, use \f(CW\*(C`tlmgr\*(C'\fR (reference just below) after the +initial installation is complete. .PP The default is \f(CW\*(C`scheme\-full\*(C'\fR, which installs everything, and this is highly recommended. @@ -228,7 +228,7 @@ simplified Chinese (zh_CN), and traditional Chinese (zh_TW). Specify the package repository to be used as the source of the installation, either a local directory via \f(CW\*(C`/path/to/directory\*(C'\fR or a \&\f(CW\*(C`file:/\*(C'\fR url, or a network location via a \f(CW\*(C`http://\*(C'\fR, \f(CW\*(C`https://\*(C'\fR, or -\&\f(CW\*(C`ftp://\*(C'\fR url. (No other protocols are supported, and \f(CW\*(C`http://\*(C'\fR may +\&\f(CW\*(C`ftp://\*(C'\fR url. (No other protocols are supported, and \f(CW\*(C`https://\*(C'\fR may not work on all platforms.) .Sp The default is to pick a mirror automatically, using @@ -322,6 +322,11 @@ and will just do the necessary post-install. Be warned that the file manually, and that the only realistic way to maintain this installation is to redo it from time to time. This option is not available via the installer interfaces. \s-1USE AT YOUR OWN RISK.\s0 +.IP "\fB\-init\-from\-profile\fR \fIprofile_file\fR" 4 +.IX Item "-init-from-profile profile_file" +Similar to \fB\-profile\fR (see \*(L"\s-1PROFILES\*(R"\s0 below), but only initializes the +installation configuration from \fIprofile_file\fR and then starts the +interactive session. .IP "\fB\-logfile\fR \fIfile\fR" 4 .IX Item "-logfile file" Write both all messages (informational, debugging, warnings) to \fIfile\fR, @@ -333,7 +338,7 @@ for example, \f(CW\*(C`/usr/local/texlive/YYYY/install\-tl.log\*(C'\fR for the \ release. .IP "\fB\-no\-cls\fR" 4 .IX Item "-no-cls" -(only for text mode installer) do not clear the screen when entering +For the text mode installer only: do not clear the screen when entering a new menu (for debugging purposes). .IP "\fB\-non\-admin\fR" 4 .IX Item "-non-admin" @@ -369,79 +374,10 @@ within the perltk and text installers. Print the TeX Live identifier for the detected platform (hardware/operating system) combination to standard output, and exit. \&\f(CW\*(C`\-print\-arch\*(C'\fR is a synonym. -.IP "\fB\-profile\fR \fIprofile\fR" 4 -.IX Item "-profile profile" -Load the file \fIprofile\fR and do the installation with no user -interaction, that is, a batch (unattended) install. -.Sp -A \fIprofile\fR file contains all the values needed to perform an -installation. From the text menu one can select \f(CW\*(C`P\*(C'\fR to save the -current setup as profile. In addition, after a normal installation -has finished, a profile for that exact installation is written to the file -\&\f(CW\*(C`tlpkg/texlive.profile\*(C'\fR. That file can be given as the argument to -\&\f(CW\*(C`\-profile\*(C'\fR to redo the exact same installation on a different system, -for example. Alternatively, you can use a custom profile, most easily -created by starting from a generated one and changing values, or an -empty file, which will take all the defaults. -.Sp -Within a profile file, if the variable \f(CW\*(C`selected_scheme\*(C'\fR is defined and -\&\fIno\fR collection variables at all are defined, then the collections -required by the specified scheme are installed, without explicitly -listing them. This eases maintenance of profile files. If any -collections are specified in a profile, though, then this does not -apply, and all desired collections must be given explicitly. -.Sp -Thus, a line \f(CW\*(C`selected_scheme scheme\-medium\*(C'\fR together with the -definitions of the installation directories (\f(CW\*(C`TEXDIR\*(C'\fR, \f(CW\*(C`TEXMFHOME\*(C'\fR, -\&\f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) suffices to install -the medium scheme with all default options. -.Sp -The list of allowed keys in a profile is given below. -For more detailed explanations on the meaning of the options -consult the TeX Live installation manual. Values are either -\&\f(CW0\fR, \f(CW1\fR, or strings. -.RS 4 -.ie n .IP "\fBinstaller options\fR (those with prefix ""instopt_"")" 4 -.el .IP "\fBinstaller options\fR (those with prefix \f(CWinstopt_\fR)" 4 -.IX Item "installer options (those with prefix instopt_)" -\&\f(CW\*(C`instopt_portable\*(C'\fR (default 0, see \f(CW\*(C`\-portable\*(C'\fR), -\&\f(CW\*(C`instopt_letter\*(C'\fR (default 0, selecting letter size instead of a4), -\&\f(CW\*(C`instopt_adjustrepo\*(C'\fR (default 1, adjust remote repository to \s-1CTAN\s0 -mirror after installation), -\&\f(CW\*(C`instopt_write18_restricted\*(C'\fR (default 1, enable write8 for a restricted -set of programs), -\&\f(CW\*(C`instopt_adjustpath\*(C'\fR (default 0 on Unix, 1 on Windows, adjust \s-1PATH\s0 environment). -.ie n .IP "\fBtlpdb options\fR (those with prefix ""tlpdbopt_"")" 4 -.el .IP "\fBtlpdb options\fR (those with prefix \f(CWtlpdbopt_\fR)" 4 -.IX Item "tlpdb options (those with prefix tlpdbopt_)" -The definitive list is give in \f(CW\*(C`TeXLive::TLConfig.pm\*(C'\fR in -\&\f(CW%TeXLive::TLConfig::TLPDBOptions\fR, together with explanations. -All items \fBbut\fR for \f(CW\*(C`tlpdbopt_location\*(C'\fR can be specified. -The current list is given below: -.Sp -\&\f(CW\*(C`tlpdbopt_autobackup\*(C'\fR, \f(CW\*(C`tlpdbopt_backupdir\*(C'\fR, \f(CW\*(C`tlpdbopt_create_formats\*(C'\fR, -\&\f(CW\*(C`tlpdbopt_desktop_integration\*(C'\fR, \f(CW\*(C`tlpdbopt_file_assocs\*(C'\fR, \f(CW\*(C`tlpdbopt_install_docfiles\*(C'\fR, -\&\f(CW\*(C`tlpdbopt_install_srcfiles\*(C'\fR, \f(CW\*(C`tlpdbopt_post_code\*(C'\fR, -\&\f(CW\*(C`tlpdbopt_sys_bin\*(C'\fR, \f(CW\*(C`tlpdbopt_sys_info\*(C'\fR, \f(CW\*(C`tlpdbopt_sys_man\*(C'\fR, -\&\f(CW\*(C`tlpdbopt_w32_multi_user\*(C'\fR, \f(CW\*(C`tlpdbopt_generate_updmap\*(C'\fR -.IP "\fBpath options\fR" 4 -.IX Item "path options" -\&\f(CW\*(C`TEXDIR\*(C'\fR, \f(CW\*(C`TEXMFHOME\*(C'\fR, \f(CW\*(C`TEXMFCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, -\&\f(CW\*(C`TEXMFVAR\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR, \f(CW\*(C`TEXMFLOCAL\*(C'\fR -.ie n .IP "\fBarchitecture selection options\fR (those starting with ""binary_"")" 4 -.el .IP "\fBarchitecture selection options\fR (those starting with \f(CWbinary_\fR)" 4 -.IX Item "architecture selection options (those starting with binary_)" -For every supported architecture of TeX Live (directories under -\&\f(CW\*(C`bin/\*(C'\fR), the key \f(CW\*(C`binary_ARCH\*(C'\fR can be set. -.Sp -Example: \f(CW\*(C`binary_x86_64\-linux\*(C'\fR -.RE -.RS 4 -.RE -.IP "\fB\-init\-from\-profile\fR \fIprofile\fR" 4 -.IX Item "-init-from-profile profile" -Similar to \fB\-profile\fR, but merely initializes the installation -configuration from \fIprofile\fR and then starts the interactive session. +.IP "\fB\-profile\fR \fIprofile_file\fR" 4 +.IX Item "-profile profile_file" +Load \fIprofile_file\fR and do the installation with no user interaction, +that is, a batch (unattended) install. See \*(L"\s-1PROFILES\*(R"\s0 below. .IP "\fB\-q\fR" 4 .IX Item "-q" Omit normal informational messages. @@ -456,16 +392,149 @@ depends on what your package repository provides; see the interactive menu list. .IP "\fB\-v\fR" 4 .IX Item "-v" -Include verbose debugging messages; repeat for maximum debugging, as in -\&\f(CW\*(C`\-v \-v\*(C'\fR. (Further repeats are accepted but ignored.) +Include verbose debugging messages; repeat for maximum debugging: \f(CW\*(C`\-v +\&\-v\*(C'\fR. (Further repeats are accepted but ignored.) .IP "\fB\-version\fR, \fB\-\-version\fR" 4 .IX Item "-version, --version" Output version information and exit. If \f(CW\*(C`\-v\*(C'\fR has also been given the revisions of the used modules are reported, too. +.SH "PROFILES" +.IX Header "PROFILES" +A \fIprofile\fR file contains all the values needed to perform an +installation. After a normal installation has finished, a profile for +that exact installation is written to the file \f(CW\*(C`tlpkg/texlive.profile\*(C'\fR. +In addition, from the text menu one can select \f(CW\*(C`P\*(C'\fR to save the current +setup as a profile at any time. Such a profile file can be given as the +argument to \f(CW\*(C`\-profile\*(C'\fR, for example to redo the exact same installation +on a different system. Alternatively, you can use a custom profile, +most easily created by starting from a generated one and changing +values, or an empty file, which will take all the defaults. +.PP +Within a profile file, each line consists of +.PP +\&\fIvariable\fR [\fIvalue\fR] +.PP +except for comment lines starting with \f(CW\*(C`#\*(C'\fR. The possible variable +names are listed below. Values, when present, are either \f(CW0\fR or \f(CW1\fR +for booleans, or strings (which must be specified without any quote +characters). Leading whitespace is ignored. +.PP +If the variable \f(CW\*(C`selected_scheme\*(C'\fR is defined and \fIno\fR collection +variables at all are defined, then the collections required by the +specified scheme (which might change over time) are installed, without +explicitly listing them. This eases maintenance of profile files. If +any collections are specified in a profile, though, then all desired +collections must be given explicitly. +.PP +For example, a line +.PP +.Vb 1 +\& selected_scheme scheme\-small +.Ve +.PP +along with definitions for the installation directories (given below +under \*(L"path options\*(R") suffices to install the \*(L"small\*(R" scheme with all +default options. The schemes are described in the \f(CW\*(C`S\*(C'\fR menu in the +text installer, or equivalent. +.PP +Besides \f(CW\*(C`selected_scheme\*(C'\fR, here is the list of variable names supported +in a profile: +.PP +\&\fBcollection options\fR (prefix \f(CW\*(C`collection\-\*(C'\fR) +.PP +Collections are specified with a variable name with the prefix +\&\f(CW\*(C`collection\-\*(C'\fR followed by a collection name; there is no value. For +instance, \f(CW\*(C`collection\-basic\*(C'\fR. The collections are described in the +\&\f(CW\*(C`C\*(C'\fR menu. +.PP +Schemes and collections (and packages) are ultimately defined by the +files in the \f(CW\*(C`tlpkg/tlpsrc/\*(C'\fR source directory. +.PP +\&\fBpath options\fR +.PP +It is best to define all of these, even though they may not be used in +the installation, so as to avoid unintentionally getting a default value +that could cause problems later. +.PP +.Vb 7 +\& TEXDIR +\& TEXMFCONFIG +\& TEXMFVAR +\& TEXMFHOME +\& TEXMFLOCAL +\& TEXMFSYSCONFIG +\& TEXMFSYSVAR +.Ve +.PP +\&\fBinstaller options\fR (prefix \f(CW\*(C`instopt_\*(C'\fR) +.ie n .IP """instopt_adjustpath"" (default 0 on Unix, 1 on Windows)" 4 +.el .IP "\f(CWinstopt_adjustpath\fR (default 0 on Unix, 1 on Windows)" 4 +.IX Item "instopt_adjustpath (default 0 on Unix, 1 on Windows)" +Adjust \f(CW\*(C`PATH\*(C'\fR environment variable. +.ie n .IP """instopt_adjustrepo"" (default 1)" 4 +.el .IP "\f(CWinstopt_adjustrepo\fR (default 1)" 4 +.IX Item "instopt_adjustrepo (default 1)" +Set remote repository to a multiplexed \s-1CTAN\s0 mirror after installation; +see \f(CW\*(C`\-repository\*(C'\fR above. +.ie n .IP """instopt_letter"" (default 0)" 4 +.el .IP "\f(CWinstopt_letter\fR (default 0)" 4 +.IX Item "instopt_letter (default 0)" +Set letter size paper as the default, instead of a4. +.ie n .IP """instopt_portable"" (default 0)" 4 +.el .IP "\f(CWinstopt_portable\fR (default 0)" 4 +.IX Item "instopt_portable (default 0)" +Install for portable use, e.g., on a \s-1USB\s0 stick. +.ie n .IP """instopt_write18_restricted"" (default 1)" 4 +.el .IP "\f(CWinstopt_write18_restricted\fR (default 1)" 4 +.IX Item "instopt_write18_restricted (default 1)" +Enable \f(CW\*(C`\ewrite18\*(C'\fR for a restricted set of programs. +.PP +\&\fBtlpdb options\fR (prefix \f(CW\*(C`tlpdbopt_\*(C'\fR) +.PP +The definitive list is given in \f(CW\*(C`tlpkg/TeXLive/TLConfig.pm\*(C'\fR, in +\&\f(CW%TeXLive::TLConfig::TLPDBOptions\fR, together with explanations. All +items given there \fIexcept\fR for \f(CW\*(C`tlpdbopt_location\*(C'\fR can be specified. +Here is the current list: +.PP +.Vb 10 +\& tlpdbopt_autobackup +\& tlpdbopt_backupdir +\& tlpdbopt_create_formats +\& tlpdbopt_desktop_integration +\& tlpdbopt_file_assocs +\& tlpdbopt_generate_updmap +\& tlpdbopt_install_docfiles +\& tlpdbopt_install_srcfiles +\& tlpdbopt_post_code +\& tlpdbopt_sys_bin +\& tlpdbopt_sys_info +\& tlpdbopt_sys_man +\& tlpdbopt_w32_multi_user +.Ve +.PP +\&\fBplatform options\fR (prefix \f(CW\*(C`binary_\*(C'\fR) +.PP +For each supported platform in TeX Live (directories under \f(CW\*(C`bin/\*(C'\fR), the +variable \f(CW\*(C`binary_\*(C'\fR\fI\s-1PLATFORM\s0\fR can be set. For example: +.PP +.Vb 1 +\& binary_x86_64\-linux +.Ve +.PP +If no \f(CW\*(C`binary_\*(C'\fR variable is specified, the default is whatever the +current machine is running. +.PP +In releases before 2017, many profile variables had different +names (not documented here; see the \f(CW\*(C`install\-tl\*(C'\fR source). They are +accepted and transformed to the names given above. When a profile is +written, the names above are always used. +.PP +For more details on all of the above options, consult the TeX Live +installation manual, linked from <http://tug.org/texlive/doc>. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR will look for the -following environment variables. They are not of interest in normal +following environment variables. They are not of interest for normal user installations. .ie n .IP """TEXLIVE_INSTALL_ENV_NOCHECK""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_ENV_NOCHECK\fR" 4 @@ -492,6 +561,9 @@ for testing. .ie n .IP """TEXLIVE_INSTALL_TEXMFCONFIG""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_TEXMFCONFIG\fR" 4 .IX Item "TEXLIVE_INSTALL_TEXMFCONFIG" +.ie n .IP """TEXLIVE_INSTALL_TEXMFVAR""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFVAR\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFVAR" .ie n .IP """TEXLIVE_INSTALL_TEXMFHOME""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_TEXMFHOME\fR" 4 .IX Item "TEXLIVE_INSTALL_TEXMFHOME" @@ -504,14 +576,11 @@ for testing. .ie n .IP """TEXLIVE_INSTALL_TEXMFSYSVAR""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_TEXMFSYSVAR\fR" 4 .IX Item "TEXLIVE_INSTALL_TEXMFSYSVAR" -.ie n .IP """TEXLIVE_INSTALL_TEXMFVAR""" 4 -.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFVAR\fR" 4 -.IX Item "TEXLIVE_INSTALL_TEXMFVAR" .PD Specify the respective directories. \f(CW\*(C`TEXLIVE_INSTALL_PREFIX\*(C'\fR defaults to \f(CW\*(C`/usr/local/texlive\*(C'\fR, while \f(CW\*(C`TEXLIVE_INSTALL_TEXDIR\*(C'\fR defaults to the release directory within that prefix, e.g., -\&\f(CW\*(C`/usr/local/texlive/2014\*(C'\fR. All the defaults can be seen by running the +\&\f(CW\*(C`/usr/local/texlive/2016\*(C'\fR. All the defaults can be seen by running the installer interactively and then typing \f(CW\*(C`D\*(C'\fR for the directory menu. .ie n .IP """NOPERLDOC""" 4 .el .IP "\f(CWNOPERLDOC\fR" 4 @@ -522,4 +591,5 @@ Don't try to run the \f(CW\*(C`\-\-help\*(C'\fR message through \f(CW\*(C`perldo This script and its documentation were written for the TeX Live distribution (<http://tug.org/texlive>) and both are licensed under the \&\s-1GNU\s0 General Public License Version 2 or later. -\&\f(CW$Id\fR$ +.PP +\&\f(CW$Id:\fR install-tl 44019 2017\-04\-24 18:25:41Z karl $ diff --git a/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf b/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf Binary files differindex 146b2efee64..df7af4658a4 100644 --- a/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf |