diff options
author | Karl Berry <karl@freefriends.org> | 2022-06-13 23:49:37 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2022-06-13 23:49:37 +0000 |
commit | 59adead34f50b227fab3a45b506f1cad7fa7655e (patch) | |
tree | 5ed4430361d72563f3fff887a9fd2821b7d621e7 /Master/texmf-dist/doc/man/man1/install-tl.1 | |
parent | 1efae0d9eece13fca6d772fc53f4098f6b1f0e00 (diff) |
tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@63584 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/install-tl.1')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.1 | 147 |
1 files changed, 127 insertions, 20 deletions
diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1 index 4410071cfbe..addd50eaf4c 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-03-16" "perl v5.34.0" "User Contributed Perl Documentation" +.TH INSTALL-TL 1 "2022-06-13" "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 @@ -156,7 +156,9 @@ on initially downloading TeX Live, see The basic idea of TeX Live installation is for you to choose one of the top-level \fIschemes\fR, each of which is defined as a different set of \&\fIcollections\fR and \fIpackages\fR, where a collection is a set of packages, -and a package is what contains actual files. +and a package is what contains actual files. Each package is in exactly +one collection, while schemes can contain any combination of packages +and collections. .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 work @@ -174,8 +176,41 @@ handled through \fBtlmgr\fR(1), the TeX Live Manager The most up-to-date version of this installer documentation is on the Internet at <https://tug.org/texlive/doc/install\-tl.html>. .PP +For step-by-step instructions, see +<https://tug.org/texlive/quickinstall.html>. +.PP For the full documentation of TeX Live, see <https://tug.org/texlive/doc>. +.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. +.ie n .IP """install\-tl \-\-paper=letter""" 4 +.el .IP "\f(CWinstall\-tl \-\-paper=letter\fR" 4 +.IX Item "install-tl --paper=letter" +Initialize paper size setting. The only values allowed are \f(CW\*(C`letter\*(C'\fR and +(the default) \f(CW\*(C`a4\*(C'\fR. +.ie n .IP """install\-tl \-\-scheme"" \fIscheme\fR" 4 +.el .IP "\f(CWinstall\-tl \-\-scheme\fR \fIscheme\fR" 4 +.IX Item "install-tl --scheme scheme" +Initialize the installation scheme; the default is \f(CW\*(C`full\*(C'\fR. For a list +of schemes, see the interactive \f(CW\*(C`S\*(C'\fR menu. +.ie n .IP """install\-tl \-\-no\-interaction""" 4 +.el .IP "\f(CWinstall\-tl \-\-no\-interaction\fR" 4 +.IX Item "install-tl --no-interaction" +Perform the installation immediately after parsing options, without +entering the interactive menu. +.ie n .IP """install\-tl \-\-profile"" \fItexlive.profile\fR" 4 +.el .IP "\f(CWinstall\-tl \-\-profile\fR \fItexlive.profile\fR" 4 +.IX Item "install-tl --profile texlive.profile" +Install, without interaction, according to the given \s-1TL\s0 profile file; +see \*(L"\s-1PROFILES\*(R"\s0 below. To initialize from the profile and then enter the +interactive menu, add \f(CW\*(C`\-\-init\-from\-profile\*(C'\fR. +.PP +Full documentation follows. .SH "OPTIONS" .IX Header "OPTIONS" As usual, all options can be specified in any order, and with either a @@ -204,10 +239,10 @@ takes you to a screen with roughly the same options as the former .RE .RS 4 .Sp -The default \s-1GUI\s0 requires Tcl/Tk. This is standard on Macs (although it -is considered deprecated since Catalina) and is 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. +The default \s-1GUI\s0 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. .RE .IP "\fB\-no\-gui\fR" 4 .IX Item "-no-gui" @@ -273,6 +308,10 @@ building TeX Live, see <https://tug.org/texlive/build.html>. .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. +.IP "\fB\-debug\-setup\-vars\fR" 4 +.IX Item "-debug-setup-vars" +Print final values of directory variables; for more debugging +information on how they were set, also specify \f(CW\*(C`\-v\*(C'\fR. .IP "\fB\-debug\-translation\fR" 4 .IX Item "-debug-translation" In the former Perl/Tk \s-1GUI\s0 modes, this option reported any missing, @@ -331,6 +370,14 @@ If the retry also fails, by default the installer proceeds to completion anyway, with the idea that it was a transient network problem and reinstallation will succeed later. If this option is specified, and the retry fails, the installer aborts. +.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. .IP "\fB\-no\-persistent\-downloads\fR" 4 .IX Item "-no-persistent-downloads" .PD 0 @@ -356,6 +403,12 @@ section of the \f(CW\*(C`tlmgr\*(C'\fR documentation, e.g., .IP "\fB\-non\-admin\fR" 4 .IX Item "-non-admin" For Windows only: configure for the current user, not for all users. +.ie n .IP "\fB\-paper\fR ""a4""\fB|\fR""letter""" 4 +.el .IP "\fB\-paper\fR \f(CWa4\fR\fB|\fR\f(CWletter\fR" 4 +.IX Item "-paper a4|letter" +Set the default paper size for all TeX Live programs, as specified. +The default is \f(CW\*(C`a4\*(C'\fR. The paper size can be set after installation with +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 @@ -386,6 +439,56 @@ menu list. .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. +.Sp +For more on the several directory trees set up by default, 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. +.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. +.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 +<https://tug.org/tds>. +.IP "\fB\-texmfhome\fR \fIdir\fR" 4 +.IX Item "-texmfhome dir" +Specify the \f(CW\*(C`TEXMFHOME\*(C'\fR directory; the default is \f(CW\*(C`~/texmf\*(C'\fR, except on +Macs, where it is \f(CW\*(C`~/Library/texmf\*(C'\fR. Analogously to \f(CW\*(C`TEXMFLOCAL\*(C'\fR, the +\&\f(CW\*(C`\-texuserdir\*(C'\fR option changes this default. +.Sp +Also as with \f(CW\*(C`TEXMFLOCAL\*(C'\fR, anything installed here must follow the \s-1TDS.\s0 +.IP "\fB\-texmfsysconfig\fR \fIdir\fR" 4 +.IX Item "-texmfsysconfig dir" +.PD 0 +.IP "\fB\-texmfsysvar\fR \fIdir\fR" 4 +.IX Item "-texmfsysvar dir" +.PD +Specify the \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR and \f(CW\*(C`TEXMFSYSVAR\*(C'\fR system directories. +.IP "\fB\-texmfconfig\fR \fIdir\fR" 4 +.IX Item "-texmfconfig dir" +.PD 0 +.IP "\fB\-texmfvar\fR \fIdir\fR" 4 +.IX Item "-texmfvar dir" +.PD +Specify the \f(CW\*(C`TEXMFCONFIG\*(C'\fR and \f(CW\*(C`TEXMFVAR\*(C'\fR user directories. .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 @@ -481,7 +584,14 @@ 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. +Install for portable use, e.g., on a \s-1USB\s0 stick, without touching the +host system. Specifically, this forces the user directories +\&\f(CW\*(C`TEXMFHOME\*(C'\fR, \f(CW\*(C`TEXMFCONFIG\*(C'\fR, \f(CW\*(C`TEXMFVAR\*(C'\fR to be identical to the system +directories \f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR, +respectively (regardless of other options and environment variable.) +.Sp +In addition, on Windows, it disables the desktop integration, path +adjustment, and file associations actions usually performed. .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)" @@ -529,14 +639,6 @@ 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 <https://tug.org/texlive/doc>. -.SH "SPACE CONSTRAINTS" -.IX Header "SPACE CONSTRAINTS" -If a POSIX-compliant \f(CW\*(C`df\*(C'\fR program (supporting \f(CW\*(C`\-P\*(C'\fR) is available, the -installer will check the available disk space in the selected -installation location, and will abort installation if there is -insufficient disk space, plus a margin of 100MB. In case this check is -invalid for your filesystem, setting the environment variable -\&\f(CW\*(C`TEXLIVE_INSTALL_NO_DISKCHECK\*(C'\fR to 1 will disable it. .SH "ENVIRONMENT VARIABLES" .IX Header "ENVIRONMENT VARIABLES" For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR looks for the @@ -569,7 +671,12 @@ Omit creating the ConTeXt cache. This is useful for redistributors. .ie n .IP """TEXLIVE_INSTALL_NO_DISKCHECK""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_NO_DISKCHECK\fR" 4 .IX Item "TEXLIVE_INSTALL_NO_DISKCHECK" -Omit free disk space check. +If set to 1, omit free disk space check. By default, if a +POSIX-compliant \f(CW\*(C`df\*(C'\fR program (supporting \f(CW\*(C`\-P\*(C'\fR) is available, the +installer checks for available disk space in the selected installation +location, and will abort installation if there is insufficient disk +space, plus a margin of 100MB. An equivalent check is made on Windows +(not involving \f(CW\*(C`df\*(C'\fR). .ie n .IP """TEXLIVE_INSTALL_NO_RESUME""" 4 .el .IP "\f(CWTEXLIVE_INSTALL_NO_RESUME\fR" 4 .IX Item "TEXLIVE_INSTALL_NO_RESUME" @@ -612,9 +719,9 @@ Specify the respective directories. \f(CW\*(C`TEXLIVE_INSTALL_PREFIX\*(C'\fR def to \f(CW\*(C`/usr/local/texlive\*(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. .Sp -To override the so-called \f(CW\*(C`TEXDIR\*(C'\fR, which defaults to the release -directory within that prefix, e.g., \f(CW\*(C`/usr/local/texlive/2020\*(C'\fR, use a -profile file (q.v.). +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" @@ -625,4 +732,4 @@ 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 62745 2022\-03\-16 22:20:47Z karl $ +\&\f(CW$Id:\fR install-tl 63573 2022\-06\-13 02:55:10Z preining $ |