summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/texlive
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-06-13 23:49:37 +0000
committerKarl Berry <karl@freefriends.org>2022-06-13 23:49:37 +0000
commit59adead34f50b227fab3a45b506f1cad7fa7655e (patch)
tree5ed4430361d72563f3fff887a9fd2821b7d621e7 /Master/texmf-dist/doc/texlive
parent1efae0d9eece13fca6d772fc53f4098f6b1f0e00 (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/texlive')
-rw-r--r--Master/texmf-dist/doc/texlive/install-tl.html132
1 files changed, 121 insertions, 11 deletions
diff --git a/Master/texmf-dist/doc/texlive/install-tl.html b/Master/texmf-dist/doc/texlive/install-tl.html
index 9fac75c7506..da7a018e44b 100644
--- a/Master/texmf-dist/doc/texlive/install-tl.html
+++ b/Master/texmf-dist/doc/texlive/install-tl.html
@@ -16,9 +16,9 @@
<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
<li><a href="#REFERENCES">REFERENCES</a></li>
+ <li><a href="#EXAMPLES">EXAMPLES</a></li>
<li><a href="#OPTIONS">OPTIONS</a></li>
<li><a href="#PROFILES">PROFILES</a></li>
- <li><a href="#SPACE-CONSTRAINTS">SPACE CONSTRAINTS</a></li>
<li><a href="#ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a></li>
<li><a href="#AUTHORS-AND-COPYRIGHT">AUTHORS AND COPYRIGHT</a></li>
</ul>
@@ -37,7 +37,7 @@
<p>This installer creates a runnable TeX Live installation from various media, including over the network, from local hard disk, a DVD, etc. The installer works on all platforms supported by TeX Live. For information on initially downloading TeX Live, see <a href="https://tug.org/texlive/acquire.html">https://tug.org/texlive/acquire.html</a>.</p>
-<p>The basic idea of TeX Live installation is for you to choose one of the top-level <i>schemes</i>, each of which is defined as a different set of <i>collections</i> and <i>packages</i>, where a collection is a set of packages, and a package is what contains actual files.</p>
+<p>The basic idea of TeX Live installation is for you to choose one of the top-level <i>schemes</i>, each of which is defined as a different set of <i>collections</i> and <i>packages</i>, where a collection is a set of packages, 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.</p>
<p>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 at the package level, use <code>tlmgr</code> (reference just below) after the initial installation is complete.</p>
@@ -49,8 +49,46 @@
<p>The most up-to-date version of this installer documentation is on the Internet at <a href="https://tug.org/texlive/doc/install-tl.html">https://tug.org/texlive/doc/install-tl.html</a>.</p>
+<p>For step-by-step instructions, see <a href="https://tug.org/texlive/quickinstall.html">https://tug.org/texlive/quickinstall.html</a>.</p>
+
<p>For the full documentation of TeX Live, see <a href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.</p>
+<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>
+
+<dl>
+
+<dt id="install-tl---paper-letter"><code>install-tl --paper=letter</code></dt>
+<dd>
+
+<p>Initialize paper size setting. The only values allowed are <code>letter</code> and (the default) <code>a4</code>.</p>
+
+</dd>
+<dt id="install-tl---scheme-scheme"><code>install-tl --scheme</code> <i>scheme</i></dt>
+<dd>
+
+<p>Initialize the installation scheme; the default is <code>full</code>. For a list of schemes, see the interactive <code>S</code> menu.</p>
+
+</dd>
+<dt id="install-tl---no-interaction"><code>install-tl --no-interaction</code></dt>
+<dd>
+
+<p>Perform the installation immediately after parsing options, without entering the interactive menu.</p>
+
+</dd>
+<dt id="install-tl---profile-texlive.profile"><code>install-tl --profile</code> <i>texlive.profile</i></dt>
+<dd>
+
+<p>Install, without interaction, according to the given TL profile file; see <a href="#PROFILES">&quot;PROFILES&quot;</a> below. To initialize from the profile and then enter the interactive menu, add <code>--init-from-profile</code>.</p>
+
+</dd>
+</dl>
+
+<p>Full documentation follows.</p>
+
<h1 id="OPTIONS">OPTIONS</h1>
<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>
@@ -80,7 +118,7 @@
</dd>
</dl>
-<p>The default GUI 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.</p>
+<p>The default GUI requires Tcl/Tk. This was standard on Macs, but has been removed in the latest macOS releases. It&#39;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>
@@ -131,6 +169,12 @@
<p>Pretend we&#39;re doing a network install, for the sole purpose of testing broken downloads via moving package files aside in a tlnet mirror.</p>
</dd>
+<dt id="debug-setup-vars"><b>-debug-setup-vars</b></dt>
+<dd>
+
+<p>Print final values of directory variables; for more debugging information on how they were set, also specify <code>-v</code>.</p>
+
+</dd>
<dt id="debug-translation"><b>-debug-translation</b></dt>
<dd>
@@ -185,6 +229,18 @@
<p>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.</p>
</dd>
+<dt id="no-installation"><b>-no-installation</b></dt>
+<dd>
+
+<p>Do not perform any installation. This is for debugging the initialization and setup routines without touching the disk.</p>
+
+</dd>
+<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>
+
+</dd>
<dt id="no-persistent-downloads"><b>-no-persistent-downloads</b></dt>
<dd>
@@ -209,6 +265,12 @@
<p>For Windows only: configure for the current user, not for all users.</p>
</dd>
+<dt id="paper-a4-letter"><b>-paper</b> <code>a4</code><b>|</b><code>letter</code></dt>
+<dd>
+
+<p>Set the default paper size for all TeX Live programs, as specified. The default is <code>a4</code>. The paper size can be set after installation with the <code>tlmgr paper</code> command.</p>
+
+</dd>
<dt id="portable"><b>-portable</b></dt>
<dd>
@@ -245,6 +307,56 @@
<p>Include verbose debugging messages; repeat for maximum debugging: <code>-v -v</code>. (Further repeats are accepted but ignored.)</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&#39;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>
+
+</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>
+
+</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>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>
+
+</dd>
+<dt id="texmfhome-dir"><b>-texmfhome</b> <i>dir</i></dt>
+<dd>
+
+<p>Specify the <code>TEXMFHOME</code> directory; the default is <code>~/texmf</code>, except on Macs, where it is <code>~/Library/texmf</code>. Analogously to <code>TEXMFLOCAL</code>, the <code>-texuserdir</code> option changes this default.</p>
+
+<p>Also as with <code>TEXMFLOCAL</code>, anything installed here must follow the TDS.</p>
+
+</dd>
+<dt id="texmfsysconfig-dir"><b>-texmfsysconfig</b> <i>dir</i></dt>
+<dd>
+
+</dd>
+<dt id="texmfsysvar-dir"><b>-texmfsysvar</b> <i>dir</i></dt>
+<dd>
+
+<p>Specify the <code>TEXMFSYSCONFIG</code> and <code>TEXMFSYSVAR</code> system directories.</p>
+
+</dd>
+<dt id="texmfconfig-dir"><b>-texmfconfig</b> <i>dir</i></dt>
+<dd>
+
+</dd>
+<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>
+
+</dd>
<dt id="version---version"><b>-version</b>, <b>--version</b></dt>
<dd>
@@ -320,7 +432,9 @@ TEXMFSYSVAR</code></pre>
<dt id="instopt_portable-default-0"><code>instopt_portable</code> (default 0)</dt>
<dd>
-<p>Install for portable use, e.g., on a USB stick.</p>
+<p>Install for portable use, e.g., on a USB stick, without touching the host system. Specifically, this forces the user directories <code>TEXMFHOME</code>, <code>TEXMFCONFIG</code>, <code>TEXMFVAR</code> to be identical to the system directories <code>TEXMFLOCAL</code>, <code>TEXMFSYSCONFIG</code>, <code>TEXMFSYSVAR</code>, respectively (regardless of other options and environment variable.)</p>
+
+<p>In addition, on Windows, it disables the desktop integration, path adjustment, and file associations actions usually performed.</p>
</dd>
<dt id="instopt_write18_restricted-default-1"><code>instopt_write18_restricted</code> (default 1)</dt>
@@ -361,10 +475,6 @@ tlpdbopt_w32_multi_user</code></pre>
<p>For more details on all of the above options, consult the TeX Live installation manual, linked from <a href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.</p>
-<h1 id="SPACE-CONSTRAINTS">SPACE CONSTRAINTS</h1>
-
-<p>If a POSIX-compliant <code>df</code> program (supporting <code>-P</code>) 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 <code>TEXLIVE_INSTALL_NO_DISKCHECK</code> to 1 will disable it.</p>
-
<h1 id="ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</h1>
<p>For ease in scripting and debugging, <code>install-tl</code> looks for the following environment variables. They are not of interest for normal user installations.</p>
@@ -400,7 +510,7 @@ tlpdbopt_w32_multi_user</code></pre>
<dt id="TEXLIVE_INSTALL_NO_DISKCHECK"><code>TEXLIVE_INSTALL_NO_DISKCHECK</code></dt>
<dd>
-<p>Omit free disk space check.</p>
+<p>If set to 1, omit free disk space check. By default, if a POSIX-compliant <code>df</code> program (supporting <code>-P</code>) 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 <code>df</code>).</p>
</dd>
<dt id="TEXLIVE_INSTALL_NO_RESUME"><code>TEXLIVE_INSTALL_NO_RESUME</code></dt>
@@ -450,7 +560,7 @@ tlpdbopt_w32_multi_user</code></pre>
<p>Specify the respective directories. <code>TEXLIVE_INSTALL_PREFIX</code> defaults to <code>/usr/local/texlive</code>. All the defaults can be seen by running the installer interactively and then typing <code>D</code> for the directory menu.</p>
-<p>To override the so-called <code>TEXDIR</code>, which defaults to the release directory within that prefix, e.g., <code>/usr/local/texlive/2020</code>, use a profile file (q.v.).</p>
+<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>
@@ -465,7 +575,7 @@ tlpdbopt_w32_multi_user</code></pre>
<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 62745 2022-03-16 22:20:47Z karl $</p>
+<p>$Id: install-tl 63573 2022-06-13 02:55:10Z preining $</p>
</body>