From 46e5e8906319117eeaa243a37f31a52845de9e99 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 18 Jun 2022 23:49:44 +0000 Subject: tl-update-auto git-svn-id: svn://tug.org/texlive/trunk@63647 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/texlive/install-tl.html | 120 ++++++++++++++++---------- 1 file changed, 76 insertions(+), 44 deletions(-) (limited to 'Master/texmf-dist/doc/texlive/install-tl.html') 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 @@
  • OPTIONS
  • PROFILES
  • ENVIRONMENT VARIABLES
  • +
  • DIRECTORY TREES
  • AUTHORS AND COPYRIGHT
  • @@ -55,9 +56,7 @@

    EXAMPLES

    -

    With no options, install-tl 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.

    +

    With no options, install-tl 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:

    @@ -93,11 +92,17 @@

    As usual, all options can be specified in any order, and with either a leading - or --. An argument value can be separated from its option by either a space or =.

    +

    The options relating to customization of the installation can also be selected in the interactive installation menus (GUI or text).

    +
    -gui [[=]module]
    +
    +
    -no-gui
    +
    +

    If no module is given, starts the Tcl/Tk (see below) GUI installer.

    If module is given loads the given installer module. Currently the following modules are supported:

    @@ -120,12 +125,6 @@

    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.

    -
    -
    -no-gui
    -
    - -

    Use the text mode installer (default except on Windows and Macs).

    -
    -lang llcode
    @@ -138,7 +137,7 @@

    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 tlmgr has the details (https://tug.org/texlive/doc/tlmgr.html#OPTIONS).

    -

    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 ctan as an abbreviation for this. (See https://ctan.org for more about CTAN and its mirrors.)

    +

    For installation, the default is to pick a mirror automatically, using https://mirror.ctan.org/systems/texlive/tlnet; the chosen mirror is then used for the entire download. You can use the special argument ctan as an abbreviation for this. (See https://ctan.org for more about CTAN and its mirrors.)

    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.

    @@ -158,7 +157,7 @@
    -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 path 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 path are copied over to bin/custom/ under your installation directory and this bin/custom/ directory is what will be added to the path for the post-install actions. To install multiple custom binary sets, manually rename custom before doing each.

    +

    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 path 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 path are copied over to bin/custom/ under your installation directory and this bin/custom/ directory is what will be added to the path for the post-install actions. To install multiple custom binary sets, manually rename custom before doing each.

    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.

    @@ -166,7 +165,7 @@
    -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.

    -debug-setup-vars
    @@ -184,7 +183,7 @@
    -force-platform platform
    -

    Instead of auto-detecting the current platform, use platform. Binaries for this platform must be present and they must actually be runnable, or installation will fail. -force-arch is a synonym.

    +

    Instead of auto-detecting the current platform, use platform. Binaries for this platform must be present in bin/platform/ and they must be runnable, or installation will fail. -force-arch is a synonym.

    -help, --help, -?
    @@ -236,7 +235,16 @@
    -no-src-install
    -

    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 tlmgr:

    + +
    tlmgr option docfiles 1
    +tlmgr option srcfiles 1
    + +

    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 fontspec package as the example):

    + +
    tlmgr install --reinstall --with-doc --with-src fontspec
    + +

    The source files mentioned here are those relating to TeX packages, such as .dtx files. The sources that are compiled to make the binaries are available separately: see https://tug.org/texlive/svn/.

    -no-installation
    @@ -248,7 +256,7 @@
    -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.

    -no-persistent-downloads
    @@ -284,7 +292,7 @@
    -portable
    -

    Install for portable use, e.g., on a USB stick. Also selectable from within the perltk and text installers.

    +

    Install for portable use, e.g., on a USB stick. See the instopt_portable description below for details.

    @@ -308,35 +316,29 @@
    -scheme scheme
    -

    Schemes are the highest level of package grouping in TeX Live; the default is to use the full scheme, which includes everything. This option overrides that default. You can change the scheme again before the actual installation with the usual menu. The scheme argument may optionally have a prefix scheme-. The list of supported scheme names depends on what your package repository provides; see the interactive menu list.

    - -
    -
    -v
    -
    - -

    Include verbose debugging messages; repeat for maximum debugging: -v -v. (Further repeats are accepted but ignored.)

    +

    Schemes are the highest level of package grouping in TeX Live; the default is to use the full scheme, which includes everything. This option overrides that default. The scheme argument value may optionally have a prefix scheme-. The list of supported scheme names depends on what your package repository provides; see the interactive menu list.

    -texdir dir
    -

    Specify the system installation directory; the default is /usr/local/texlive/YYYY for release YYYY. Specifying this option also causes the TEXMFLOCAL, TEXMFSYSCONFIG, and TEXMFSYSVAR directories to be set as subdirectories, so they don't have to be set individually.

    +

    Specify the system installation directory; the default is /usr/local/texlive/YYYY for release YYYY. Specifying this option also causes the TEXMFLOCAL, TEXMFSYSCONFIG, and TEXMFSYSVAR directories to be set as subdirectories of dir, so they don't have to be set individually.

    -

    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 "DIRECTORY TREES" 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.

    -texuserdir dir
    -

    Specify the user installation directory; the default is ~/.texliveYYYY (except on Macs, where there is no leading dot). Specifying this also causes the TEXMFHOME, TEXMFCONFIG, and TEXMFVAR directories to be set as subdirectories.

    +

    Specify the user installation directory; the default is ~/.texliveYYYY (except on Macs, where there is no leading dot). Specifying this also causes the TEXMFHOME, TEXMFCONFIG, and TEXMFVAR directories to be set as subdirectories of dir.

    -texmflocal dir
    -

    Specify the TEXMFLOCAL directory; the default is /usr/local/texlive/texmf-local, 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 -texdir option changes this, putting TEXMFLOCAL under the main tree, on the theory that you want to use some setup different than the default. The -texmflocal option can be used to specify an explicit directory for it.

    +

    Specify the TEXMFLOCAL directory; the default is /usr/local/texlive/texmf-local, 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 -texdir option changes this, putting TEXMFLOCAL under the main tree. The -texmflocal option can be used to specify an explicit directory.

    -

    Anything installed here must follow the TeX directory structure (TDS), e.g., TEXMFHOME/tex/latex/mypkg/mypkg.sty. See the TDS reference at https://tug.org/tds.

    +

    Anything installed here must follow the TeX directory structure (TDS), e.g., TEXMFHOME/tex/latex/mypkg/mypkg.sty. TDS reference: https://tug.org/tds.

    -texmfhome dir
    @@ -364,7 +366,13 @@
    -texmfvar dir
    -

    Specify the TEXMFCONFIG and TEXMFVAR user directories.

    +

    Specify the TEXMFCONFIG and TEXMFVAR user directories. The defaults are ~/.texliveYYYY/texmf-{config,var}, except on Macs, where the leading dot is omitted (~/texliveYYYY/...).

    + +
    +
    -v
    +
    + +

    Include verbose debugging messages; repeat for maximum debugging: -v -v. (Further repeats are accepted but ignored.)

    -version, --version
    @@ -377,9 +385,9 @@

    PROFILES

    -

    A profile 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 tlpkg/texlive.profile. In addition, from the text menu one can select P to save the current setup as a profile at any time.

    +

    A profile 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 tlpkg/texlive.profile. In addition, from the text menu one can select P 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.

    -

    Such a profile file can be given as the argument to -profile, 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.

    +

    Such a profile file can be given as the argument to -profile, 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.

    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 tlmgr to work at the package level.

    @@ -389,7 +397,7 @@

    except for comment lines starting with #. The possible variable names are listed below. Values, when present, are either 0 or 1 for booleans, or strings (which must be specified without any quote characters). Leading whitespace is ignored.

    -

    If the variable selected_scheme is defined and no 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.

    +

    If the variable selected_scheme is defined and no 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.

    For example, a line

    @@ -397,7 +405,7 @@

    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 S menu in the text installer, or equivalent.

    -

    Besides selected_scheme, here is the list of variable names supported in a profile:

    +

    In addition to selected_scheme, here are the other variable names supported in a profile:

    collection options (prefix collection-)

    @@ -407,15 +415,15 @@

    path options

    -

    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.

    TEXDIR
    -TEXMFCONFIG
    -TEXMFVAR
    -TEXMFHOME
     TEXMFLOCAL
     TEXMFSYSCONFIG
    -TEXMFSYSVAR
    +TEXMFSYSVAR +TEXMFCONFIG +TEXMFVAR +TEXMFHOME

    installer options (prefix instopt_)

    @@ -491,6 +499,12 @@ tlpdbopt_w32_multi_user
    +
    NOPERLDOC
    +
    + +

    Don't try to run the --help message through perldoc.

    + +
    TEXLIVE_DOWNLOADER
    @@ -573,19 +587,37 @@ tlpdbopt_w32_multi_user

    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.

    -
    NOPERLDOC
    -
    +
    -

    Don't try to run the --help message through perldoc.

    +

    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.

    + +

    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.

    + +
    +----------------+--------------------------------------+--------------+------------------+
    +|    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    |
    ++----------------+--------------------------------------+--------------+------------------+
    + +

    In addition, as mentioned in the previous section, each tree has an environment variable TEXLIVE_INSTALL_tree which overrides the default; command line and profile settings both override environment variable settings.

    + +

    The defaults vary slightly on Macs, as explained above in "OPTIONS".

    + +

    For more on the directory trees and their intended usage, see the main TeX Live documentation at https://tug.org/texlive/doc.

    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 GNU General Public License Version 2 or later.

    -

    $Id: install-tl 63586 2022-06-14 01:04:46Z preining $

    +

    $Id: install-tl 63643 2022-06-18 21:43:37Z karl $

    -- cgit v1.2.3