diff options
author | Karl Berry <karl@freefriends.org> | 2022-06-18 23:49:44 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-06-18 23:49:44 +0000 |
commit | 46e5e8906319117eeaa243a37f31a52845de9e99 (patch) | |
tree | 23928b546c9b5ce6cc91d556c45b7a654222f64d /Master/texmf-dist/doc | |
parent | 2dca20329981c6adff1b6c1f739f89522ef0f101 (diff) |
tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@63647 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.1 | 198 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.man1.pdf | bin | 55389 -> 58604 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/texlive/install-tl.html | 120 |
3 files changed, 206 insertions, 112 deletions
diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1 index 60ff41da177..c4441f57c4e 100644 --- a/Master/texmf-dist/doc/man/man1/install-tl.1 +++ b/Master/texmf-dist/doc/man/man1/install-tl.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "INSTALL-TL 1" -.TH INSTALL-TL 1 "2022-06-14" "perl v5.34.0" "User Contributed Perl Documentation" +.TH INSTALL-TL 1 "2022-06-18" "perl v5.34.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 @@ -184,10 +184,9 @@ For the full documentation of TeX Live, see .SH "EXAMPLES" .IX Header "EXAMPLES" With no options, \f(CW\*(C`install\-tl\*(C'\fR drops you into an interactive menu where -essentially all default settings can be changed. -.PP -With options, you can initialize the settings in various ways, or -perform the installation without interaction. +essentially all default settings can be changed. With options, you can +initialize the settings in various ways, or perform the installation +without interaction. Some examples: .ie n .IP """install\-tl \-\-paper=letter""" 4 .el .IP "\f(CWinstall\-tl \-\-paper=letter\fR" 4 .IX Item "install-tl --paper=letter" @@ -216,8 +215,15 @@ Full documentation follows. As usual, all options can be specified in any order, and with either a leading \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR. An argument value can be separated from its option by either a space or \f(CW\*(C`=\*(C'\fR. +.PP +The options relating to customization of the installation can also be +selected in the interactive installation menus (\s-1GUI\s0 or text). .IP "\fB\-gui\fR [[=]\fImodule\fR]" 4 .IX Item "-gui [[=]module]" +.PD 0 +.IP "\fB\-no\-gui\fR" 4 +.IX Item "-no-gui" +.PD If no \fImodule\fR is given, starts the Tcl/Tk (see below) \s-1GUI\s0 installer. .Sp If \fImodule\fR is given loads the given installer module. Currently the @@ -244,9 +250,6 @@ removed in the latest macOS releases. It's often already installed on GNU/Linux, or can be easily installed through a distro package manager. For Windows, TeX Live provides a Tcl/Tk runtime. .RE -.IP "\fB\-no\-gui\fR" 4 -.IX Item "-no-gui" -Use the text mode installer (default except on Windows and Macs). .IP "\fB\-lang\fR \fIllcode\fR" 4 .IX Item "-lang llcode" By default, the Tcl \s-1GUI\s0 uses the language detection built into @@ -267,9 +270,9 @@ http(s), ftp, or scp. The documentation for \f(CW\*(C`tlmgr\*(C'\fR has the deta .Sp For installation, the default is to pick a mirror automatically, using <https://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is -used for the entire download. You can use the special argument \f(CW\*(C`ctan\*(C'\fR -as an abbreviation for this. (See <https://ctan.org> for more about \s-1CTAN\s0 -and its mirrors.) +then used for the entire download. You can use the special argument +\&\f(CW\*(C`ctan\*(C'\fR as an abbreviation for this. (See <https://ctan.org> for more +about \s-1CTAN\s0 and its mirrors.) .Sp After installation is complete, you can use that installation as the repository for another installation. If you chose to install less than @@ -291,23 +294,24 @@ Giving this command line option allows configuring such \*(L"foreign\*(R" settings. .IP "\fB\-custom\-bin\fR \fIpath\fR" 4 .IX Item "-custom-bin path" -If you have built your own set of TeX Live binaries (perhaps because -your platform was not supported by TeX Live out of the box), this option -allows you to specify the \fIpath\fR to a directory where the binaries for -the current system are present. The installation will continue as -usual, but at the end all files from \fIpath\fR are copied over to -\&\f(CW\*(C`bin/custom/\*(C'\fR under your installation directory and this \f(CW\*(C`bin/custom/\*(C'\fR -directory is what will be added to the path for the post-install -actions. To install multiple custom binary sets, manually rename -\&\f(CW\*(C`custom\*(C'\fR before doing each. +If you have built your own set of TeX Live binaries (e.g., because +precompiled binaries were not provided by \s-1TL\s0 for your platform), this +option allows you to specify the \fIpath\fR to a directory where the +binaries for the current system are present. The installation will +continue as usual, but at the end all files from \fIpath\fR are copied over +to \f(CW\*(C`bin/custom/\*(C'\fR under your installation directory and this +\&\f(CW\*(C`bin/custom/\*(C'\fR directory is what will be added to the path for the +post-install actions. To install multiple custom binary sets, manually +rename \f(CW\*(C`custom\*(C'\fR before doing each. .Sp For more information on custom binaries, see <https://tug.org/texlive/custom\-bin.html>. For general information on building TeX Live, see <https://tug.org/texlive/build.html>. .IP "\fB\-debug\-fakenet\fR" 4 .IX Item "-debug-fakenet" -Pretend we're doing a network install, for the sole purpose of testing -broken downloads via moving package files aside in a tlnet mirror. +Pretend we're doing a network install. This is for the sole purpose of +testing the code to handle broken downloads, via moving package files +aside in a tlnet mirror hierarchy. .IP "\fB\-debug\-setup\-vars\fR" 4 .IX Item "-debug-setup-vars" Print final values of directory variables; for more debugging @@ -321,8 +325,9 @@ what remains to be done. .IP "\fB\-force\-platform\fR \fIplatform\fR" 4 .IX Item "-force-platform platform" Instead of auto-detecting the current platform, use \fIplatform\fR. -Binaries for this platform must be present and they must actually be -runnable, or installation will fail. \f(CW\*(C`\-force\-arch\*(C'\fR is a synonym. +Binaries for this platform must be present in \f(CW\*(C`bin/\*(C'\fR\fIplatform\fR\f(CW\*(C`/\*(C'\fR and +they must be runnable, or installation will fail. \f(CW\*(C`\-force\-arch\*(C'\fR is a +synonym. .IP "\fB\-help\fR, \fB\-\-help\fR, \fB\-?\fR" 4 .IX Item "-help, --help, -?" Display this help and exit. (This help is also on the web at @@ -376,16 +381,35 @@ retry fails, the installer aborts. .IP "\fB\-no\-src\-install\fR" 4 .IX Item "-no-src-install" .PD -Do not install source/doc files and set the options to not install source/doc -files in the saved database. +Do not install the documentation resp. source package files, both for +the immediate installation and for future updates. After installation, +inclusion of the doc/src files can be re-enabled via \f(CW\*(C`tlmgr\*(C'\fR: +.Sp +.Vb 2 +\& tlmgr option docfiles 1 +\& tlmgr option srcfiles 1 +.Ve +.Sp +If you later find that you want the doc/src files for a package that has +been installed without them, you can get them like this (using the +\&\f(CW\*(C`fontspec\*(C'\fR package as the example): +.Sp +.Vb 1 +\& tlmgr install \-\-reinstall \-\-with\-doc \-\-with\-src fontspec +.Ve +.Sp +The source files mentioned here are those relating to TeX packages, such +as \f(CW\*(C`.dtx\*(C'\fR files. The sources that are compiled to make the binaries are +available separately: see <https://tug.org/texlive/svn/>. .IP "\fB\-no\-installation\fR" 4 .IX Item "-no-installation" Do not perform any installation. This is for debugging the initialization and setup routines without touching the disk. .IP "\fB\-no\-interaction\fR" 4 .IX Item "-no-interaction" -Do not enter the interactive menu, just perform the installation after -initialization and option parsing. +Do not enter the interactive menu; immediately perform the installation +after initialization and option parsing. Also omit the check for a +previous installation and asking about importing previous settings. .IP "\fB\-no\-persistent\-downloads\fR" 4 .IX Item "-no-persistent-downloads" .PD 0 @@ -419,8 +443,8 @@ The default is \f(CW\*(C`a4\*(C'\fR. The paper size can be set after installatio the \f(CW\*(C`tlmgr paper\*(C'\fR command. .IP "\fB\-portable\fR" 4 .IX Item "-portable" -Install for portable use, e.g., on a \s-1USB\s0 stick. Also selectable from -within the perltk and text installers. +Install for portable use, e.g., on a \s-1USB\s0 stick. See the +\&\f(CW\*(C`instopt_portable\*(C'\fR description below for details. .IP "\fB\-print\-platform\fR" 4 .IX Item "-print-platform" Print the TeX Live identifier for the detected platform @@ -437,44 +461,40 @@ Omit normal informational messages. .IP "\fB\-scheme\fR \fIscheme\fR" 4 .IX Item "-scheme scheme" Schemes are the highest level of package grouping in TeX Live; the -default is to use the \f(CW\*(C`full\*(C'\fR scheme, which includes everything. This -option overrides that default. You can change the scheme again before -the actual installation with the usual menu. The \fIscheme\fR argument may -optionally have a prefix \f(CW\*(C`scheme\-\*(C'\fR. The list of supported scheme names +default is to use the \f(CW\*(C`full\*(C'\fR scheme, which includes everything. This +option overrides that default. The \fIscheme\fR argument value may +optionally have a prefix \f(CW\*(C`scheme\-\*(C'\fR. The list of supported scheme names 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: \f(CW\*(C`\-v -\&\-v\*(C'\fR. (Further repeats are accepted but ignored.) .IP "\fB\-texdir\fR \fIdir\fR" 4 .IX Item "-texdir dir" Specify the system installation directory; the default is \&\f(CW\*(C`/usr/local/texlive/YYYY\*(C'\fR for release \s-1YYYY.\s0 Specifying this option also causes the \f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, and \f(CW\*(C`TEXMFSYSVAR\*(C'\fR -directories to be set as subdirectories, so they don't have to be set -individually. +directories to be set as subdirectories of \fIdir\fR, so they don't have to +be set individually. .Sp -For more on the several directory trees set up by default, see the main -TeX Live documentation at <https://tug.org/texlive/doc>. +There is a brief summary of these directories trees at \*(L"\s-1DIRECTORY +TREES\*(R"\s0 below; for details on the trees set up by default, and their +intended usage, see the main TeX Live documentation at +<https://tug.org/texlive/doc>. .IP "\fB\-texuserdir\fR \fIdir\fR" 4 .IX Item "-texuserdir dir" Specify the user installation directory; the default is \&\f(CW\*(C`~/.texliveYYYY\*(C'\fR (except on Macs, where there is no leading dot). Specifying this also causes the \f(CW\*(C`TEXMFHOME\*(C'\fR, \f(CW\*(C`TEXMFCONFIG\*(C'\fR, and -\&\f(CW\*(C`TEXMFVAR\*(C'\fR directories to be set as subdirectories. +\&\f(CW\*(C`TEXMFVAR\*(C'\fR directories to be set as subdirectories of \fIdir\fR. .IP "\fB\-texmflocal\fR \fIdir\fR" 4 .IX Item "-texmflocal dir" Specify the \f(CW\*(C`TEXMFLOCAL\*(C'\fR directory; the default is \&\f(CW\*(C`/usr/local/texlive/texmf\-local\*(C'\fR, that is, one level up from the main installation. This is so locally-installed packages can be easily used across releases, which is usually desirable. Specifying the \f(CW\*(C`\-texdir\*(C'\fR -option changes this, putting \f(CW\*(C`TEXMFLOCAL\*(C'\fR under the main tree, on the -theory that you want to use some setup different than the default. The -\&\f(CW\*(C`\-texmflocal\*(C'\fR option can be used to specify an explicit directory for it. +option changes this, putting \f(CW\*(C`TEXMFLOCAL\*(C'\fR under the main tree. The +\&\f(CW\*(C`\-texmflocal\*(C'\fR option can be used to specify an explicit directory. .Sp Anything installed here must follow the TeX directory structure (\s-1TDS\s0), -e.g., \f(CW\*(C`TEXMFHOME/tex/latex/mypkg/mypkg.sty\*(C'\fR. See the \s-1TDS\s0 reference at +e.g., \f(CW\*(C`TEXMFHOME/tex/latex/mypkg/mypkg.sty\*(C'\fR. \s-1TDS\s0 reference: <https://tug.org/tds>. .IP "\fB\-texmfhome\fR \fIdir\fR" 4 .IX Item "-texmfhome dir" @@ -497,23 +517,30 @@ Specify the \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR and \f(CW\*(C`TEXMFSYSVAR\*(C'\fR s .IX Item "-texmfvar dir" .PD Specify the \f(CW\*(C`TEXMFCONFIG\*(C'\fR and \f(CW\*(C`TEXMFVAR\*(C'\fR user directories. +The defaults are \f(CW\*(C`~/.texliveYYYY/texmf\-{config,var}\*(C'\fR, except on Macs, +where the leading dot is omitted (\f(CW\*(C`~/texliveYYYY/...\*(C'\fR). +.IP "\fB\-v\fR" 4 +.IX Item "-v" +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 is also given, the versions of the TeX Live modules used are also reported. .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 +A \fIprofile\fR file normally 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. +setup as a profile at any time. These are small text files; feel free to +peruse and edit them according to your needs. .PP 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. +starting from a generated one and changing values. An empty profile +file will cause the installer to use the defaults. .PP As mentioned above, the installer only supports selection by scheme and collections, not individual packages, so packages cannot be specified in @@ -531,9 +558,9 @@ characters). Leading whitespace is ignored. 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. +explicitly listing them. This eases maintenance of profile files. If any +collections are specified in a profile, though, then the scheme is +ignored and all desired collections must be given explicitly. .PP For example, a line .PP @@ -546,8 +573,8 @@ under \*(L"path options\*(R") suffices to install the \*(L"small\*(R" scheme wit 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: +In addition to \f(CW\*(C`selected_scheme\*(C'\fR, here are the other variable names +supported in a profile: .PP \&\fBcollection options\fR (prefix \f(CW\*(C`collection\-\*(C'\fR) .PP @@ -561,18 +588,18 @@ 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. +It is best to define all of these, even though they may not be used in a +given 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 +\& TEXMFCONFIG +\& TEXMFVAR +\& TEXMFHOME .Ve .PP \&\fBinstaller options\fR (prefix \f(CW\*(C`instopt_\*(C'\fR) @@ -652,6 +679,10 @@ installation manual, linked from <https://tug.org/texlive/doc>. For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR looks for the following environment variables. They are not of interest for normal user installations. +.ie n .IP """NOPERLDOC""" 4 +.el .IP "\f(CWNOPERLDOC\fR" 4 +.IX Item "NOPERLDOC" +Don't try to run the \f(CW\*(C`\-\-help\*(C'\fR message through \f(CW\*(C`perldoc\*(C'\fR. .ie n .IP """TEXLIVE_DOWNLOADER""" 4 .el .IP "\f(CWTEXLIVE_DOWNLOADER\fR" 4 .IX Item "TEXLIVE_DOWNLOADER" @@ -730,14 +761,45 @@ installer interactively and then typing \f(CW\*(C`D\*(C'\fR for the directory me The various command line options for specifying directories override these environment variables; since specifying both is usually accidental, a warning is given if the values are different. -.ie n .IP """NOPERLDOC""" 4 -.el .IP "\f(CWNOPERLDOC\fR" 4 -.IX Item "NOPERLDOC" -Don't try to run the \f(CW\*(C`\-\-help\*(C'\fR message through \f(CW\*(C`perldoc\*(C'\fR. +.SH "DIRECTORY TREES" +.IX Header "DIRECTORY TREES" +There are a plethora of ways to specify the plethora of directory trees +used by TeX Live. By far the simplest, and recommended, approach is not +to change anything. The defaults suffice for the vast majority of +installations. +.PP +But, for the sake of explanation, here is a table of the trees and the +command line options that change them. The first group of three are +system directories, and the second group of three are user directories; +the two groups are quite analogous. +.PP +.Vb 11 +\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\& | tree | default | group change | single change | +\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\& | TEXMFLOCAL | /usr/local/texlive/YYYY/texmf\-local | \-\-texdir | \-\-texmflocal | +\& | TEXMFSYSVAR | /usr/local/texlive/YYYY/texmf\-var | \-\-texdir | \-\-texmfsysvar | +\& | TEXMFSYSCONFIG | /usr/local/texlive/YYYY/texmf\-config | \-\-texdir | \-\-texmfsysconfig | +\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +\& | TEXMFHOME | ~/texmf | \-\-texuserdir | \-\-texmfhome | +\& | TEXMFVAR | ~/.texliveYYYY/texmf\-var | \-\-texuserdir | \-\-texmfvar | +\& | TEXMFCONFIG | ~/.texliveYYYY/texmf\-config | \-\-texuserdir | \-\-texmfconfig | +\& +\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+ +.Ve +.PP +In addition, as mentioned in the previous section, each tree has an +environment variable \f(CW\*(C`TEXLIVE_INSTALL_\*(C'\fR\fItree\fR which overrides the +default; command line and profile settings both override environment +variable settings. +.PP +The defaults vary slightly on Macs, as explained above in \*(L"\s-1OPTIONS\*(R"\s0. +.PP +For more on the directory trees and their intended usage, see the main +TeX Live documentation at <https://tug.org/texlive/doc>. .SH "AUTHORS AND COPYRIGHT" .IX Header "AUTHORS AND COPYRIGHT" This script and its documentation were written for the TeX Live distribution (<https://tug.org/texlive>) and both are licensed under the \&\s-1GNU\s0 General Public License Version 2 or later. .PP -\&\f(CW$Id:\fR install-tl 63586 2022\-06\-14 01:04:46Z preining $ +\&\f(CW$Id:\fR install-tl 63643 2022\-06\-18 21:43:37Z 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 98d34bc8380..8b7604540a2 100644 --- a/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/install-tl.man1.pdf diff --git a/Master/texmf-dist/doc/texlive/install-tl.html b/Master/texmf-dist/doc/texlive/install-tl.html index f69f6e4e55e..026720483b1 100644 --- a/Master/texmf-dist/doc/texlive/install-tl.html +++ b/Master/texmf-dist/doc/texlive/install-tl.html @@ -20,6 +20,7 @@ <li><a href="#OPTIONS">OPTIONS</a></li> <li><a href="#PROFILES">PROFILES</a></li> <li><a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a></li> + <li><a href="#DIRECTORY-TREES">DIRECTORY TREES</a></li> <li><a href="#AUTHORS-AND-COPYRIGHT">AUTHORS AND COPYRIGHT</a></li> </ul> @@ -55,9 +56,7 @@ <h1 id="EXAMPLES">EXAMPLES</h1> -<p>With no options, <code>install-tl</code> drops you into an interactive menu where essentially all default settings can be changed.</p> - -<p>With options, you can initialize the settings in various ways, or perform the installation without interaction.</p> +<p>With no options, <code>install-tl</code> drops you into an interactive menu where essentially all default settings can be changed. With options, you can initialize the settings in various ways, or perform the installation without interaction. Some examples:</p> <dl> @@ -93,11 +92,17 @@ <p>As usual, all options can be specified in any order, and with either a leading <code>-</code> or <code>--</code>. An argument value can be separated from its option by either a space or <code>=</code>.</p> +<p>The options relating to customization of the installation can also be selected in the interactive installation menus (GUI or text).</p> + <dl> <dt id="gui-module"><b>-gui</b> [[=]<i>module</i>]</dt> <dd> +</dd> +<dt id="no-gui"><b>-no-gui</b></dt> +<dd> + <p>If no <i>module</i> is given, starts the Tcl/Tk (see below) GUI installer.</p> <p>If <i>module</i> is given loads the given installer module. Currently the following modules are supported:</p> @@ -121,12 +126,6 @@ <p>The default GUI requires Tcl/Tk. This was standard on Macs, but has been removed in the latest macOS releases. It's often already installed on GNU/Linux, or can be easily installed through a distro package manager. For Windows, TeX Live provides a Tcl/Tk runtime.</p> </dd> -<dt id="no-gui"><b>-no-gui</b></dt> -<dd> - -<p>Use the text mode installer (default except on Windows and Macs).</p> - -</dd> <dt id="lang-llcode"><b>-lang</b> <i>llcode</i></dt> <dd> @@ -138,7 +137,7 @@ <p>Specify the package repository to be used as the source of the installation. In short, this can be a directory name or a url using http(s), ftp, or scp. The documentation for <code>tlmgr</code> has the details (<a href="https://tug.org/texlive/doc/tlmgr.html#OPTIONS">https://tug.org/texlive/doc/tlmgr.html#OPTIONS</a>).</p> -<p>For installation, the default is to pick a mirror automatically, using <a href="https://mirror.ctan.org/systems/texlive/tlnet">https://mirror.ctan.org/systems/texlive/tlnet</a>; the chosen mirror is used for the entire download. You can use the special argument <code>ctan</code> as an abbreviation for this. (See <a href="https://ctan.org">https://ctan.org</a> for more about CTAN and its mirrors.)</p> +<p>For installation, the default is to pick a mirror automatically, using <a href="https://mirror.ctan.org/systems/texlive/tlnet">https://mirror.ctan.org/systems/texlive/tlnet</a>; the chosen mirror is then used for the entire download. You can use the special argument <code>ctan</code> as an abbreviation for this. (See <a href="https://ctan.org">https://ctan.org</a> for more about CTAN and its mirrors.)</p> <p>After installation is complete, you can use that installation as the repository for another installation. If you chose to install less than the full scheme containing all packages, the list of available schemes will be adjusted accordingly.</p> @@ -158,7 +157,7 @@ <dt id="custom-bin-path"><b>-custom-bin</b> <i>path</i></dt> <dd> -<p>If you have built your own set of TeX Live binaries (perhaps because your platform was not supported by TeX Live out of the box), this option allows you to specify the <i>path</i> to a directory where the binaries for the current system are present. The installation will continue as usual, but at the end all files from <i>path</i> are copied over to <code>bin/custom/</code> under your installation directory and this <code>bin/custom/</code> directory is what will be added to the path for the post-install actions. To install multiple custom binary sets, manually rename <code>custom</code> before doing each.</p> +<p>If you have built your own set of TeX Live binaries (e.g., because precompiled binaries were not provided by TL for your platform), this option allows you to specify the <i>path</i> to a directory where the binaries for the current system are present. The installation will continue as usual, but at the end all files from <i>path</i> are copied over to <code>bin/custom/</code> under your installation directory and this <code>bin/custom/</code> directory is what will be added to the path for the post-install actions. To install multiple custom binary sets, manually rename <code>custom</code> before doing each.</p> <p>For more information on custom binaries, see <a href="https://tug.org/texlive/custom-bin.html">https://tug.org/texlive/custom-bin.html</a>. For general information on building TeX Live, see <a href="https://tug.org/texlive/build.html">https://tug.org/texlive/build.html</a>.</p> @@ -166,7 +165,7 @@ <dt id="debug-fakenet"><b>-debug-fakenet</b></dt> <dd> -<p>Pretend we're doing a network install, for the sole purpose of testing broken downloads via moving package files aside in a tlnet mirror.</p> +<p>Pretend we're doing a network install. This is for the sole purpose of testing the code to handle broken downloads, via moving package files aside in a tlnet mirror hierarchy.</p> </dd> <dt id="debug-setup-vars"><b>-debug-setup-vars</b></dt> @@ -184,7 +183,7 @@ <dt id="force-platform-platform"><b>-force-platform</b> <i>platform</i></dt> <dd> -<p>Instead of auto-detecting the current platform, use <i>platform</i>. Binaries for this platform must be present and they must actually be runnable, or installation will fail. <code>-force-arch</code> is a synonym.</p> +<p>Instead of auto-detecting the current platform, use <i>platform</i>. Binaries for this platform must be present in <code>bin/</code><i>platform</i><code>/</code> and they must be runnable, or installation will fail. <code>-force-arch</code> is a synonym.</p> </dd> <dt id="help---help"><b>-help</b>, <b>--help</b>, <b>-?</b></dt> @@ -236,7 +235,16 @@ <dt id="no-src-install"><b>-no-src-install</b></dt> <dd> -<p>Do not install source/doc files and set the options to not install source/doc files in the saved database.</p> +<p>Do not install the documentation resp. source package files, both for the immediate installation and for future updates. After installation, inclusion of the doc/src files can be re-enabled via <code>tlmgr</code>:</p> + +<pre><code>tlmgr option docfiles 1 +tlmgr option srcfiles 1</code></pre> + +<p>If you later find that you want the doc/src files for a package that has been installed without them, you can get them like this (using the <code>fontspec</code> package as the example):</p> + +<pre><code>tlmgr install --reinstall --with-doc --with-src fontspec</code></pre> + +<p>The source files mentioned here are those relating to TeX packages, such as <code>.dtx</code> files. The sources that are compiled to make the binaries are available separately: see <a href="https://tug.org/texlive/svn/">https://tug.org/texlive/svn/</a>.</p> </dd> <dt id="no-installation"><b>-no-installation</b></dt> @@ -248,7 +256,7 @@ <dt id="no-interaction"><b>-no-interaction</b></dt> <dd> -<p>Do not enter the interactive menu, just perform the installation after initialization and option parsing.</p> +<p>Do not enter the interactive menu; immediately perform the installation after initialization and option parsing. Also omit the check for a previous installation and asking about importing previous settings.</p> </dd> <dt id="no-persistent-downloads"><b>-no-persistent-downloads</b></dt> @@ -284,7 +292,7 @@ <dt id="portable"><b>-portable</b></dt> <dd> -<p>Install for portable use, e.g., on a USB stick. Also selectable from within the perltk and text installers.</p> +<p>Install for portable use, e.g., on a USB stick. See the <code>instopt_portable</code> description below for details.</p> </dd> <dt id="print-platform"><b>-print-platform</b></dt> @@ -308,35 +316,29 @@ <dt id="scheme-scheme"><b>-scheme</b> <i>scheme</i></dt> <dd> -<p>Schemes are the highest level of package grouping in TeX Live; the default is to use the <code>full</code> scheme, which includes everything. This option overrides that default. You can change the scheme again before the actual installation with the usual menu. The <i>scheme</i> argument may optionally have a prefix <code>scheme-</code>. The list of supported scheme names depends on what your package repository provides; see the interactive menu list.</p> - -</dd> -<dt id="v"><b>-v</b></dt> -<dd> - -<p>Include verbose debugging messages; repeat for maximum debugging: <code>-v -v</code>. (Further repeats are accepted but ignored.)</p> +<p>Schemes are the highest level of package grouping in TeX Live; the default is to use the <code>full</code> scheme, which includes everything. This option overrides that default. The <i>scheme</i> argument value may optionally have a prefix <code>scheme-</code>. The list of supported scheme names depends on what your package repository provides; see the interactive menu list.</p> </dd> <dt id="texdir-dir"><b>-texdir</b> <i>dir</i></dt> <dd> -<p>Specify the system installation directory; the default is <code>/usr/local/texlive/YYYY</code> for release YYYY. Specifying this option also causes the <code>TEXMFLOCAL</code>, <code>TEXMFSYSCONFIG</code>, and <code>TEXMFSYSVAR</code> directories to be set as subdirectories, so they don't have to be set individually.</p> +<p>Specify the system installation directory; the default is <code>/usr/local/texlive/YYYY</code> for release YYYY. Specifying this option also causes the <code>TEXMFLOCAL</code>, <code>TEXMFSYSCONFIG</code>, and <code>TEXMFSYSVAR</code> directories to be set as subdirectories of <i>dir</i>, so they don't have to be set individually.</p> -<p>For more on the several directory trees set up by default, see the main TeX Live documentation at <a href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.</p> +<p>There is a brief summary of these directories trees at <a href="#DIRECTORY-TREES">"DIRECTORY TREES"</a> below; for details on the trees set up by default, and their intended usage, see the main TeX Live documentation at <a href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.</p> </dd> <dt id="texuserdir-dir"><b>-texuserdir</b> <i>dir</i></dt> <dd> -<p>Specify the user installation directory; the default is <code>~/.texliveYYYY</code> (except on Macs, where there is no leading dot). Specifying this also causes the <code>TEXMFHOME</code>, <code>TEXMFCONFIG</code>, and <code>TEXMFVAR</code> directories to be set as subdirectories.</p> +<p>Specify the user installation directory; the default is <code>~/.texliveYYYY</code> (except on Macs, where there is no leading dot). Specifying this also causes the <code>TEXMFHOME</code>, <code>TEXMFCONFIG</code>, and <code>TEXMFVAR</code> directories to be set as subdirectories of <i>dir</i>.</p> </dd> <dt id="texmflocal-dir"><b>-texmflocal</b> <i>dir</i></dt> <dd> -<p>Specify the <code>TEXMFLOCAL</code> directory; the default is <code>/usr/local/texlive/texmf-local</code>, that is, one level up from the main installation. This is so locally-installed packages can be easily used across releases, which is usually desirable. Specifying the <code>-texdir</code> option changes this, putting <code>TEXMFLOCAL</code> under the main tree, on the theory that you want to use some setup different than the default. The <code>-texmflocal</code> option can be used to specify an explicit directory for it.</p> +<p>Specify the <code>TEXMFLOCAL</code> directory; the default is <code>/usr/local/texlive/texmf-local</code>, that is, one level up from the main installation. This is so locally-installed packages can be easily used across releases, which is usually desirable. Specifying the <code>-texdir</code> option changes this, putting <code>TEXMFLOCAL</code> under the main tree. The <code>-texmflocal</code> option can be used to specify an explicit directory.</p> -<p>Anything installed here must follow the TeX directory structure (TDS), e.g., <code>TEXMFHOME/tex/latex/mypkg/mypkg.sty</code>. See the TDS reference at <a href="https://tug.org/tds">https://tug.org/tds</a>.</p> +<p>Anything installed here must follow the TeX directory structure (TDS), e.g., <code>TEXMFHOME/tex/latex/mypkg/mypkg.sty</code>. TDS reference: <a href="https://tug.org/tds">https://tug.org/tds</a>.</p> </dd> <dt id="texmfhome-dir"><b>-texmfhome</b> <i>dir</i></dt> @@ -364,7 +366,13 @@ <dt id="texmfvar-dir"><b>-texmfvar</b> <i>dir</i></dt> <dd> -<p>Specify the <code>TEXMFCONFIG</code> and <code>TEXMFVAR</code> user directories.</p> +<p>Specify the <code>TEXMFCONFIG</code> and <code>TEXMFVAR</code> user directories. The defaults are <code>~/.texliveYYYY/texmf-{config,var}</code>, except on Macs, where the leading dot is omitted (<code>~/texliveYYYY/...</code>).</p> + +</dd> +<dt id="v"><b>-v</b></dt> +<dd> + +<p>Include verbose debugging messages; repeat for maximum debugging: <code>-v -v</code>. (Further repeats are accepted but ignored.)</p> </dd> <dt id="version---version"><b>-version</b>, <b>--version</b></dt> @@ -377,9 +385,9 @@ <h1 id="PROFILES">PROFILES</h1> -<p>A <i>profile</i> 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 <code>tlpkg/texlive.profile</code>. In addition, from the text menu one can select <code>P</code> to save the current setup as a profile at any time.</p> +<p>A <i>profile</i> file normally 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 <code>tlpkg/texlive.profile</code>. In addition, from the text menu one can select <code>P</code> to save the current setup as a profile at any time. These are small text files; feel free to peruse and edit them according to your needs.</p> -<p>Such a profile file can be given as the argument to <code>-profile</code>, 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.</p> +<p>Such a profile file can be given as the argument to <code>-profile</code>, 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. An empty profile file will cause the installer to use the defaults.</p> <p>As mentioned above, the installer only supports selection by scheme and collections, not individual packages, so packages cannot be specified in profile files either. Use <code>tlmgr</code> to work at the package level.</p> @@ -389,7 +397,7 @@ <p>except for comment lines starting with <code>#</code>. The possible variable names are listed below. Values, when present, are either <code>0</code> or <code>1</code> for booleans, or strings (which must be specified without any quote characters). Leading whitespace is ignored.</p> -<p>If the variable <code>selected_scheme</code> is defined and <i>no</i> 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.</p> +<p>If the variable <code>selected_scheme</code> is defined and <i>no</i> 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 the scheme is ignored and all desired collections must be given explicitly.</p> <p>For example, a line</p> @@ -397,7 +405,7 @@ <p>along with definitions for the installation directories (given below under "path options") suffices to install the "small" scheme with all default options. The schemes are described in the <code>S</code> menu in the text installer, or equivalent.</p> -<p>Besides <code>selected_scheme</code>, here is the list of variable names supported in a profile:</p> +<p>In addition to <code>selected_scheme</code>, here are the other variable names supported in a profile:</p> <p><b>collection options</b> (prefix <code>collection-</code>)</p> @@ -407,15 +415,15 @@ <p><b>path options</b></p> -<p>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.</p> +<p>It is best to define all of these, even though they may not be used in a given installation, so as to avoid unintentionally getting a default value that could cause problems later.</p> <pre><code>TEXDIR -TEXMFCONFIG -TEXMFVAR -TEXMFHOME TEXMFLOCAL TEXMFSYSCONFIG -TEXMFSYSVAR</code></pre> +TEXMFSYSVAR +TEXMFCONFIG +TEXMFVAR +TEXMFHOME</code></pre> <p><b>installer options</b> (prefix <code>instopt_</code>)</p> @@ -491,6 +499,12 @@ tlpdbopt_w32_multi_user</code></pre> <dl> +<dt id="NOPERLDOC"><code>NOPERLDOC</code></dt> +<dd> + +<p>Don't try to run the <code>--help</code> message through <code>perldoc</code>.</p> + +</dd> <dt id="TEXLIVE_DOWNLOADER"><code>TEXLIVE_DOWNLOADER</code></dt> <dd> @@ -573,19 +587,37 @@ tlpdbopt_w32_multi_user</code></pre> <p>The various command line options for specifying directories override these environment variables; since specifying both is usually accidental, a warning is given if the values are different.</p> </dd> -<dt id="NOPERLDOC"><code>NOPERLDOC</code></dt> -<dd> +</dl> -<p>Don't try to run the <code>--help</code> message through <code>perldoc</code>.</p> +<h1 id="DIRECTORY-TREES">DIRECTORY TREES</h1> -</dd> -</dl> +<p>There are a plethora of ways to specify the plethora of directory trees used by TeX Live. By far the simplest, and recommended, approach is not to change anything. The defaults suffice for the vast majority of installations.</p> + +<p>But, for the sake of explanation, here is a table of the trees and the command line options that change them. The first group of three are system directories, and the second group of three are user directories; the two groups are quite analogous.</p> + +<pre><code>+----------------+--------------------------------------+--------------+------------------+ +| tree | default | group change | single change | ++----------------+--------------------------------------+--------------+------------------+ +| TEXMFLOCAL | /usr/local/texlive/YYYY/texmf-local | --texdir | --texmflocal | +| TEXMFSYSVAR | /usr/local/texlive/YYYY/texmf-var | --texdir | --texmfsysvar | +| TEXMFSYSCONFIG | /usr/local/texlive/YYYY/texmf-config | --texdir | --texmfsysconfig | ++----------------+--------------------------------------+--------------+------------------+ +| TEXMFHOME | ~/texmf | --texuserdir | --texmfhome | +| TEXMFVAR | ~/.texliveYYYY/texmf-var | --texuserdir | --texmfvar | +| TEXMFCONFIG | ~/.texliveYYYY/texmf-config | --texuserdir | --texmfconfig | ++----------------+--------------------------------------+--------------+------------------+</code></pre> + +<p>In addition, as mentioned in the previous section, each tree has an environment variable <code>TEXLIVE_INSTALL_</code><i>tree</i> which overrides the default; command line and profile settings both override environment variable settings.</p> + +<p>The defaults vary slightly on Macs, as explained above in <a href="#OPTIONS">"OPTIONS"</a>.</p> + +<p>For more on the directory trees and their intended usage, see the main TeX Live documentation at <a href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.</p> <h1 id="AUTHORS-AND-COPYRIGHT">AUTHORS AND COPYRIGHT</h1> <p>This script and its documentation were written for the TeX Live distribution (<a href="https://tug.org/texlive">https://tug.org/texlive</a>) and both are licensed under the GNU General Public License Version 2 or later.</p> -<p>$Id: install-tl 63586 2022-06-14 01:04:46Z preining $</p> +<p>$Id: install-tl 63643 2022-06-18 21:43:37Z karl $</p> </body> |