diff options
author | Karl Berry <karl@freefriends.org> | 2023-02-26 21:56:36 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2023-02-26 21:56:36 +0000 |
commit | a836aa89aaff61055928dbf4ba0ea3ef8f15bc51 (patch) | |
tree | c596163059357f93ad260db853fd3955219d87f1 /Build/source/doc | |
parent | 5f54db29da979f05965d02659e3f6530b5c8c228 (diff) |
general doc update for engines/etc.
git-svn-id: svn://tug.org/texlive/trunk@66203 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Build/source/doc')
-rw-r--r-- | Build/source/doc/Makefile.am | 1 | ||||
-rw-r--r-- | Build/source/doc/Makefile.in | 2 | ||||
-rw-r--r-- | Build/source/doc/tlbuild-incl/install-tl.texi | 400 | ||||
-rw-r--r-- | Build/source/doc/tlbuild-incl/tlmgr.texi | 471 | ||||
-rw-r--r-- | Build/source/doc/tlbuild.info | 4145 |
5 files changed, 2732 insertions, 2287 deletions
diff --git a/Build/source/doc/Makefile.am b/Build/source/doc/Makefile.am index d254f6fa0ea..1eb7b8f5690 100644 --- a/Build/source/doc/Makefile.am +++ b/Build/source/doc/Makefile.am @@ -16,6 +16,7 @@ EXTRA_DIST = \ # no reasonable way to avoid it with the pod doc. MAKEINFOFLAGS = --set INFO_SPECIAL_CHARS_WARNING=0 +MAKEINFOFLAGS += --disable-encoding # autogenerate the top-level README files. readme-files: tlbuild.info diff --git a/Build/source/doc/Makefile.in b/Build/source/doc/Makefile.in index 48f737d3061..8802ef3b7a1 100644 --- a/Build/source/doc/Makefile.in +++ b/Build/source/doc/Makefile.in @@ -463,7 +463,7 @@ EXTRA_DIST = \ # no reasonable way to avoid it with the pod doc. -MAKEINFOFLAGS = --set INFO_SPECIAL_CHARS_WARNING=0 +MAKEINFOFLAGS = --set INFO_SPECIAL_CHARS_WARNING=0 --disable-encoding # autogenerate texinfo from install-tl and tlmgr pod. # none of this is intended to be executed except manually. diff --git a/Build/source/doc/tlbuild-incl/install-tl.texi b/Build/source/doc/tlbuild-incl/install-tl.texi index 957f361ec55..7495627cc7e 100644 --- a/Build/source/doc/tlbuild-incl/install-tl.texi +++ b/Build/source/doc/tlbuild-incl/install-tl.texi @@ -1,31 +1,20 @@ @node install-tl @appendix install-tl -@menu -* install-tl NAME:: -* install-tl SYNOPSIS:: -* install-tl DESCRIPTION:: -* install-tl REFERENCES:: -* install-tl OPTIONS:: -* install-tl PROFILES:: -* install-tl ENVIRONMENT VARIABLES:: -* install-tl AUTHORS AND COPYRIGHT:: -@end menu - @node install-tl NAME -@appendixsec NAME +@appendixsec install-tl NAME install-tl - TeX Live cross-platform installer @node install-tl SYNOPSIS -@appendixsec SYNOPSIS +@appendixsec install-tl SYNOPSIS install-tl [@emph{option}]... install-tl-windows.bat [@emph{option}]... @node install-tl DESCRIPTION -@appendixsec DESCRIPTION +@appendixsec install-tl DESCRIPTION This installer creates a runnable TeX Live installation from various media, including over the network, from local hard disk, a DVD, etc. The @@ -36,7 +25,9 @@ on initially downloading TeX Live, see The basic idea of TeX Live installation is for you to choose one of the top-level @emph{schemes}, each of which is defined as a different set of @emph{collections} and @emph{packages}, 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. 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 @@ -56,20 +47,67 @@ handled through @strong{tlmgr}(1), the TeX Live Manager The most up-to-date version of this installer documentation is on the Internet at @url{https://tug.org/texlive/doc/install-tl.html}. +For step-by-step instructions, see +@url{https://tug.org/texlive/quickinstall.html}. + For the full documentation of TeX Live, see @url{https://tug.org/texlive/doc}. +@node install-tl EXAMPLES +@appendixsec install-tl EXAMPLES + +With no options, @code{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: + +@table @asis +@item @code{install-tl --paper=letter} +@anchor{install-tl @code{install-tl --paper=letter}} + +Initialize paper size setting. The only values allowed are @code{letter} and +(the default) @code{a4}. + +@item @code{install-tl --scheme} @emph{scheme} +@anchor{install-tl @code{install-tl --scheme} @emph{scheme}} + +Initialize the installation scheme; the default is @code{full}. For a list +of schemes, see the interactive @code{S} menu. + +@item @code{install-tl --no-interaction} +@anchor{install-tl @code{install-tl --no-interaction}} + +Perform the installation immediately after parsing options, without +entering the interactive menu. + +@item @code{install-tl --profile} @emph{texlive.profile} +@anchor{install-tl @code{install-tl --profile} @emph{texlive.profile}} + +Install, without interaction, according to the given TL profile file; +see @ref{install-tl PROFILES,, PROFILES} below. To initialize from the profile and then enter the +interactive menu, add @code{--init-from-profile}. + +@end table + +Full documentation follows. + @node install-tl OPTIONS -@appendixsec OPTIONS +@appendixsec install-tl OPTIONS As usual, all options can be specified in any order, and with either a leading @code{-} or @code{--}. An argument value can be separated from its option by either a space or @code{=}. +The options relating to customization of the installation can also be +selected in the interactive installation menus (GUI or text). + @table @asis @item @strong{-gui} [[=]@emph{module}] @anchor{install-tl @strong{-gui} [[=]@emph{module}]} +@item @strong{-no-gui} +@anchor{install-tl @strong{-no-gui}} + If no @emph{module} is given, starts the Tcl/Tk (see below) GUI installer. If @emph{module} is given loads the given installer module. Currently the @@ -93,15 +131,10 @@ takes you to a screen with roughly the same options as the former @end table -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. - -@item @strong{-no-gui} -@anchor{install-tl @strong{-no-gui}} - -Use the text mode installer (default except on Windows and Macs). +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. @item @strong{-lang} @emph{llcode} @anchor{install-tl @strong{-lang} @emph{llcode}} @@ -126,9 +159,9 @@ http(s), ftp, or scp. The documentation for @code{tlmgr} has the details For installation, the default is to pick a mirror automatically, using @url{https://mirror.ctan.org/systems/texlive/tlnet}; the chosen mirror is -used for the entire download. You can use the special argument @code{ctan} -as an abbreviation for this. (See @url{https://ctan.org} for more about CTAN -and its mirrors.) +then used for the entire download. You can use the special argument +@code{ctan} as an abbreviation for this. (See @url{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 @@ -156,15 +189,15 @@ settings. @item @strong{-custom-bin} @emph{path} @anchor{install-tl @strong{-custom-bin} @emph{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 @emph{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 @emph{path} are copied over to -@code{bin/custom/} under your installation directory and this @code{bin/custom/} -directory is what will be added to the path for the post-install -actions. To install multiple custom binary sets, manually rename -@code{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 @emph{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 @emph{path} are copied over +to @code{bin/custom/} under your installation directory and this +@code{bin/custom/} directory is what will be added to the path for the +post-install actions. To install multiple custom binary sets, manually +rename @code{custom} before doing each. For more information on custom binaries, see @url{https://tug.org/texlive/custom-bin.html}. For general information on @@ -173,8 +206,15 @@ building TeX Live, see @url{https://tug.org/texlive/build.html}. @item @strong{-debug-fakenet} @anchor{install-tl @strong{-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. + +@item @strong{-debug-setup-vars} +@anchor{install-tl @strong{-debug-setup-vars}} + +Print final values of directory variables; for more debugging +information on how they were set, also specify @code{-v}. @item @strong{-debug-translation} @anchor{install-tl @strong{-debug-translation}} @@ -188,11 +228,12 @@ what remains to be done. @anchor{install-tl @strong{-force-platform} @emph{platform}} Instead of auto-detecting the current platform, use @emph{platform}. -Binaries for this platform must be present and they must actually be -runnable, or installation will fail. @code{-force-arch} is a synonym. +Binaries for this platform must be present in @code{bin/}@emph{platform}@code{/} and +they must be runnable, or installation will fail. @code{-force-arch} is a +synonym. -@item @strong{-help}, @strong{--help}, @strong{-?} -@anchor{install-tl @strong{-help}@comma{} @strong{--help}@comma{} @strong{-?}} +@item @strong{-help}, @strong{@asis{}-@asis{}-@asis{}help}, @strong{-?} +@anchor{install-tl @strong{-help}@comma{} @strong{@asis{}-@asis{}-@asis{}help}@comma{} @strong{-?}} Display this help and exit. (This help is also on the web at @url{https://tug.org/texlive/doc/install-tl.html}). Sometimes the @code{perldoc} @@ -234,7 +275,61 @@ release. @anchor{install-tl @strong{-no-cls}} For the text mode installer only: do not clear the screen when entering -a new menu (for debugging purposes). +a new menu. For debugging. + +@item @strong{-no-continue} +@anchor{install-tl @strong{-no-continue}} + +Quit early on installation failure of a non-core package. + +By default, a few core packages are installed first; then, a failed +installation of any other (non-core) package is noted, but does not stop +the installation. Any such failed packages are retried, once. + +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. + +@item @strong{-no-doc-install} +@anchor{install-tl @strong{-no-doc-install}} + +@item @strong{-no-src-install} +@anchor{install-tl @strong{-no-src-install}} + +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}: + +@verbatim + tlmgr option docfiles 1 + tlmgr option srcfiles 1 +@end verbatim + +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} package as the example): + +@verbatim + tlmgr install --reinstall --with-doc --with-src fontspec +@end verbatim + +The source files mentioned here are those relating to TeX packages, such +as @code{.dtx} files. The sources that are compiled to make the binaries are +available separately: see @url{https://tug.org/texlive/svn/}. + +@item @strong{-no-installation} +@anchor{install-tl @strong{-no-installation}} + +Do not perform any installation. This is for debugging the +initialization and setup routines without touching the disk. + +@item @strong{-no-interaction} +@anchor{install-tl @strong{-no-interaction}} + +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. @item @strong{-no-persistent-downloads} @anchor{install-tl @strong{-no-persistent-downloads}} @@ -243,7 +338,7 @@ a new menu (for debugging purposes). @anchor{install-tl @strong{-persistent-downloads}} For network installs, activating this option makes the installer try to -set up a persistent connection using the @code{Net::LWP} Perl module. This +set up a persistent connection using the @code{LWP} Perl module. This opens only one connection between your computer and the server per session and reuses it, instead of initiating a new download for each package, which typically yields a significant speed-up. @@ -266,11 +361,18 @@ section of the @code{tlmgr} documentation, e.g., For Windows only: configure for the current user, not for all users. +@item @strong{-paper} @code{a4}@strong{|}@code{letter} +@anchor{install-tl @strong{-paper} @code{a4}@strong{|}@code{letter}} + +Set the default paper size for all TeX Live programs, as specified. +The default is @code{a4}. The paper size can be set after installation with +the @code{tlmgr paper} command. + @item @strong{-portable} @anchor{install-tl @strong{-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 +@code{instopt_portable} description below for details. @item @strong{-print-platform} @anchor{install-tl @strong{-print-platform}} @@ -295,21 +397,84 @@ Omit normal informational messages. @anchor{install-tl @strong{-scheme} @emph{scheme}} Schemes are the highest level of package grouping in TeX Live; the -default is to use the @code{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 @emph{scheme} argument may -optionally have a prefix @code{scheme-}. The list of supported scheme names +default is to use the @code{full} scheme, which includes everything. This +option overrides that default. The @emph{scheme} argument value may +optionally have a prefix @code{scheme-}. The list of supported scheme names depends on what your package repository provides; see the interactive menu list. +@item @strong{-texdir} @emph{dir} +@anchor{install-tl @strong{-texdir} @emph{dir}} + +Specify the system installation directory; the default is +@code{/usr/local/texlive/YYYY} for release YYYY. Specifying this option also +causes the @code{TEXMFLOCAL}, @code{TEXMFSYSCONFIG}, and @code{TEXMFSYSVAR} +directories to be set as subdirectories of @emph{dir}, so they don't have to +be set individually. + +There is a brief summary of these directories trees at @ref{install-tl DIRECTORY +TREES,, DIRECTORY +TREES} below; for details on the trees set up by default, and their +intended usage, see the main TeX Live documentation at +@url{https://tug.org/texlive/doc}. + +@item @strong{-texuserdir} @emph{dir} +@anchor{install-tl @strong{-texuserdir} @emph{dir}} + +Specify the user installation directory; the default is +@code{~/.texliveYYYY} (except on Macs, where there is no leading dot). +Specifying this also causes the @code{TEXMFHOME}, @code{TEXMFCONFIG}, and +@code{TEXMFVAR} directories to be set as subdirectories of @emph{dir}. + +@item @strong{-texmflocal} @emph{dir} +@anchor{install-tl @strong{-texmflocal} @emph{dir}} + +Specify the @code{TEXMFLOCAL} directory; the default is +@code{/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 @code{-texdir} +option changes this, putting @code{TEXMFLOCAL} under the main tree. The +@code{-texmflocal} option can be used to specify an explicit directory. + +Anything installed here must follow the TeX directory structure (TDS), +e.g., @code{TEXMFHOME/tex/latex/mypkg/mypkg.sty}. TDS reference: +@url{https://tug.org/tds}. + +@item @strong{-texmfhome} @emph{dir} +@anchor{install-tl @strong{-texmfhome} @emph{dir}} + +Specify the @code{TEXMFHOME} directory; the default is @code{~/texmf}, except on +Macs, where it is @code{~/Library/texmf}. Analogously to @code{TEXMFLOCAL}, the +@code{-texuserdir} option changes this default. + +Also as with @code{TEXMFLOCAL}, anything installed here must follow the TDS. + +@item @strong{-texmfsysconfig} @emph{dir} +@anchor{install-tl @strong{-texmfsysconfig} @emph{dir}} + +@item @strong{-texmfsysvar} @emph{dir} +@anchor{install-tl @strong{-texmfsysvar} @emph{dir}} + +Specify the @code{TEXMFSYSCONFIG} and @code{TEXMFSYSVAR} system directories. + +@item @strong{-texmfconfig} @emph{dir} +@anchor{install-tl @strong{-texmfconfig} @emph{dir}} + +@item @strong{-texmfvar} @emph{dir} +@anchor{install-tl @strong{-texmfvar} @emph{dir}} + +Specify the @code{TEXMFCONFIG} and @code{TEXMFVAR} user directories. +The defaults are @code{~/.texliveYYYY/texmf-@{config,var@}}, except on Macs, +where the leading dot is omitted (@code{~/texliveYYYY/...}). + @item @strong{-v} @anchor{install-tl @strong{-v}} Include verbose debugging messages; repeat for maximum debugging: @code{-v -v}. (Further repeats are accepted but ignored.) -@item @strong{-version}, @strong{--version} -@anchor{install-tl @strong{-version}@comma{} @strong{--version}} +@item @strong{-version}, @strong{@asis{}-@asis{}-@asis{}version} +@anchor{install-tl @strong{-version}@comma{} @strong{@asis{}-@asis{}-@asis{}version}} Output version information and exit. If @code{-v} is also given, the versions of the TeX Live modules used are also reported. @@ -319,17 +484,18 @@ versions of the TeX Live modules used are also reported. @node install-tl PROFILES @appendixsec PROFILES -A @emph{profile} file contains all the values needed to perform an -installation. After a normal installation has finished, a profile for +A @emph{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 @code{tlpkg/texlive.profile}. In addition, from the text menu one can select @code{P} 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. Such a profile file can be given as the argument to @code{-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. +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 @@ -347,9 +513,9 @@ characters). Leading whitespace is ignored. If the variable @code{selected_scheme} is defined and @emph{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. +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 @@ -362,8 +528,8 @@ under "path options") suffices to install the "small" scheme with all default options. The schemes are described in the @code{S} menu in the text installer, or equivalent. -Besides @code{selected_scheme}, here is the list of variable names supported -in a profile: +In addition to @code{selected_scheme}, here are the other variable names +supported in a profile: @strong{collection options} (prefix @code{collection-}) @@ -377,18 +543,18 @@ files in the @code{tlpkg/tlpsrc/} source directory. @strong{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. @verbatim TEXDIR - TEXMFCONFIG - TEXMFVAR - TEXMFHOME TEXMFLOCAL TEXMFSYSCONFIG TEXMFSYSVAR + TEXMFCONFIG + TEXMFVAR + TEXMFHOME @end verbatim @strong{installer options} (prefix @code{instopt_}) @@ -413,7 +579,14 @@ Set letter size paper as the default, instead of a4. @item @code{instopt_portable} (default 0) @anchor{install-tl @code{instopt_portable} (default 0)} -Install for portable use, e.g., on a USB stick. +Install for portable use, e.g., on a USB stick, without touching the +host system. Specifically, this forces the user directories +@code{TEXMFHOME}, @code{TEXMFCONFIG}, @code{TEXMFVAR} to be identical to the system +directories @code{TEXMFLOCAL}, @code{TEXMFSYSCONFIG}, @code{TEXMFSYSVAR}, +respectively (regardless of other options and environment variable.) + +In addition, on Windows, it disables the desktop integration, path +adjustment, and file associations actions usually performed. @item @code{instopt_write18_restricted} (default 1) @anchor{install-tl @code{instopt_write18_restricted} (default 1)} @@ -473,6 +646,11 @@ following environment variables. They are not of interest for normal user installations. @table @asis +@item @code{NOPERLDOC} +@anchor{install-tl @code{NOPERLDOC}} + +Don't try to run the @code{--help} message through @code{perldoc}. + @item @code{TEXLIVE_DOWNLOADER} @anchor{install-tl @code{TEXLIVE_DOWNLOADER}} @@ -498,6 +676,16 @@ variables. Omit creating the ConTeXt cache. This is useful for redistributors. +@item @code{TEXLIVE_INSTALL_NO_DISKCHECK} +@anchor{install-tl @code{TEXLIVE_INSTALL_NO_DISKCHECK}} + +If set to 1, omit free disk space check. By default, if a +POSIX-compliant @code{df} program (supporting @code{-Pk}) 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}). + @item @code{TEXLIVE_INSTALL_NO_RESUME} @anchor{install-tl @code{TEXLIVE_INSTALL_NO_RESUME}} @@ -541,16 +729,72 @@ Specify the respective directories. @code{TEXLIVE_INSTALL_PREFIX} defaults to @code{/usr/local/texlive}. All the defaults can be seen by running the installer interactively and then typing @code{D} for the directory menu. -To override the so-called @code{TEXDIR}, which defaults to the release -directory within that prefix, e.g., @code{/usr/local/texlive/2020}, 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. -@item @code{NOPERLDOC} -@anchor{install-tl @code{NOPERLDOC}} +@end table -Don't try to run the @code{--help} message through @code{perldoc}. +@node install-tl DIRECTORY TREES +@appendixsec DIRECTORY TREES -@end table +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. + +@verbatim + +----------------+--------------------------------------+--------------+------------------+ + | tree | default | group change | single change | + +----------------+--------------------------------------+--------------+------------------+ + | TEXMFLOCAL | /usr/local/texlive/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 | + +----------------+--------------------------------------+--------------+------------------+ +@end verbatim + +In addition, as mentioned in the previous section, each tree has an +environment variable @code{TEXLIVE_INSTALL_}@emph{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 @ref{install-tl OPTIONS,, OPTIONS}. + +For the user trees, the default value uses @code{~}, and this is left as a +literal @code{~} in @code{texmf.cnf}. That way, each user can have their own +@code{TEXMFHOME}, etc., as intended. On the other hand, for the system +trees, if @code{~} is used during the installation, this is assumed to +simply be a typing shorthand, and the expanded home directory is written +in @code{texmf.cnf}, since it doesn't make sense to have user-specific +system directories. + +For more on the directory trees and their intended usage, see the main +TeX Live documentation at @url{https://tug.org/texlive/doc}. + +@node install-tl BUGS +@appendixsec install-tl BUGS + +The @code{install-tl} script copies itself into the installed tree. +Usually, it can be run from there, using the installed tree as the +source for another installation. Occasionally, however, there may be +incompatibilities in the code of the new @code{install-tl} and the +infrastructure, resulting in (probably) inscrutable Perl errors. The +way forward is to run @code{install-tl} out of the installer package +(@code{install-tl-unx.tar.gz} or @code{install-tl.zip}) instead of the +installation. Feel free to also report the issue; usually the code +can be easily synced up again. + +By the way, do not try to use @code{install-tl} to adjust options or +installed packages in an existing installed tree. Use @code{tlmgr} instead. @node install-tl AUTHORS AND COPYRIGHT @appendixsec AUTHORS AND COPYRIGHT @@ -559,5 +803,5 @@ This script and its documentation were written for the TeX Live distribution (@url{https://tug.org/texlive}) and both are licensed under the GNU General Public License Version 2 or later. -$Id: install-tl 62146 2022-02-22 22:48:10Z karl $ +$Id: install-tl 66112 2023-02-23 23:28:27Z karl $ diff --git a/Build/source/doc/tlbuild-incl/tlmgr.texi b/Build/source/doc/tlbuild-incl/tlmgr.texi index f1a4403831f..c80589363c4 100644 --- a/Build/source/doc/tlbuild-incl/tlmgr.texi +++ b/Build/source/doc/tlbuild-incl/tlmgr.texi @@ -1,35 +1,18 @@ @node tlmgr @appendix tlmgr -@menu -* tlmgr NAME:: -* tlmgr SYNOPSIS:: -* tlmgr DESCRIPTION:: -* tlmgr EXAMPLES:: -* tlmgr OPTIONS:: -* tlmgr ACTIONS:: -* tlmgr CONFIGURATION FILE FOR TLMGR:: -* tlmgr CRYPTOGRAPHIC VERIFICATION:: -* tlmgr USER MODE:: -* tlmgr MULTIPLE REPOSITORIES:: -* tlmgr GUI FOR TLMGR:: -* tlmgr MACHINE-READABLE OUTPUT:: -* tlmgr ENVIRONMENT VARIABLES:: -* tlmgr AUTHORS AND COPYRIGHT:: -@end menu - @node tlmgr NAME -@appendixsec NAME +@appendixsec tlmgr NAME tlmgr - the native TeX Live Manager @node tlmgr SYNOPSIS -@appendixsec SYNOPSIS +@appendixsec tlmgr SYNOPSIS tlmgr [@emph{option}...] @emph{action} [@emph{option}...] [@emph{operand}...] @node tlmgr DESCRIPTION -@appendixsec DESCRIPTION +@appendixsec tlmgr DESCRIPTION @strong{tlmgr} manages an existing TeX Live installation, both packages and configuration options. For information on initially downloading and @@ -51,7 +34,7 @@ See @url{https://tug.org/texlive/doc} for all the TeX Live documentation available. @node tlmgr EXAMPLES -@appendixsec EXAMPLES +@appendixsec tlmgr EXAMPLES After successfully installing TeX Live, here are a few common operations with @code{tlmgr}: @@ -61,7 +44,7 @@ with @code{tlmgr}: @anchor{tlmgr @code{tlmgr option repository ctan}} @item @code{tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet} -@anchor{tlmgr @code{tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet}} +@anchor{tlmgr @code{tlmgr option repository https@asis{:}//mirror.ctan.org/systems/texlive/tlnet}} Tell @code{tlmgr} to use a nearby CTAN mirror for future updates; useful if you installed TeX Live from the DVD image and want to have continuing @@ -97,7 +80,7 @@ For all the capabilities and details of @code{tlmgr}, please read the following voluminous information. @node tlmgr OPTIONS -@appendixsec OPTIONS +@appendixsec tlmgr OPTIONS The following options to @code{tlmgr} are global options, not specific to any action. All options, whether global or action-specific, can be @@ -107,8 +90,8 @@ non-option argument will be the main action. In all cases, between an option name and its value. @table @asis -@item @strong{--repository} @emph{url|path} -@anchor{tlmgr @strong{--repository} @emph{url|path}} +@item @strong{@asis{}-@asis{}-@asis{}repository} @emph{url|path} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}repository} @emph{url|path}} Specify the package repository from which packages should be installed or updated, either a local directory or network location, as below. This @@ -147,7 +130,7 @@ Locations can be specified as any of the following: @anchor{tlmgr @code{/some/local/dir}} @item @code{file:/some/local/dir} -@anchor{tlmgr @code{file:/some/local/dir}} +@anchor{tlmgr @code{file@asis{:}/some/local/dir}} Equivalent ways of specifying a local directory. @@ -155,7 +138,7 @@ Equivalent ways of specifying a local directory. @anchor{tlmgr @code{ctan}} @item @code{https://mirror.ctan.org/systems/texlive/tlnet} -@anchor{tlmgr @code{https://mirror.ctan.org/systems/texlive/tlnet}} +@anchor{tlmgr @code{https@asis{:}//mirror.ctan.org/systems/texlive/tlnet}} Pick a CTAN mirror automatically, trying for one that is both nearby and up-to-date. The chosen mirror is used for the entire download. The bare @@ -163,7 +146,7 @@ up-to-date. The chosen mirror is used for the entire download. The bare more about CTAN and its mirrors.) @item @code{http://server/path/to/tlnet} -@anchor{tlmgr @code{http://server/path/to/tlnet}} +@anchor{tlmgr @code{http@asis{:}//server/path/to/tlnet}} Standard HTTP. If the (default) LWP method is used, persistent connections are supported. TL can also use @code{curl} or @code{wget} to do the @@ -172,7 +155,7 @@ downloads, or an arbitrary user-specified program, as described in the (@url{https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES}). @item @code{https://server/path/to/tlnet} -@anchor{tlmgr @code{https://server/path/to/tlnet}} +@anchor{tlmgr @code{https@asis{:}//server/path/to/tlnet}} Again, if the (default) LWP method is used, this supports persistent connections. Unfortunately, some versions of @code{wget} and @code{curl} do not @@ -182,19 +165,19 @@ certificate roots. The simplest workaround for this problem is to use http or ftp. @item @code{ftp://server/path/to/tlnet} -@anchor{tlmgr @code{ftp://server/path/to/tlnet}} +@anchor{tlmgr @code{ftp@asis{:}//server/path/to/tlnet}} If the (default) LWP method is used, persistent connections are supported. @item @code{user@@machine:/path/to/tlnet} -@anchor{tlmgr @code{user@@machine:/path/to/tlnet}} +@anchor{tlmgr @code{user@@machine@asis{:}/path/to/tlnet}} @item @code{scp://user@@machine/path/to/tlnet} -@anchor{tlmgr @code{scp://user@@machine/path/to/tlnet}} +@anchor{tlmgr @code{scp@asis{:}//user@@machine/path/to/tlnet}} @item @code{ssh://user@@machine/path/to/tlnet} -@anchor{tlmgr @code{ssh://user@@machine/path/to/tlnet}} +@anchor{tlmgr @code{ssh@asis{:}//user@@machine/path/to/tlnet}} These forms are equivalent; they all use @code{scp} to transfer files. Using @code{ssh-agent} is recommended. (Info: @@ -206,8 +189,8 @@ These forms are equivalent; they all use @code{scp} to transfer files. Using If the repository is on the network, trailing @code{/} characters and/or trailing @code{/tlpkg} and/or @code{/archive} components are ignored. -@item @strong{--gui} [@emph{action}] -@anchor{tlmgr @strong{--gui} [@emph{action}]} +@item @strong{@asis{}-@asis{}-@asis{}gui} [@emph{action}] +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}gui} [@emph{action}]} Two notable GUI front-ends for @code{tlmgr}, @code{tlshell} and @code{tlcockpit}, are started up as separate programs; see their own documentation. @@ -228,8 +211,8 @@ However, the native GUI requires Perl/TK, which is no longer included in TeX Live's Perl distribution for Windows. You may find @code{tlshell} or @code{tlcockpit} easier to work with. -@item @strong{--gui-lang} @emph{llcode} -@anchor{tlmgr @strong{--gui-lang} @emph{llcode}} +@item @strong{@asis{}-@asis{}-@asis{}gui-lang} @emph{llcode} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}gui-lang} @emph{llcode}} By default, the GUI tries to deduce your language from the environment (on Windows via the registry, on Unix via @code{LC_MESSAGES}). If that fails @@ -244,54 +227,54 @@ necessarily completely translated) are: @w{English (en, default)}, tlshell shares its message catalog with tlmgr. -@item @strong{--command-logfile} @emph{file} -@anchor{tlmgr @strong{--command-logfile} @emph{file}} +@item @strong{@asis{}-@asis{}-@asis{}command-logfile} @emph{file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}command-logfile} @emph{file}} @code{tlmgr} logs the output of all programs invoked (mktexlr, mtxrun, fmtutil, updmap) to a separate log file, by default @code{TEXMFSYSVAR/web2c/tlmgr-commands.log}. This option allows you to specify a different file for the log. -@item @strong{--debug-translation} -@anchor{tlmgr @strong{--debug-translation}} +@item @strong{@asis{}-@asis{}-@asis{}debug-translation} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}debug-translation}} In GUI mode, this switch tells @code{tlmgr} to report any untranslated (or missing) messages to standard error. This can help translators to see what remains to be done. -@item @strong{--machine-readable} -@anchor{tlmgr @strong{--machine-readable}} +@item @strong{@asis{}-@asis{}-@asis{}machine-readable} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}machine-readable}} Instead of the normal output intended for human consumption, write (to standard output) a fixed format more suitable for machine parsing. See the @ref{tlmgr MACHINE-READABLE OUTPUT,, MACHINE-READABLE OUTPUT} section below. -@item @strong{--no-execute-actions} -@anchor{tlmgr @strong{--no-execute-actions}} +@item @strong{@asis{}-@asis{}-@asis{}no-execute-actions} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-execute-actions}} Suppress the execution of the execute actions as defined in the tlpsrc files. Documented only for completeness, as this is only useful in debugging. -@item @strong{--package-logfile} @emph{file} -@anchor{tlmgr @strong{--package-logfile} @emph{file}} +@item @strong{@asis{}-@asis{}-@asis{}package-logfile} @emph{file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}package-logfile} @emph{file}} @code{tlmgr} logs all package actions (install, remove, update, failed updates, failed restores) to a separate log file, by default @code{TEXMFSYSVAR/web2c/tlmgr.log}. This option allows you to specify a different file for the log. -@item @strong{--pause} -@anchor{tlmgr @strong{--pause}} +@item @strong{@asis{}-@asis{}-@asis{}pause} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}pause}} This option makes @code{tlmgr} wait for user input before exiting. Useful on Windows to avoid disappearing command windows. -@item @strong{--persistent-downloads} -@anchor{tlmgr @strong{--persistent-downloads}} +@item @strong{@asis{}-@asis{}-@asis{}persistent-downloads} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}persistent-downloads}} -@item @strong{--no-persistent-downloads} -@anchor{tlmgr @strong{--no-persistent-downloads}} +@item @strong{@asis{}-@asis{}-@asis{}no-persistent-downloads} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-persistent-downloads}} For network-based installations, this option (on by default) makes @code{tlmgr} try to set up a persistent connection (using the @code{LWP} Perl @@ -302,25 +285,25 @@ download for each package. If this is not possible, @code{tlmgr} will fall back to using @code{wget}. To disable these persistent connections, use @code{--no-persistent-downloads}. -@item @strong{--pin-file} -@anchor{tlmgr @strong{--pin-file}} +@item @strong{@asis{}-@asis{}-@asis{}pin-file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}pin-file}} Change the pinning file location from @code{TEXMFLOCAL/tlpkg/pinning.txt} (see @ref{tlmgr Pinning,, Pinning} below). Documented only for completeness, as this is only useful in debugging. -@item @strong{--usermode} -@anchor{tlmgr @strong{--usermode}} +@item @strong{@asis{}-@asis{}-@asis{}usermode} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}usermode}} Activates user mode for this run of @code{tlmgr}; see @ref{tlmgr USER MODE,, USER MODE} below. -@item @strong{--usertree} @emph{dir} -@anchor{tlmgr @strong{--usertree} @emph{dir}} +@item @strong{@asis{}-@asis{}-@asis{}usertree} @emph{dir} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}usertree} @emph{dir}} Uses @emph{dir} for the tree in user mode; see @ref{tlmgr USER MODE,, USER MODE} below. -@item @strong{--verify-repo=[none|main|all]} -@anchor{tlmgr @strong{--verify-repo=[none|main|all]}} +@item @strong{@asis{}-@asis{}-@asis{}verify-repo=[none|main|all]} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}verify-repo=[none|main|all]}} Defines the level of verification done: If @code{none} is specified, no verification whatsoever is done. If @code{main} is given and a working GnuPG @@ -343,39 +326,6 @@ revision number for the loaded TeX Live Perl modules are shown, too. @node tlmgr ACTIONS @appendixsec ACTIONS -@menu -* tlmgr help:: -* tlmgr version:: -* tlmgr backup:: -* tlmgr candidates @emph{pkg}:: -* tlmgr check [@emph{option}...] [depends|executes|files|runfiles|texmfdbs|all]:: -* tlmgr conf:: -* tlmgr dump-tlpdb [@emph{option}...] [--json]:: -* tlmgr generate:: -* tlmgr gui:: -* tlmgr info:: -* tlmgr init-usertree:: -* tlmgr install [@emph{option}...] @emph{pkg}...:: -* tlmgr key:: -* tlmgr list:: -* tlmgr option:: -* tlmgr paper:: -* tlmgr path:: -* tlmgr pinning:: -* tlmgr platform:: -* tlmgr postaction:: -* tlmgr print-platform:: -* tlmgr print-platform-info:: -* tlmgr remove [@emph{option}...] @emph{pkg}...:: -* tlmgr repository:: -* tlmgr restore:: -* tlmgr search:: -* tlmgr shell:: -* tlmgr show:: -* tlmgr uninstall:: -* tlmgr update [@emph{option}...] [@emph{pkg}...]:: -@end menu - @node tlmgr help @appendixsubsec help @@ -397,8 +347,8 @@ If @code{-v} has been given the revisions of the used modules are reported, too. @appendixsubsec backup @table @asis -@item @strong{backup [@emph{option}...] --all} -@anchor{tlmgr @strong{backup [@emph{option}...] --all}} +@item @strong{backup [@emph{option}...] @asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{backup [@emph{option}...] @asis{}-@asis{}-@asis{}all}} @item @strong{backup [@emph{option}...] @emph{pkg}...} @anchor{tlmgr @strong{backup [@emph{option}...] @emph{pkg}...}} @@ -422,30 +372,30 @@ the @code{option} action. Options: @table @asis -@item @strong{--backupdir} @emph{directory} -@anchor{tlmgr @strong{--backupdir} @emph{directory}} +@item @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory}} Overrides the @code{backupdir} option setting in the TLPDB. The @emph{directory} argument is required and must specify an existing, writable directory where backups are to be placed. -@item @strong{--all} -@anchor{tlmgr @strong{--all}} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all}} If @code{--clean} is not specified, make a backup of all packages in the TeX Live installation; this will take quite a lot of space and time. If @code{--clean} is specified, all packages are pruned. -@item @strong{--clean}[=@emph{N}] -@anchor{tlmgr @strong{--clean}[=@emph{N}]} +@item @strong{@asis{}-@asis{}-@asis{}clean}[=@emph{N}] +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}clean}[=@emph{N}]} Instead of making backups, prune the backup directory of old backups, as explained above. The optional integer argument @emph{N} overrides the @code{autobackup} option set in the TLPDB. You must use @code{--all} or a list of packages together with this option, as desired. -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run}} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run}} Nothing is actually backed up or removed; instead, the actions to be performed are written to the terminal. @@ -523,8 +473,8 @@ this. It checks that: Options: @table @asis -@item @strong{--use-svn} -@anchor{tlmgr @strong{--use-svn}} +@item @strong{@asis{}-@asis{}-@asis{}use-svn} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}use-svn}} Use the output of @code{svn status} instead of listing the files; for checking the TL development repository. (This is run nightly.) @@ -535,11 +485,11 @@ checking the TL development repository. (This is run nightly.) @appendixsubsec conf @table @asis -@item @strong{conf [texmf|tlmgr|updmap [--conffile @emph{file}] [--delete] [@emph{key} [@emph{value}]]]} -@anchor{tlmgr @strong{conf [texmf|tlmgr|updmap [--conffile @emph{file}] [--delete] [@emph{key} [@emph{value}]]]}} +@item @strong{conf [texmf|tlmgr|updmap [@asis{}-@asis{}-@asis{}conffile @emph{file}] [@asis{}-@asis{}-@asis{}delete] [@emph{key} [@emph{value}]]]} +@anchor{tlmgr @strong{conf [texmf|tlmgr|updmap [@asis{}-@asis{}-@asis{}conffile @emph{file}] [@asis{}-@asis{}-@asis{}delete] [@emph{key} [@emph{value}]]]}} -@item @strong{conf auxtrees [--conffile @emph{file}] [show|add|remove] [@emph{value}]} -@anchor{tlmgr @strong{conf auxtrees [--conffile @emph{file}] [show|add|remove] [@emph{value}]}} +@item @strong{conf auxtrees [@asis{}-@asis{}-@asis{}conffile @emph{file}] [show|add|remove] [@emph{value}]} +@anchor{tlmgr @strong{conf auxtrees [@asis{}-@asis{}-@asis{}conffile @emph{file}] [show|add|remove] [@emph{value}]}} With only @code{conf}, show general configuration information for TeX Live, including active configuration files, path settings, and more. This is @@ -551,7 +501,7 @@ user-specific @code{tlmgr} configuration file (see below), or the first found (via @code{kpsewhich}) @code{updmap.cfg} file, respectively. If @emph{key} is given in addition, shows the value of only that @emph{key} in -the respective file. If option @emph{--delete} is also given, the value in +the respective file. If option @emph{@asis{}-@asis{}-@asis{}delete} is also given, the value in the given configuration file is entirely removed (not just commented out). @@ -595,8 +545,8 @@ breakage is possible. @end table -@node tlmgr dump-tlpdb [@emph{option}...] [--json] -@appendixsubsec dump-tlpdb [@emph{option}...] [--json] +@node tlmgr dump-tlpdb [@emph{option}...] [@asis{}-@asis{}-@asis{}json] +@appendixsubsec dump-tlpdb [@emph{option}...] [@asis{}-@asis{}-@asis{}json] Dump complete local or remote TLPDB to standard output, as-is. The output is analogous to the @code{--machine-readable} output; see @@ -605,18 +555,18 @@ output is analogous to the @code{--machine-readable} output; see Options: @table @asis -@item @strong{--local} -@anchor{tlmgr @strong{--local}} +@item @strong{@asis{}-@asis{}-@asis{}local} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}local}} Dump the local TLPDB. -@item @strong{--remote} -@anchor{tlmgr @strong{--remote}} +@item @strong{@asis{}-@asis{}-@asis{}remote} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}remote}} Dump the remote TLPDB. -@item @strong{--json} -@anchor{tlmgr @strong{--json}} +@item @strong{@asis{}-@asis{}-@asis{}json} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}json}} Instead of dumping the actual content, the database is dumped as JSON. For the format of JSON output see @code{tlpkg/doc/JSON-formats.txt}, @@ -720,8 +670,8 @@ extension recreates only that given language file. Options: @table @asis -@item @strong{--dest} @emph{output_file} -@anchor{tlmgr @strong{--dest} @emph{output_file}} +@item @strong{@asis{}-@asis{}-@asis{}dest} @emph{output_file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dest} @emph{output_file}} specifies the output file (defaults to the respective location in @code{TEXMFSYSVAR}). If @code{--dest} is given to @code{generate language}, it @@ -732,14 +682,14 @@ name of the @code{language.dat.lua} file. (This is just to avoid overwriting; if you want a specific name for each output file, we recommend invoking @code{tlmgr} twice.) -@item @strong{--localcfg} @emph{local_conf_file} -@anchor{tlmgr @strong{--localcfg} @emph{local_conf_file}} +@item @strong{@asis{}-@asis{}-@asis{}localcfg} @emph{local_conf_file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}localcfg} @emph{local_conf_file}} specifies the (optional) local additions (defaults to the respective location in @code{TEXMFLOCAL}). -@item @strong{--rebuild-sys} -@anchor{tlmgr @strong{--rebuild-sys}} +@item @strong{@asis{}-@asis{}-@asis{}rebuild-sys} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}rebuild-sys}} tells @code{tlmgr} to run necessary programs after config files have been regenerated. These are: @@ -814,30 +764,30 @@ but are still supported for backward compatibility. Options: @table @asis -@item @strong{--list} -@anchor{tlmgr @strong{--list}} +@item @strong{@asis{}-@asis{}-@asis{}list} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}list}} If the option @code{--list} is given with a package, the list of contained files is also shown, including those for platform-specific dependencies. When given with schemes and collections, @code{--list} outputs their dependencies in a similar way. -@item @strong{--only-installed} -@anchor{tlmgr @strong{--only-installed}} +@item @strong{@asis{}-@asis{}-@asis{}only-installed} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}only-installed}} If this option is given, the installation source will not be used; only locally installed packages, collections, or schemes are listed. -@item @strong{--only-remote} -@anchor{tlmgr @strong{--only-remote}} +@item @strong{@asis{}-@asis{}-@asis{}only-remote} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}only-remote}} Only list packages from the remote repository. Useful when checking what is available in a remote repository using @code{tlmgr --repo ... --only-remote info}. Note that @code{--only-installed} and @code{--only-remote} cannot both be specified. -@item @strong{--data @code{item1,item2,...}} -@anchor{tlmgr @strong{--data @code{item1@comma{}item2@comma{}...}}} +@item @strong{@asis{}-@asis{}-@asis{}data @code{item1,item2,...}} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}data @code{item1@comma{}item2@comma{}...}}} If the option @code{--data} is given, its argument must be a comma or colon separated list of field names from: @code{name}, @code{category}, @code{localrev}, @@ -862,8 +812,8 @@ At this writing, the @code{cat-contact-*} fields include: @code{home}, may be empty or a url value. A brief description is on the CTAN upload page for new packages: @url{https://ctan.org/upload}. -@item @strong{--json} -@anchor{tlmgr @strong{--json} 1} +@item @strong{@asis{}-@asis{}-@asis{}json} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}json} 1} In case @code{--json} is specified, the output is a JSON encoded array where each array element is the JSON representation of a single @code{TLPOBJ} but @@ -893,34 +843,34 @@ By default this also installs all packages on which the given @emph{pkg}s are dependent. Options: @table @asis -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run} 1} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run} 1} Nothing is actually installed; instead, the actions to be performed are written to the terminal. -@item @strong{--file} -@anchor{tlmgr @strong{--file}} +@item @strong{@asis{}-@asis{}-@asis{}file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}file}} Instead of fetching a package from the installation repository, use the package files given on the command line. These files must be standard TeX Live package files (with contained tlpobj file). -@item @strong{--force} -@anchor{tlmgr @strong{--force}} +@item @strong{@asis{}-@asis{}-@asis{}force} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}force}} If updates to @code{tlmgr} itself (or other parts of the basic infrastructure) are present, @code{tlmgr} will bail out and not perform the installation unless this option is given. Not recommended. -@item @strong{--no-depends} -@anchor{tlmgr @strong{--no-depends}} +@item @strong{@asis{}-@asis{}-@asis{}no-depends} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends}} Do not install dependencies. (By default, installing a package ensures that all dependencies of this package are fulfilled.) -@item @strong{--no-depends-at-all} -@anchor{tlmgr @strong{--no-depends-at-all}} +@item @strong{@asis{}-@asis{}-@asis{}no-depends-at-all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends-at-all}} Normally, when you install a package which ships binary files the respective binary package will also be installed. That is, for a @@ -929,8 +879,8 @@ an @code{i386-linux} system. This option suppresses this behavior, and also implies @code{--no-depends}. Don't use it unless you are sure of what you are doing. -@item @strong{--reinstall} -@anchor{tlmgr @strong{--reinstall}} +@item @strong{@asis{}-@asis{}-@asis{}reinstall} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}reinstall}} Reinstall a package (including dependencies for collections) even if it already seems to be installed (i.e, is present in the TLPDB). This is @@ -939,11 +889,11 @@ useful to recover from accidental removal of files in the hierarchy. When re-installing, only dependencies on normal packages are followed (i.e., not those of category Scheme or Collection). -@item @strong{--with-doc} -@anchor{tlmgr @strong{--with-doc}} +@item @strong{@asis{}-@asis{}-@asis{}with-doc} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}with-doc}} -@item @strong{--with-src} -@anchor{tlmgr @strong{--with-src}} +@item @strong{@asis{}-@asis{}-@asis{}with-src} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}with-src}} While not recommended, the @code{install-tl} program provides an option to omit installation of all documentation and/or source files. (By @@ -1000,11 +950,11 @@ Synonym for @ref{tlmgr info,, info}. @appendixsubsec option @table @asis -@item @strong{option [--json] [show]} -@anchor{tlmgr @strong{option [--json] [show]}} +@item @strong{option [@asis{}-@asis{}-@asis{}json] [show]} +@anchor{tlmgr @strong{option [@asis{}-@asis{}-@asis{}json] [show]}} -@item @strong{option [--json] showall|help} -@anchor{tlmgr @strong{option [--json] showall|help}} +@item @strong{option [@asis{}-@asis{}-@asis{}json] showall|help} +@anchor{tlmgr @strong{option [@asis{}-@asis{}-@asis{}json] showall|help}} @item @strong{option @emph{key} [@emph{value}]} @anchor{tlmgr @strong{option @emph{key} [@emph{value}]}} @@ -1119,11 +1069,11 @@ instead of only the current user. All three options are on by default. @item @strong{paper [a4|letter]} @anchor{tlmgr @strong{paper [a4|letter]}} -@item @strong{<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [@emph{papersize}|--list]}> -@anchor{tlmgr @strong{<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [@emph{papersize}|--list]}>} +@item @strong{<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [@emph{papersize}|@asis{}-@asis{}-@asis{}list]}> +@anchor{tlmgr @strong{<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [@emph{papersize}|@asis{}-@asis{}-@asis{}list]}>} -@item @strong{paper --json} -@anchor{tlmgr @strong{paper --json}} +@item @strong{paper @asis{}-@asis{}-@asis{}json} +@anchor{tlmgr @strong{paper @asis{}-@asis{}-@asis{}json}} @end table @@ -1159,11 +1109,11 @@ settings. @appendixsubsec path @table @asis -@item @strong{path [--w32mode=user|admin] add} -@anchor{tlmgr @strong{path [--w32mode=user|admin] add}} +@item @strong{path [@asis{}-@asis{}-@asis{}w32mode=user|admin] add} +@anchor{tlmgr @strong{path [@asis{}-@asis{}-@asis{}w32mode=user|admin] add}} -@item @strong{path [--w32mode=user|admin] remove} -@anchor{tlmgr @strong{path [--w32mode=user|admin] remove}} +@item @strong{path [@asis{}-@asis{}-@asis{}w32mode=user|admin] remove} +@anchor{tlmgr @strong{path [@asis{}-@asis{}-@asis{}w32mode=user|admin] remove}} On Unix, adds or removes symlinks for executables, man pages, and info pages in the system directories specified by the respective options (see @@ -1261,8 +1211,8 @@ Platform detection is needed to select the proper @code{xz} and Options: @table @asis -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run} 2} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run} 2} Nothing is actually installed; instead, the actions to be performed are written to the terminal. @@ -1289,8 +1239,8 @@ line, or for all if @code{--all} is given. Options: @table @asis -@item @strong{--w32mode=[user|admin]} -@anchor{tlmgr @strong{--w32mode=[user|admin]}} +@item @strong{@asis{}-@asis{}-@asis{}w32mode=[user|admin]} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}w32mode=[user|admin]}} If the option @code{--w32mode} is given the value @code{user}, all actions will only be carried out in the user-accessible parts of the @@ -1298,16 +1248,16 @@ registry/filesystem, while the value @code{admin} selects the system-wide parts of the registry for the file associations. If you do not have enough permissions, using @code{--w32mode=admin} will not succeed. -@item @strong{--fileassocmode=[1|2]} -@anchor{tlmgr @strong{--fileassocmode=[1|2]}} +@item @strong{@asis{}-@asis{}-@asis{}fileassocmode=[1|2]} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}fileassocmode=[1|2]}} @code{--fileassocmode} specifies the action for file associations. If it is set to 1 (the default), only new associations are added; if it is set to 2, all associations are set to the TeX Live programs. (See also @code{option fileassocs}.) -@item @strong{--all} -@anchor{tlmgr @strong{--all} 1} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all} 1} Carry out the postactions for all packages @@ -1337,37 +1287,37 @@ collection dependencies of that collection. However, when removing a package, dependencies are never removed. Options: @table @asis -@item @strong{--all} -@anchor{tlmgr @strong{--all} 2} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all} 2} Uninstalls all of TeX Live, asking for confirmation unless @code{--force} is also specified. -@item @strong{--backup} -@anchor{tlmgr @strong{--backup}} +@item @strong{@asis{}-@asis{}-@asis{}backup} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backup}} -@item @strong{--backupdir} @emph{directory} -@anchor{tlmgr @strong{--backupdir} @emph{directory} 1} +@item @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} 1} These options behave just as with the @ref{tlmgr update -[@emph{option}...] [...], update,, update} action (q.v.), except they apply to making +[@emph{option}...] [@emph{pkg}...],, update} action (q.v.), except they apply to making backups of packages before they are removed. The default is to make such a backup, that is, to save a copy of packages before removal. The @ref{tlmgr restore,, restore} action explains how to restore from a backup. -@item @strong{--no-depends} -@anchor{tlmgr @strong{--no-depends} 1} +@item @strong{@asis{}-@asis{}-@asis{}no-depends} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends} 1} Do not remove dependent packages. -@item @strong{--no-depends-at-all} -@anchor{tlmgr @strong{--no-depends-at-all} 1} +@item @strong{@asis{}-@asis{}-@asis{}no-depends-at-all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends-at-all} 1} -See above under @ref{tlmgr install [@emph{option}...] @emph{pkg}..., install, install} (and beware). +See above under @ref{tlmgr install [@emph{option}...] @emph{pkg}...,, install} (and beware). -@item @strong{--force} -@anchor{tlmgr @strong{--force} 1} +@item @strong{@asis{}-@asis{}-@asis{}force} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}force} 1} By default, removal of a package or collection that is a dependency of another collection or scheme is not allowed. With this option, the @@ -1378,8 +1328,8 @@ is still listed in an installed collection or scheme will not be updated, and will be mentioned as @code{forcibly removed} in the output of @code{tlmgr update --list}. -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run} 3} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run} 3} Nothing is actually removed; instead, the actions to be performed are written to the terminal. @@ -1463,8 +1413,8 @@ otherwise, all operations will fail! @item @strong{restore [@emph{option}...] @emph{pkg} [@emph{rev}]} @anchor{tlmgr @strong{restore [@emph{option}...] @emph{pkg} [@emph{rev}]}} -@item @strong{restore [@emph{option}...] --all} -@anchor{tlmgr @strong{restore [@emph{option}...] --all}} +@item @strong{restore [@emph{option}...] @asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{restore [@emph{option}...] @asis{}-@asis{}-@asis{}all}} Restore a package from a previously-made backup. @@ -1484,32 +1434,32 @@ specified, try to restore the package from the specified backup. Options: @table @asis -@item @strong{--all} -@anchor{tlmgr @strong{--all} 3} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all} 3} Try to restore the latest revision of all package backups found in the backup directory. Additional non-option arguments (like @emph{pkg}) are not allowed. -@item @strong{--backupdir} @emph{directory} -@anchor{tlmgr @strong{--backupdir} @emph{directory} 2} +@item @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} 2} Specify the directory where the backups are to be found. If not given it will be taken from the configuration setting in the TLPDB. -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run} 4} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run} 4} Nothing is actually restored; instead, the actions to be performed are written to the terminal. -@item @strong{--force} -@anchor{tlmgr @strong{--force} 2} +@item @strong{@asis{}-@asis{}-@asis{}force} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}force} 2} Don't ask questions. -@item @strong{--json} -@anchor{tlmgr @strong{--json} 2} +@item @strong{@asis{}-@asis{}-@asis{}json} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}json} 2} When listing backups, the option @code{--json} turn on JSON output. The format is an array of JSON objects (@code{name}, @code{rev}, @code{date}). @@ -1527,11 +1477,11 @@ If both @code{--json} and @code{--data} are given, @code{--json} takes precedenc @item @strong{search [@emph{option}...] @emph{what}} @anchor{tlmgr @strong{search [@emph{option}...] @emph{what}}} -@item @strong{search [@emph{option}...] --file @emph{what}} -@anchor{tlmgr @strong{search [@emph{option}...] --file @emph{what}}} +@item @strong{search [@emph{option}...] @asis{}-@asis{}-@asis{}file @emph{what}} +@anchor{tlmgr @strong{search [@emph{option}...] @asis{}-@asis{}-@asis{}file @emph{what}}} -@item @strong{search [@emph{option}...] --all @emph{what}} -@anchor{tlmgr @strong{search [@emph{option}...] --all @emph{what}}} +@item @strong{search [@emph{option}...] @asis{}-@asis{}-@asis{}all @emph{what}} +@anchor{tlmgr @strong{search [@emph{option}...] @asis{}-@asis{}-@asis{}all @emph{what}}} By default, search the names, short descriptions, and long descriptions of all locally installed packages for the argument @emph{what}, interpreted @@ -1540,24 +1490,24 @@ as a (Perl) regular expression. Options: @table @asis -@item @strong{--file} -@anchor{tlmgr @strong{--file} 1} +@item @strong{@asis{}-@asis{}-@asis{}file} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}file} 1} List all filenames containing @emph{what}. -@item @strong{--all} -@anchor{tlmgr @strong{--all} 4} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all} 4} Search everything: package names, descriptions and filenames. -@item @strong{--global} -@anchor{tlmgr @strong{--global}} +@item @strong{@asis{}-@asis{}-@asis{}global} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}global}} Search the TeX Live Database of the installation medium, instead of the local installation. -@item @strong{--word} -@anchor{tlmgr @strong{--word}} +@item @strong{@asis{}-@asis{}-@asis{}word} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}word}} Restrict the search of package names and descriptions (but not filenames) to match only full words. For example, searching for @@ -1645,7 +1595,7 @@ Synonym for @ref{tlmgr info,, info}. @node tlmgr uninstall @appendixsubsec uninstall -Synonym for @ref{tlmgr remove [@emph{option}...] @emph{pkg}..., remove, remove}. +Synonym for @ref{tlmgr remove [@emph{option}...] @emph{pkg}...,, remove}. @node tlmgr update [@emph{option}...] [@emph{pkg}...] @appendixsubsec update [@emph{option}...] [@emph{pkg}...] @@ -1655,8 +1605,8 @@ at the installation source. Either @code{--all} or at least one @emph{pkg} name must be specified. Options: @table @asis -@item @strong{--all} -@anchor{tlmgr @strong{--all} 5} +@item @strong{@asis{}-@asis{}-@asis{}all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}all} 5} Update all installed packages except for @code{tlmgr} itself. If updates to @code{tlmgr} itself are present, this gives an error, unless also the option @@ -1695,8 +1645,8 @@ record the repository from which packages come from.) If you want to exclude some packages from the current update run (e.g., due to a slow link), see the @code{--exclude} option below. -@item @strong{--self} -@anchor{tlmgr @strong{--self}} +@item @strong{@asis{}-@asis{}-@asis{}self} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}self}} Update @code{tlmgr} itself (that is, the infrastructure packages) if updates to it are present. On Windows this includes updates to the private Perl @@ -1716,14 +1666,14 @@ In short: # ... this last at your own risk, not recommended! @end verbatim -@item @strong{--dry-run} -@anchor{tlmgr @strong{--dry-run} 5} +@item @strong{@asis{}-@asis{}-@asis{}dry-run} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}dry-run} 5} Nothing is actually installed; instead, the actions to be performed are written to the terminal. This is a more detailed report than @code{--list}. -@item @strong{--list} [@emph{pkg}] -@anchor{tlmgr @strong{--list} [@emph{pkg}]} +@item @strong{@asis{}-@asis{}-@asis{}list} [@emph{pkg}] +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}list} [@emph{pkg}]} Concisely list the packages which would be updated, newly installed, or removed, without actually changing anything. @@ -1737,8 +1687,8 @@ same as @code{tlmgr update --list --all}). If neither @code{--all} nor @code{--self} is given, but specific package names are given, those packages are checked for updates. -@item @strong{--exclude} @emph{pkg} -@anchor{tlmgr @strong{--exclude} @emph{pkg}} +@item @strong{@asis{}-@asis{}-@asis{}exclude} @emph{pkg} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}exclude} @emph{pkg}} Exclude @emph{pkg} from the update process. If this option is given more than once, its arguments accumulate. @@ -1761,8 +1711,8 @@ supported in these circumstances. This option can also be set permanently in the tlmgr config file with the key @code{update-exclude}. -@item @strong{--no-auto-remove} [@emph{pkg}...] -@anchor{tlmgr @strong{--no-auto-remove} [@emph{pkg}...]} +@item @strong{@asis{}-@asis{}-@asis{}no-auto-remove} [@emph{pkg}...] +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-auto-remove} [@emph{pkg}...]} By default, @code{tlmgr} tries to remove packages in an existing collection which have disappeared on the server, as described above under @code{--all}. @@ -1771,8 +1721,8 @@ This option prevents such removals, either for all packages (with inconsistent TeX installation, since packages are not infrequently renamed or replaced by their authors. Therefore this is not recommended. -@item @strong{--no-auto-install} [@emph{pkg}...] -@anchor{tlmgr @strong{--no-auto-install} [@emph{pkg}...]} +@item @strong{@asis{}-@asis{}-@asis{}no-auto-install} [@emph{pkg}...] +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-auto-install} [@emph{pkg}...]} Under normal circumstances @code{tlmgr} will install packages which are new on the server, as described above under @code{--all}. This option prevents @@ -1798,8 +1748,8 @@ is equivalent to Again, since packages are sometimes renamed or replaced, using this option is not recommended. -@item @strong{--reinstall-forcibly-removed} -@anchor{tlmgr @strong{--reinstall-forcibly-removed}} +@item @strong{@asis{}-@asis{}-@asis{}reinstall-forcibly-removed} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}reinstall-forcibly-removed}} Under normal circumstances @code{tlmgr} will not install packages that have been forcibly removed by the user; that is, removed with @code{remove @@ -1814,11 +1764,11 @@ installation with the server's idea of what is available: tlmgr update --reinstall-forcibly-removed --all @end verbatim -@item @strong{--backup} -@anchor{tlmgr @strong{--backup} 1} +@item @strong{@asis{}-@asis{}-@asis{}backup} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backup} 1} -@item @strong{--backupdir} @emph{directory} -@anchor{tlmgr @strong{--backupdir} @emph{directory} 3} +@item @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}backupdir} @emph{directory} 3} These two options control the creation of backups of packages @emph{before} updating; that is, backing up packages as currently installed. If @@ -1840,20 +1790,20 @@ incompatibility. The @ref{tlmgr restore,, restore} action explains how to restore from a backup. -@item @strong{--no-depends} -@anchor{tlmgr @strong{--no-depends} 2} +@item @strong{@asis{}-@asis{}-@asis{}no-depends} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends} 2} If you call for updating a package normally all depending packages will also be checked for updates and updated if necessary. This switch suppresses this behavior. -@item @strong{--no-depends-at-all} -@anchor{tlmgr @strong{--no-depends-at-all} 2} +@item @strong{@asis{}-@asis{}-@asis{}no-depends-at-all} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}no-depends-at-all} 2} -See above under @ref{tlmgr install [@emph{option}...] @emph{pkg}..., install, install} (and beware). +See above under @ref{tlmgr install [@emph{option}...] @emph{pkg}...,, install} (and beware). -@item @strong{--force} -@anchor{tlmgr @strong{--force} 3} +@item @strong{@asis{}-@asis{}-@asis{}force} +@anchor{tlmgr @strong{@asis{}-@asis{}-@asis{}force} 3} Force update of normal packages, without updating @code{tlmgr} itself (unless the @code{--self} option is also given). Not recommended. @@ -1993,10 +1943,6 @@ of these keys are obtainable from the standard key servers. Additional trusted keys can be added using the @code{key} action. -@menu -* tlmgr Configuration of GnuPG invocation:: -@end menu - @node tlmgr Configuration of GnuPG invocation @appendixsubsec Configuration of GnuPG invocation @@ -2064,12 +2010,6 @@ installed into a user tree. Description of changes of actions in user mode: -@menu -* tlmgr User mode install:: -* tlmgr User mode backup@comma{} restore@comma{} remove@comma{} update:: -* tlmgr User mode generate@comma{} option@comma{} paper:: -@end menu - @node tlmgr User mode install @appendixsubsec User mode install @@ -2104,6 +2044,12 @@ just as in normal mode. In user mode, these actions operate only on the user tree's configuration files and/or @code{texlive.tlpdb}. +@node tlmgr User mode logs +@appendixsubsec User mode logs + +In user mode, @code{tlmgr.log} and <tlmgr-commands.log> are written in the +@code{TEXMFVAR/web2c/} directlry instead of @code{TEXMFSYSVAR/web2c/}. + @node tlmgr MULTIPLE REPOSITORIES @appendixsec MULTIPLE REPOSITORIES @@ -2136,10 +2082,6 @@ anything from there. You also have to specify which packages should be taken from the new repository, by specifying so-called ``pinning'' rules, described next. -@menu -* tlmgr Pinning:: -@end menu - @node tlmgr Pinning @appendixsubsec Pinning @@ -2246,21 +2188,9 @@ repository. To load a different repository, see the @code{tlmgr} menu item. Finally, the status area at the bottom of the window gives additional information about what is going on. -@menu -* tlmgr Main display:: -* tlmgr Menu bar:: -* tlmgr GUI options:: -@end menu - @node tlmgr Main display @appendixsubsec Main display -@menu -* tlmgr Display configuration area:: -* tlmgr Package list area:: -* tlmgr Main display action buttons:: -@end menu - @node tlmgr Display configuration area @appendixsubsubsec Display configuration area @@ -2501,15 +2431,10 @@ written to stdout). The idea is that a program can get all the information it needs by reading stdout. Currently this option only applies to the -@ref{tlmgr update [@emph{option}...] [@emph{pkg}...], update, update}, -@ref{tlmgr install [@emph{option}...] @emph{pkg}..., install, install}, and +@ref{tlmgr update [@emph{option}...] [@emph{pkg}...],, update}, +@ref{tlmgr install [@emph{option}...] @emph{pkg}...,, install}, and @ref{tlmgr option,, option} actions. -@menu -* tlmgr Machine-readable @code{update} and @code{install} output:: -* tlmgr Machine-readable @code{option} output:: -@end menu - @node tlmgr Machine-readable @code{update} and @code{install} output @appendixsubsec Machine-readable @code{update} and @code{install} output @@ -2758,5 +2683,5 @@ This script and its documentation were written for the TeX Live distribution (@url{https://tug.org/texlive}) and both are licensed under the GNU General Public License Version 2 or later. -$Id: tlmgr.pl 62273 2022-02-28 08:52:17Z preining $ +$Id: tlmgr.pl 65998 2023-02-21 01:33:24Z karl $ diff --git a/Build/source/doc/tlbuild.info b/Build/source/doc/tlbuild.info index 89b4ae36582..7738306fdd1 100644 --- a/Build/source/doc/tlbuild.info +++ b/Build/source/doc/tlbuild.info @@ -3,8 +3,8 @@ tlbuild.texi. This file documents the TeX Live build system and more. -Copyright © 2016–2023 Karl Berry. -Copyright © 2013–2015 Karl Berry & Peter Breitenlohner. +Copyright (C) 2016-2023 Karl Berry. +Copyright (C) 2013-2015 Karl Berry & Peter Breitenlohner. Permission is granted to make and distribute verbatim copies of this manual provided the copyright notice and this permission notice are @@ -65,12 +65,12 @@ release. This manual is aimed at system installers and programmers, and focuses on how to configure, build, and develop the TeX Live (TL) sources. It is also available as plain text files in the source tree: -‘source/README.*’. +'source/README.*'. - The main ‘source/README’ file in the TL source tree provides + The main 'source/README' file in the TL source tree provides maximally-terse information for doing a build, and portability information for different systems, along with -‘source/doc/README.solaris’. +'source/doc/README.solaris'. For information on acquiring the TL sources, see <https://tug.org/texlive/svn>. The canonical source repository uses @@ -79,27 +79,27 @@ Subversion, and we have no plans to change this. This manual does not duplicate the information found in other TL documentation resources, such as: - • The TeX Live web pages: <https://tug.org/texlive>. + * The TeX Live web pages: <https://tug.org/texlive>. - • The web page describing how to build the binaries which are + * The web page describing how to build the binaries which are distributed with TeX Live: <https://tug.org/texlive/build.html>. - • The TeX Live user manual: <https://tug.org/texlive/doc.html>, or - run ‘texdoc texlive’. + * The TeX Live user manual: <https://tug.org/texlive/doc.html>, or + run 'texdoc texlive'. - • Other TeX-related Texinfo manuals (*note (web2c)::, *note + * Other TeX-related Texinfo manuals (*note (web2c)::, *note (kpathsea)::, etc.): <https://tug.org/texinfohtml/>, or check the - ‘TeX’ category in the GNU Info system. + 'TeX' category in the GNU Info system. - • Package documentation: - <https://tug.org/texlive/Contents/live/doc.html>, or the ‘doc.html’ + * Package documentation: + <https://tug.org/texlive/Contents/live/doc.html>, or the 'doc.html' file at the top level of the installed TL. - As an exception, the full documentation for ‘install-tl’ and ‘tlmgr’ + As an exception, the full documentation for 'install-tl' and 'tlmgr' is included here as appendices, simply because it is easy to do so. The same text is available online (linked from <https://tug.org/texlive/doc.html>, or by invoking the program with -‘--help’ (or look at the end of the source). +'--help' (or look at the end of the source). File: tlbuild.info, Node: Overview of build system, Next: Prerequisites, Prev: Introduction, Up: Top @@ -109,34 +109,34 @@ File: tlbuild.info, Node: Overview of build system, Next: Prerequisites, Prev The TeX Live build system was redesigned in 2009 to consistently use Autoconf, Automake, and Libtool. Thus, running - ‘configure && make && make check && make install’ -or the essentially-equivalent top-level ‘Build’ script suffices to build -and install the TL programs. The ‘make check’ clause performs various -tests of the generated programs—not strictly required but strongly -recommended. Running ‘configure --help’ will display a comprehensive -list of all ‘configure’ options. + 'configure && make && make check && make install' +or the essentially-equivalent top-level 'Build' script suffices to build +and install the TL programs. The 'make check' clause performs various +tests of the generated programs--not strictly required but strongly +recommended. Running 'configure --help' will display a comprehensive +list of all 'configure' options. The main components of the TL build system are: -‘libs/LIB’ +'libs/LIB' Generic libraries. -‘texk/LIB’ - TeX-specific libraries in subdirectories, notably LIB=‘kpathsea’. - (The other one is ‘texk/ptexenc’.) +'texk/LIB' + TeX-specific libraries in subdirectories, notably LIB='kpathsea'. + (The other one is 'texk/ptexenc'.) -‘texk/PROG’ +'texk/PROG' TeX-specific programs (that use Kpathsea). -‘utils/PROG’ - Other programs (that don’t use Kpathsea). +'utils/PROG' + Other programs (that don't use Kpathsea). The primary design goal of the build system is modularity. Each program and library module (or package) specifies its own requirements and properties, such as required libraries, whether an installed -(system) version of a library can be used, ‘configure’ options to be +(system) version of a library can be used, 'configure' options to be seen at the top level, and more. An explicit list of all available -modules is kept in a single central place: ‘m4/kpse-pkgs.m4’. +modules is kept in a single central place: 'm4/kpse-pkgs.m4'. A second, related goal is to configure and build each library before configuring any other (program or library) module which uses that @@ -159,78 +159,78 @@ File: tlbuild.info, Node: Prerequisites, Next: Building, Prev: Overview of bu *************** Overall, building the TeX Live programs, when using all libraries from -the TL source tree, requires C and C++11 compilers, GNU ‘make’, and +the TL source tree, requires C and C++11 compilers, GNU 'make', and Python. - • If ‘make’ from your ‘PATH’ is not GNU ‘make’, you can set the - ‘MAKE’ environment variable to whatever is necessary. + * If 'make' from your 'PATH' is not GNU 'make', you can set the + 'MAKE' environment variable to whatever is necessary. - GNU ‘make’ is required only because of third-party libraries, + GNU 'make' is required only because of third-party libraries, notably FreeType. Automake/Autoconf output in general, and the - TL-maintained directories, work with any reasonable ‘make’.(1) + TL-maintained directories, work with any reasonable 'make'.(1) - • A C++11 compiler is similarly required because of the third-party - libraries ICU and HarfBuzz (at least); the program ‘dvisvgm’ also + * A C++11 compiler is similarly required because of the third-party + libraries ICU and HarfBuzz (at least); the program 'dvisvgm' also requires C++11. It is possible to build what remains with older compilers, but you have to remove the C++11-dependent sources. *Note Build one package::. - • Python is required by ICU tests. (If you know how to disable these + * Python is required by ICU tests. (If you know how to disable these tests and thus eliminate the requirement, please write.) A few programs in the tree have additional requirements: -‘web2c’ - requires ‘perl’ for some tests run by ‘make check’. Incidentally, - the TeX Live installer (‘install-tl’) and manager (‘tlmgr’) are +'web2c' + requires 'perl' for some tests run by 'make check'. Incidentally, + the TeX Live installer ('install-tl') and manager ('tlmgr') are also written in Perl, but this does not matter for compiling the sources. -‘xdvik’ -‘xpdfopen’ +'xdvik' +'xpdfopen' require X11 headers and libraries, typically in devel(opment) packages that are not installed by default. -‘xetex’ - requires ‘fontconfig’ (again both headers and library), or, for - MacOS only, the ‘ApplicationServices’ and ‘Cocoa’ frameworks. +'xetex' + requires 'fontconfig' (again both headers and library), or, for + MacOS only, the 'ApplicationServices' and 'Cocoa' frameworks. -‘xindy’ - requires GNU ‘clisp’, ‘libsigsegv’, and ‘libiconv’; additionally, - to build the rules and/or documentation: ‘perl’, ‘latex’, - ‘pdflatex’. +'xindy' + requires GNU 'clisp', 'libsigsegv', and 'libiconv'; additionally, + to build the rules and/or documentation: 'perl', 'latex', + 'pdflatex'. Lacking the required tools, building these programs must avoided, e.g., -‘configure --without-x --disable-xetex --disable-xindy’ +'configure --without-x --disable-xetex --disable-xindy' Modifying source files induces more requirements, as one might expect: - • Modification of any ‘.y’ or ‘.l’ source files requires ‘bison’ or - ‘flex’ to update the corresponding C sources. + * Modification of any '.y' or '.l' source files requires 'bison' or + 'flex' to update the corresponding C sources. - • Modification of the sources for ‘.info’ files requires ‘makeinfo’. + * Modification of the sources for '.info' files requires 'makeinfo'. - • Modification of any part of the build system (M4 macros, - ‘configure.ac’, ‘Makefile.am’, or their fragments) requires GNU M4, + * Modification of any part of the build system (M4 macros, + 'configure.ac', 'Makefile.am', or their fragments) requires GNU M4, GNU Autoconf, GNU Automake, and GNU Libtool to update the generated files. Furthermore, to reliably reproduce the build files, the original GNU releases of these tools must be used, not any distro packaging of them. *Note Build system tools::, for more discussion. - If you haven’t modified any source files, and infrastructure tools -such as ‘autoconf’ or ‘makeinfo’ are still being run, check your -timestamps—notably, ‘use-commit-times’ must be set to ‘yes’ in your + If you haven't modified any source files, and infrastructure tools +such as 'autoconf' or 'makeinfo' are still being run, check your +timestamps--notably, 'use-commit-times' must be set to 'yes' in your Subversion configuration (*note Build system tools::). No infrastructure tools are needed to do a normal build (barring bugs). ---------- Footnotes ---------- - (1) There is one exception in TL: the ‘tangle-sh’ and related rules -use ‘$@’ to mean the target name, a feature not present in all ‘make’s. -This could be alleviated by laborious editing, but since there’s no way -to avoid GNU ‘make’ for builds of the entire tree, it does not seem + (1) There is one exception in TL: the 'tangle-sh' and related rules +use '$@' to mean the target name, a feature not present in all 'make's. +This could be alleviated by laborious editing, but since there's no way +to avoid GNU 'make' for builds of the entire tree, it does not seem worth the trouble. @@ -239,25 +239,25 @@ File: tlbuild.info, Node: Building, Next: Installing, Prev: Prerequisites, U 4 Building ********** -The top-level ‘Build’ script is intended to simplify building the -binaries distributed with TeX Live itself—we call this the “native” TL -build. It runs ‘configure && make world’, which builds everything in a -subdirectory of the main source tree (default ‘Work/’), installs -everything in another subdirectory (default ‘inst/’), and finally runs -‘make check’. The exact directory and command names can be specified +The top-level 'Build' script is intended to simplify building the +binaries distributed with TeX Live itself--we call this the "native" TL +build. It runs 'configure && make world', which builds everything in a +subdirectory of the main source tree (default 'Work/'), installs +everything in another subdirectory (default 'inst/'), and finally runs +'make check'. The exact directory and command names can be specified via environment variables and a few leading options. All remaining -arguments (assignments or options) are passed to the ‘configure’ script. -Please take a look at the ‘./Build’ source file for more information; it +arguments (assignments or options) are passed to the 'configure' script. +Please take a look at the './Build' source file for more information; it is a straightforward shell script. An alternative, and the one we will mainly discuss here, is to run -‘configure’ and ‘make’ in a suitable empty subdirectory. Building in +'configure' and 'make' in a suitable empty subdirectory. Building in the source directory itself is not supported (sorry). * Menu: -* Build iteration:: What ‘configure’ and ‘make’ do in TL. -* Build in parallel:: Simultaneous ‘make’ processes. +* Build iteration:: What 'configure' and 'make' do in TL. +* Build in parallel:: Simultaneous 'make' processes. * Build distribution:: Making a distribution tarball. * Build one package:: Example of working on just one program. * Build one engine:: Example of building just one TeX engine. @@ -269,22 +269,22 @@ File: tlbuild.info, Node: Build iteration, Next: Build in parallel, Up: Build 4.1 Build iteration =================== -Running the top-level ‘configure’ script configures the top level and -the subdirectories ‘libs’, ‘utils’, and ‘texk’. Running ‘make’ at the +Running the top-level 'configure' script configures the top level and +the subdirectories 'libs', 'utils', and 'texk'. Running 'make' at the top level first iterates over the TeX-specific libraries, and then runs -‘make’ in ‘libs’, ‘utils’, and ‘texk’ to iterate over the generic +'make' in 'libs', 'utils', and 'texk' to iterate over the generic libraries, utility programs, and TeX-specific programs, respectively. These iterations consist of two steps: 1. For each library or program module not yet configured, run - ‘configure’, adding the configure option ‘--disable-build’ if the - module need not be built, otherwise running ‘make all’. + 'configure', adding the configure option '--disable-build' if the + module need not be built, otherwise running 'make all'. - 2. For each library or program module that must be built, run ‘make’ - for the selected target(s): ‘default’ or ‘all’ to (re-)build, - ‘check’ to run tests, ‘install’, etc. + 2. For each library or program module that must be built, run 'make' + for the selected target(s): 'default' or 'all' to (re-)build, + 'check' to run tests, 'install', etc. - Running the top-level ‘make’ a second time iterates again over all + Running the top-level 'make' a second time iterates again over all the library and program modules, and finds (should find) nothing to be done. @@ -294,14 +294,14 @@ File: tlbuild.info, Node: Build in parallel, Next: Build distribution, Prev: 4.2 Build in parallel ===================== -The TL build system carefully formulates dependencies as well as ‘make’ -rules when a tool (such as ‘tangle’, ‘ctangle’, and ‘convert’) creates -several output files. This allows for parallel builds (‘make -j N’ with -N>1 or even ‘make -j’) that can considerably speed up the TL build. +The TL build system carefully formulates dependencies as well as 'make' +rules when a tool (such as 'tangle', 'ctangle', and 'convert') creates +several output files. This allows for parallel builds ('make -j N' with +N>1 or even 'make -j') that can considerably speed up the TL build. Incidentally, a noticeable speed-up can be independently gained by -using a configure cache file, i.e., specifying the ‘configure’ option -‘-C’ (recommended). +using a configure cache file, i.e., specifying the 'configure' option +'-C' (recommended). File: tlbuild.info, Node: Build distribution, Next: Build one package, Prev: Build in parallel, Up: Building @@ -309,9 +309,9 @@ File: tlbuild.info, Node: Build distribution, Next: Build one package, Prev: 4.3 Build distribution ====================== -Running ‘make dist’ at the top level creates a tarball -‘tex-live-YYYY-MM-DD.tar.xz’ from the TL source tree. Running ‘make -distcheck’ also verifies that this tarball suffices to build and install +Running 'make dist' at the top level creates a tarball +'tex-live-YYYY-MM-DD.tar.xz' from the TL source tree. Running 'make +distcheck' also verifies that this tarball suffices to build and install all of TL. This is useful for checking consistency of the source tree and @@ -325,14 +325,14 @@ File: tlbuild.info, Node: Build one package, Next: Build one engine, Prev: Bu 4.4 Build one package ===================== -To build one package, the basic idea is to use the ‘configure’ option -‘--disable-all-pkgs’ (*note --disable-all-pkgs::). Then all program and +To build one package, the basic idea is to use the 'configure' option +'--disable-all-pkgs' (*note --disable-all-pkgs::). Then all program and library modules are configured but none are made. However, the -‘Makefile’s still contain all build rules and dependencies and can be +'Makefile's still contain all build rules and dependencies and can be invoked to build an individual program or library, first building any required libraries. - Here is an example from start to finish for working on ‘dvipdfm-x’. + Here is an example from start to finish for working on 'dvipdfm-x'. Unfortunately, this does not suffice for building the TeX engines; see the next section. @@ -363,20 +363,20 @@ the next section. TEXMFCNF=$TEXMFROOT/texmf-dist/web2c \ ./xdvipdfmx ... - Then you can modify source files in ‘mydir/texk/dvipdfm-x’ and rerun -‘make’ in ‘mydir/Work/texk/dvipdfm-x’ to rebuild; that build directory + Then you can modify source files in 'mydir/texk/dvipdfm-x' and rerun +'make' in 'mydir/Work/texk/dvipdfm-x' to rebuild; that build directory is where the binary ends up and where you can run a debugger, etc. - The second line of the ‘configure’ invocation shows examples of extra + The second line of the 'configure' invocation shows examples of extra things you likely want to specify if you intend to hack the sources (and -not just build binaries): the ‘-C’ speeds ‘configure’ by enabling a -cache file, and the ‘CFLAGS’ and ‘CXXFLAGS’ settings eliminate compiler +not just build binaries): the '-C' speeds 'configure' by enabling a +cache file, and the 'CFLAGS' and 'CXXFLAGS' settings eliminate compiler optimization for debugging purposes. Of course, you need to actually look at the output and check that -things are working. There are many ‘configure’ options you can tweak as -desired; check the output from ‘configure --help’. It is also a good -idea to run ‘make check’ after making any changes, to ensure that +things are working. There are many 'configure' options you can tweak as +desired; check the output from 'configure --help'. It is also a good +idea to run 'make check' after making any changes, to ensure that whatever tests have been written still pass. Reducing source download size @@ -386,48 +386,48 @@ The above retrieves the entire TL source tree (several hundred megabytes). It is natural to ask if this is really necessary. Strictly speaking, the answer is no, but it is vastly more convenient to do so. If you cut down the source tree, you must also give additional -‘configure’ flags to individually disable using system versions of -libraries, or the intricacies of the dependencies (such as ‘teckit’ -requiring ‘zlib’) will have undesired side effects. For an example of -this approach, see the ‘build-pdftex.sh’ script in the ‘pdftex’ +'configure' flags to individually disable using system versions of +libraries, or the intricacies of the dependencies (such as 'teckit' +requiring 'zlib') will have undesired side effects. For an example of +this approach, see the 'build-pdftex.sh' script in the 'pdftex' development source (details at <http://pdftex.org>), which is indeed such a cut-down TL source tree. GCC used by default ................... -By default, the ‘gcc’ compilers will be used if present; otherwise, +By default, the 'gcc' compilers will be used if present; otherwise, individual packages may use something different. You can explicitly -specify the compilers to be used with the environment variables ‘CC’, -‘CXX’, and ‘OBJCXX’. +specify the compilers to be used with the environment variables 'CC', +'CXX', and 'OBJCXX'. Removing C+11 dependency ........................ Some libraries and programs require C++11; one such is XeTeX. If you want to build with an older compiler lacking such support, you need to -(re)move those source directories; unfortunately, specifying ‘--disable’ -for them does not suffice. It’s also necessary to specify -‘--disable-xetex’ explicitly. Specifically, before running ‘configure ---disable-xetex ...’: +(re)move those source directories; unfortunately, specifying '--disable' +for them does not suffice. It's also necessary to specify +'--disable-xetex' explicitly. Specifically, before running 'configure +--disable-xetex ...': rm -rf libs/icu libs/graphite2 texk/dvisvgm texk/web2c/xetexdir - Also, even with ‘--disable-all-pkgs’, dependencies are (currently) + Also, even with '--disable-all-pkgs', dependencies are (currently) checked. One notable case: if a (non-MacOS) system does not have -‘fontconfig’, XeTeX cannot be built (*note Prerequisites::), and -‘configure’ will terminate even with ‘--disable-xetex’. To proceed -without such dependencies, specify ‘--enable-missing’ also. +'fontconfig', XeTeX cannot be built (*note Prerequisites::), and +'configure' will terminate even with '--disable-xetex'. To proceed +without such dependencies, specify '--enable-missing' also. As of 2022, HarfBuzz also requires C++11. Therefore even more would -have to be disabled and removed, notably including ‘luahbtex’, the +have to be disabled and removed, notably including 'luahbtex', the standard engine used for LuaLaTeX. Removing that would not be acceptable for builds intended for distribution; but perhaps for testing the above information could still be useful. - In general, the TL ‘configure’ will run in all directories. + In general, the TL 'configure' will run in all directories. Therefore a general workaround for build problems is to remove failing -directories from the tree, and also specify the relevant ‘--disable-...’ +directories from the tree, and also specify the relevant '--disable-...' option(s). Patches to improve all this would be most welcome. @@ -455,45 +455,45 @@ original TeX: cd texk/web2c # cd engine build directory make tex # must specify target - The first ‘make’ run will configure everything, and even build the + The first 'make' run will configure everything, and even build the libraries, even though the packages are disabled. The source tree can be cut down to just what is needed for the given engine (the separate pdfTeX and LuaTeX source repositories do this, for example), but see caveats in previous section. When the -‘--disable-xetex’ and ‘--enable-missing’ options are needed is also +'--disable-xetex' and '--enable-missing' options are needed is also explained in the previous section. If you want to debug an X-related program or shared library setup, or -other variants, change the ‘configure’ options accordingly. Either -‘../Build’ or ‘../configure’ can be run. +other variants, change the 'configure' options accordingly. Either +'../Build' or '../configure' can be run. - Then it is necessary to again specify the target engine (‘tex’, in -the above) in the ‘make’. + Then it is necessary to again specify the target engine ('tex', in +the above) in the 'make'. All these complications are rather unfortunate. Patches are welcome. Testing one engine .................. -To run only the tests for a given engine, say ‘hitex’: +To run only the tests for a given engine, say 'hitex': make -C $ww check SUBDIRS=. TESTS='$(hitex_tests)' -where ‘$ww’ is the web2c build directory, that is, -‘ww=/wherever/Build/source/Work/texk/web2c’. +where '$ww' is the web2c build directory, that is, +'ww=/wherever/Build/source/Work/texk/web2c'. - It’s also possible to run individual tests the same way, using the -test name exactly as specified in the ‘.am’ file: + It's also possible to run individual tests the same way, using the +test name exactly as specified in the '.am' file: make -C $ww check SUBDIRS=. TESTS=hitexdir/tests/hello.test - If you get tired of looking at the ‘Entering’/‘Leaving directory’ -lines, you can add the (GNU) make option ‘--no-print-dir’. + If you get tired of looking at the 'Entering'/'Leaving directory' +lines, you can add the (GNU) make option '--no-print-dir'. You may find it useful to put lengthy incantations like this into a -trivial shell script with a short name (say, ‘hitst’). Then you just -run ‘hitst’ and edit the file when necessary to change things around. +trivial shell script with a short name (say, 'hitst'). Then you just +run 'hitst' and edit the file when necessary to change things around. File: tlbuild.info, Node: Cross compilation, Prev: Build one engine, Up: Building @@ -501,21 +501,21 @@ File: tlbuild.info, Node: Cross compilation, Prev: Build one engine, Up: Buil 4.6 Cross compilation ===================== -In a cross compilation a “build” system is used to create binaries to be -executed on a “host” system with different hardware and/or operating +In a cross compilation a "build" system is used to create binaries to be +executed on a "host" system with different hardware and/or operating system. In simple cases, the build system can execute binaries for the host system. This typically occurs for bi-arch systems where, e.g., -‘i386-linux’ binaries can run on ‘x86_64-linux’ systems and ‘win32’ -binaries can run on ‘win64’ systems. Although sometimes called “native -cross”, technically this is not cross compilation at all. In most such +'i386-linux' binaries can run on 'x86_64-linux' systems and 'win32' +binaries can run on 'win64' systems. Although sometimes called "native +cross", technically this is not cross compilation at all. In most such cases it suffices to specify suitable compiler flags. It might be -useful to add the configure option ‘--build=HOST’ to get the correct -canonical host name, but note that this should _not_ be ‘--host=HOST’ +useful to add the configure option '--build=HOST' to get the correct +canonical host name, but note that this should _not_ be '--host=HOST' (*note (autoconf)Hosts and Cross-Compilation::). - In order to build, e.g., 32-bit binaries with ‘clang’ on a 64-bit + In order to build, e.g., 32-bit binaries with 'clang' on a 64-bit MacOS system one could use: TL_BUILD_ENV="CC='clang -arch i386' \ @@ -536,13 +536,13 @@ File: tlbuild.info, Node: Cross configuring, Next: Cross problems, Up: Cross In a standard cross compilation, binaries for the host system cannot execute on the build system and it is necessary to specify the configure -options ‘--host=HOST’ and ‘--build=BUILD’ with two different values. +options '--host=HOST' and '--build=BUILD' with two different values. - Building binaries requires suitable “cross” tools, e.g., compiler, -linker, and archiver, and perhaps a “cross” version of ‘pkg-config’ and + Building binaries requires suitable "cross" tools, e.g., compiler, +linker, and archiver, and perhaps a "cross" version of 'pkg-config' and similar to locate host system libraries. Autoconf expects that these cross tools are given by their usual variables or found under their -usual name prefixed with ‘HOST-’. Here a list of such tools and +usual name prefixed with 'HOST-'. Here a list of such tools and corresponding variables: ar AR @@ -555,8 +555,8 @@ corresponding variables: ranlib RANLIB strip STRIP -In order to, e.g., build ‘mingw32’ binaries on ‘x86_64-linux’ with a -cross compiler found as ‘i386-pc-mingw32-gcc’ one would specify +In order to, e.g., build 'mingw32' binaries on 'x86_64-linux' with a +cross compiler found as 'i386-pc-mingw32-gcc' one would specify --host=i386-pc-mingw32 --build=x86_64-linux-gnu @@ -564,9 +564,9 @@ or perhaps --host=mingw32 --build=x86_64-linux CC=i386-pc-mingw32-gcc -but this latter, especially, might require adding ‘CXX’ and others. +but this latter, especially, might require adding 'CXX' and others. - Configure arguments such as ‘CFLAGS=...’ refer to the cross compiler. + Configure arguments such as 'CFLAGS=...' refer to the cross compiler. If necessary, you can specify compilers and flags for the few auxiliary C and C++ programs required for the build process as configure arguments @@ -586,31 +586,31 @@ File: tlbuild.info, Node: Cross problems, Prev: Cross configuring, Up: Cross The fact that binaries for the host system cannot be executed on the build system causes some problems. - One problem is that configure tests using ‘AC_RUN_IFELSE’ can compile + One problem is that configure tests using 'AC_RUN_IFELSE' can compile and link the test program but cannot execute it. Such tests should be avoided if possible and otherwise must supply a pessimistic test result. Another problem arises if the build process must execute some (auxiliary or installable) programs. Auxiliary programs can be placed into a subdirectory that is configured natively as is done for -‘texk/web2c/web2c’, ‘texk/dvipsk/squeeze’, and ‘texk/xdvik/squeeze’. -The module ‘libs/freetype2’ uses the value of ‘CC_BUILD’, ‘BUILD-gcc’, -‘gcc’, or ‘cc’ as the compiler for the auxiliary program. +'texk/web2c/web2c', 'texk/dvipsk/squeeze', and 'texk/xdvik/squeeze'. +The module 'libs/freetype2' uses the value of 'CC_BUILD', 'BUILD-gcc', +'gcc', or 'cc' as the compiler for the auxiliary program. The situation for installable programs needed by the build process is somewhat different. A rather expensive possibility, chosen for the ICU -libraries in module ‘libs/icu’, is to first compile natively for the +libraries in module 'libs/icu', is to first compile natively for the build system and in a second step to use these (uninstalled) programs during the cross compilation. - This approach would also be possible for the tools such as ‘tangle’ -used in the module ‘texk/web2c’ to build the WEB programs, but that -would require first building a native ‘kpathsea’ library. To avoid this + This approach would also be possible for the tools such as 'tangle' +used in the module 'texk/web2c' to build the WEB programs, but that +would require first building a native 'kpathsea' library. To avoid this complication, cross compilation of programs written in (C)WEB requires -sufficiently recent installed versions of ‘tangle’, ‘ctangle’, -‘otangle’, and ‘tie’. +sufficiently recent installed versions of 'tangle', 'ctangle', +'otangle', and 'tie'. - Building ‘xindy’ requires running the host system ‘clisp’ binary, + Building 'xindy' requires running the host system 'clisp' binary, thus cross compilation is painful, but possible. @@ -619,22 +619,22 @@ File: tlbuild.info, Node: Installing, Next: Layout and infrastructure, Prev: 5 Installing ************ -This section discusses the results of ‘make install’ in the source tree. +This section discusses the results of 'make install' in the source tree. - The main consideration is that ‘make install’ is not enough to make a + The main consideration is that 'make install' is not enough to make a usable TeX installation. Beyond the compiled binaries, (thousands of) -support files are needed; just as a first example, ‘plain.tex’ is not in +support files are needed; just as a first example, 'plain.tex' is not in the source tree. These support files are maintained completely independently and are not present in the TL source tree. The best basis for dealing with them -is the TeX Live (plain text) database in ‘Master/tlpkg/texlive.tlpdb’, -and/or the TeX Live installer, ‘install-tl’. More information is under -‘Master/tlpkg’ and at <https://tug.org/texlive/distro.html>. +is the TeX Live (plain text) database in 'Master/tlpkg/texlive.tlpdb', +and/or the TeX Live installer, 'install-tl'. More information is under +'Master/tlpkg' and at <https://tug.org/texlive/distro.html>. * Menu: -* Installation directories:: The prefix, ‘bindir’, etc., directories. +* Installation directories:: The prefix, 'bindir', etc., directories. * Linked scripts:: Scripts not maintained in the sources. * Distro builds:: Configuring and building for OS distributions. @@ -644,15 +644,15 @@ File: tlbuild.info, Node: Installation directories, Next: Linked scripts, Up: 5.1 Installation directories ============================ -Running ‘make install’ (or ‘make install-strip’) installs executables in -‘BINDIR’, libraries in ‘LIBDIR’, headers in ‘INCLUDEDIR’, general data -(including “linked scripts”, *note Linked scripts::) in -‘DATAROOTDIR/texmf-dist’, man pages in ‘MANDIR’, and Info files in -‘INFODIR’. +Running 'make install' (or 'make install-strip') installs executables in +'BINDIR', libraries in 'LIBDIR', headers in 'INCLUDEDIR', general data +(including "linked scripts", *note Linked scripts::) in +'DATAROOTDIR/texmf-dist', man pages in 'MANDIR', and Info files in +'INFODIR'. - The values of these directories are determined by ‘configure’ and can -be specified explicitly as options such as ‘--prefix=PREFIX’ or -‘--bindir=BINDIR’; otherwise, they are given by their usual Autoconf + The values of these directories are determined by 'configure' and can +be specified explicitly as options such as '--prefix=PREFIX' or +'--bindir=BINDIR'; otherwise, they are given by their usual Autoconf defaults: PREFIX /usr/local @@ -666,22 +666,22 @@ defaults: except possibly modified as follows: - • If the option ‘--enable-multiplatform’ is given, ‘/PLATFORM’ (i.e., - the canonical platform name) is appended to ‘BINDIR’ and ‘LIBDIR’. + * If the option '--enable-multiplatform' is given, '/PLATFORM' (i.e., + the canonical platform name) is appended to 'BINDIR' and 'LIBDIR'. This is implied for a native TL build. - • In a native TL build, ‘DATAROOTDIR’ is set to ‘PREFIX’, ‘INFODIR’ - is set to ‘PREFIX/texmf-dist/doc/info’, and ‘MANDIR’ to - ‘PREFIX/texmf-dist/doc/man’, corresponding to the directories used + * In a native TL build, 'DATAROOTDIR' is set to 'PREFIX', 'INFODIR' + is set to 'PREFIX/texmf-dist/doc/info', and 'MANDIR' to + 'PREFIX/texmf-dist/doc/man', corresponding to the directories used in the TL distribution. -The top-level ‘configure’ script displays all these installation paths. +The top-level 'configure' script displays all these installation paths. - For the native TL build, the ‘Build’ script leaves the binaries in -‘./inst/bin/STD-SYSTEM-TRIPLET’. The new binaries are not directly + For the native TL build, the 'Build' script leaves the binaries in +'./inst/bin/STD-SYSTEM-TRIPLET'. The new binaries are not directly usable from that location; they need to be copied to -‘Master/bin/TL-PLATFORM’. The other files and directories that end up -in ‘./inst/’ are ignored. +'Master/bin/TL-PLATFORM'. The other files and directories that end up +in './inst/' are ignored. File: tlbuild.info, Node: Linked scripts, Next: Distro builds, Prev: Installation directories, Up: Installing @@ -692,26 +692,26 @@ File: tlbuild.info, Node: Linked scripts, Next: Distro builds, Prev: Installa Quite a few executables are architecture-independent shell, Perl, or other interpreted scripts, rather than compiled binaries. A few are maintained as part of the TL source tree, but most are maintained -elsewhere with copies under ‘texk/texlive/linked_scripts’. +elsewhere with copies under 'texk/texlive/linked_scripts'. - These so-called “linked scripts” are installed under -‘DATAROOTDIR/texmf-dist/scripts’; for Unix-like systems a symbolic link -is made in ‘BINDIR’. For example, a symlink points from ‘BINDIR/ps2eps’ -to ‘DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl’. For Windows, a -standard wrapper binary (copied to, e.g., ‘BINDIR/ps2eps.exe’) serves + These so-called "linked scripts" are installed under +'DATAROOTDIR/texmf-dist/scripts'; for Unix-like systems a symbolic link +is made in 'BINDIR'. For example, a symlink points from 'BINDIR/ps2eps' +to 'DATAROOTDIR/texmf-dist/scripts/ps2eps/ps2eps.pl'. For Windows, a +standard wrapper binary (copied to, e.g., 'BINDIR/ps2eps.exe') serves the same purpose. The source for the wrapper is in -‘texk/texlive/w32_wrapper’. +'texk/texlive/w32_wrapper'. One reason for this is to avoid having many copies of the same script; a more important reason is that it guarantees the scripts will stay in sync across the different supported operating systems. - Most important of all, we want the ‘BINDIR’ resulting from the build + Most important of all, we want the 'BINDIR' resulting from the build to be as close as possible to what is in the TL distribution. At -present, there are a few exceptions—Asymptote, Biber, Xindy—and each one -creates considerable extra work. We don’t want to add more. (See +present, there are a few exceptions--Asymptote, Biber, Xindy--and each +one creates considerable extra work. We don't want to add more. (See <https://tug.org/texlive/build.html> for information about building -those exceptions, as well as the ‘xz’ and ‘wget’ programs that are used +those exceptions, as well as the 'xz' and 'wget' programs that are used in the TL infrastructure.) @@ -722,50 +722,50 @@ File: tlbuild.info, Node: Distro builds, Prev: Linked scripts, Up: Installing Although they use the same code base, building for the native TL distribution as shipped by the TeX user groups is typically quite -different from a “distro” build needed by, e.g., a full GNU/Linux or BSD +different from a "distro" build needed by, e.g., a full GNU/Linux or BSD operating system distribution. The native TL distribution uses shared libraries only when absolutely -necessary (‘libc’, ‘libm’, X11 libraries, and ‘libfontconfig’). In +necessary ('libc', 'libm', X11 libraries, and 'libfontconfig'). In contrast, a distro typically wants to use as many shared libraries as possible from elsewhere on the system, including TeX-specific libraries -such as ‘libkpathsea’ (even though Kpathsea has never officially been +such as 'libkpathsea' (even though Kpathsea has never officially been released as a shared library). In addition, the installation paths will, in general, be completely different. - Here are the ‘configure’ options that distro builds are likely to + Here are the 'configure' options that distro builds are likely to find most relevant: -‘--disable-native-texlive-build’ +'--disable-native-texlive-build' This must be specified to avoid interference from the many tweaks we do for the native TL build. -‘--with-banner-add=/SOMEDISTRO’ - This isn’t technically required, but is strongly recommended, so +'--with-banner-add=/SOMEDISTRO' + This isn't technically required, but is strongly recommended, so your build and your distro can be distinguished from others. -‘--enable-shared’ +'--enable-shared' Build shared versions of the TeX-specific libraries (uses - ‘libtool’). + 'libtool'). -‘--disable-static’ +'--disable-static' Do not build the static versions of the TeX-specific libraries. -‘--with-system-LIB’ - Look for and use a system version of the library LIB. ‘configure - --help’ will give you the list of possibilities. +'--with-system-LIB' + Look for and use a system version of the library LIB. 'configure + --help' will give you the list of possibilities. -‘--with-LIB-includes=DIR’ -‘--with-LIB-libdir=DIR’ +'--with-LIB-includes=DIR' +'--with-LIB-libdir=DIR' If needed, allows you to specify where the headers/code are for the given library LIB. -‘--prefix=/usr’ -‘--prefix=/opt/TeXLive’ - Or whatever your convention is. The default is ‘/usr/local’ and - you shouldn’t install there for a distro. +'--prefix=/usr' +'--prefix=/opt/TeXLive' + Or whatever your convention is. The default is '/usr/local' and + you shouldn't install there for a distro. -‘--libdir=\${exec_prefix}/lib64’ +'--libdir=\${exec_prefix}/lib64' May be needed for 64-bit bi-architecture (GNU/Linux) systems. You will need to take care of the support files mentioned above @@ -782,9 +782,9 @@ File: tlbuild.info, Node: Layout and infrastructure, Next: Configure options, 6 Layout and infrastructure *************************** -The TeX Live source tree is the subtree rooted at ‘Build/source’ of the +The TeX Live source tree is the subtree rooted at 'Build/source' of the complete TL distribution and contains the sources for all executables -distributed by TL, as well as ‘configure’ scripts and ‘make’ rules to +distributed by TL, as well as 'configure' scripts and 'make' rules to build and install them together with some of their support files. * Menu: @@ -804,15 +804,15 @@ File: tlbuild.info, Node: Build system tools, Next: Top-level directories, Up As mentioned above (*note Prerequisites::), a normal build has few requirements. On the other hand, if you want to modify the TeX Live -infrastructure sources, such as ‘configure.ac’ or ‘Makefile.am’ files, +infrastructure sources, such as 'configure.ac' or 'Makefile.am' files, you will need to have several additional tools installed. In general, the TL build system uses the latest released versions of the GNU build tools, installed directly from the original GNU releases -(e.g., by building them with ‘configure --prefix=/usr/local/gnu’ and -having ‘PATH’ start with ‘/usr/local/gnu/bin’). We have found that +(e.g., by building them with 'configure --prefix=/usr/local/gnu' and +having 'PATH' start with '/usr/local/gnu/bin'). We have found that trying to use the versions of these tools packaged for distros causes -many extra hassles, so don’t do that, tempting as it may be. +many extra hassles, so don't do that, tempting as it may be. Currently the versions we use are: @@ -825,25 +825,25 @@ many extra hassles, so don’t do that, tempting as it may be. makeinfo (GNU texinfo) 7.0.2 These versions should be used to update the generated files (e.g., -‘configure’ or ‘Makefile.in’) in all or parts of the TL tree after their +'configure' or 'Makefile.in') in all or parts of the TL tree after their dependencies have been changed. This can be done explicitly with the -top-level ‘reautoconf’ script or implicitly by using the configure -option ‘--enable-maintainer-mode’. +top-level 'reautoconf' script or implicitly by using the configure +option '--enable-maintainer-mode'. It has often turned out that the bison and flex versions are not -critical; however, the autotools versions are. If you don’t have the +critical; however, the autotools versions are. If you don't have the given versions, get them before modifying the build infrastructure. The files in the Subversion repository (see <https://tug.org/texlive/svn>) are all up to date (barring bugs). For this to be reflected by their timestamps in your checkout, be sure to -set ‘use-commit-times=yes’ in ‘~/.subversion/config’ or the equivalent. +set 'use-commit-times=yes' in '~/.subversion/config' or the equivalent. If timestamps are wrong, you may also be able to avoid unnecessary -runs of ‘bison’, ‘flex’, or ‘makeinfo’ with ‘touch’ of the generated -(‘.c’, ‘.h’, or ‘.info’) files. With ‘--enable-maintainer-mode’ it may -also be necessary to ‘touch’ first ‘aclocal.m4’, then ‘configure’ and -‘config.h.in’ (or ‘c-auto.in’), and finally all ‘Makefile.in’ files. +runs of 'bison', 'flex', or 'makeinfo' with 'touch' of the generated +('.c', '.h', or '.info') files. With '--enable-maintainer-mode' it may +also be necessary to 'touch' first 'aclocal.m4', then 'configure' and +'config.h.in' (or 'c-auto.in'), and finally all 'Makefile.in' files. File: tlbuild.info, Node: Top-level directories, Next: Autoconf macros, Prev: Build system tools, Up: Layout and infrastructure @@ -855,39 +855,39 @@ Here is a brief description of the top-level directories in the TeX Live source tree. As mentioned at the beginning of *note Overview of build system::, -the main source directories are ‘texk/’ (TeX-specific programs and -libraries), ‘utils/’ (additional programs), and ‘libs/’ (generic +the main source directories are 'texk/' (TeX-specific programs and +libraries), 'utils/' (additional programs), and 'libs/' (generic libraries). - In addition, the top-level directories ‘am/’ and ‘m4/’ contain -‘Makefile.am’ fragments and Autoconf macros, respectively, used in many -places. Specifically, the file ‘m4/kpse-pkgs.m4’ contains lists of all + In addition, the top-level directories 'am/' and 'm4/' contain +'Makefile.am' fragments and Autoconf macros, respectively, used in many +places. Specifically, the file 'm4/kpse-pkgs.m4' contains lists of all program and library modules; missing modules are silently ignored. (This helps in creating cut-down source trees.) Each module contributes fragments (in separate files) defining its -capabilities and requirements to the ‘configure.ac’ scripts at the -top-level and in the subdirectories ‘libs’, ‘utils’, and ‘texk’. The -fragments from program modules supply ‘configure’ options to disable or +capabilities and requirements to the 'configure.ac' scripts at the +top-level and in the subdirectories 'libs', 'utils', and 'texk'. The +fragments from program modules supply 'configure' options to disable or enable building them; those from library modules specify if an installed (system) version of that library can be used. This ultimately -determines which modules need to be built—although all modules must be -configured for the benefit of ‘make’ targets such as ‘dist’ or -‘distcheck’. +determines which modules need to be built--although all modules must be +configured for the benefit of 'make' targets such as 'dist' or +'distcheck'. - The top-level ‘build-aux/’ directory contains the common files -‘compile’, ‘config.guess’, ‘config.sub’, ‘depcomp’, etc. used by most + The top-level 'build-aux/' directory contains the common files +'compile', 'config.guess', 'config.sub', 'depcomp', etc. used by most packages. These are taken from the GNU Gnulib sources (<https://www.gnu.org/software/gnulib>), which in turn synchronizes with any ultimate upstream repository. There are independent copies of some of these in a few other places, e.g., -‘libs/freetype2/freetype-*/builds/unix/’. The ‘reautoconf’ script does +'libs/freetype2/freetype-*/builds/unix/'. The 'reautoconf' script does not touch those, but a TL cron job keeps them in sync (nightly). - When the top-level ‘./Build’ script is used to build TL, two more two -more top-level directories appear: ‘Work/’ for the build tree, and -‘inst/’ for the install tree (from ‘make install’). These names (and -everything else about ‘Build’’s operation) can be changed by setting + When the top-level './Build' script is used to build TL, two more two +more top-level directories appear: 'Work/' for the build tree, and +'inst/' for the install tree (from 'make install'). These names (and +everything else about 'Build''s operation) can be changed by setting environment variables before running it; see the script source. @@ -897,9 +897,9 @@ File: tlbuild.info, Node: Autoconf macros, Next: Library modules, Prev: Top-l =================== Here we describe a few of the Autoconf macros used in several -modules—many more are defined in the sources; see the top-level ‘m4/’ +modules--many more are defined in the sources; see the top-level 'm4/' directory. These general macros are supplemented by module-specific -macros in directories such as ‘texk/dvipng/m4/’; some of those are +macros in directories such as 'texk/dvipng/m4/'; some of those are described in following sections (*note Library modules:: and *note Program modules::). @@ -922,18 +922,18 @@ The TL sources use two general setup macros: -- Macro: KPSE_BASIC (NAME, [MORE-OPTIONS]) Initialize the basic TL infrastructure for module NAME: - ‘AM_INIT_AUTOMAKE([foreign MORE-OPTIONS])’ - ‘AM_MAINTAINER_MODE’ - ‘KPSE_COMPILER_WARNINGS’ + 'AM_INIT_AUTOMAKE([foreign MORE-OPTIONS])' + 'AM_MAINTAINER_MODE' + 'KPSE_COMPILER_WARNINGS' and make sure the C compiler understands function prototypes. This is used for all generic library and program modules. -- Macro: KPSE_COMMON (NAME, [MORE-OPTIONS]) - Like ‘KPSE_BASIC’ but add: - ‘LT_PREREQ([2.2.6])’ - ‘LT_INIT([win32-dll])’ - ‘AC_SYS_LARGEFILE’ - ‘AC_FUNC_FSEEKO’ + Like 'KPSE_BASIC' but add: + 'LT_PREREQ([2.2.6])' + 'LT_INIT([win32-dll])' + 'AC_SYS_LARGEFILE' + 'AC_FUNC_FSEEKO' along with checks for frequently used functions, headers, types, and structures. This is used for TeX-specific modules. @@ -946,20 +946,20 @@ File: tlbuild.info, Node: Macros for programs, Next: Macros for compilers, Pr Macros for program checks: -- Macro: KPSE_CHECK_LATEX - Set ‘LATEX’ to the first of ‘latex’, ‘elatex’, or ‘lambda’ which - exists in ‘PATH’, or to ‘no’ if none of them exists. Call - ‘AC_SUBST’ for ‘LATEX’. The result of this test can be overridden - by setting the ‘LATEX’ environment variable or the cache variable - ‘ac_cv_prog_LATEX’. + Set 'LATEX' to the first of 'latex', 'elatex', or 'lambda' which + exists in 'PATH', or to 'no' if none of them exists. Call + 'AC_SUBST' for 'LATEX'. The result of this test can be overridden + by setting the 'LATEX' environment variable or the cache variable + 'ac_cv_prog_LATEX'. -- Macro: KPSE_CHECK_PDFLATEX - Check for ‘pdflatex’ in ‘PATH’ and set ‘PDFLATEX’. + Check for 'pdflatex' in 'PATH' and set 'PDFLATEX'. -- Macro: KPSE_CHECK_PERL - Check for ‘perl’ or ‘perl5’ in ‘PATH’ and set ‘PERL’. + Check for 'perl' or 'perl5' in 'PATH' and set 'PERL'. -- Macro: KPSE_PROG_LEX - Call ‘AC_PROG_LEX’ and add the flag ‘-l’ for ‘flex’. + Call 'AC_PROG_LEX' and add the flag '-l' for 'flex'. File: tlbuild.info, Node: Macros for compilers, Next: Macros for libraries, Prev: Macros for programs, Up: Autoconf macros @@ -971,30 +971,30 @@ Macros for compiler-related checks: -- Macro: KPSE_COMPILER_WARNINGS When using the (Objective) C/C++ compiler, set - ‘WARNING_[OBJ]C[XX]FLAGS’ to suitable warning flags (depending on - the value given to or implied for ‘--enable-compiler-warnings’). - Call ‘AC_SUBST’ for them. At present this assumes GNU compiler + 'WARNING_[OBJ]C[XX]FLAGS' to suitable warning flags (depending on + the value given to or implied for '--enable-compiler-warnings'). + Call 'AC_SUBST' for them. At present this assumes GNU compiler warning options, but could be extended to others if necessary. - This macro caches its results in the ‘kpse_cv_warning_cflags’, ... + This macro caches its results in the 'kpse_cv_warning_cflags', ... variables. -- Macro: KPSE_COMPILER_VISIBILITY When using the C or C++ compiler, try to set - ‘VISIBILITY_C[XX]FLAGS’ to flags to hide external symbols. Call - ‘AC_SUBST’ for this variable. At present this only tests for the - compiler option ‘-fvisibility=hidden’, but could be extended if + 'VISIBILITY_C[XX]FLAGS' to flags to hide external symbols. Call + 'AC_SUBST' for this variable. At present this only tests for the + compiler option '-fvisibility=hidden', but could be extended if necessary. - This macro caches its results in the ‘kpse_cv_visibility_cflags’ or - ‘kpse_cv_visibility_cxxflags’ variable. + This macro caches its results in the 'kpse_cv_visibility_cflags' or + 'kpse_cv_visibility_cxxflags' variable. -- Macro: KPSE_CXX_HACK - Provide the configure option ‘--enable-cxx-runtime-hack’. If - enabled and when using ‘g++’, try to statically link with - ‘libstdc++’, notably improving portability of the resulting binary. + Provide the configure option '--enable-cxx-runtime-hack'. If + enabled and when using 'g++', try to statically link with + 'libstdc++', notably improving portability of the resulting binary. - This macro caches its result in the ‘kpse_cv_cxx_hack’ variable. + This macro caches its result in the 'kpse_cv_cxx_hack' variable. File: tlbuild.info, Node: Macros for libraries, Next: Macros for library and header flags, Prev: Macros for compilers, Up: Autoconf macros @@ -1005,8 +1005,8 @@ File: tlbuild.info, Node: Macros for libraries, Next: Macros for library and h One macro for a library check: -- Macro: KPSE_LARGEFILE (VARIABLE, [EXTRA-DEFINE]) - Call ‘AC_SYS_LARGEFILE’ and ‘AC_FUNC_FSEEKO’ and append suitable - ‘-D’ flags (optionally including ‘-DEXTRA-DEFINE’) to VARIABLE. + Call 'AC_SYS_LARGEFILE' and 'AC_FUNC_FSEEKO' and append suitable + '-D' flags (optionally including '-DEXTRA-DEFINE') to VARIABLE. File: tlbuild.info, Node: Macros for library and header flags, Next: Macros for Windows, Prev: Macros for libraries, Up: Autoconf macros @@ -1014,33 +1014,33 @@ File: tlbuild.info, Node: Macros for library and header flags, Next: Macros fo 6.3.5 Macros for library and header flags ----------------------------------------- -Each library module ‘libs/LIB’ or ‘texk/LIB’ is supplemented by a macro -‘KPSE_LIB_FLAGS’ (all uppercase) that provides make variables for that -library. E.g., for ‘libs/libpng’: +Each library module 'libs/LIB' or 'texk/LIB' is supplemented by a macro +'KPSE_LIB_FLAGS' (all uppercase) that provides make variables for that +library. E.g., for 'libs/libpng': -- Macro: KPSE_LIBPNG_FLAGS - Provide the configure option ‘--with-system-libpng’. Set and - ‘AC_SUBST’ ‘make’ variables for modules using this library (either + Provide the configure option '--with-system-libpng'. Set and + 'AC_SUBST' 'make' variables for modules using this library (either an installed version or from the TeX Live tree): - ‘LIBPNG_INCLUDES’ for use in ‘CPPFLAGS’, - ‘LIBPNG_LIBS’ for use in ‘LDADD’, - ‘LIBPNG_DEPEND’ for use as a Makefile dependency, - ‘LIBPNG_RULE’ for the ‘make’ rules to rebuild the library. + 'LIBPNG_INCLUDES' for use in 'CPPFLAGS', + 'LIBPNG_LIBS' for use in 'LDADD', + 'LIBPNG_DEPEND' for use as a Makefile dependency, + 'LIBPNG_RULE' for the 'make' rules to rebuild the library. -- Macro: KPSE_ADD_FLAGS (NAME) - Temporarily extend ‘CPPFLAGS’ and ‘LIBS’ with the values required - for the library module ‘NAME’. + Temporarily extend 'CPPFLAGS' and 'LIBS' with the values required + for the library module 'NAME'. -- Macro: KPSE_RESTORE_FLAGS - Restore ‘CPPFLAGS’ and ‘LIBS’ to their original values. + Restore 'CPPFLAGS' and 'LIBS' to their original values. - As an example, the ‘configure.ac’ file for a hypothetical program -‘utils/foo’ using ‘libpng’, and hence ‘zlib’, would contain + As an example, the 'configure.ac' file for a hypothetical program +'utils/foo' using 'libpng', and hence 'zlib', would contain KPSE_ZLIB_FLAGS KPSE_LIBPNG_FLAGS -and its ‘Makefile.am’ would be along these lines: +and its 'Makefile.am' would be along these lines: bin_PROGRAMS = foo AM_CPPFLAGS = ${LIBPNG_INCLUDES} ${ZLIB_INCLUDES} foo_LDADD = ${LIBPNG_LIBS} ${ZLIB_LIBS} @@ -1050,13 +1050,13 @@ and its ‘Makefile.am’ would be along these lines: ## Rebuild libpng @LIBPNG_RULE@ - If it were necessary to examine whether certain ‘zlib’ or ‘libpng’ -features were available, ‘configure.ac’ should be continued this way: + If it were necessary to examine whether certain 'zlib' or 'libpng' +features were available, 'configure.ac' should be continued this way: KPSE_ADD_FLAGS([zlib]) - ... # tests for ‘zlib’ features, if any + ... # tests for 'zlib' features, if any KPSE_ADD_FLAGS([libpng]) - ... # tests for ‘libpng’ features - KPSE_RESTORE_FLAGS # restore ‘CPPFLAGS’ and ‘LIBS’ + ... # tests for 'libpng' features + KPSE_RESTORE_FLAGS # restore 'CPPFLAGS' and 'LIBS' File: tlbuild.info, Node: Macros for Windows, Prev: Macros for library and header flags, Up: Autoconf macros @@ -1068,33 +1068,33 @@ Windows differs in several aspects from Unix-like systems, many of them due to the lack of symbolic links. -- Macro: KPSE_CHECK_WIN32 - Check if compiling for a Windows system. The result is either ‘no’ - for Unix-like systems (including Cygwin), ‘mingw32’ for Windows - with GCC, or ‘native’ for Windows with MSVC. The result is cached - in the ‘kpse_cv_have_win32’ variable. + Check if compiling for a Windows system. The result is either 'no' + for Unix-like systems (including Cygwin), 'mingw32' for Windows + with GCC, or 'native' for Windows with MSVC. The result is cached + in the 'kpse_cv_have_win32' variable. -- Macro: KPSE_COND_WIN32 - Call ‘KPSE_CHECK_WIN32’ and define the Automake conditional ‘WIN32’ - (‘true’ if the value of ‘kpse_cv_have_win32’ is not ‘no’). + Call 'KPSE_CHECK_WIN32' and define the Automake conditional 'WIN32' + ('true' if the value of 'kpse_cv_have_win32' is not 'no'). -- Macro: KPSE_COND_MINGW32 - Call ‘KPSE_COND_WIN32’ and define the Automake conditional - ‘MINGW32’ (‘true’ if the value of ‘kpse_cv_have_win32’ is - ‘mingw32’). + Call 'KPSE_COND_WIN32' and define the Automake conditional + 'MINGW32' ('true' if the value of 'kpse_cv_have_win32' is + 'mingw32'). -- Macro: KPSE_COND_WIN32_WRAP - Call ‘KPSE_COND_WIN32’ and define the Automake conditional - ‘WIN32_WRAP’ (‘true’ if the standard Windows wrapper - (‘texk/texlive/w32_wrapper/runscript.exe’) exists. This wrapper is - used on Windows instead of symlinks for the “linked scripts” (*note + Call 'KPSE_COND_WIN32' and define the Automake conditional + 'WIN32_WRAP' ('true' if the standard Windows wrapper + ('texk/texlive/w32_wrapper/runscript.exe') exists. This wrapper is + used on Windows instead of symlinks for the "linked scripts" (*note Linked scripts::). -- Macro: KPSE_WIN32_CALL - Call ‘KPSE_COND_WIN32’ and check if the file - ‘texk/texlive/w32_wrapper/callexe.c’ exists; if it does, create a - symlink in the build tree. Compiling ‘callexe.c’ with - ‘-DEXEPROG='"FOO.exe"'’ and installing ‘callexe.exe’ as ‘BAR.exe’ - is used on Windows instead of a symlink ‘BAR->FOO’ for Unix-like + Call 'KPSE_COND_WIN32' and check if the file + 'texk/texlive/w32_wrapper/callexe.c' exists; if it does, create a + symlink in the build tree. Compiling 'callexe.c' with + '-DEXEPROG='"FOO.exe"'' and installing 'callexe.exe' as 'BAR.exe' + is used on Windows instead of a symlink 'BAR->FOO' for Unix-like systems. @@ -1109,27 +1109,27 @@ structure and variation. * Menu: -* png library:: ‘libs/libpng’ -* zlib library:: ‘libs/zlib’ -* freetype library:: ‘libs/freetype2’ -* kpathsea library:: ‘texk/kpathsea’ +* png library:: 'libs/libpng' +* zlib library:: 'libs/zlib' +* freetype library:: 'libs/freetype2' +* kpathsea library:: 'texk/kpathsea' File: tlbuild.info, Node: png library, Next: zlib library, Up: Library modules -6.4.1 The ‘png’ library in ‘libs/libpng’ +6.4.1 The 'png' library in 'libs/libpng' ---------------------------------------- -The “generic” ‘png’ library uses the source tree in the subdirectory -‘libpng-src/’, with all modifications for TL recorded in ‘TLpatches/*’. -The ‘configure.ac’ fragment ‘ac/withenable.ac’ contains +The "generic" 'png' library uses the source tree in the subdirectory +'libpng-src/', with all modifications for TL recorded in 'TLpatches/*'. +The 'configure.ac' fragment 'ac/withenable.ac' contains KPSE_WITH_LIB([libpng], [zlib]) -to specify the module name and indicate the dependency on ‘zlib’. A -third literal argument ‘‘tree’’ would specify that the library from the +to specify the module name and indicate the dependency on 'zlib'. A +third literal argument ''tree'' would specify that the library from the TeX Live tree cannot be replaced by a system version. That not being -the case here, a second fragment ‘ac/libpng.ac’ contains +the case here, a second fragment 'ac/libpng.ac' contains KPSE_TRY_LIB([libpng], [#include <png.h>], @@ -1145,85 +1145,85 @@ thus providing the simple C code return 0; } which Autoconf uses to verify the usability of a system version with C -code. The analogous macro ‘KPSE_TRY_LIBXX’ would check using C++. -These fragments are included by the ‘configure.ac’ at the top level of -TL (‘Build/source/configure.ac’). +code. The analogous macro 'KPSE_TRY_LIBXX' would check using C++. +These fragments are included by the 'configure.ac' at the top level of +TL ('Build/source/configure.ac'). For this library, like many other modules, a proxy build system for -TL is used, consisting of our own ‘configure.ac’, ‘Makefile.am’, -‘include/Makefile.am’; the distributed build system is not used. +TL is used, consisting of our own 'configure.ac', 'Makefile.am', +'include/Makefile.am'; the distributed build system is not used. (Consequently, a few generated files and auxiliary scripts are removed from the distributed source tree.) - The public headers ‘png.h’, ‘pngconf.h’, and ‘pnglibconf.h’ are -“installed” (as symlinks) under ‘include/’ in the build tree exactly as -they are for a system version under, e.g., ‘/usr/include/’. + The public headers 'png.h', 'pngconf.h', and 'pnglibconf.h' are +"installed" (as symlinks) under 'include/' in the build tree exactly as +they are for a system version under, e.g., '/usr/include/'. - The module is supplemented by the file ‘m4/kpse-libpng-flags.m4’ that -defines the M4 macro ‘KPSE_LIBPNG_FLAGS’ used by all modules depending -on this library in their ‘configure.ac’ to generate the ‘make’ variables -‘LIBPNG_INCLUDES’ for use in ‘CPPFLAGS’, ‘LIBPNG_LIBS’ for use in -‘LDADD’, ‘LIBPNG_DEPEND’ for use as dependencies, and ‘LIBPNG_RULE’ for -the ‘make’ rules to rebuild the library. + The module is supplemented by the file 'm4/kpse-libpng-flags.m4' that +defines the M4 macro 'KPSE_LIBPNG_FLAGS' used by all modules depending +on this library in their 'configure.ac' to generate the 'make' variables +'LIBPNG_INCLUDES' for use in 'CPPFLAGS', 'LIBPNG_LIBS' for use in +'LDADD', 'LIBPNG_DEPEND' for use as dependencies, and 'LIBPNG_RULE' for +the 'make' rules to rebuild the library. - ‘m4/kpse-libpng-flags.m4’ also supplies the configure option -‘--with-system-libpng’, which then uses ‘pkg-config’ to determine the + 'm4/kpse-libpng-flags.m4' also supplies the configure option +'--with-system-libpng', which then uses 'pkg-config' to determine the flags required for the system library. File: tlbuild.info, Node: zlib library, Next: freetype library, Prev: png library, Up: Library modules -6.4.2 The ‘zlib’ library in ‘libs/zlib’ +6.4.2 The 'zlib' library in 'libs/zlib' --------------------------------------- -This generic library is very much analogous to ‘libpng’, but without the -dependency on any other library. The file ‘m4/kpse-zlib-flags.m4’ -supplies the configure option ‘--with-system-zlib’, as well as -‘--with-zlib-includes’ and ‘--with-zlib-libdir’ to specify non-standard -locations of the ‘zlib’ headers and/or library. +This generic library is very much analogous to 'libpng', but without the +dependency on any other library. The file 'm4/kpse-zlib-flags.m4' +supplies the configure option '--with-system-zlib', as well as +'--with-zlib-includes' and '--with-zlib-libdir' to specify non-standard +locations of the 'zlib' headers and/or library. File: tlbuild.info, Node: freetype library, Next: kpathsea library, Prev: zlib library, Up: Library modules -6.4.3 The ‘freetype’ library in ‘libs/freetype2’ +6.4.3 The 'freetype' library in 'libs/freetype2' ------------------------------------------------ This module uses a wrapper build system. In contrast to the proxy build described earlier, the wrapper build has an almost trivial -‘configure.ac’ and a ‘Makefile.am’ which invokes the ‘configure’ and -‘make’ in the distributed source, followed by ‘make install’ with the TL +'configure.ac' and a 'Makefile.am' which invokes the 'configure' and +'make' in the distributed source, followed by 'make install' with the TL build tree as destination. In other words, this actually uses the build system provided by upstream (possibly patched). The flags required for the system library are obtained through -‘freetype-config’. +'freetype-config'. File: tlbuild.info, Node: kpathsea library, Prev: freetype library, Up: Library modules -6.4.4 The ‘kpathsea’ library in ‘texk/kpathsea’ +6.4.4 The 'kpathsea' library in 'texk/kpathsea' ----------------------------------------------- This is one of the TeX-specific libraries that are maintained as part of -TeX Live (*note (kpathsea)::); the other is ‘ptexenc’. These TeX +TeX Live (*note (kpathsea)::); the other is 'ptexenc'. These TeX libraries are Libtool libraries (static and/or shared) and are installed -by ‘make install’ together with the programs. They are, however, not +by 'make install' together with the programs. They are, however, not part of the TL DVD as distributed by TeX user groups, and have never been officially released for standalone use. It is possible, and probably useful for distro builds (*note Distro -builds::), to specify the configure option ‘--with-system-kpathsea’ in +builds::), to specify the configure option '--with-system-kpathsea' in order to use a system version of the library. Programs outside the TL -tree should use ‘pkg-config’ for the required flags. - - In addition to ‘kpathsea/ac/withenable.ac’ and -‘kpathsea/ac/kpathsea.ac’ here there is a third fragment -‘kpathsea.ac/mktex.ac’, included by both ‘withenable.ac’ and -‘configure.ac’, which supplies configure options such as -‘--enable-mktextfm-default’. These determine the compile time default -of whether or not to run ‘mktextfm’ (and similar) to generate a missing -‘.tfm’ (or whatever) file. In any case, however, the command line -options ‘-mktex=tfm’ or ‘-no-mktex=tfm’ for the TeX-like engines +tree should use 'pkg-config' for the required flags. + + In addition to 'kpathsea/ac/withenable.ac' and +'kpathsea/ac/kpathsea.ac' here there is a third fragment +'kpathsea.ac/mktex.ac', included by both 'withenable.ac' and +'configure.ac', which supplies configure options such as +'--enable-mktextfm-default'. These determine the compile time default +of whether or not to run 'mktextfm' (and similar) to generate a missing +'.tfm' (or whatever) file. In any case, however, the command line +options '-mktex=tfm' or '-no-mktex=tfm' for the TeX-like engines override this default. @@ -1237,85 +1237,85 @@ for a few of the programs in TL. * Menu: -* t1utils package:: ‘utils/t1utils’ -* xindy package:: ‘utils/xindy’ -* xdvik package:: ‘texk/xdvik’ -* asymptote:: ‘utils/asymptote’ +* t1utils package:: 'utils/t1utils' +* xindy package:: 'utils/xindy' +* xdvik package:: 'texk/xdvik' +* asymptote:: 'utils/asymptote' File: tlbuild.info, Node: t1utils package, Next: xindy package, Up: Program modules -6.5.1 The ‘t1utils’ package in ‘utils/t1utils’ +6.5.1 The 't1utils' package in 'utils/t1utils' ---------------------------------------------- -Here we use the distributed source tree ‘t1utils-src’ with modifications -documented in ‘TLpatches/*’ and a proxy build system consisting of -‘configure.ac’ and ‘Makefile.am’. The fragment ‘ac/withenable.ac’ +Here we use the distributed source tree 't1utils-src' with modifications +documented in 'TLpatches/*' and a proxy build system consisting of +'configure.ac' and 'Makefile.am'. The fragment 'ac/withenable.ac' contains KPSE_ENABLE_PROG([t1utils]) specifying the module name without any dependencies, and supplies the -configure option ‘--disable-t1utils’. +configure option '--disable-t1utils'. File: tlbuild.info, Node: xindy package, Next: xdvik package, Prev: t1utils package, Up: Program modules -6.5.2 The ‘xindy’ package in ‘utils/xindy’ +6.5.2 The 'xindy' package in 'utils/xindy' ------------------------------------------ -This module uses the distributed source tree ‘xindy-src/’ with -modifications documented in ‘TLpatches/*’, and a wrapper ‘configure.ac’ -and ‘Makefile.am’ that descends into ‘xindy-src’. +This module uses the distributed source tree 'xindy-src/' with +modifications documented in 'TLpatches/*', and a wrapper 'configure.ac' +and 'Makefile.am' that descends into 'xindy-src'. - The ‘xindy’ build requires a ‘make’ that supports a ‘VPATH’ build, -can handle all targets, and does not refer to ‘${top_srcdir}’ or -‘${top_builddir}’. The fragment ‘xindy/ac/withenable.ac’ contains + The 'xindy' build requires a 'make' that supports a 'VPATH' build, +can handle all targets, and does not refer to '${top_srcdir}' or +'${top_builddir}'. The fragment 'xindy/ac/withenable.ac' contains KPSE_ENABLE_PROG([xindy], , [disable]) m4_include(kpse_TL[utils/xindy/ac/xindy.ac]) m4_include(kpse_TL[utils/xindy/ac/clisp.ac]) -where ‘disable’ in the third argument indicates that ‘xindy’ is only -built if explicitly enabled by the user with ‘configure --enable-xindy’ -(the need for ‘clisp’ makes it too painful to enable by default). +where 'disable' in the third argument indicates that 'xindy' is only +built if explicitly enabled by the user with 'configure --enable-xindy' +(the need for 'clisp' makes it too painful to enable by default). - The additional fragments ‘ac/xindy.ac’ and ‘ac/clisp.ac’ specify more -‘configure’ options to be seen at the top level, with ‘ac/xindy.ac’ also -included by ‘configure.ac’. + The additional fragments 'ac/xindy.ac' and 'ac/clisp.ac' specify more +'configure' options to be seen at the top level, with 'ac/xindy.ac' also +included by 'configure.ac'. File: tlbuild.info, Node: xdvik package, Next: asymptote, Prev: xindy package, Up: Program modules -6.5.3 The ‘xdvik’ package in ‘texk/xdvik’ +6.5.3 The 'xdvik' package in 'texk/xdvik' ----------------------------------------- This package is maintained as part of the TeX Live tree with sources in -its own directory (‘texk/xdvik/’). The fragment -‘xdvik/ac/withenable.ac’ contains +its own directory ('texk/xdvik/'). The fragment +'xdvik/ac/withenable.ac' contains dnl extra_dirs = texk/xdvik/squeeze KPSE_ENABLE_PROG([xdvik], [kpathsea freetype2], [x]) m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac]) -thus specifying dependencies on the ‘kpathsea’, ‘freetype’, and X11 -libraries. The M4 comment (following ‘dnl’) signals the subsidiary -‘squeeze/configure.ac’. This is needed because the main executable -‘xdvi-bin’ (to be installed as, e.g., ‘xdvi-xaw’) is for the ‘host’ -system whereas the auxiliary program ‘squeeze/squeeze’ has to run on the -‘build’ system; in a cross compilation, these differ. +thus specifying dependencies on the 'kpathsea', 'freetype', and X11 +libraries. The M4 comment (following 'dnl') signals the subsidiary +'squeeze/configure.ac'. This is needed because the main executable +'xdvi-bin' (to be installed as, e.g., 'xdvi-xaw') is for the 'host' +system whereas the auxiliary program 'squeeze/squeeze' has to run on the +'build' system; in a cross compilation, these differ. - The additional fragment ‘ac/xdvik.ac’ is also included by -‘configure.ac’ and supplies the configure option ‘--with-xdvi-x-toolkit’ + The additional fragment 'ac/xdvik.ac' is also included by +'configure.ac' and supplies the configure option '--with-xdvi-x-toolkit' also seen at the top level. File: tlbuild.info, Node: asymptote, Prev: xdvik package, Up: Program modules -6.5.4 The subdirectory ‘utils/asymptote’ +6.5.4 The subdirectory 'utils/asymptote' ---------------------------------------- -This subdirectory contains the sources for ‘asy’ and ‘xasy’ but due to +This subdirectory contains the sources for 'asy' and 'xasy' but due to its complexity and prerequisites (e.g., OpenGL) it is not part of the TL build system. These programs must be built and installed independently, but are included on the TL DVD together with their support files. See @@ -1330,12 +1330,12 @@ File: tlbuild.info, Node: Extending TeX Live, Prev: Program modules, Up: Layo This section outlines the basic process for adding new packages to the TL build system. - In any case, a new package directory ‘foo’ should contain the + In any case, a new package directory 'foo' should contain the original sources, modified only with changes necessary for TL, in -‘foo/foo-src’. The changes should be documented in ‘foo/TLpatches/*’, -and also be submitted upstream whenever reasonable. In addition, ‘foo/’ -will need the usual Automake build-related files (‘configure.ac’, -‘Makefile.am’, etc. Please maintain ‘foo/ChangeLog’ for all TL changes. +'foo/foo-src'. The changes should be documented in 'foo/TLpatches/*', +and also be submitted upstream whenever reasonable. In addition, 'foo/' +will need the usual Automake build-related files ('configure.ac', +'Makefile.am', etc. Please maintain 'foo/ChangeLog' for all TL changes. * Menu: @@ -1350,102 +1350,102 @@ File: tlbuild.info, Node: Adding a new program module, Next: Adding a new engi 6.6.1 Adding a new program module --------------------------------- -A TeX-specific program module in a subdirectory ‘texk/PROG’ may use the -TeX-specific libraries and is included by adding its name ‘PROG’ to the -M4 list ‘kpse_texk_pkgs’ defined in ‘m4/kpse-pkgs.m4’. +A TeX-specific program module in a subdirectory 'texk/PROG' may use the +TeX-specific libraries and is included by adding its name 'PROG' to the +M4 list 'kpse_texk_pkgs' defined in 'm4/kpse-pkgs.m4'. - A generic program module in a subdirectory ‘utils/PROG’ must not use -the TeX-specific libraries and is included by adding its name ‘PROG’ to -the M4 list ‘kpse_utils_pkgs’ in ‘m4/kpse-pkgs.m4’. + A generic program module in a subdirectory 'utils/PROG' must not use +the TeX-specific libraries and is included by adding its name 'PROG' to +the M4 list 'kpse_utils_pkgs' in 'm4/kpse-pkgs.m4'. - In either case, the subdirectory ‘texk/PROG’ or ‘utils/PROG’ must -provide a fragment ‘ac/withenable.ac’ that contains the M4 macro -‘KPSE_ENABLE_PROG’ defined in ‘m4/kpse-setup.m4’ with ‘PROG’ as the + In either case, the subdirectory 'texk/PROG' or 'utils/PROG' must +provide a fragment 'ac/withenable.ac' that contains the M4 macro +'KPSE_ENABLE_PROG' defined in 'm4/kpse-setup.m4' with 'PROG' as the mandatory first argument and three optional arguments: 1. a list of required libraries from the TL tree; - 2. a list of options: ‘disable’ if this module is not to be built - without the configure option ‘--enable-PROG’, ‘native’ if cross - compilation is not possible, ‘x’ if the program requires X11 + 2. a list of options: 'disable' if this module is not to be built + without the configure option '--enable-PROG', 'native' if cross + compilation is not possible, 'x' if the program requires X11 libraries; - 3. a comment added to the help text for the ‘configure’ option - ‘--enable-PROG’ or ‘--disable-PROG’. + 3. a comment added to the help text for the 'configure' option + '--enable-PROG' or '--disable-PROG'. - If the module requires specific ‘configure’ options to be seen at the -top level, they should be defined in an additional fragment ‘ac/PROG.ac’ -included from ‘ac/withenable.ac’ and ‘configure.ac’. + If the module requires specific 'configure' options to be seen at the +top level, they should be defined in an additional fragment 'ac/PROG.ac' +included from 'ac/withenable.ac' and 'configure.ac'. Usually, the new program is maintained somewhere outside of TeX Live. In that case, as above, we put the upstream sources into a subdirectory -‘PROG-src’ (e.g., ‘utils/newprog/newprog-src’). We do not typically run -‘configure’ in this original ‘...-src’ directory, but only in our own -directory; but we do compile using the source files in ‘...-src’. +'PROG-src' (e.g., 'utils/newprog/newprog-src'). We do not typically run +'configure' in this original '...-src' directory, but only in our own +directory; but we do compile using the source files in '...-src'. So, to summarize the files that must (usually) be created inside a -new TL source directory (‘texk/newprog’ or ‘utils/newprog’): +new TL source directory ('texk/newprog' or 'utils/newprog'): -‘ac/withenable.ac’ - The ‘KPSE_ENABLE_PROG’ call just explained. +'ac/withenable.ac' + The 'KPSE_ENABLE_PROG' call just explained. -‘configure.ac’ -‘Makefile.am’ - By merging the contents of the original ‘configure.ac’ (if +'configure.ac' +'Makefile.am' + By merging the contents of the original 'configure.ac' (if provided) and a comparable program already in TL. In the above - example, one line that will be needed in ‘configure.ac’ (can be - added before the ‘AC_CONFIG_FILES’ at the end) is: + example, one line that will be needed in 'configure.ac' (can be + added before the 'AC_CONFIG_FILES' at the end) is: AC_SUBST([NEWPROG_TREE], [newprog-src]) - and then use ‘@NEWPROG_TREE@’ in ‘Makefile.am’ where needed. + and then use '@NEWPROG_TREE@' in 'Makefile.am' where needed. In general, there is no magic recipe for this part of the job. - It’s necessary to think about what needs to be done in the original - vs. in TeX Live. It’s useful to look at the setup for the most - comparable programs already in TL that you can find. It’s also - useful to grep the entire ‘Build/source’ tree for whatever you can + It's necessary to think about what needs to be done in the original + vs. in TeX Live. It's useful to look at the setup for the most + comparable programs already in TL that you can find. It's also + useful to grep the entire 'Build/source' tree for whatever you can think of to investigate how something is done. Most of the - TL-specific macros are defined in ‘Build/source/m4/*’. + TL-specific macros are defined in 'Build/source/m4/*'. -‘TLpatches/TL-Changes’ +'TLpatches/TL-Changes' First actions taken after getting the original source tree; typically removal of derived or unused common files. -‘TLpatches/patch-...’ +'TLpatches/patch-...' If any changes are needed to the original sources, record the patches here so they can be applied next time. Also, send them - upstream so that we don’t have to maintain them forever. + upstream so that we don't have to maintain them forever. -‘ChangeLog’ +'ChangeLog' Record all TL-specific changes, now and in the future. - After populating the new TL source directory (‘.../newprog/’, in the -above), run GNU ‘autoreconf’ there (*note Build system tools::). Once -that works, if you are the one who’s eventually going to commit the new -package, ‘svn add’ the necessary files, including the generated -‘Makefile.in aclocal.m4 configure’, and ‘svn:ignore’ the Automake cache -‘autom4te.cache’. (This is so people checking out the TL source tree do -not have to run any autotools, but can simply run ‘configure’.) - - To reiterate: do not fail to commit the generated ‘configure’ and -other files. The m4 code in ‘kpse-pkgs.m4’ uses the existence of -‘configure’ to determine whether to descend into (and configure) a given + After populating the new TL source directory ('.../newprog/', in the +above), run GNU 'autoreconf' there (*note Build system tools::). Once +that works, if you are the one who's eventually going to commit the new +package, 'svn add' the necessary files, including the generated +'Makefile.in aclocal.m4 configure', and 'svn:ignore' the Automake cache +'autom4te.cache'. (This is so people checking out the TL source tree do +not have to run any autotools, but can simply run 'configure'.) + + To reiterate: do not fail to commit the generated 'configure' and +other files. The m4 code in 'kpse-pkgs.m4' uses the existence of +'configure' to determine whether to descend into (and configure) a given subdirectory. - Then, run the TL tool ‘reautoconf’ in the top-level TL -‘Build/source/’ directory, to incorporate the new program into the build -tree. It is good to then rebuild the whole tree (e.g., using TL’s -‘Build/Build’ script) to get all the necessary files generated. + Then, run the TL tool 'reautoconf' in the top-level TL +'Build/source/' directory, to incorporate the new program into the build +tree. It is good to then rebuild the whole tree (e.g., using TL's +'Build/Build' script) to get all the necessary files generated. It will probably fail. So then you need to keep at it until the program compiles and tests successfully. The most efficient way is to -rerun ‘autoreconf’ as needed in the new source directory -(‘Build/source/.../newprog’), then ‘make’ in the corresponding build -directory (‘Build/work/.../newprog’), then ‘make check’, etc. In the +rerun 'autoreconf' as needed in the new source directory +('Build/source/.../newprog'), then 'make' in the corresponding build +directory ('Build/work/.../newprog'), then 'make check', etc. In the end, also make sure that the whole tree builds from scratch. - After final success, don’t forget to commit. (Or email the TL + After final success, don't forget to commit. (Or email the TL maintainers with the patch.) @@ -1455,32 +1455,32 @@ File: tlbuild.info, Node: Adding a new engine, Next: Adding a new generic libr ------------------------- Adding a new TeX engine is not completely different from adding a -program, but it’s not all that similar, either. In this case, the main -work is done by creating a new subdirectory of ‘texk/web2c/’ for the -engine. The subdirectory is conventionally named ending in ‘dir’, like -‘pdftexdir’ and ‘xetexdir’, to avoid clashes with executable names. +program, but it's not all that similar, either. In this case, the main +work is done by creating a new subdirectory of 'texk/web2c/' for the +engine. The subdirectory is conventionally named ending in 'dir', like +'pdftexdir' and 'xetexdir', to avoid clashes with executable names. The source files for the new engine should be put in this -‘NEWENGINEdir’ subdirectory. Also, a file -‘NEWENGINEdir/am/NEWENGINE.am’ (e.g., ‘pdftexdir/am/pdftex.am’ is needed +'NEWENGINEdir' subdirectory. Also, a file +'NEWENGINEdir/am/NEWENGINE.am' (e.g., 'pdftexdir/am/pdftex.am' is needed with the Makefile fragment needed to build it. - The overall ‘web2c/Makefile.am’ needs to have an ‘include’ statement -added to insert that ‘NEWENGINE.am’ file. + The overall 'web2c/Makefile.am' needs to have an 'include' statement +added to insert that 'NEWENGINE.am' file. - In ‘web2c/ac/web2c.ac’, a line needs to be added in the definition of -the ‘kpse_tex_progs’ variable to include it in the build. That line + In 'web2c/ac/web2c.ac', a line needs to be added in the definition of +the 'kpse_tex_progs' variable to include it in the build. That line specifies whether the new engine is built by default, and the additional libraries requires. For examples of building engines in CWEB, you can check the existing -‘hitexdir’ and ‘mplibdir’ directories; these are somewhat simpler than +'hitexdir' and 'mplibdir' directories; these are somewhat simpler than LuaTeX. Of course, every engine will have its own unique features and requirements, so existing examples will only take you so far. - Web2c is built as one “package”, with each subdirectory’s ‘.am’ -fragment inserted with an Automake ‘include’. This means that, for -instance, ‘$(srcdir)’ is ‘.../web2c’, not ‘.../webdir/enginedir’. It is + Web2c is built as one "package", with each subdirectory's '.am' +fragment inserted with an Automake 'include'. This means that, for +instance, '$(srcdir)' is '.../web2c', not '.../webdir/enginedir'. It is a difficult setup to come to terms with, but the alternative is to recurse into each engine subdirectory, and that would be far worse (*note (automake)Directories::). @@ -1491,41 +1491,41 @@ File: tlbuild.info, Node: Adding a new generic library module, Next: Adding a 6.6.3 Adding a new generic library module ----------------------------------------- -A generic library module in a subdirectory ‘libs/LIB’ must not depend on +A generic library module in a subdirectory 'libs/LIB' must not depend on TeX-specific libraries, by definition. It is included by adding its -name ‘LIB’ to the M4 macro ‘kpse_libs_pkgs’ in ‘m4/kpse-pkgs.m4’—before +name 'LIB' to the M4 macro 'kpse_libs_pkgs' in 'm4/kpse-pkgs.m4'--before any other libraries from the TeX Live tree on which it depends. - As with program modules, the subdirectory ‘libs/LIB’ must contain the + As with program modules, the subdirectory 'libs/LIB' must contain the sources and build system for the library (and any installable support -programs) and a fragment ‘ac/withenable.ac’ that contains the M4 macro -‘KPSE_WITH_LIB’ defined in ‘m4/kpse-setup.m4’ with ‘LIB’ as the +programs) and a fragment 'ac/withenable.ac' that contains the M4 macro +'KPSE_WITH_LIB' defined in 'm4/kpse-setup.m4' with 'LIB' as the mandatory first argument and two optional arguments: a list of required libraries from the TL tree, and a list of options: for libraries, -currently there is only one—specify ‘tree’ if this library cannot be +currently there is only one--specify 'tree' if this library cannot be replaced by a system version. - If a system version can be used, a second fragment ‘ac/LIB.ac’ is -needed, containing the M4 macro ‘KPSE_TRY_LIB’ (or ‘KPSE_TRY_LIBXX’) -with ‘LIB’ as the mandatory first argument and two additional arguments -for the Autoconf macro ‘AC_LANG_PROGRAM’ used to compile and link a + If a system version can be used, a second fragment 'ac/LIB.ac' is +needed, containing the M4 macro 'KPSE_TRY_LIB' (or 'KPSE_TRY_LIBXX') +with 'LIB' as the mandatory first argument and two additional arguments +for the Autoconf macro 'AC_LANG_PROGRAM' used to compile and link a small C (or C++) program as sanity check for using the system library. - In addition a file ‘m4/kpse-LIB-flags’ (at the top level) must define -the M4 macro ‘KPSE_LIB_FLAGS’ (all uppercase) setting up the ‘make’ -variables ‘LIB_INCLUDES’, ‘LIB_LIBS’, ‘LIB_DEPEND’, and ‘LIB_RULE’ with -the values required for ‘CPPFLAGS’, ‘LDADD’, dependencies, and a -(multi-line) ‘make’ rule to rebuild the library when necessary. All of + In addition a file 'm4/kpse-LIB-flags' (at the top level) must define +the M4 macro 'KPSE_LIB_FLAGS' (all uppercase) setting up the 'make' +variables 'LIB_INCLUDES', 'LIB_LIBS', 'LIB_DEPEND', and 'LIB_RULE' with +the values required for 'CPPFLAGS', 'LDADD', dependencies, and a +(multi-line) 'make' rule to rebuild the library when necessary. All of that is needed for the library from the TL tree and, if supported, for a system version. - If a system library is allowed, ‘KPSE_LIB_FLAGS’ also provides the -configure option ‘--with-system-LIB’ and uses the additional M4 macro -‘KPSE_LIB_SYSTEM_FLAGS’ to generate the ‘make’ variables for a system + If a system library is allowed, 'KPSE_LIB_FLAGS' also provides the +configure option '--with-system-LIB' and uses the additional M4 macro +'KPSE_LIB_SYSTEM_FLAGS' to generate the 'make' variables for a system library. In addition, the definition of the M4 macro -‘KPSE_ALL_SYSTEM_FLAGS’ in ‘m4/kpse-pkgs.m4’ must be extended by the +'KPSE_ALL_SYSTEM_FLAGS' in 'm4/kpse-pkgs.m4' must be extended by the line: - ‘AC_REQUIRE([KPSE_LIB_SYSTEM_FLAGS])’ + 'AC_REQUIRE([KPSE_LIB_SYSTEM_FLAGS])' File: tlbuild.info, Node: Adding a new TeX-specific library module, Prev: Adding a new generic library module, Up: Extending TeX Live @@ -1533,15 +1533,15 @@ File: tlbuild.info, Node: Adding a new TeX-specific library module, Prev: Addi 6.6.4 Adding a new TeX-specific library module ---------------------------------------------- -A TeX-specific library module in a subdirectory ‘texk/LIB’ may depend on +A TeX-specific library module in a subdirectory 'texk/LIB' may depend on other TeX-specific libraries but must not depend on any generic library from the TL tree. It is included in the same general ways as a generic library (see the previous section), with these modifications: - • The library name ‘LIB’ is added to the M4 macro - ‘kpse_texlibs_pkgs’, which is also in ‘m4/kpse-pkgs.m4’. + * The library name 'LIB' is added to the M4 macro + 'kpse_texlibs_pkgs', which is also in 'm4/kpse-pkgs.m4'. - • The fragment ‘ac/withenable.ac’ must use ‘KPSE_WITH_TEXLIB’. + * The fragment 'ac/withenable.ac' must use 'KPSE_WITH_TEXLIB'. File: tlbuild.info, Node: Configure options, Next: Coding conventions, Prev: Layout and infrastructure, Up: Top @@ -1550,23 +1550,23 @@ File: tlbuild.info, Node: Configure options, Next: Coding conventions, Prev: ******************* Corresponding to the large number of program and library modules there -are a large number ‘configure’ options, most of which are described +are a large number 'configure' options, most of which are described here. The command - ‘configure --help’ + 'configure --help' at the top level gives an exhaustive list of all global options and a few important module-specific ones, whereas, e.g., - ‘texk/lcdf-typetools/configure --help’ -also displays the ‘lcdf-typetools’ specific options, which are not shown + 'texk/lcdf-typetools/configure --help' +also displays the 'lcdf-typetools' specific options, which are not shown at the top level. The help text also mentions several influential environment variables, but for TeX Live it is better to specify them as assignments on the command line. - The ‘./Build’ script used to make the binaries shipped with TeX Live -invokes the top-level ‘configure’ with a few additional options (*note + The './Build' script used to make the binaries shipped with TeX Live +invokes the top-level 'configure' with a few additional options (*note Building::). The defaults discussed below are those for the actual -‘configure’ script; invoking ‘configure’ via ‘./Build’ yields different +'configure' script; invoking 'configure' via './Build' yields different results. Defaults for most options are set at the top level and propagated @@ -1606,55 +1606,55 @@ Here are the global configure options. File: tlbuild.info, Node: --disable-native-texlive-build, Next: --prefix --bindir ..., Up: Global configure options -7.1.1 ‘--disable-native-texlive-build’ +7.1.1 '--disable-native-texlive-build' -------------------------------------- If enabled (the default), build for a TL binary distribution as shipped -by the TeX user groups. This requires GNU ‘make’ and implies -‘--enable-multiplatform’ and ‘--enable-cxx-runtime-hack’ (unless they -are explicitly disabled), and enforces ‘--disable-shared’. +by the TeX user groups. This requires GNU 'make' and implies +'--enable-multiplatform' and '--enable-cxx-runtime-hack' (unless they +are explicitly disabled), and enforces '--disable-shared'. If building TL for a GNU/Linux or other distribution, this should be disabled and system versions of most libraries should be used (*note Distro builds::). - A related option, ‘--enable-texlive-build’, is automatically passed + A related option, '--enable-texlive-build', is automatically passed to all subdirectories (and cannot be disabled). Subdirectories that can -also be built independently from the TL tree (such as ‘utils/xindy’ and -‘texk/dvipng’) but cooperate with TL can use this option to enable +also be built independently from the TL tree (such as 'utils/xindy' and +'texk/dvipng') but cooperate with TL can use this option to enable TL-specific adaptations, such as installation paths. File: tlbuild.info, Node: --prefix --bindir ..., Next: --disable-largefile, Prev: --disable-native-texlive-build, Up: Global configure options -7.1.2 ‘--prefix’, ‘--bindir’, ... +7.1.2 '--prefix', '--bindir', ... --------------------------------- These standard Autoconf options specify various installation directories as usual. For the complete list, *note Installation directories::. - Also as usual, all values are prefixed by the value of ‘DESTDIR’, if -set, on the ‘make’ command line (*note Installation in a temporary + Also as usual, all values are prefixed by the value of 'DESTDIR', if +set, on the 'make' command line (*note Installation in a temporary location: (automake)Staged Installs.). File: tlbuild.info, Node: --disable-largefile, Next: --disable-missing, Prev: --prefix --bindir ..., Up: Global configure options -7.1.3 ‘--disable-largefile’ +7.1.3 '--disable-largefile' --------------------------- Omit large file support (LFS), which is needed on most 32-bit Unix systems for files with 2GB or more. Regardless of this option, the size -of ‘DVI’ and ‘GF’ files must always be <2GB, due to the file format +of 'DVI' and 'GF' files must always be <2GB, due to the file format specifications. With LFS, there is no fixed limit on the size of PDF files created by -‘pdftex’ or PostScript files created by ‘dvips’. +'pdftex' or PostScript files created by 'dvips'. File: tlbuild.info, Node: --disable-missing, Next: --enable-compiler-warnings=LEVEL, Prev: --disable-largefile, Up: Global configure options -7.1.4 ‘--disable-missing’ +7.1.4 '--disable-missing' ------------------------- Immediately terminate the build process if a requested program or @@ -1664,86 +1664,86 @@ when figuring out a specific (sub)set of modules to enable. File: tlbuild.info, Node: --enable-compiler-warnings=LEVEL, Next: --enable-cxx-runtime-hack, Prev: --disable-missing, Up: Global configure options -7.1.5 ‘--enable-compiler-warnings=’LEVEL +7.1.5 '--enable-compiler-warnings='LEVEL ---------------------------------------- Enable various levels of compiler warnings for C, C++, and/or -Objective C: the LEVEL value can be one of: ‘no min yes max all’. The -default is ‘yes’ in ‘maintainer-mode’ (see below) and ‘min’ otherwise. -This option defines the variables ‘WARNING_[OBJ]C[XX]FLAGS’, but these +Objective C: the LEVEL value can be one of: 'no min yes max all'. The +default is 'yes' in 'maintainer-mode' (see below) and 'min' otherwise. +This option defines the variables 'WARNING_[OBJ]C[XX]FLAGS', but these variables are not consistently used in all library and program modules. At present, these warning flags assume options from the GNU compilers. File: tlbuild.info, Node: --enable-cxx-runtime-hack, Next: --enable-maintainer-mode, Prev: --enable-compiler-warnings=LEVEL, Up: Global configure options -7.1.6 ‘--enable-cxx-runtime-hack’ +7.1.6 '--enable-cxx-runtime-hack' --------------------------------- -If enabled (as it is for the native TL build), when using ‘g++’, try to -statically link with ‘libstdc++’, thus improving portability of the +If enabled (as it is for the native TL build), when using 'g++', try to +statically link with 'libstdc++', thus improving portability of the resulting binary. *Note Macros for compilers::. File: tlbuild.info, Node: --enable-maintainer-mode, Next: --enable-multiplatform, Prev: --enable-cxx-runtime-hack, Up: Global configure options -7.1.7 ‘--enable-maintainer-mode’ +7.1.7 '--enable-maintainer-mode' -------------------------------- -Enable ‘make’ rules and dependencies not useful (and sometimes +Enable 'make' rules and dependencies not useful (and sometimes confusing) to the casual user. This requires current versions of the GNU build tools (*note Build system tools::), as it automatically -rebuilds infrastructure files as needed. *Note ‘missing’ and -‘AM_MAINTAINER_MODE’: (automake)maintainer-mode. +rebuilds infrastructure files as needed. *Note 'missing' and +'AM_MAINTAINER_MODE': (automake)maintainer-mode. File: tlbuild.info, Node: --enable-multiplatform, Next: --enable-shared, Prev: --enable-maintainer-mode, Up: Global configure options -7.1.8 ‘--enable-multiplatform’ +7.1.8 '--enable-multiplatform' ------------------------------ -If enabled (as it is for the native TL build) and ‘--bindir=DIR’ or -‘--libdir=DIR’ are not specified, install executables and libraries in -per-platform subdirectories of ‘EPREFIX/bin’ and ‘EPREFIX/lib’ where -EPREFIX is the value given or implied for ‘exec_prefix’. In any case, -the values for ‘bindir’ and ‘libdir’ are automatically propagated to all +If enabled (as it is for the native TL build) and '--bindir=DIR' or +'--libdir=DIR' are not specified, install executables and libraries in +per-platform subdirectories of 'EPREFIX/bin' and 'EPREFIX/lib' where +EPREFIX is the value given or implied for 'exec_prefix'. In any case, +the values for 'bindir' and 'libdir' are automatically propagated to all subdirectories. File: tlbuild.info, Node: --enable-shared, Next: --enable-silent-rules, Prev: --enable-multiplatform, Up: Global configure options -7.1.9 ‘--enable-shared’ +7.1.9 '--enable-shared' ----------------------- Build shared versions of the TeX-specific libraries such as -‘libkpathsea’. This is not allowed for a native TL build (i.e., -‘--disable-native-texlive-build’ must also be specified). +'libkpathsea'. This is not allowed for a native TL build (i.e., +'--disable-native-texlive-build' must also be specified). File: tlbuild.info, Node: --enable-silent-rules, Next: --without-ln-s, Prev: --enable-shared, Up: Global configure options -7.1.10 ‘--enable-silent-rules’ +7.1.10 '--enable-silent-rules' ------------------------------ -Enable the use of less verbose build rules. When using GNU ‘make’ (or -any ‘make’ implementation supporting nested variable expansions), you -can specify ‘V=1’ on the ‘make’ command line to get more verbosity, or -‘V=0’ to get less, regardless of this option. +Enable the use of less verbose build rules. When using GNU 'make' (or +any 'make' implementation supporting nested variable expansions), you +can specify 'V=1' on the 'make' command line to get more verbosity, or +'V=0' to get less, regardless of this option. File: tlbuild.info, Node: --without-ln-s, Next: --without-x, Prev: --enable-silent-rules, Up: Global configure options -7.1.11 ‘--without-ln-s’ +7.1.11 '--without-ln-s' ----------------------- -Required when using a system without a working ‘ln -s’ to build binaries -for a Unix-like system. However, ‘make install’ will not create +Required when using a system without a working 'ln -s' to build binaries +for a Unix-like system. However, 'make install' will not create anything useful, and might fail. File: tlbuild.info, Node: --without-x, Prev: --without-ln-s, Up: Global configure options -7.1.12 ‘--without-x’ +7.1.12 '--without-x' -------------------- Disable all programs using the X Window System. @@ -1754,7 +1754,7 @@ File: tlbuild.info, Node: Program-specific configure options, Next: Library-sp 7.2 Program-specific configure options ====================================== -Here are (some of) the program-specific ‘configure’ options. +Here are (some of) the program-specific 'configure' options. * Menu: @@ -1771,197 +1771,197 @@ Here are (some of) the program-specific ‘configure’ options. File: tlbuild.info, Node: --enable-PROG --disable-PROG, Next: --disable-all-pkgs, Up: Program-specific configure options -7.2.1 ‘--enable-PROG’, ‘--disable-PROG’ +7.2.1 '--enable-PROG', '--disable-PROG' --------------------------------------- -Do or do not build and install the program(s) of module ‘PROG’. +Do or do not build and install the program(s) of module 'PROG'. File: tlbuild.info, Node: --disable-all-pkgs, Next: Configure options for texk/web2c, Prev: --enable-PROG --disable-PROG, Up: Program-specific configure options -7.2.2 ‘--disable-all-pkgs’ +7.2.2 '--disable-all-pkgs' -------------------------- -Do not build any program modules by default—only those explicitly +Do not build any program modules by default--only those explicitly enabled. This is useful when one wants to work on only a single -program, which is specified with an additional ‘--enable’ option, e.g., -‘--enable-dvipdfm-x’. It’s still simplest to check out and configure +program, which is specified with an additional '--enable' option, e.g., +'--enable-dvipdfm-x'. It's still simplest to check out and configure the whole source tree, but at least only the program you are interested in, and its dependencies, are built. *Note Build one package::. Without this option, all modules are built except those that are -explicitly disabled or specify ‘disable’ in their ‘ac/withenable.ac’ +explicitly disabled or specify 'disable' in their 'ac/withenable.ac' fragment. File: tlbuild.info, Node: Configure options for texk/web2c, Next: Configure options for texk/bibtex-x, Prev: --disable-all-pkgs, Up: Program-specific configure options -7.2.3 Configure options for ‘texk/web2c’ +7.2.3 Configure options for 'texk/web2c' ---------------------------------------- -‘--with-banner-add=STR’ -Add ‘STR’ to the default version string (which is ‘‘TeX Live YEAR’’ or -‘‘Web2C YEAR’’) appended to banner lines. This is ignored for a native -TL build, but distro builds should specify, e.g., ‘/SOMEDISTRO’. +'--with-banner-add=STR' +Add 'STR' to the default version string (which is ''TeX Live YEAR'' or +''Web2C YEAR'') appended to banner lines. This is ignored for a native +TL build, but distro builds should specify, e.g., '/SOMEDISTRO'. -‘--with-editor=CMD’ -Specify the command ‘CMD’ to invoke from the ‘e’ option of TeX and -friends, replacing the default ‘vi +%d '%s'’ for Unix or ‘texworks ---position=%d "%s"’ for Windows. +'--with-editor=CMD' +Specify the command 'CMD' to invoke from the 'e' option of TeX and +friends, replacing the default 'vi +%d '%s'' for Unix or 'texworks +--position=%d "%s"' for Windows. -‘--with-fontconfig-includes=DIR’, ‘--with-fontconfig-libdir=DIR’ -Building XeTeX on non-Mac systems requires the ‘fontconfig’ library +'--with-fontconfig-includes=DIR', '--with-fontconfig-libdir=DIR' +Building XeTeX on non-Mac systems requires the 'fontconfig' library headers and code. If one or both of these options are given, the required flags are derived from them; otherwise, they are determined via -‘pkg-config’ (if present). +'pkg-config' (if present). -‘--with-mf-x-toolkit’ -Use the X toolkit (‘libXt’) for Metafont (the default is to use the -lowest-level ‘Xlib’ support; it seems this has the best chance of +'--with-mf-x-toolkit' +Use the X toolkit ('libXt') for Metafont (the default is to use the +lowest-level 'Xlib' support; it seems this has the best chance of working across X installations nowadays). -‘--disable-dump-share’ -Make the ‘fmt’/‘base’ dump files architecture dependent (somewhat faster +'--disable-dump-share' +Make the 'fmt'/'base' dump files architecture dependent (somewhat faster on LittleEndian architectures). -‘--disable-ipc’ -Disable TeX’s ‘--ipc’ option. +'--disable-ipc' +Disable TeX's '--ipc' option. -‘--disable-mf-nowin’ -Do not build a separate non-graphically-capable Metafont (‘mf-nowin’). +'--disable-mf-nowin' +Do not build a separate non-graphically-capable Metafont ('mf-nowin'). -‘--disable-tex’, ‘--enable-etex’, ... +'--disable-tex', '--enable-etex', ... Do not or do build the various TeX, Metafont, and MetaPost engines -(defaults are defined in the fragment ‘texk/web2c/ac/web2c.ac’). +(defaults are defined in the fragment 'texk/web2c/ac/web2c.ac'). -‘--disable-web-progs’ -Do not build the original WEB programs ‘bibtex’, ..., ‘weave’. Useful +'--disable-web-progs' +Do not build the original WEB programs 'bibtex', ..., 'weave'. Useful if, e.g., you only want to (re)build some engines. -‘--enable-auto-core’ +'--enable-auto-core' This option causes TeX and Metafont to produce a core dump when a particular hacky filename is encountered, for use in creating preloaded binaries. This is rarely done nowadays. -‘--enable-libtool-hack’ -If enabled (which is the default for all platforms), prevents ‘libtool’ -from linking explicitly with dependencies of ‘libfontconfig’ such as -‘libexpat’. +'--enable-libtool-hack' +If enabled (which is the default for all platforms), prevents 'libtool' +from linking explicitly with dependencies of 'libfontconfig' such as +'libexpat'. -‘--enable-*win’ +'--enable-*win' Include various types of non-X window support for Metafont (EPSF output, -‘mftalk’, old graphics terminals, ...). +'mftalk', old graphics terminals, ...). -‘--enable-tex-synctex’, ‘--disable-etex-synctex’, ... -Build the TeX engines with or without ‘SyncTeX’ support; ignored for a +'--enable-tex-synctex', '--disable-etex-synctex', ... +Build the TeX engines with or without 'SyncTeX' support; ignored for a native TeX Live build. Defaults are defined in -‘texk/web2c/ac/web2c.ac’. +'texk/web2c/ac/web2c.ac'. -‘--disable-synctex’ -Do not build the ‘SyncTeX’ library and tool. +'--disable-synctex' +Do not build the 'SyncTeX' library and tool. File: tlbuild.info, Node: Configure options for texk/bibtex-x, Next: Configure options for texk/dvipdfm-x, Prev: Configure options for texk/web2c, Up: Program-specific configure options -7.2.4 Configure options for ‘texk/bibtex-x’ +7.2.4 Configure options for 'texk/bibtex-x' ------------------------------------------- -The programs ‘bibtex8’ and ‘bibtexu’ have been merged into the module -‘bibtex-x’ (extended BibTeX). +The programs 'bibtex8' and 'bibtexu' have been merged into the module +'bibtex-x' (extended BibTeX). -‘--disable-bibtex8’ -Do not build the ‘bibtex8’ program. +'--disable-bibtex8' +Do not build the 'bibtex8' program. -‘--disable-bibtexu’ -Do not build the ‘bibtexu’ program (building ‘bibtexu’ requires ‘ICU’ +'--disable-bibtexu' +Do not build the 'bibtexu' program (building 'bibtexu' requires 'ICU' libraries). File: tlbuild.info, Node: Configure options for texk/dvipdfm-x, Next: Configure options for texk/dvisvgm, Prev: Configure options for texk/bibtex-x, Up: Program-specific configure options -7.2.5 Configure options for ‘texk/dvipdfm-x’ +7.2.5 Configure options for 'texk/dvipdfm-x' -------------------------------------------- -The former modules ‘dvipdfmx’ (extended DVI to PDF converter) and -‘xdvipdfmx’ (the same, as used by XeTeX) have been merged into -‘dvipdfm-x’ at the source level. Two separate binaries are still -created by default. In addition, ‘dvipdfm’ is created as a symlink to -‘dvipdfmx’, with backward-compatible (very slightly different) behavior. +The former modules 'dvipdfmx' (extended DVI to PDF converter) and +'xdvipdfmx' (the same, as used by XeTeX) have been merged into +'dvipdfm-x' at the source level. Two separate binaries are still +created by default. In addition, 'dvipdfm' is created as a symlink to +'dvipdfmx', with backward-compatible (very slightly different) behavior. -‘--disable-dvipdfmx’ -Do not build the ‘dvipdfmx’ program or make the ‘dvipdfm’ symlink. +'--disable-dvipdfmx' +Do not build the 'dvipdfmx' program or make the 'dvipdfm' symlink. -‘--disable-xdvipdfmx’ -Do not build the ‘xdvipdfmx’ program. +'--disable-xdvipdfmx' +Do not build the 'xdvipdfmx' program. File: tlbuild.info, Node: Configure options for texk/dvisvgm, Next: Configure options for texk/texlive, Prev: Configure options for texk/dvipdfm-x, Up: Program-specific configure options -7.2.6 Configure options for ‘texk/dvisvgm’ +7.2.6 Configure options for 'texk/dvisvgm' ------------------------------------------ -‘--with-system-libgs’ -Build ‘dvisvgm’ using installed Ghostscript (‘gs’) headers and library -(not allowed for a native TL build). The default is to load the ‘gs’ +'--with-system-libgs' +Build 'dvisvgm' using installed Ghostscript ('gs') headers and library +(not allowed for a native TL build). The default is to load the 'gs' library at runtime if possible, else to disable support for PostScript specials. -‘--without-libgs’ -Build ‘dvisvgm’ without PostScript support at all. Because the dynamic +'--without-libgs' +Build 'dvisvgm' without PostScript support at all. Because the dynamic loading just mentioned defeats all attempts at static linking, the result can crash due to library incompatibilities, e.g., on CentOS 5. -‘--with-libgs-includes=DIR’, ‘--with-libgs-libdir=DIR’ +'--with-libgs-includes=DIR', '--with-libgs-libdir=DIR' Specify non-standard locations of the Ghostscript headers and library. File: tlbuild.info, Node: Configure options for texk/texlive, Next: Configure options for texk/xdvik, Prev: Configure options for texk/dvisvgm, Up: Program-specific configure options -7.2.7 Configure options for ‘texk/texlive’ +7.2.7 Configure options for 'texk/texlive' ------------------------------------------ -‘--disable-linked-scripts’ -Do not install the “linked scripts” (*note Linked scripts::), except for -the TL scripts required to run ‘texlinks’. +'--disable-linked-scripts' +Do not install the "linked scripts" (*note Linked scripts::), except for +the TL scripts required to run 'texlinks'. File: tlbuild.info, Node: Configure options for texk/xdvik, Next: Configure options for utils/xindy, Prev: Configure options for texk/texlive, Up: Program-specific configure options -7.2.8 Configure options for ‘texk/xdvik’ +7.2.8 Configure options for 'texk/xdvik' ---------------------------------------- -‘--with-gs=FILENAME’ -Hardwire the location of Ghostscript (‘gs’) as called by Xdvik. +'--with-gs=FILENAME' +Hardwire the location of Ghostscript ('gs') as called by Xdvik. -‘--with-xdvi-x-toolkit=KIT’ -Use toolkit ‘KIT’ for ‘xdvik’, one of: ‘motif xaw xaw3d neXtaw’. The -default is ‘motif’ if available, else ‘xaw’. +'--with-xdvi-x-toolkit=KIT' +Use toolkit 'KIT' for 'xdvik', one of: 'motif xaw xaw3d neXtaw'. The +default is 'motif' if available, else 'xaw'. -‘--enable-xi2-scrolling’ -Use XInput 2.1 “smooth scrolling” if available (default: yes, except for +'--enable-xi2-scrolling' +Use XInput 2.1 "smooth scrolling" if available (default: yes, except for a native TL build). File: tlbuild.info, Node: Configure options for utils/xindy, Prev: Configure options for texk/xdvik, Up: Program-specific configure options -7.2.9 Configure options for ‘utils/xindy’ +7.2.9 Configure options for 'utils/xindy' ----------------------------------------- -‘--enable-xindy-rules’ -Build and install ‘xindy’ rules (default: yes, except for a native TL +'--enable-xindy-rules' +Build and install 'xindy' rules (default: yes, except for a native TL build). -‘--enable-xindy-docs’ -Build and install ‘xindy’ documentation (default: yes, except for a +'--enable-xindy-docs' +Build and install 'xindy' documentation (default: yes, except for a native TL build). -‘--with-clisp-runtime=FILENAME’ -Specifies the full path for the Clisp runtime file (‘lisp.run’ or -‘lisp.exe’) to be installed. When specified as ‘default’ (the default +'--with-clisp-runtime=FILENAME' +Specifies the full path for the Clisp runtime file ('lisp.run' or +'lisp.exe') to be installed. When specified as 'default' (the default for a native TL build) the path is determined by the Clisp executable; -the value ‘system’ (not allowed for a native TL build, but the default -otherwise) indicates that ‘xindy’ will use the installed version of -‘clisp’ (which must be identical to the one used to build ‘xindy’). +the value 'system' (not allowed for a native TL build, but the default +otherwise) indicates that 'xindy' will use the installed version of +'clisp' (which must be identical to the one used to build 'xindy'). File: tlbuild.info, Node: Library-specific configure options, Next: Variables for configure, Prev: Program-specific configure options, Up: Configure options @@ -1969,21 +1969,21 @@ File: tlbuild.info, Node: Library-specific configure options, Next: Variables 7.3 Library-specific configure options ====================================== -Here are (some of) the library-specific ‘configure’ options, starting +Here are (some of) the library-specific 'configure' options, starting with this generic one: -‘--with-system-LIB’ +'--with-system-LIB' - Use an installed (system) version of the library ‘LIB’; this option + Use an installed (system) version of the library 'LIB'; this option exists for most libraries, but is not allowed for a native TL build. Using a system version implies also using the system versions of all libraries that LIB depends on. - For many libraries ‘--with-LIB-includes=DIR’ and -‘--with-LIB-libdir=DIR’ can specify non-standard search locations; -others use ‘pkg-config’ or similar to determine the required flags. + For many libraries '--with-LIB-includes=DIR' and +'--with-LIB-libdir=DIR' can specify non-standard search locations; +others use 'pkg-config' or similar to determine the required flags. - The top-level ‘configure’ script performs a consistency check for all + The top-level 'configure' script performs a consistency check for all required system libraries and bails out if tests fail. * Menu: @@ -1993,25 +1993,25 @@ required system libraries and bails out if tests fail. File: tlbuild.info, Node: Configure options for kpathsea, Up: Library-specific configure options -7.3.1 Configure options for ‘kpathsea’ +7.3.1 Configure options for 'kpathsea' -------------------------------------- -‘--enable-CMD-default’, ‘--disable-CMD-default’ +'--enable-CMD-default', '--disable-CMD-default' Determine the compile time default for whether or not to run CMD, which is one of: -‘mkocp’ +'mkocp' (Omega compiled translation process file) -‘mkofm’ +'mkofm' (Omega font metrics file) -‘mktexfmt’ +'mktexfmt' (format/base dump file) -‘mktexmf’ +'mktexmf' (Metafont source) -‘mktexpk’ +'mktexpk' (PK bitmap font) -‘mktextex’ +'mktextex' (TeX source) -‘mktextfm’ +'mktextfm' (TFM file) to generate the specified type of file dynamically. The default can be @@ -2023,44 +2023,44 @@ File: tlbuild.info, Node: Variables for configure, Prev: Library-specific conf 7.4 Variables for configure =========================== -The values for these variables can be specified as ‘configure’ arguments -of the form ‘VAR=VALUE’. They can also be defined in the environment, +The values for these variables can be specified as 'configure' arguments +of the form 'VAR=VALUE'. They can also be defined in the environment, but that might not work for cross compilations. -‘CC’ -‘CXX’ -‘CPPFLAGS’ +'CC' +'CXX' +'CPPFLAGS' And plenty more. As usual with Autoconf, these variables specify the name (or full path) of compilers, preprocessor flags, and similar. *Note (autoconf)Preset Output Variables::. -‘CLISP’ - Name (or full path) of the ‘clisp’ executable, used to build - ‘xindy’. +'CLISP' + Name (or full path) of the 'clisp' executable, used to build + 'xindy'. -‘FT2_CONFIG’ -‘ICU_CONFIG’ -‘PKG_CONFIG’ - These specify the name (or path) for the ‘freetype-config’, - ‘icu-config’, and ‘pkg-config’ commands used to determine the flags - required for system versions of ‘libfreetype’, the ICU libraries, +'FT2_CONFIG' +'ICU_CONFIG' +'PKG_CONFIG' + These specify the name (or path) for the 'freetype-config', + 'icu-config', and 'pkg-config' commands used to determine the flags + required for system versions of 'libfreetype', the ICU libraries, and other libraries, respectively. -‘KPSEWHICH’ - Name (or path) of an installed ‘kpsewhich’ binary, used by ‘make - check’ to determine the location of, e.g., ‘cmbx10.tfm’. +'KPSEWHICH' + Name (or path) of an installed 'kpsewhich' binary, used by 'make + check' to determine the location of, e.g., 'cmbx10.tfm'. -‘MAKE’ -‘SED’ - And more. Name (or path) of the ‘make’, ‘sed’, and similar +'MAKE' +'SED' + And more. Name (or path) of the 'make', 'sed', and similar programs; used at the top level and propagated to all subdirectories. -‘PERL’ -‘LATEX’ -‘PDFLATEX’ - Name (or full path) for the ‘perl’, ‘latex’, and ‘pdflatex’ - commands used, e.g., to build the ‘xindy’ documentation. +'PERL' +'LATEX' +'PDFLATEX' + Name (or full path) for the 'perl', 'latex', and 'pdflatex' + commands used, e.g., to build the 'xindy' documentation. File: tlbuild.info, Node: Coding conventions, Next: Continuous integration, Prev: Configure options, Up: Top @@ -2068,12 +2068,12 @@ File: tlbuild.info, Node: Coding conventions, Next: Continuous integration, P 8 Coding conventions ******************** -Ideally, building all of TeX Live with ‘--enable-compiler-warnings=max’ +Ideally, building all of TeX Live with '--enable-compiler-warnings=max' should produce no (GCC) compiler warnings at all. In spite of considerable efforts into that direction we are still far from that goal and there are reasons that we may never fully reach it. Below are some rules about declarations of functions or variables and the use of -‘const’. These rules should be applied to the code maintained in the +'const'. These rules should be applied to the code maintained in the TeX Live tree and for other packages whose maintainers are willing to accept patches. @@ -2093,7 +2093,7 @@ C standards The TeX Live build system no longer supports pre-ANSI C compilers. Thus all function prototypes and definitions must conform to the ANSI C -standard (including ‘void’ in the declaration of C functions with no +standard (including 'void' in the declaration of C functions with no parameters). On the other hand, TL is built for a wide variety of systems, not all of which support the C99 standard. Therefore using C99 features should be avoided if that can easily be done. In particular, C @@ -2102,10 +2102,10 @@ comments. If some C99 (or later) constructs must be used, the module should verify that they are available and otherwise provide an alternative. -For example, the module ‘texk/chktex’ uses the C99 function ‘stpcpy()’ +For example, the module 'texk/chktex' uses the C99 function 'stpcpy()' that may or may not be available on a particular system. It uses -‘AC_CHECK_DECLS([stpcpy])’ in ‘configure.ac’ to test this, and provides -a perhaps less efficient alternative (in the file ‘Utility.h’): +'AC_CHECK_DECLS([stpcpy])' in 'configure.ac' to test this, and provides +a perhaps less efficient alternative (in the file 'Utility.h'): #if !(defined HAVE_DECL_STPCPY && HAVE_DECL_STPCPY) static inline char *stpcpy(char *dest, const char *src) @@ -2117,17 +2117,17 @@ a perhaps less efficient alternative (in the file ‘Utility.h’): Static functions ................ -Functions used in only one file should be declared ‘static’; they +Functions used in only one file should be declared 'static'; they require no prototype except in forward declarations. Extern functions ................ -Functions not declared ‘static’, usually because they are used in -several files, require an (‘extern’) prototype in exactly one header +Functions not declared 'static', usually because they are used in +several files, require an ('extern') prototype in exactly one header file, which is included in the file defining the function and in all -files using that function—this is the only way to guarantee consistency -between definition and use. There should be no ‘extern’ declarations +files using that function--this is the only way to guarantee consistency +between definition and use. There should be no 'extern' declarations sprinkled throughout the C code (with or without comments as to where that function is defined). @@ -2135,7 +2135,7 @@ Variable declarations ..................... The declaration of global variables follows analogous rules: they are -either declared ‘static’ if used in only one file or declared ‘extern’ +either declared 'static' if used in only one file or declared 'extern' in exactly one header and instantiated in exactly one file. @@ -2144,39 +2144,39 @@ File: tlbuild.info, Node: Const, Prev: Declarations and definitions, Up: Codi 8.2 Const ========= -The ‘const’ feature of C is valuable, but easy to mis-use. +The 'const' feature of C is valuable, but easy to mis-use. Function parameters ................... Ideally, a function parameter not modified by the function should be -declared as ‘const’. This is important in particular for strings -(‘char*’) because the actual arguments are often string literals. It is -perfectly legitimate and safe to use a type ‘char*’ value for a type -‘const char*’ variable (in an assignment, as initializer, as function +declared as 'const'. This is important in particular for strings +('char*') because the actual arguments are often string literals. It is +perfectly legitimate and safe to use a type 'char*' value for a type +'const char*' variable (in an assignment, as initializer, as function argument, or as return value). It is equally safe to use a type -‘char**’ value for a type ‘const char*const*’ variable, but not for a -type ‘const char**’ variable since that might cause modification of a +'char**' value for a type 'const char*const*' variable, but not for a +type 'const char**' variable since that might cause modification of a quantity supposed to be constant. - Getting all ‘const’ qualifiers right can get quite involved but can + Getting all 'const' qualifiers right can get quite involved but can almost always be done. There are only a couple notable exceptions: the -X11 headers are full of declarations that ought to use ‘const’ but do -not; at one time, ‘libfreetype’ also did not fully specify ‘const’, but +X11 headers are full of declarations that ought to use 'const' but do +not; at one time, 'libfreetype' also did not fully specify 'const', but this has not been checked recently. -What must be avoided with ‘const’ +What must be avoided with 'const' ................................. -The GCC compiler warnings “assignment discards qualifiers...” and -analogous warnings for “initialization”, “passing arg”, or “return” must +The GCC compiler warnings "assignment discards qualifiers..." and +analogous warnings for "initialization", "passing arg", or "return" must be strenuously avoided in our own code. The only exception is when they are caused by X11 declarations or other third party code. -What should be avoided with ‘const’ +What should be avoided with 'const' ................................... -A type cast, e.g., from ‘const char*’ to ‘char*’ does not solve any +A type cast, e.g., from 'const char*' to 'char*' does not solve any problems; depending on warning options, it may only hide them. Therefore such casts should be avoided whenever possible and otherwise must be carefully analyzed to make sure that they cannot cause the @@ -2209,7 +2209,7 @@ File: tlbuild.info, Node: Transfer from Subversion to Github, Next: Automatic ====================================== The git-svn program (<https://git-scm.com/docs/git-svn>) is used to -check out the subtree ‘Build/source’ of the canonical Subversion +check out the subtree 'Build/source' of the canonical Subversion repository. The author index file used is not maintained in either Git or Subversion but can be provided on request. @@ -2217,36 +2217,36 @@ or Subversion but can be provided on request. git svn --authors-file usermap clone \ svn://USER@tug.org/texlive/trunk/Build/source -where the ‘usermap’ file maps Subversion user names to name and emails +where the 'usermap' file maps Subversion user names to name and emails of the authors. Anonymous checkout is also possible: git svn --authors-file usermap clone \ svn://tug.org/texlive/trunk/Build/source In the following, we will use _admin_ to refer to a user who has read/write access to the TeX Live subversion repository, and is also an -administrator of the ‘‘TeX-Live’’ team at Github. The above initial -checkout has been carried out by _admin_ on the server ‘texlive.info’. +administrator of the ''TeX-Live'' team at Github. The above initial +checkout has been carried out by _admin_ on the server 'texlive.info'. - On Github, a new git repository named ‘texlive-source’ was created by -_admin_ within the ‘TeX-Live’ “organization” + On Github, a new git repository named 'texlive-source' was created by +_admin_ within the 'TeX-Live' "organization" (<https://github.com/TeX-Live>). The remote was added to the checkout -with ‘git remote add origin git@github.com:TeX-Live/texlive-source.git’. +with 'git remote add origin git@github.com:TeX-Live/texlive-source.git'. To automate the update on Github, a new ssh key was generated and -added to the ‘texlive-source’ repository on Github as deployment key. -Thus, pushes using this key can only go to the ‘texlive-source’ +added to the 'texlive-source' repository on Github as deployment key. +Thus, pushes using this key can only go to the 'texlive-source' repository and not anywhere else. - The usage of ‘git-svn’ requires a strict discipline to keep a linear + The usage of 'git-svn' requires a strict discipline to keep a linear history in the master branch. Since we are aiming at a pure mirror -facility on Github, we have decided to further restrict the ‘master’ -branch of the ‘texlive-source’ repository on Github to changes by +facility on Github, we have decided to further restrict the 'master' +branch of the 'texlive-source' repository on Github to changes by _admin_. - This setup allows other developers to branch off ‘master’ and push + This setup allows other developers to branch off 'master' and push their branches to the Github repository, but all updates need to come -from the local ‘master’ (not the one on Github) to Subversion, back to -‘master’ on ‘texlive.info’, and from there to Github. +from the local 'master' (not the one on Github) to Subversion, back to +'master' on 'texlive.info', and from there to Github. File: tlbuild.info, Node: Automatic update of the Git mirror, Next: CI testing on Travis-CI, Prev: Transfer from Subversion to Github, Up: Continuous integration @@ -2254,10 +2254,10 @@ File: tlbuild.info, Node: Automatic update of the Git mirror, Next: CI testing 9.2 Automatic update of the Git mirror ====================================== -_admin_ has installed a cron job on ‘texlive.info’ running every 30 -minute which essentially runs ‘git svn rebase’ and ‘git push’ in the -‘master’ branch of the checkout. The first command fetches the changes -from the Subversion repository and updates the ‘master’ branch with +_admin_ has installed a cron job on 'texlive.info' running every 30 +minute which essentially runs 'git svn rebase' and 'git push' in the +'master' branch of the checkout. The first command fetches the changes +from the Subversion repository and updates the 'master' branch with them, and the second pushes changes (if any) to Github. @@ -2266,10 +2266,10 @@ File: tlbuild.info, Node: CI testing on Travis-CI, Next: Releases on Github, 9.3 CI testing on Travis-CI =========================== -The ‘source’ tree of TeX Live contains a top-level file ‘.travis.yml’ +The 'source' tree of TeX Live contains a top-level file '.travis.yml' which controls the automatic testing on Travis-CI. _admin_ has -registered with Travis-CI and allowed access to the Github’s ‘TeX-Live’ -organization’s ‘texlive-source’ repository. The default settings are to +registered with Travis-CI and allowed access to the Github's 'TeX-Live' +organization's 'texlive-source' repository. The default settings are to build the last commit of each push. No further action is necessary on Travis-CI. @@ -2282,7 +2282,7 @@ File: tlbuild.info, Node: Releases on Github, Prev: CI testing on Travis-CI, 9.4 Releases on Github ====================== -Given a git checkout of ‘texlive-source’: +Given a git checkout of 'texlive-source': git pull git tag build-svnNNNN @@ -2290,7 +2290,7 @@ Given a git checkout of ‘texlive-source’: and the result will appear at <https://github.com/TeX-Live/texlive-source/releases>. Releases can -also be made manually from that web page (see ‘tl-update-bindir’ for +also be made manually from that web page (see 'tl-update-bindir' for hints). @@ -2305,24 +2305,27 @@ Appendix A install-tl * install-tl SYNOPSIS:: * install-tl DESCRIPTION:: * install-tl REFERENCES:: +* install-tl EXAMPLES:: * install-tl OPTIONS:: * install-tl PROFILES:: * install-tl ENVIRONMENT VARIABLES:: +* install-tl DIRECTORY TREES:: +* install-tl BUGS:: * install-tl AUTHORS AND COPYRIGHT:: File: tlbuild.info, Node: install-tl NAME, Next: install-tl SYNOPSIS, Up: install-tl -A.1 NAME -======== +A.1 install-tl NAME +=================== install-tl - TeX Live cross-platform installer File: tlbuild.info, Node: install-tl SYNOPSIS, Next: install-tl DESCRIPTION, Prev: install-tl NAME, Up: install-tl -A.2 SYNOPSIS -============ +A.2 install-tl SYNOPSIS +======================= install-tl [_option_]... @@ -2331,8 +2334,8 @@ install-tl [_option_]... File: tlbuild.info, Node: install-tl DESCRIPTION, Next: install-tl REFERENCES, Prev: install-tl SYNOPSIS, Up: install-tl -A.3 DESCRIPTION -=============== +A.3 install-tl DESCRIPTION +========================== This installer creates a runnable TeX Live installation from various media, including over the network, from local hard disk, a DVD, etc. @@ -2343,18 +2346,20 @@ information on initially downloading TeX Live, see The basic idea of TeX Live installation is for you to choose one of the top-level _schemes_, each of which is defined as a different set of _collections_ and _packages_, 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. 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 ‘tlmgr’ (reference just below) after the +work at the package level, use 'tlmgr' (reference just below) after the initial installation is complete. - The default is ‘scheme-full’, which installs everything, and this is + The default is 'scheme-full', which installs everything, and this is highly recommended. -File: tlbuild.info, Node: install-tl REFERENCES, Next: install-tl OPTIONS, Prev: install-tl DESCRIPTION, Up: install-tl +File: tlbuild.info, Node: install-tl REFERENCES, Next: install-tl EXAMPLES, Prev: install-tl DESCRIPTION, Up: install-tl A.4 REFERENCES ============== @@ -2366,49 +2371,87 @@ through *tlmgr*(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>. + For step-by-step instructions, see +<https://tug.org/texlive/quickinstall.html>. + For the full documentation of TeX Live, see <https://tug.org/texlive/doc>. -File: tlbuild.info, Node: install-tl OPTIONS, Next: install-tl PROFILES, Prev: install-tl REFERENCES, Up: install-tl +File: tlbuild.info, Node: install-tl EXAMPLES, Next: install-tl OPTIONS, Prev: install-tl REFERENCES, Up: install-tl -A.5 OPTIONS -=========== +A.5 install-tl 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. Some examples: + +'install-tl --paper=letter' + + Initialize paper size setting. The only values allowed are + 'letter' and (the default) 'a4'. + +'install-tl --scheme' _scheme_ + + Initialize the installation scheme; the default is 'full'. For a + list of schemes, see the interactive 'S' menu. + +'install-tl --no-interaction' + + Perform the installation immediately after parsing options, without + entering the interactive menu. + +'install-tl --profile' _texlive.profile_ + + Install, without interaction, according to the given TL profile + file; see *note PROFILES: install-tl PROFILES. below. To + initialize from the profile and then enter the interactive menu, + add '--init-from-profile'. + + Full documentation follows. + + +File: tlbuild.info, Node: install-tl OPTIONS, Next: install-tl PROFILES, Prev: install-tl EXAMPLES, Up: install-tl + +A.6 install-tl OPTIONS +====================== 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 ‘=’. +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: - ‘text’ + 'text' The text mode user interface (default on Unix systems, - including Macs). Same as the ‘-no-gui’ option. + including Macs). Same as the '-no-gui' option. - ‘tcl’ (or "perltk" or "wizard" or "expert" or nothing) + 'tcl' (or "perltk" or "wizard" or "expert" or nothing) The Tcl/Tk user interface (default on Windows). It starts with a small number of configuration options, roughly equivalent to what the former wizard option offers, but a - button ‘Advanced’ takes you to a screen with roughly the same - options as the former ‘perltk’ interface. - - 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. - -*-no-gui* + button 'Advanced' takes you to a screen with roughly the same + options as the former 'perltk' interface. - Use the text mode installer (default except on Windows and Macs). + 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. *-lang* _llcode_ @@ -2426,13 +2469,13 @@ by either a space or ‘=’. 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 + 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 + 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 @@ -2444,9 +2487,9 @@ by either a space or ‘=’. This option allows you to choose a particular mirror from the current list of active CTAN mirrors. This option is supported in - the ‘text’ and ‘gui’ installer modes, and will also offer to + the 'text' and 'gui' installer modes, and will also offer to install from local media if available, or from a repository - specified on the command line. It’s useful when the (default) + specified on the command line. It's useful when the (default) automatic redirection does not choose a good host for you. *-all-options* @@ -2458,15 +2501,15 @@ by either a space or ‘=’. *-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 @@ -2474,9 +2517,14 @@ by either a space or ‘=’. *-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* + + Print final values of directory variables; for more debugging + information on how they were set, also specify '-v'. *-debug-translation* @@ -2488,25 +2536,25 @@ by either a space or ‘=’. *-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. + 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*, *-?* +*-help*, *--help*, *-?* Display this help and exit. (This help is also on the web at <https://tug.org/texlive/doc/install-tl.html>). Sometimes the - ‘perldoc’ and/or ‘PAGER’ programs on the system have problems, + 'perldoc' and/or 'PAGER' programs on the system have problems, possibly resulting in control characters being literally output. - This can’t always be detected, but you can set the ‘NOPERLDOC’ - environment variable and ‘perldoc’ will not be used. + This can't always be detected, but you can set the 'NOPERLDOC' + environment variable and 'perldoc' will not be used. *-in-place* This is a quick-and-dirty installation option in case you already have an rsync or svn checkout of TeX Live. It will use the checkout as-is and will just do the necessary post-install. Be - warned that the file ‘tlpkg/texlive.tlpdb’ may be rewritten, that + warned that the file 'tlpkg/texlive.tlpdb' may be rewritten, that removal has to be done 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. USE AT YOUR @@ -2526,35 +2574,82 @@ by either a space or ‘=’. If this option is not given, the installer will create a log file in the root of the writable installation tree, for example, - ‘/usr/local/texlive/YYYY/install-tl.log’ for the _YYYY_ release. + '/usr/local/texlive/YYYY/install-tl.log' for the _YYYY_ release. *-no-cls* For the text mode installer only: do not clear the screen when - entering a new menu (for debugging purposes). + entering a new menu. For debugging. + +*-no-continue* + + Quit early on installation failure of a non-core package. + + By default, a few core packages are installed first; then, a failed + installation of any other (non-core) package is noted, but does not + stop the installation. Any such failed packages are retried, once. + + 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. + +*-no-doc-install* + +*-no-src-install* + + 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* + + Do not perform any installation. This is for debugging the + initialization and setup routines without touching the disk. + +*-no-interaction* + + 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* *-persistent-downloads* For network installs, activating this option makes the installer - try to set up a persistent connection using the ‘Net::LWP’ Perl - module. This opens only one connection between your computer and - the server per session and reuses it, instead of initiating a new - download for each package, which typically yields a significant - speed-up. + try to set up a persistent connection using the 'LWP' Perl module. + This opens only one connection between your computer and the server + per session and reuses it, instead of initiating a new download for + each package, which typically yields a significant speed-up. This option is turned on by default, and the installation program - will fall back to using ‘wget’ if this is not possible. To disable + will fall back to using 'wget' if this is not possible. To disable usage of LWP and persistent connections, use - ‘-no-persistent-downloads’. + '-no-persistent-downloads'. *-no-verify-downloads* - By default, if a GnuPG ‘gpg’ binary is found in PATH, downloads are + By default, if a GnuPG 'gpg' binary is found in PATH, downloads are verified against a cryptographic signature. This option disables such verification. The full description is in the Crytographic - Verification section of the ‘tlmgr’ documentation, e.g., + Verification section of the 'tlmgr' documentation, e.g., <https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION> *-non-admin* @@ -2562,16 +2657,22 @@ by either a space or ‘=’. For Windows only: configure for the current user, not for all users. +*-paper* 'a4'*|*'letter' + + Set the default paper size for all TeX Live programs, as specified. + The default is 'a4'. The paper size can be set after installation + with the 'tlmgr paper' command. + *-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. *-print-platform* Print the TeX Live identifier for the detected platform (hardware/operating system) combination to standard output, and - exit. ‘-print-arch’ is a synonym. + exit. '-print-arch' is a synonym. *-profile* _profile_file_ @@ -2587,61 +2688,118 @@ by either a space or ‘=’. *-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. + 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 of _dir_, so they don't + have to be set individually. + + There is a brief summary of these directories trees at *note + DIRECTORY TREES: install-tl 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 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. 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'. TDS reference: + <https://tug.org/tds>. + +*-texmfhome* _dir_ + + Specify the 'TEXMFHOME' directory; the default is '~/texmf', except + on Macs, where it is '~/Library/texmf'. Analogously to + 'TEXMFLOCAL', the '-texuserdir' option changes this default. + + Also as with 'TEXMFLOCAL', anything installed here must follow the + TDS. + +*-texmfsysconfig* _dir_ + +*-texmfsysvar* _dir_ + + Specify the 'TEXMFSYSCONFIG' and 'TEXMFSYSVAR' system directories. + +*-texmfconfig* _dir_ + +*-texmfvar* _dir_ + + 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.) + '-v -v'. (Further repeats are accepted but ignored.) -*-version*, *–version* +*-version*, *--version* - Output version information and exit. If ‘-v’ is also given, the + Output version information and exit. If '-v' is also given, the versions of the TeX Live modules used are also reported. File: tlbuild.info, Node: install-tl PROFILES, Next: install-tl ENVIRONMENT VARIABLES, Prev: install-tl OPTIONS, Up: install-tl -A.6 PROFILES +A.7 PROFILES ============ -A _profile_ file contains all the values needed to perform an +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. +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 + 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. +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 +specified in profile files either. Use 'tlmgr' to work at the package level. Within a profile file, each line consists of _variable_ [_value_] - except for comment lines starting with ‘#’. The possible variable -names are listed below. Values, when present, are either ‘0’ or ‘1’ for + 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 + 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. +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 @@ -2649,64 +2807,72 @@ collections must be given explicitly. 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 +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 + In addition to 'selected_scheme', here are the other variable names supported in a profile: - *collection options* (prefix ‘collection-’) + *collection options* (prefix 'collection-') Collections are specified with a variable name with the prefix -‘collection-’ followed by a collection name; there is no value. For -instance, ‘collection-basic’. The collections are described in the ‘C’ +'collection-' followed by a collection name; there is no value. For +instance, 'collection-basic'. The collections are described in the 'C' menu. Schemes and collections (and packages) are ultimately defined by the -files in the ‘tlpkg/tlpsrc/’ source directory. +files in the 'tlpkg/tlpsrc/' source directory. *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. +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 + TEXMFCONFIG + TEXMFVAR + TEXMFHOME - *installer options* (prefix ‘instopt_’) + *installer options* (prefix 'instopt_') -‘instopt_adjustpath’ (default 0 on Unix, 1 on Windows) +'instopt_adjustpath' (default 0 on Unix, 1 on Windows) - Adjust ‘PATH’ environment variable. + Adjust 'PATH' environment variable. -‘instopt_adjustrepo’ (default 1) +'instopt_adjustrepo' (default 1) Set remote repository to a multiplexed CTAN mirror after - installation; see ‘-repository’ above. + installation; see '-repository' above. -‘instopt_letter’ (default 0) +'instopt_letter' (default 0) Set letter size paper as the default, instead of a4. -‘instopt_portable’ (default 0) +'instopt_portable' (default 0) + + Install for portable use, e.g., on a USB stick, without touching + the host system. Specifically, this forces the user directories + 'TEXMFHOME', 'TEXMFCONFIG', 'TEXMFVAR' to be identical to the + system directories 'TEXMFLOCAL', 'TEXMFSYSCONFIG', 'TEXMFSYSVAR', + respectively (regardless of other options and environment + variable.) - Install for portable use, e.g., on a USB stick. + In addition, on Windows, it disables the desktop integration, path + adjustment, and file associations actions usually performed. -‘instopt_write18_restricted’ (default 1) +'instopt_write18_restricted' (default 1) - Enable ‘\write18’ for a restricted set of programs. + Enable '\write18' for a restricted set of programs. - *tlpdb options* (prefix ‘tlpdbopt_’) + *tlpdb options* (prefix 'tlpdbopt_') - The definitive list is given in ‘tlpkg/TeXLive/TLConfig.pm’, in the -hash ‘%TeXLive::TLConfig::TLPDBOptions’, together with explanations. -All items given there _except_ for ‘tlpdbopt_location’ can be specified. + The definitive list is given in 'tlpkg/TeXLive/TLConfig.pm', in the +hash '%TeXLive::TLConfig::TLPDBOptions', together with explanations. +All items given there _except_ for 'tlpdbopt_location' can be specified. Here is the current list: tlpdbopt_autobackup @@ -2723,18 +2889,18 @@ Here is the current list: tlpdbopt_sys_man tlpdbopt_w32_multi_user - *platform options* (prefix ‘binary_’) + *platform options* (prefix 'binary_') - For each supported platform in TeX Live (directories under ‘bin/’), -the variable ‘binary_’_PLATFORM_ can be set with value 1. For example: + For each supported platform in TeX Live (directories under 'bin/'), +the variable 'binary_'_PLATFORM_ can be set with value 1. For example: binary_x86_64-linux 1 - If no ‘binary_’ settings are made, the default is whatever the + If no 'binary_' settings are made, the default is whatever the current machine is running. In releases before 2017, many profile variables had different names -(not documented here; see the ‘install-tl’ source). They are accepted +(not documented here; see the 'install-tl' source). They are accepted and transformed to the names given above. When a profile is written, the names above are always used. @@ -2742,89 +2908,164 @@ the names above are always used. installation manual, linked from <https://tug.org/texlive/doc>. -File: tlbuild.info, Node: install-tl ENVIRONMENT VARIABLES, Next: install-tl AUTHORS AND COPYRIGHT, Prev: install-tl PROFILES, Up: install-tl +File: tlbuild.info, Node: install-tl ENVIRONMENT VARIABLES, Next: install-tl DIRECTORY TREES, Prev: install-tl PROFILES, Up: install-tl -A.7 ENVIRONMENT VARIABLES +A.8 ENVIRONMENT VARIABLES ========================= -For ease in scripting and debugging, ‘install-tl’ looks for the +For ease in scripting and debugging, 'install-tl' looks for the following environment variables. They are not of interest for normal user installations. -‘TEXLIVE_DOWNLOADER’ +'NOPERLDOC' -‘TL_DOWNLOAD_PROGRAM’ + Don't try to run the '--help' message through 'perldoc'. -‘TL_DOWNLOAD_ARGS’ +'TEXLIVE_DOWNLOADER' + +'TL_DOWNLOAD_PROGRAM' + +'TL_DOWNLOAD_ARGS' These override the normal choice of a download program; see the - ‘tlmgr’ documentation, e.g., + 'tlmgr' documentation, e.g., <https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>. -‘TEXLIVE_INSTALL_ENV_NOCHECK’ +'TEXLIVE_INSTALL_ENV_NOCHECK' Omit the check for environment variables containing the string - ‘tex’. People developing TeX-related software are likely to have + 'tex'. People developing TeX-related software are likely to have many such variables. -‘TEXLIVE_INSTALL_NO_CONTEXT_CACHE’ +'TEXLIVE_INSTALL_NO_CONTEXT_CACHE' Omit creating the ConTeXt cache. This is useful for redistributors. -‘TEXLIVE_INSTALL_NO_RESUME’ +'TEXLIVE_INSTALL_NO_DISKCHECK' + + If set to 1, omit free disk space check. By default, if a + POSIX-compliant 'df' program (supporting '-Pk') 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 'df'). + +'TEXLIVE_INSTALL_NO_RESUME' Omit check for installing on top of a previous installation and then asking about importing previous settings. -‘TEXLIVE_INSTALL_NO_WELCOME’ +'TEXLIVE_INSTALL_NO_WELCOME' Omit printing the welcome message after successful installation, e.g., when testing. -‘TEXLIVE_INSTALL_PAPER’ +'TEXLIVE_INSTALL_PAPER' Set the default paper size for all relevant programs; must be - either ‘letter’ or ‘a4’. The default is ‘a4’. + either 'letter' or 'a4'. The default is 'a4'. -‘TEXLIVE_INSTALL_PREFIX’ +'TEXLIVE_INSTALL_PREFIX' -‘TEXLIVE_INSTALL_TEXMFCONFIG’ +'TEXLIVE_INSTALL_TEXMFCONFIG' -‘TEXLIVE_INSTALL_TEXMFVAR’ +'TEXLIVE_INSTALL_TEXMFVAR' -‘TEXLIVE_INSTALL_TEXMFHOME’ +'TEXLIVE_INSTALL_TEXMFHOME' -‘TEXLIVE_INSTALL_TEXMFLOCAL’ +'TEXLIVE_INSTALL_TEXMFLOCAL' -‘TEXLIVE_INSTALL_TEXMFSYSCONFIG’ +'TEXLIVE_INSTALL_TEXMFSYSCONFIG' -‘TEXLIVE_INSTALL_TEXMFSYSVAR’ +'TEXLIVE_INSTALL_TEXMFSYSVAR' - Specify the respective directories. ‘TEXLIVE_INSTALL_PREFIX’ - defaults to ‘/usr/local/texlive’. All the defaults can be seen by - running the installer interactively and then typing ‘D’ for the + Specify the respective directories. 'TEXLIVE_INSTALL_PREFIX' + defaults to '/usr/local/texlive'. All the defaults can be seen by + running the installer interactively and then typing 'D' for the directory menu. - To override the so-called ‘TEXDIR’, which defaults to the release - directory within that prefix, e.g., ‘/usr/local/texlive/2020’, 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. + + +File: tlbuild.info, Node: install-tl DIRECTORY TREES, Next: install-tl BUGS, Prev: install-tl ENVIRONMENT VARIABLES, Up: install-tl + +A.9 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/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 *note +OPTIONS: install-tl OPTIONS. + + For the user trees, the default value uses '~', and this is left as a +literal '~' in 'texmf.cnf'. That way, each user can have their own +'TEXMFHOME', etc., as intended. On the other hand, for the system +trees, if '~' is used during the installation, this is assumed to simply +be a typing shorthand, and the expanded home directory is written in +'texmf.cnf', since it doesn't make sense to have user-specific system +directories. + + For more on the directory trees and their intended usage, see the +main TeX Live documentation at <https://tug.org/texlive/doc>. + + +File: tlbuild.info, Node: install-tl BUGS, Next: install-tl AUTHORS AND COPYRIGHT, Prev: install-tl DIRECTORY TREES, Up: install-tl + +A.10 install-tl BUGS +==================== -‘NOPERLDOC’ +The 'install-tl' script copies itself into the installed tree. Usually, +it can be run from there, using the installed tree as the source for +another installation. Occasionally, however, there may be +incompatibilities in the code of the new 'install-tl' and the +infrastructure, resulting in (probably) inscrutable Perl errors. The +way forward is to run 'install-tl' out of the installer package +('install-tl-unx.tar.gz' or 'install-tl.zip') instead of the +installation. Feel free to also report the issue; usually the code can +be easily synced up again. - Don’t try to run the ‘--help’ message through ‘perldoc’. + By the way, do not try to use 'install-tl' to adjust options or +installed packages in an existing installed tree. Use 'tlmgr' instead. -File: tlbuild.info, Node: install-tl AUTHORS AND COPYRIGHT, Prev: install-tl ENVIRONMENT VARIABLES, Up: install-tl +File: tlbuild.info, Node: install-tl AUTHORS AND COPYRIGHT, Prev: install-tl BUGS, Up: install-tl -A.8 AUTHORS AND COPYRIGHT -========================= +A.11 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 62146 2022-02-22 22:48:10Z karl $ + $Id: install-tl 66112 2023-02-23 23:28:27Z karl $ File: tlbuild.info, Node: tlmgr, Next: Index, Prev: install-tl, Up: Top @@ -2852,24 +3093,24 @@ Appendix B tlmgr File: tlbuild.info, Node: tlmgr NAME, Next: tlmgr SYNOPSIS, Up: tlmgr -B.1 NAME -======== +B.1 tlmgr NAME +============== tlmgr - the native TeX Live Manager File: tlbuild.info, Node: tlmgr SYNOPSIS, Next: tlmgr DESCRIPTION, Prev: tlmgr NAME, Up: tlmgr -B.2 SYNOPSIS -============ +B.2 tlmgr SYNOPSIS +================== tlmgr [_option_...] _action_ [_option_...] [_operand_...] File: tlbuild.info, Node: tlmgr DESCRIPTION, Next: tlmgr EXAMPLES, Prev: tlmgr SYNOPSIS, Up: tlmgr -B.3 DESCRIPTION -=============== +B.3 tlmgr DESCRIPTION +===================== *tlmgr* manages an existing TeX Live installation, both packages and configuration options. For information on initially downloading and @@ -2878,7 +3119,7 @@ installing TeX Live, see <https://tug.org/texlive/acquire.html>. The most up-to-date version of this documentation (updated nightly from the development sources) is available at <https://tug.org/texlive/tlmgr.html>, along with procedures for updating -‘tlmgr’ itself and information about test versions. +'tlmgr' itself and information about test versions. TeX Live is organized into a few top-level _schemes_, each of which is specified as a different set of _collections_ and _packages_, where a @@ -2893,68 +3134,68 @@ available. File: tlbuild.info, Node: tlmgr EXAMPLES, Next: tlmgr OPTIONS, Prev: tlmgr DESCRIPTION, Up: tlmgr -B.4 EXAMPLES -============ +B.4 tlmgr EXAMPLES +================== After successfully installing TeX Live, here are a few common operations -with ‘tlmgr’: +with 'tlmgr': -‘tlmgr option repository ctan’ +'tlmgr option repository ctan' -‘tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet’ +'tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet' - Tell ‘tlmgr’ to use a nearby CTAN mirror for future updates; useful + Tell 'tlmgr' to use a nearby CTAN mirror for future updates; useful if you installed TeX Live from the DVD image and want to have - continuing updates. The two commands are equivalent; ‘ctan’ is + continuing updates. The two commands are equivalent; 'ctan' is just an alias for the given url. - Caveat: ‘mirror.ctan.org’ resolves to many different hosts, and + Caveat: 'mirror.ctan.org' resolves to many different hosts, and they are not perfectly synchronized; we recommend updating only daily (at most), and not more often. You can choose a particular mirror if problems; the list of all CTAN mirrors with the status of each is at <https://ctan.org/mirrors/mirmon>. -‘tlmgr update --list’ +'tlmgr update --list' Report what would be updated without actually updating anything. -‘tlmgr update --all’ +'tlmgr update --all' Make your local TeX installation correspond to what is in the package repository (typically useful when updating from CTAN). -‘tlmgr info’ _what_ +'tlmgr info' _what_ Display detailed information about a package _what_, such as the installation status and description, of searches for _what_ in all packages. - For all the capabilities and details of ‘tlmgr’, please read the + For all the capabilities and details of 'tlmgr', please read the following voluminous information. File: tlbuild.info, Node: tlmgr OPTIONS, Next: tlmgr ACTIONS, Prev: tlmgr EXAMPLES, Up: tlmgr -B.5 OPTIONS -=========== +B.5 tlmgr OPTIONS +================= -The following options to ‘tlmgr’ are global options, not specific to any +The following options to 'tlmgr' are global options, not specific to any action. All options, whether global or action-specific, can be given anywhere on the command line, and in any order. The first non-option -argument will be the main action. In all cases, ‘--’_option_ and -‘-’_option_ are equivalent, and an ‘=’ is optional between an option +argument will be the main action. In all cases, '--'_option_ and +'-'_option_ are equivalent, and an '=' is optional between an option name and its value. -*–repository* _url|path_ +*--repository* _url|path_ Specify the package repository from which packages should be installed or updated, either a local directory or network location, as below. This overridesthe default package repository found in - the installation’s TeX Live Package Database (a.k.a. the TLPDB, - which is given entirely in the file ‘tlpkg/texlive.tlpdb’). + the installation's TeX Live Package Database (a.k.a. the TLPDB, + which is given entirely in the file 'tlpkg/texlive.tlpdb'). - This ‘--repository’ option changes the location only for the - current run; to make a permanent change, use ‘option repository’ + This '--repository' option changes the location only for the + current run; to make a permanent change, use 'option repository' (see the *note option: tlmgr option. action). As an example, you can choose a particular CTAN mirror with @@ -2966,75 +3207,75 @@ name and its value. directory have to be specified. The list of CTAN mirrors is available at <https://ctan.org/mirrors/mirmon>. - Here’s an example of using a local directory: + Here's an example of using a local directory: -repository /local/TL/repository - For backward compatibility and convenience, ‘--location’ and - ‘--repo’ are accepted as aliases for this option. + For backward compatibility and convenience, '--location' and + '--repo' are accepted as aliases for this option. Locations can be specified as any of the following: - ‘/some/local/dir’ + '/some/local/dir' - ‘file:/some/local/dir’ + 'file:/some/local/dir' Equivalent ways of specifying a local directory. - ‘ctan’ + 'ctan' - ‘https://mirror.ctan.org/systems/texlive/tlnet’ + 'https://mirror.ctan.org/systems/texlive/tlnet' Pick a CTAN mirror automatically, trying for one that is both nearby and up-to-date. The chosen mirror is used for the - entire download. The bare ‘ctan’ is merely an alias for the + entire download. The bare 'ctan' is merely an alias for the full url. (See <https://ctan.org> for more about CTAN and its mirrors.) - ‘http://server/path/to/tlnet’ + 'http://server/path/to/tlnet' Standard HTTP. If the (default) LWP method is used, persistent - connections are supported. TL can also use ‘curl’ or ‘wget’ + connections are supported. TL can also use 'curl' or 'wget' to do the downloads, or an arbitrary user-specified program, - as described in the ‘tlmgr’ documentation + as described in the 'tlmgr' documentation (<https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>). - ‘https://server/path/to/tlnet’ + 'https://server/path/to/tlnet' Again, if the (default) LWP method is used, this supports persistent connections. Unfortunately, some versions of - ‘wget’ and ‘curl’ do not support https, and even when ‘wget’ + 'wget' and 'curl' do not support https, and even when 'wget' supports https, certificates may be rejected even when the certificate is fine, due to a lack of local certificate roots. The simplest workaround for this problem is to use http or ftp. - ‘ftp://server/path/to/tlnet’ + 'ftp://server/path/to/tlnet' If the (default) LWP method is used, persistent connections are supported. - ‘user@machine:/path/to/tlnet’ + 'user@machine:/path/to/tlnet' - ‘scp://user@machine/path/to/tlnet’ + 'scp://user@machine/path/to/tlnet' - ‘ssh://user@machine/path/to/tlnet’ + 'ssh://user@machine/path/to/tlnet' - These forms are equivalent; they all use ‘scp’ to transfer - files. Using ‘ssh-agent’ is recommended. (Info: + These forms are equivalent; they all use 'scp' to transfer + files. Using 'ssh-agent' is recommended. (Info: <https://en.wikipedia.org/wiki/OpenSSH>, <https://en.wikipedia.org/wiki/Ssh-agent>.) - If the repository is on the network, trailing ‘/’ characters and/or - trailing ‘/tlpkg’ and/or ‘/archive’ components are ignored. + If the repository is on the network, trailing '/' characters and/or + trailing '/tlpkg' and/or '/archive' components are ignored. -*–gui* [_action_] +*--gui* [_action_] - Two notable GUI front-ends for ‘tlmgr’, ‘tlshell’ and ‘tlcockpit’, + Two notable GUI front-ends for 'tlmgr', 'tlshell' and 'tlcockpit', are started up as separate programs; see their own documentation. - ‘tlmgr’ itself has a graphical interface as well as the command - line interface. You can give the option to invoke it, ‘--gui’, + 'tlmgr' itself has a graphical interface as well as the command + line interface. You can give the option to invoke it, '--gui', together with an action to be brought directly into the respective screen of the GUI. For example, running @@ -3045,14 +3286,14 @@ name and its value. TLMGR: tlmgr GUI FOR TLMGR. However, the native GUI requires Perl/TK, which is no longer - included in TeX Live’s Perl distribution for Windows. You may find - ‘tlshell’ or ‘tlcockpit’ easier to work with. + included in TeX Live's Perl distribution for Windows. You may find + 'tlshell' or 'tlcockpit' easier to work with. -*–gui-lang* _llcode_ +*--gui-lang* _llcode_ By default, the GUI tries to deduce your language from the environment (on Windows via the registry, on Unix via - ‘LC_MESSAGES’). If that fails you can select a different language + 'LC_MESSAGES'). If that fails you can select a different language by giving this option with a language code (based on ISO 639-1). Currently supported (but not necessarily completely translated) are: English (en, default), Czech (cs), German (de), French (fr), @@ -3063,92 +3304,92 @@ name and its value. tlshell shares its message catalog with tlmgr. -*–command-logfile* _file_ +*--command-logfile* _file_ - ‘tlmgr’ logs the output of all programs invoked (mktexlr, mtxrun, + 'tlmgr' logs the output of all programs invoked (mktexlr, mtxrun, fmtutil, updmap) to a separate log file, by default - ‘TEXMFSYSVAR/web2c/tlmgr-commands.log’. This option allows you to + 'TEXMFSYSVAR/web2c/tlmgr-commands.log'. This option allows you to specify a different file for the log. -*–debug-translation* +*--debug-translation* - In GUI mode, this switch tells ‘tlmgr’ to report any untranslated + In GUI mode, this switch tells 'tlmgr' to report any untranslated (or missing) messages to standard error. This can help translators to see what remains to be done. -*–machine-readable* +*--machine-readable* Instead of the normal output intended for human consumption, write (to standard output) a fixed format more suitable for machine parsing. See the *note MACHINE-READABLE OUTPUT: tlmgr MACHINE-READABLE OUTPUT. section below. -*–no-execute-actions* +*--no-execute-actions* Suppress the execution of the execute actions as defined in the tlpsrc files. Documented only for completeness, as this is only useful in debugging. -*–package-logfile* _file_ +*--package-logfile* _file_ - ‘tlmgr’ logs all package actions (install, remove, update, failed + 'tlmgr' logs all package actions (install, remove, update, failed updates, failed restores) to a separate log file, by default - ‘TEXMFSYSVAR/web2c/tlmgr.log’. This option allows you to specify a + 'TEXMFSYSVAR/web2c/tlmgr.log'. This option allows you to specify a different file for the log. -*–pause* +*--pause* - This option makes ‘tlmgr’ wait for user input before exiting. + This option makes 'tlmgr' wait for user input before exiting. Useful on Windows to avoid disappearing command windows. -*–persistent-downloads* +*--persistent-downloads* -*–no-persistent-downloads* +*--no-persistent-downloads* For network-based installations, this option (on by default) makes - ‘tlmgr’ try to set up a persistent connection (using the ‘LWP’ Perl + 'tlmgr' try to set up a persistent connection (using the 'LWP' Perl module). The idea is to open and reuse only one connection per session between your computer and the server, instead of initiating a new download for each package. - If this is not possible, ‘tlmgr’ will fall back to using ‘wget’. + If this is not possible, 'tlmgr' will fall back to using 'wget'. To disable these persistent connections, use - ‘--no-persistent-downloads’. + '--no-persistent-downloads'. -*–pin-file* +*--pin-file* Change the pinning file location from - ‘TEXMFLOCAL/tlpkg/pinning.txt’ (see *note Pinning: tlmgr Pinning. + 'TEXMFLOCAL/tlpkg/pinning.txt' (see *note Pinning: tlmgr Pinning. below). Documented only for completeness, as this is only useful in debugging. -*–usermode* +*--usermode* - Activates user mode for this run of ‘tlmgr’; see *note USER MODE: + Activates user mode for this run of 'tlmgr'; see *note USER MODE: tlmgr USER MODE. below. -*–usertree* _dir_ +*--usertree* _dir_ Uses _dir_ for the tree in user mode; see *note USER MODE: tlmgr USER MODE. below. -*–verify-repo=[none|main|all]* +*--verify-repo=[none|main|all]* - Defines the level of verification done: If ‘none’ is specified, no - verification whatsoever is done. If ‘main’ is given and a working - GnuPG (‘gpg’) binary is available, all repositories are checked, - but only the main repository is required to be signed. If ‘all’ is + Defines the level of verification done: If 'none' is specified, no + verification whatsoever is done. If 'main' is given and a working + GnuPG ('gpg') binary is available, all repositories are checked, + but only the main repository is required to be signed. If 'all' is given, then all repositories need to be signed. See *note CRYPTOGRAPHIC VERIFICATION: tlmgr CRYPTOGRAPHIC VERIFICATION. below for details. The standard options for TeX Live programs are also accepted: -‘--help/-h/-?’, ‘--version’, ‘-q’ (no informational messages), ‘-v’ +'--help/-h/-?', '--version', '-q' (no informational messages), '-v' (debugging messages, can be repeated). For the details about these, see -the ‘TeXLive::TLUtils’ documentation. +the 'TeXLive::TLUtils' documentation. - The ‘--version’ option shows version information about the TeX Live -release and about the ‘tlmgr’ script itself. If ‘-v’ is also given, + The '--version' option shows version information about the TeX Live +release and about the 'tlmgr' script itself. If '-v' is also given, revision number for the loaded TeX Live Perl modules are shown, too. @@ -3196,12 +3437,12 @@ File: tlbuild.info, Node: tlmgr help, Next: tlmgr version, Up: tlmgr ACTIONS B.6.1 help ---------- -Display this help information and exit (same as ‘--help’, and on the web -at <https://tug.org/texlive/doc/tlmgr.html>). Sometimes the ‘perldoc’ -and/or ‘PAGER’ programs on the system have problems, resulting in -control characters being literally output. This can’t always be -detected, but you can set the ‘NOPERLDOC’ environment variable and -‘perldoc’ will not be used. +Display this help information and exit (same as '--help', and on the web +at <https://tug.org/texlive/doc/tlmgr.html>). Sometimes the 'perldoc' +and/or 'PAGER' programs on the system have problems, resulting in +control characters being literally output. This can't always be +detected, but you can set the 'NOPERLDOC' environment variable and +'perldoc' will not be used. File: tlbuild.info, Node: tlmgr version, Next: tlmgr backup, Prev: tlmgr help, Up: tlmgr ACTIONS @@ -3209,9 +3450,9 @@ File: tlbuild.info, Node: tlmgr version, Next: tlmgr backup, Prev: tlmgr help B.6.2 version ------------- -Gives version information (same as ‘--version’). +Gives version information (same as '--version'). - If ‘-v’ has been given the revisions of the used modules are + If '-v' has been given the revisions of the used modules are reported, too. @@ -3220,51 +3461,51 @@ File: tlbuild.info, Node: tlmgr backup, Next: tlmgr candidates _pkg_, Prev: t B.6.3 backup ------------ -*backup [_option_...] –all* +*backup [_option_...] --all* *backup [_option_...] _pkg_...* - If the ‘--clean’ option is not specified, this action makes a - backup of the given packages, or all packages given ‘--all’. These - backups are saved to the value of the ‘--backupdir’ option, if that - is an existing and writable directory. If ‘--backupdir’ is not - given, the ‘backupdir’ option setting in the TLPDB is used, if + If the '--clean' option is not specified, this action makes a + backup of the given packages, or all packages given '--all'. These + backups are saved to the value of the '--backupdir' option, if that + is an existing and writable directory. If '--backupdir' is not + given, the 'backupdir' option setting in the TLPDB is used, if present. If both are missing, no backups are made. (The installer - sets ‘backupdir’ to ‘.../tlpkg/backups’, under the TL root + sets 'backupdir' to '.../tlpkg/backups', under the TL root installation directory, so it is usually defined; see the *note option: tlmgr option. description for more information.) - If the ‘--clean’ option is specified, backups are pruned (removed) + If the '--clean' option is specified, backups are pruned (removed) instead of saved. The optional integer value _N_ may be specified to set the number of backups that will be retained when cleaning. - If ‘N’ is not given, the value of the ‘autobackup’ option is used. + If 'N' is not given, the value of the 'autobackup' option is used. If both are missing, an error is issued. For more details of - backup pruning, see the ‘option’ action. + backup pruning, see the 'option' action. Options: - *–backupdir* _directory_ + *--backupdir* _directory_ - Overrides the ‘backupdir’ option setting in the TLPDB. The + Overrides the 'backupdir' option setting in the TLPDB. The _directory_ argument is required and must specify an existing, writable directory where backups are to be placed. - *–all* + *--all* - If ‘--clean’ is not specified, make a backup of all packages + If '--clean' is not specified, make a backup of all packages in the TeX Live installation; this will take quite a lot of - space and time. If ‘--clean’ is specified, all packages are + space and time. If '--clean' is specified, all packages are pruned. - *–clean*[=_N_] + *--clean*[=_N_] Instead of making backups, prune the backup directory of old backups, as explained above. The optional integer argument - _N_ overrides the ‘autobackup’ option set in the TLPDB. You - must use ‘--all’ or a list of packages together with this + _N_ overrides the 'autobackup' option set in the TLPDB. You + must use '--all' or a list of packages together with this option, as desired. - *–dry-run* + *--dry-run* Nothing is actually backed up or removed; instead, the actions to be performed are written to the terminal. @@ -3286,7 +3527,7 @@ B.6.5 check [_option_...] [depends|executes|files|runfiles|texmfdbs|all] Execute one (or all) check(s) of the consistency of the installation. If no problems are found, there will be no output. (To get a view of -what is being done, run ‘tlmgr -v check’.) +what is being done, run 'tlmgr -v check'.) *depends* @@ -3294,17 +3535,17 @@ what is being done, run ‘tlmgr -v check’.) collection, but are themselves not installed, and those packages which are not contained in any collection. - If you call ‘tlmgr check collections’ this test will be carried out - instead since former versions for ‘tlmgr’ called it that way. + If you call 'tlmgr check collections' this test will be carried out + instead since former versions for 'tlmgr' called it that way. *executes* - Check that the files referred to by ‘execute’ directives in the TeX + Check that the files referred to by 'execute' directives in the TeX Live Database are present. *files* - Checks that all files listed in the local TLPDB (‘texlive.tlpdb’) + Checks that all files listed in the local TLPDB ('texlive.tlpdb') are actually present, and lists those missing. *runfiles* @@ -3314,23 +3555,23 @@ what is being done, run ‘tlmgr -v check’.) *texmfdbs* - Checks related to the ‘ls-R’ files. If you have defined new trees, - or changed the ‘TEXMF’ or ‘TEXMFDBS’ variables, it can’t hurt to + Checks related to the 'ls-R' files. If you have defined new trees, + or changed the 'TEXMF' or 'TEXMFDBS' variables, it can't hurt to run this. It checks that: - - all items in ‘TEXMFDBS’ have the ‘!!’ prefix. + - all items in 'TEXMFDBS' have the '!!' prefix. - - all items in ‘TEXMFBDS’ have an ‘ls-R’ file (if they exist at all). + - all items in 'TEXMFBDS' have an 'ls-R' file (if they exist at all). - - all items in ‘TEXMF’ with ‘!!’ are listed in ‘TEXMFDBS’. + - all items in 'TEXMF' with '!!' are listed in 'TEXMFDBS'. - - all items in ‘TEXMF’ with an ‘ls-R’ file are listed in ‘TEXMFDBS’. + - all items in 'TEXMF' with an 'ls-R' file are listed in 'TEXMFDBS'. Options: -*–use-svn* +*--use-svn* - Use the output of ‘svn status’ instead of listing the files; for + Use the output of 'svn status' instead of listing the files; for checking the TL development repository. (This is run nightly.) @@ -3339,52 +3580,52 @@ File: tlbuild.info, Node: tlmgr conf, Next: tlmgr dump-tlpdb [_option_...] [-- B.6.6 conf ---------- -*conf [texmf|tlmgr|updmap [–conffile _file_] [–delete] [_key_ [_value_]]]* +*conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]* -*conf auxtrees [–conffile _file_] [show|add|remove] [_value_]* +*conf auxtrees [--conffile _file_] [show|add|remove] [_value_]* - With only ‘conf’, show general configuration information for TeX + With only 'conf', show general configuration information for TeX Live, including active configuration files, path settings, and - more. This is like running ‘texconfig conf’, but works on all + more. This is like running 'texconfig conf', but works on all supported platforms. - With one of ‘conf texmf’, ‘conf tlmgr’, or ‘conf updmap’, shows all - key/value pairs (i.e., all settings) as saved in ‘ROOT/texmf.cnf’, - the user-specific ‘tlmgr’ configuration file (see below), or the - first found (via ‘kpsewhich’) ‘updmap.cfg’ file, respectively. + With one of 'conf texmf', 'conf tlmgr', or 'conf updmap', shows all + key/value pairs (i.e., all settings) as saved in 'ROOT/texmf.cnf', + the user-specific 'tlmgr' configuration file (see below), or the + first found (via 'kpsewhich') 'updmap.cfg' file, respectively. If _key_ is given in addition, shows the value of only that _key_ - in the respective file. If option _–delete_ is also given, the + in the respective file. If option _--delete_ is also given, the value in the given configuration file is entirely removed (not just commented out). If _value_ is given in addition, _key_ is set to _value_ in the respective file. _No error checking is done!_ - The ‘PATH’ value shown by ‘conf’ is as used by ‘tlmgr’. The - directory in which the ‘tlmgr’ executable is found is automatically + The 'PATH' value shown by 'conf' is as used by 'tlmgr'. The + directory in which the 'tlmgr' executable is found is automatically prepended to the PATH value inherited from the environment. Here is a practical example of changing configuration values. If - the execution of (some or all) system commands via ‘\write18’ was + the execution of (some or all) system commands via '\write18' was left enabled during installation, you can disable it afterwards: tlmgr conf texmf shell_escape 0 - The subcommand ‘auxtrees’ allows adding and removing arbitrary - additional texmf trees, completely under user control. ‘auxtrees - show’ shows the list of additional trees, ‘auxtrees add’ _tree_ - adds a tree to the list, and ‘auxtrees remove’ _tree_ removes a + The subcommand 'auxtrees' allows adding and removing arbitrary + additional texmf trees, completely under user control. 'auxtrees + show' shows the list of additional trees, 'auxtrees add' _tree_ + adds a tree to the list, and 'auxtrees remove' _tree_ removes a tree from the list (if present). The trees should not contain an - ‘ls-R’ file (or files will not be found if the ‘ls-R’ becomes + 'ls-R' file (or files will not be found if the 'ls-R' becomes stale). This works by manipulating the Kpathsea variable - ‘TEXMFAUXTREES’, in (by default) ‘ROOT/texmf.cnf’. Example: + 'TEXMFAUXTREES', in (by default) 'ROOT/texmf.cnf'. Example: tlmgr conf auxtrees add /quick/test/tree tlmgr conf auxtrees remove /quick/test/tree In all cases the configuration file can be explicitly specified via - the option ‘--conffile’ _file_, e.g., if you don’t want to change + the option '--conffile' _file_, e.g., if you don't want to change the system-wide configuration. Warning: The general facility for changing configuration values is @@ -3395,37 +3636,37 @@ B.6.6 conf File: tlbuild.info, Node: tlmgr dump-tlpdb [_option_...] [--json], Next: tlmgr generate, Prev: tlmgr conf, Up: tlmgr ACTIONS -B.6.7 dump-tlpdb [_option_...] [–json] --------------------------------------- +B.6.7 dump-tlpdb [_option_...] [--json] +--------------------------------------- Dump complete local or remote TLPDB to standard output, as-is. The -output is analogous to the ‘--machine-readable’ output; see *note +output is analogous to the '--machine-readable' output; see *note MACHINE-READABLE OUTPUT: tlmgr MACHINE-READABLE OUTPUT. section. Options: -*–local* +*--local* Dump the local TLPDB. -*–remote* +*--remote* Dump the remote TLPDB. -*–json* +*--json* Instead of dumping the actual content, the database is dumped as JSON. For the format of JSON output see - ‘tlpkg/doc/JSON-formats.txt’, format definition ‘TLPDB’. + 'tlpkg/doc/JSON-formats.txt', format definition 'TLPDB'. - Exactly one of ‘--local’ and ‘--remote’ must be given. + Exactly one of '--local' and '--remote' must be given. In either case, the first line of the output specifies the repository location, in this format: "location-url" "\t" location - where ‘location-url’ is the literal field name, followed by a tab, + where 'location-url' is the literal field name, followed by a tab, and _location_ is the file or url to the repository. Line endings may be either LF or CRLF depending on the current @@ -3445,34 +3686,34 @@ B.6.8 generate *generate [_option_...] language.dat.lua* - The ‘generate’ action overwrites any manual changes made in the + The 'generate' action overwrites any manual changes made in the respective files: it recreates them from scratch based on the information of the installed packages, plus local adaptions. The TeX -Live installer and ‘tlmgr’ routinely call ‘generate’ for all of these +Live installer and 'tlmgr' routinely call 'generate' for all of these files. - For managing your own fonts, please read the ‘updmap --help’ + For managing your own fonts, please read the 'updmap --help' information and/or <https://tug.org/fonts/fontinstall.html>. - For managing your own formats, please read the ‘fmtutil --help’ + For managing your own formats, please read the 'fmtutil --help' information. - In more detail: ‘generate’ remakes any of the configuration files -‘language.dat’, ‘language.def’, and ‘language.dat.lua’ from the + In more detail: 'generate' remakes any of the configuration files +'language.dat', 'language.def', and 'language.dat.lua' from the information present in the local TLPDB, plus locally-maintained files. - The locally-maintained files are ‘language-local.dat’, -‘language-local.def’, or ‘language-local.dat.lua’, searched for in -‘TEXMFLOCAL’ in the respective directories. If local additions are + The locally-maintained files are 'language-local.dat', +'language-local.def', or 'language-local.dat.lua', searched for in +'TEXMFLOCAL' in the respective directories. If local additions are present, the final file is made by starting with the main file, omitting any entries that the local file specifies to be disabled, and finally appending the local file. - (Historical note: The formerly supported ‘updmap-local.cfg’ and -‘fmtutil-local.cnf’ are no longer read, since ‘updmap’ and ‘fmtutil’ now + (Historical note: The formerly supported 'updmap-local.cfg' and +'fmtutil-local.cnf' are no longer read, since 'updmap' and 'fmtutil' now reads and supports multiple configuration files. Thus, local additions -can and should be put into an ‘updmap.cfg’ of ‘fmtutil.cnf’ file in -‘TEXMFLOCAL’. The ‘generate updmap’ and ‘generate fmtutil’ actions no +can and should be put into an 'updmap.cfg' of 'fmtutil.cnf' file in +'TEXMFLOCAL'. The 'generate updmap' and 'generate fmtutil' actions no longer exist.) Local files specify entries to be disabled with a comment line, @@ -3481,50 +3722,50 @@ namely one of these: %!NAME --!NAME - where ‘language.dat’ and ‘language.def’ use ‘%’, and -‘language.dat.lua’ use ‘--’. In all cases, the _name_ is the respective + where 'language.dat' and 'language.def' use '%', and +'language.dat.lua' use '--'. In all cases, the _name_ is the respective format name or hyphenation pattern identifier. Examples: %!german --!usenglishmax - (Of course, you’re not likely to actually want to disable those -particular items. They’re just examples.) + (Of course, you're not likely to actually want to disable those +particular items. They're just examples.) After such a disabling line, the local file can include another entry for the same item, if a different definition is desired. In general, except for the special disabling lines, the local files follow the same syntax as the master files. - The form ‘generate language’ recreates all three files -‘language.dat’, ‘language.def’, and ‘language.dat.lua’, while the forms + The form 'generate language' recreates all three files +'language.dat', 'language.def', and 'language.dat.lua', while the forms with an extension recreates only that given language file. Options: -*–dest* _output_file_ +*--dest* _output_file_ specifies the output file (defaults to the respective location in - ‘TEXMFSYSVAR’). If ‘--dest’ is given to ‘generate language’, it - serves as a basename onto which ‘.dat’ will be appended for the - name of the ‘language.dat’ output file, ‘.def’ will be appended to - the value for the name of the ‘language.def’ output file, and - ‘.dat.lua’ to the name of the ‘language.dat.lua’ file. (This is + 'TEXMFSYSVAR'). If '--dest' is given to 'generate language', it + serves as a basename onto which '.dat' will be appended for the + name of the 'language.dat' output file, '.def' will be appended to + the value for the name of the 'language.def' output file, and + '.dat.lua' to the name of the 'language.dat.lua' file. (This is just to avoid overwriting; if you want a specific name for each - output file, we recommend invoking ‘tlmgr’ twice.) + output file, we recommend invoking 'tlmgr' twice.) -*–localcfg* _local_conf_file_ +*--localcfg* _local_conf_file_ specifies the (optional) local additions (defaults to the - respective location in ‘TEXMFLOCAL’). + respective location in 'TEXMFLOCAL'). -*–rebuild-sys* +*--rebuild-sys* - tells ‘tlmgr’ to run necessary programs after config files have - been regenerated. These are: ‘fmtutil-sys --all’ after ‘generate - fmtutil’, ‘fmtutil-sys --byhyphen .../language.dat’ after ‘generate - language.dat’, and ‘fmtutil-sys --byhyphen .../language.def’ after - ‘generate language.def’. + tells 'tlmgr' to run necessary programs after config files have + been regenerated. These are: 'fmtutil-sys --all' after 'generate + fmtutil', 'fmtutil-sys --byhyphen .../language.dat' after 'generate + language.dat', and 'fmtutil-sys --byhyphen .../language.def' after + 'generate language.def'. These subsequent calls cause the newly-generated files to actually take effect. This is not done by default since those calls are @@ -3558,9 +3799,9 @@ B.6.10 info *info [_option_...] schemes* With no argument, lists all packages available at the package - repository, prefixing those already installed with ‘i’. + repository, prefixing those already installed with 'i'. - With the single word ‘collections’ or ‘schemes’ as the argument, + With the single word 'collections' or 'schemes' as the argument, lists the request type instead of all packages. With any other arguments, display information about _pkg_: the @@ -3581,70 +3822,70 @@ B.6.10 info It also displays information taken from the TeX Catalogue, namely the package version, date, and license. Consider these, especially the package version, as approximations only, due to timing skew of - the updates of the different pieces. By contrast, the ‘revision’ + the updates of the different pieces. By contrast, the 'revision' value comes directly from TL and is reliable. - The former actions ‘show’ and ‘list’ are merged into this action, + The former actions 'show' and 'list' are merged into this action, but are still supported for backward compatibility. Options: - *–list* + *--list* - If the option ‘--list’ is given with a package, the list of + If the option '--list' is given with a package, the list of contained files is also shown, including those for platform-specific dependencies. When given with schemes and - collections, ‘--list’ outputs their dependencies in a similar + collections, '--list' outputs their dependencies in a similar way. - *–only-installed* + *--only-installed* If this option is given, the installation source will not be used; only locally installed packages, collections, or schemes are listed. - *–only-remote* + *--only-remote* Only list packages from the remote repository. Useful when - checking what is available in a remote repository using ‘tlmgr - --repo ... --only-remote info’. Note that ‘--only-installed’ - and ‘--only-remote’ cannot both be specified. + checking what is available in a remote repository using 'tlmgr + --repo ... --only-remote info'. Note that '--only-installed' + and '--only-remote' cannot both be specified. - *–data ‘item1,item2,...’* + *--data 'item1,item2,...'* - If the option ‘--data’ is given, its argument must be a comma - or colon separated list of field names from: ‘name’, - ‘category’, ‘localrev’, ‘remoterev’, ‘shortdesc’, ‘longdesc’, - ‘installed’, ‘size’, ‘relocatable’, ‘depends’, ‘cat-version’, - ‘cat-date’, ‘cat-license’, plus various ‘cat-contact-*’ fields + If the option '--data' is given, its argument must be a comma + or colon separated list of field names from: 'name', + 'category', 'localrev', 'remoterev', 'shortdesc', 'longdesc', + 'installed', 'size', 'relocatable', 'depends', 'cat-version', + 'cat-date', 'cat-license', plus various 'cat-contact-*' fields (see below). - The ‘cat-*’ fields all come from the TeX Catalogue + The 'cat-*' fields all come from the TeX Catalogue (<https://ctan.org/pkg/catalogue>). For each, there are two - more variants with prefix ‘l’ and ‘r’, e.g., ‘lcat-version’ - and ‘rcat-version’, which indicate the local and remote - information, respectively. The variants without ‘l’ and ‘r’ + more variants with prefix 'l' and 'r', e.g., 'lcat-version' + and 'rcat-version', which indicate the local and remote + information, respectively. The variants without 'l' and 'r' show the most current one, which is normally the remote value. - The requested packages’ information is listed in CSV format, + The requested packages' information is listed in CSV format, one package per line, and the column information is given by - the ‘itemN’. The ‘depends’ column contains the names of all - the dependencies separated by ‘:’ characters. + the 'itemN'. The 'depends' column contains the names of all + the dependencies separated by ':' characters. - At this writing, the ‘cat-contact-*’ fields include: ‘home’, - ‘repository’, ‘support’, ‘bugs’, ‘announce’, ‘development’. + At this writing, the 'cat-contact-*' fields include: 'home', + 'repository', 'support', 'bugs', 'announce', 'development'. Each may be empty or a url value. A brief description is on the CTAN upload page for new packages: <https://ctan.org/upload>. - *–json* + *--json* - In case ‘--json’ is specified, the output is a JSON encoded + In case '--json' is specified, the output is a JSON encoded array where each array element is the JSON representation of a - single ‘TLPOBJ’ but with additional information. For details - see ‘tlpkg/doc/JSON-formats.txt’, format definition: - ‘TLPOBJINFO’. If both ‘--json’ and ‘--data’ are given, - ‘--json’ takes precedence. + single 'TLPOBJ' but with additional information. For details + see 'tlpkg/doc/JSON-formats.txt', format definition: + 'TLPOBJINFO'. If both '--json' and '--data' are given, + '--json' takes precedence. File: tlbuild.info, Node: tlmgr init-usertree, Next: tlmgr install [_option_...] _pkg_..., Prev: tlmgr info, Up: tlmgr ACTIONS @@ -3653,8 +3894,8 @@ B.6.11 init-usertree -------------------- Sets up a texmf tree for so-called user mode management, either the -default user tree (‘TEXMFHOME’), or one specified on the command line -with ‘--usertree’. See *note USER MODE: tlmgr USER MODE. below. +default user tree ('TEXMFHOME'), or one specified on the command line +with '--usertree'. See *note USER MODE: tlmgr USER MODE. below. File: tlbuild.info, Node: tlmgr install [_option_...] _pkg_..., Next: tlmgr key, Prev: tlmgr init-usertree, Up: tlmgr ACTIONS @@ -3663,44 +3904,44 @@ B.6.12 install [_option_...] _pkg_... ------------------------------------- Install each _pkg_ given on the command line, if it is not already -installed. It does not touch existing packages; see the ‘update’ action +installed. It does not touch existing packages; see the 'update' action for how to get the latest version of a package. By default this also installs all packages on which the given _pkg_s are dependent. Options: -*–dry-run* +*--dry-run* Nothing is actually installed; instead, the actions to be performed are written to the terminal. -*–file* +*--file* Instead of fetching a package from the installation repository, use the package files given on the command line. These files must be standard TeX Live package files (with contained tlpobj file). -*–force* +*--force* - If updates to ‘tlmgr’ itself (or other parts of the basic - infrastructure) are present, ‘tlmgr’ will bail out and not perform + If updates to 'tlmgr' itself (or other parts of the basic + infrastructure) are present, 'tlmgr' will bail out and not perform the installation unless this option is given. Not recommended. -*–no-depends* +*--no-depends* Do not install dependencies. (By default, installing a package ensures that all dependencies of this package are fulfilled.) -*–no-depends-at-all* +*--no-depends-at-all* Normally, when you install a package which ships binary files the respective binary package will also be installed. That is, for a - package ‘foo’, the package ‘foo.i386-linux’ will also be installed - on an ‘i386-linux’ system. This option suppresses this behavior, - and also implies ‘--no-depends’. Don’t use it unless you are sure + package 'foo', the package 'foo.i386-linux' will also be installed + on an 'i386-linux' system. This option suppresses this behavior, + and also implies '--no-depends'. Don't use it unless you are sure of what you are doing. -*–reinstall* +*--reinstall* Reinstall a package (including dependencies for collections) even if it already seems to be installed (i.e, is present in the TLPDB). @@ -3710,22 +3951,22 @@ are dependent. Options: When re-installing, only dependencies on normal packages are followed (i.e., not those of category Scheme or Collection). -*–with-doc* +*--with-doc* -*–with-src* +*--with-src* - While not recommended, the ‘install-tl’ program provides an option + While not recommended, the 'install-tl' program provides an option to omit installation of all documentation and/or source files. (By default, everything is installed.) After such an installation, you may find that you want the documentation or source files for a given package after all. You can get them by using these options - in conjunction with ‘--reinstall’, as in (using the ‘fontspec’ + in conjunction with '--reinstall', as in (using the 'fontspec' package as the example): tlmgr install --reinstall --with-doc --with-src fontspec This action does not automatically add new symlinks in system -directories; you need to run ‘tlmgr path add’ (*note path: tlmgr path.) +directories; you need to run 'tlmgr path add' (*note path: tlmgr path.) yourself if you are using this feature and want new symlinks added. @@ -3740,18 +3981,18 @@ B.6.13 key *key remove _keyid_* - The action ‘key’ allows listing, adding and removing additional GPG + The action 'key' allows listing, adding and removing additional GPG keys to the set of trusted keys, that is, those that are used to verify the TeX Live databases. - With the ‘list’ argument, ‘key’ lists all keys. + With the 'list' argument, 'key' lists all keys. - The ‘add’ argument requires another argument, either a filename or - ‘-’ for stdin, from which the key is added. The key is added to - the local keyring ‘GNUPGHOME/repository-keys.gpg’, which is - normally ‘tlpkg/gpg/repository-keys.gpg’. + The 'add' argument requires another argument, either a filename or + '-' for stdin, from which the key is added. The key is added to + the local keyring 'GNUPGHOME/repository-keys.gpg', which is + normally 'tlpkg/gpg/repository-keys.gpg'. - The ‘remove’ argument requires a key id and removes the requested + The 'remove' argument requires a key id and removes the requested id from the local keyring. @@ -3768,29 +4009,29 @@ File: tlbuild.info, Node: tlmgr option, Next: tlmgr paper, Prev: tlmgr list, B.6.15 option ------------- -*option [–json] [show]* +*option [--json] [show]* -*option [–json] showall|help* +*option [--json] showall|help* *option _key_ [_value_]* - The first form, ‘show’, shows the global TeX Live settings currently -saved in the TLPDB with a short description and the ‘key’ used for + The first form, 'show', shows the global TeX Live settings currently +saved in the TLPDB with a short description and the 'key' used for changing it in parentheses. - The second form, ‘showall’, is similar, but also shows options which -can be defined but are not currently set to any value (‘help’ is a + The second form, 'showall', is similar, but also shows options which +can be defined but are not currently set to any value ('help' is a synonym). - Both ‘show...’ forms take an option ‘--json’, which dumps the option + Both 'show...' forms take an option '--json', which dumps the option information in JSON format. In this case, both forms dump the same data. For the format of the JSON output see -‘tlpkg/doc/JSON-formats.txt’, format definition ‘TLOPTION’. +'tlpkg/doc/JSON-formats.txt', format definition 'TLOPTION'. In the third form, with _key_, if _value_ is not given, the setting for _key_ is displayed. If _value_ is present, _key_ is set to _value_. - Possible values for _key_ are (run ‘tlmgr option showall’ for the + Possible values for _key_ are (run 'tlmgr option showall' for the definitive list): repository (default package repository), @@ -3807,64 +4048,64 @@ definitive list): fileassocs (Windows-only: change file associations) multiuser (Windows-only: install for all users) - One common use of ‘option’ is to permanently change the installation + One common use of 'option' is to permanently change the installation to get further updates from the Internet, after originally installing from DVD. To do this, you can run tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet - The ‘install-tl’ documentation has more information about the -possible values for ‘repository’. (For backward compatibility, -‘location’ can be used as a synonym for ‘repository’.) + The 'install-tl' documentation has more information about the +possible values for 'repository'. (For backward compatibility, +'location' can be used as a synonym for 'repository'.) - If ‘formats’ is set (this is the default), then formats are + If 'formats' is set (this is the default), then formats are regenerated when either the engine or the format files have changed. Disable this only when you know how and want to regenerate formats yourself whenever needed (which is often, in practice). - The ‘postcode’ option controls execution of per-package + The 'postcode' option controls execution of per-package postinstallation action code. It is set by default, and again disabling is not likely to be of interest except to developers doing debugging. - The ‘docfiles’ and ‘srcfiles’ options control the installation of + The 'docfiles' and 'srcfiles' options control the installation of their respective file groups (documentation, sources; grouping is approximate) per package. By default both are enabled (1). Either or both can be disabled (set to 0) if disk space is limited or for minimal testing installations, etc. When disabled, the respective files are not downloaded at all. - The options ‘autobackup’ and ‘backupdir’ determine the defaults for -the actions ‘update’, ‘backup’ and ‘restore’. These three actions need -a directory in which to read or write the backups. If ‘--backupdir’ is -not specified on the command line, the ‘backupdir’ option value is used -(if set). The TL installer sets ‘backupdir’ to ‘.../tlpkg/backups’, + The options 'autobackup' and 'backupdir' determine the defaults for +the actions 'update', 'backup' and 'restore'. These three actions need +a directory in which to read or write the backups. If '--backupdir' is +not specified on the command line, the 'backupdir' option value is used +(if set). The TL installer sets 'backupdir' to '.../tlpkg/backups', under the TL root installation directory. - The ‘autobackup’ option (de)activates automatic generation of -backups. Its value is an integer. If the ‘autobackup’ value is ‘-1’, -no backups are removed. If ‘autobackup’ is 0 or more, it specifies the + The 'autobackup' option (de)activates automatic generation of +backups. Its value is an integer. If the 'autobackup' value is '-1', +no backups are removed. If 'autobackup' is 0 or more, it specifies the number of backups to keep. Thus, backups are disabled if the value is -0. In the ‘--clean’ mode of the ‘backup’ action this option also +0. In the '--clean' mode of the 'backup' action this option also specifies the number to be kept. The default value is 1, so that backups are made, but only one backup is kept. - To setup ‘autobackup’ to ‘-1’ on the command line, use: + To setup 'autobackup' to '-1' on the command line, use: tlmgr option -- autobackup -1 - The ‘--’ avoids having the ‘-1’ treated as an option. (The ‘--’ + The '--' avoids having the '-1' treated as an option. (The '--' stops parsing for options at the point where it appears; this is a general feature across most Unix programs.) - The ‘sys_bin’, ‘sys_man’, and ‘sys_info’ options are used on Unix + The 'sys_bin', 'sys_man', and 'sys_info' options are used on Unix systems to control the generation of links for executables, Info files -and man pages. See the ‘path’ action for details. +and man pages. See the 'path' action for details. The last three options affect behavior on Windows installations. If -‘desktop_integration’ is set, then some packages will install items in a -sub-folder of the Start menu for ‘tlmgr gui’, documentation, etc. If -‘fileassocs’ is set, Windows file associations are made (see also the -‘postaction’ action). Finally, if ‘multiuser’ is set, then adaptions to +'desktop_integration' is set, then some packages will install items in a +sub-folder of the Start menu for 'tlmgr gui', documentation, etc. If +'fileassocs' is set, Windows file associations are made (see also the +'postaction' action). Finally, if 'multiuser' is set, then adaptions to the registry and the menus are done for all users on the system instead of only the current user. All three options are on by default. @@ -3876,36 +4117,36 @@ B.6.16 paper *paper [a4|letter]* -*<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|–list]*> +*<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*> -*paper –json* +*paper --json* - With no arguments (‘tlmgr paper’), shows the default paper size + With no arguments ('tlmgr paper'), shows the default paper size setting for all known programs. - With one argument (e.g., ‘tlmgr paper a4’), sets the default for all + With one argument (e.g., 'tlmgr paper a4'), sets the default for all known programs to that paper size. With a program given as the first argument and no paper size -specified (e.g., ‘tlmgr dvips paper’), shows the default paper size for +specified (e.g., 'tlmgr dvips paper'), shows the default paper size for that program. With a program given as the first argument and a paper size as the -last argument (e.g., ‘tlmgr dvips paper a4’), set the default for that +last argument (e.g., 'tlmgr dvips paper a4'), set the default for that program to that paper size. - With a program given as the first argument and ‘--list’ given as the -last argument (e.g., ‘tlmgr dvips paper --list’), shows all valid paper + With a program given as the first argument and '--list' given as the +last argument (e.g., 'tlmgr dvips paper --list'), shows all valid paper sizes for that program. The first size shown is the default. - If ‘--json’ is specified without other options, the paper setup is + If '--json' is specified without other options, the paper setup is dumped in JSON format. For the format of JSON output see -‘tlpkg/doc/JSON-formats.txt’, format definition ‘TLPAPER’. +'tlpkg/doc/JSON-formats.txt', format definition 'TLPAPER'. Incidentally, this syntax of having a specific program name before -the ‘paper’ keyword is unusual. It is inherited from the longstanding -‘texconfig’ script, which supports other configuration settings for some -programs, notably ‘dvips’. ‘tlmgr’ does not support those extra +the 'paper' keyword is unusual. It is inherited from the longstanding +'texconfig' script, which supports other configuration settings for some +programs, notably 'dvips'. 'tlmgr' does not support those extra settings. @@ -3914,9 +4155,9 @@ File: tlbuild.info, Node: tlmgr path, Next: tlmgr pinning, Prev: tlmgr paper, B.6.17 path ----------- -*path [–w32mode=user|admin] add* +*path [--w32mode=user|admin] add* -*path [–w32mode=user|admin] remove* +*path [--w32mode=user|admin] remove* On Unix, adds or removes symlinks for executables, man pages, and info pages in the system directories specified by the respective @@ -3929,22 +4170,22 @@ B.6.17 path On Windows, the registry part where the binary directory is added or removed is determined in the following way: - If the user has admin rights, and the option ‘--w32mode’ is not + If the user has admin rights, and the option '--w32mode' is not given, the setting _w32_multi_user_ determines the location (i.e., if it is on then the system path, otherwise the user path is changed). - If the user has admin rights, and the option ‘--w32mode’ is given, + If the user has admin rights, and the option '--w32mode' is given, this option determines the path to be adjusted. - If the user does not have admin rights, and the option ‘--w32mode’ + If the user does not have admin rights, and the option '--w32mode' is not given, and the setting _w32_multi_user_ is off, the user path is changed, while if the setting _w32_multi_user_ is on, a warning is issued that the caller does not have enough privileges. - If the user does not have admin rights, and the option ‘--w32mode’ - is given, it must be ‘user’ and the user path will be adjusted. If - a user without admin rights uses the option ‘--w32mode admin’ a + If the user does not have admin rights, and the option '--w32mode' + is given, it must be 'user' and the user path will be adjusted. If + a user without admin rights uses the option '--w32mode admin' a warning is issued that the caller does not have enough privileges. @@ -3953,24 +4194,24 @@ File: tlbuild.info, Node: tlmgr pinning, Next: tlmgr platform, Prev: tlmgr pa B.6.18 pinning -------------- -The ‘pinning’ action manages the pinning file, see *note Pinning: tlmgr +The 'pinning' action manages the pinning file, see *note Pinning: tlmgr Pinning. below. -‘pinning show’ +'pinning show' Shows the current pinning data. -‘pinning add’ _repo_ _pkgglob_... +'pinning add' _repo_ _pkgglob_... Pins the packages matching the _pkgglob_(s) to the repository _repo_. -‘pinning remove’ _repo_ _pkgglob_... +'pinning remove' _repo_ _pkgglob_... Any packages recorded in the pinning file matching the <pkgglob>s for the given repository _repo_ are removed. -‘pinning remove _repo_ --all’ +'pinning remove _repo_ --all' Remove all pinning data for repository _repo_. @@ -3986,31 +4227,31 @@ B.6.19 platform *platform set auto* - ‘platform list’ lists the TeX Live names of all the platforms - (a.k.a. architectures), (‘i386-linux’, ...) available at the + 'platform list' lists the TeX Live names of all the platforms + (a.k.a. architectures), ('i386-linux', ...) available at the package repository. - ‘platform add’ _platform_... adds the executables for each given + 'platform add' _platform_... adds the executables for each given platform _platform_ to the installation from the repository. - ‘platform remove’ _platform_... removes the executables for each + 'platform remove' _platform_... removes the executables for each given platform _platform_ from the installation, but keeps the currently running platform in any case. - ‘platform set’ _platform_ switches TeX Live to always use the given + 'platform set' _platform_ switches TeX Live to always use the given platform instead of auto detection. - ‘platform set auto’ switches TeX Live to auto detection mode for + 'platform set auto' switches TeX Live to auto detection mode for platform. - Platform detection is needed to select the proper ‘xz’ and ‘wget’ + Platform detection is needed to select the proper 'xz' and 'wget' binaries that are shipped with TeX Live. - ‘arch’ is a synonym for ‘platform’. + 'arch' is a synonym for 'platform'. Options: - *–dry-run* + *--dry-run* Nothing is actually installed; instead, the actions to be performed are written to the terminal. @@ -4025,30 +4266,30 @@ B.6.20 postaction *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]* - Carry out the postaction ‘shortcut’, ‘fileassoc’, or ‘script’ given + Carry out the postaction 'shortcut', 'fileassoc', or 'script' given as the second required argument in install or remove mode (which is the first required argument), for either the packages given on the - command line, or for all if ‘--all’ is given. + command line, or for all if '--all' is given. Options: - *–w32mode=[user|admin]* + *--w32mode=[user|admin]* - If the option ‘--w32mode’ is given the value ‘user’, all + If the option '--w32mode' is given the value 'user', all actions will only be carried out in the user-accessible parts - of the registry/filesystem, while the value ‘admin’ selects + of the registry/filesystem, while the value 'admin' selects the system-wide parts of the registry for the file associations. If you do not have enough permissions, using - ‘--w32mode=admin’ will not succeed. + '--w32mode=admin' will not succeed. - *–fileassocmode=[1|2]* + *--fileassocmode=[1|2]* - ‘--fileassocmode’ specifies the action for file associations. + '--fileassocmode' specifies the action for file associations. If it is set to 1 (the default), only new associations are added; if it is set to 2, all associations are set to the TeX - Live programs. (See also ‘option fileassocs’.) + Live programs. (See also 'option fileassocs'.) - *–all* + *--all* Carry out the postactions for all packages @@ -4060,7 +4301,7 @@ B.6.21 print-platform Print the TeX Live identifier for the detected platform (hardware/operating system) combination to standard output, and exit. -‘--print-arch’ is a synonym. +'--print-arch' is a synonym. File: tlbuild.info, Node: tlmgr print-platform-info, Next: tlmgr remove [_option_...] _pkg_..., Prev: tlmgr print-platform, Up: tlmgr ACTIONS @@ -4078,21 +4319,21 @@ B.6.23 remove [_option_...] _pkg_... ------------------------------------ Remove each _pkg_ specified. Removing a collection removes all package -dependencies (unless ‘--no-depends’ is specified), but not any +dependencies (unless '--no-depends' is specified), but not any collection dependencies of that collection. However, when removing a package, dependencies are never removed. Options: -*–all* +*--all* Uninstalls all of TeX Live, asking for confirmation unless - ‘--force’ is also specified. + '--force' is also specified. -*–backup* +*--backup* -*–backupdir* _directory_ +*--backupdir* _directory_ - These options behave just as with the *note update: (update)tlmgr - update [_option_...] [...]. action (q.v.), except they apply to + These options behave just as with the *note update: tlmgr update + [_option_...] [_pkg_...]. action (q.v.), except they apply to making backups of packages before they are removed. The default is to make such a backup, that is, to save a copy of packages before removal. @@ -4100,34 +4341,34 @@ package, dependencies are never removed. Options: The *note restore: tlmgr restore. action explains how to restore from a backup. -*–no-depends* +*--no-depends* Do not remove dependent packages. -*–no-depends-at-all* +*--no-depends-at-all* See above under *note install: tlmgr install [_option_...] _pkg_.... (and beware). -*–force* +*--force* By default, removal of a package or collection that is a dependency of another collection or scheme is not allowed. With this option, the package will be removed unconditionally. Use with care. - A package that has been removed using the ‘--force’ option because + A package that has been removed using the '--force' option because it is still listed in an installed collection or scheme will not be - updated, and will be mentioned as ‘forcibly removed’ in the output - of ‘tlmgr update --list’. + updated, and will be mentioned as 'forcibly removed' in the output + of 'tlmgr update --list'. -*–dry-run* +*--dry-run* Nothing is actually removed; instead, the actions to be performed are written to the terminal. - Except with ‘--all’, this ‘remove’ action does not automatically + Except with '--all', this 'remove' action does not automatically remove symlinks to executables from system directories; you need to run -‘tlmgr path remove’ (*note path: tlmgr path.) yourself if you remove an +'tlmgr path remove' (*note path: tlmgr path.) yourself if you remove an individual package with a symlink in a system directory. @@ -4151,24 +4392,24 @@ B.6.24 repository This action manages the list of repositories. See *note (MULTIPLE_REPOSITORIES):: below for detailed explanations. - The first form, ‘repository list’, lists all configured + The first form, 'repository list', lists all configured repositories and the respective tags if set. If a path, url, or - tag is given after the ‘list’ keyword, it is interpreted as the + tag is given after the 'list' keyword, it is interpreted as the source from which to initialize a TL database and lists the contained packages. This can also be an otherwise-unused repository, either local or remote. If the option - ‘--with-platforms’ is specified in addition, for each package the + '--with-platforms' is specified in addition, for each package the available platforms (if any) are also listed. - The form ‘repository add’ adds a repository (optionally attaching a - tag) to the list of repositories, while ‘repository remove’ removes + The form 'repository add' adds a repository (optionally attaching a + tag) to the list of repositories, while 'repository remove' removes a repository, either by full path/url, or by tag. - The form ‘repository set’ sets the list of available repositories + The form 'repository set' sets the list of available repositories to the items given on the command line, overwriting previous settings. - The form ‘repository status’ reports the verification status of the + The form 'repository status' reports the verification status of the loaded repositories with the format of one repository per line with fields separated by a single space: @@ -4185,7 +4426,7 @@ B.6.24 repository That is, in normal (not machine-readable) output, the third field (numeric verification status) is not present. - In all cases, one of the repositories must be tagged as ‘main’; + In all cases, one of the repositories must be tagged as 'main'; otherwise, all operations will fail! @@ -4196,18 +4437,18 @@ B.6.25 restore *restore [_option_...] _pkg_ [_rev_]* -*restore [_option_...] –all* +*restore [_option_...] --all* Restore a package from a previously-made backup. - If ‘--all’ is given, try to restore the latest revision of all + If '--all' is given, try to restore the latest revision of all package backups found in the backup directory. Otherwise, if neither _pkg_ nor _rev_ are given, list the available backup revisions for all packages. With _pkg_ given but no _rev_, list all available backup revisions of _pkg_. - When listing available packages, ‘tlmgr’ shows the revision, and in + When listing available packages, 'tlmgr' shows the revision, and in parenthesis the creation time if available (in format yyyy-mm-dd hh:mm). @@ -4216,34 +4457,34 @@ B.6.25 restore Options: - *–all* + *--all* Try to restore the latest revision of all package backups found in the backup directory. Additional non-option arguments (like _pkg_) are not allowed. - *–backupdir* _directory_ + *--backupdir* _directory_ Specify the directory where the backups are to be found. If not given it will be taken from the configuration setting in the TLPDB. - *–dry-run* + *--dry-run* Nothing is actually restored; instead, the actions to be performed are written to the terminal. - *–force* + *--force* - Don’t ask questions. + Don't ask questions. - *–json* + *--json* - When listing backups, the option ‘--json’ turn on JSON output. - The format is an array of JSON objects (‘name’, ‘rev’, - ‘date’). For details see ‘tlpkg/doc/JSON-formats.txt’, format - definition: ‘TLBACKUPS’. If both ‘--json’ and ‘--data’ are - given, ‘--json’ takes precedence. + When listing backups, the option '--json' turn on JSON output. + The format is an array of JSON objects ('name', 'rev', + 'date'). For details see 'tlpkg/doc/JSON-formats.txt', format + definition: 'TLBACKUPS'. If both '--json' and '--data' are + given, '--json' takes precedence. File: tlbuild.info, Node: tlmgr search, Next: tlmgr shell, Prev: tlmgr restore, Up: tlmgr ACTIONS @@ -4253,9 +4494,9 @@ B.6.26 search *search [_option_...] _what_* -*search [_option_...] –file _what_* +*search [_option_...] --file _what_* -*search [_option_...] –all _what_* +*search [_option_...] --all _what_* By default, search the names, short descriptions, and long descriptions of all locally installed packages for the argument @@ -4263,26 +4504,26 @@ B.6.26 search Options: - *–file* + *--file* List all filenames containing _what_. - *–all* + *--all* Search everything: package names, descriptions and filenames. - *–global* + *--global* Search the TeX Live Database of the installation medium, instead of the local installation. - *–word* + *--word* Restrict the search of package names and descriptions (but not filenames) to match only full words. For example, searching - for ‘table’ with this option will not output packages - containing the word ‘tables’ (unless they also contain the - word ‘table’ on its own). + for 'table' with this option will not output packages + containing the word 'tables' (unless they also contain the + word 'table' on its own). File: tlbuild.info, Node: tlmgr shell, Next: tlmgr show, Prev: tlmgr search, Up: tlmgr ACTIONS @@ -4292,12 +4533,12 @@ B.6.27 shell Starts an interactive mode, where tlmgr prompts for commands. This can be used directly, or for scripting. The first line of output is -‘protocol’ _n_, where _n_ is an unsigned number identifying the protocol +'protocol' _n_, where _n_ is an unsigned number identifying the protocol version (currently 1). In general, tlmgr actions that can be given on the command line translate to commands in this shell mode. For example, you can say -‘update --list’ to see what would be updated. The TLPDB is loaded the +'update --list' to see what would be updated. The TLPDB is loaded the first time it is needed (not at the beginning), and used for the rest of the session. @@ -4305,7 +4546,7 @@ the session. protocol - Print ‘protocol _n_’, the current protocol version. + Print 'protocol _n_', the current protocol version. help @@ -4321,8 +4562,8 @@ quit, end, bye, byebye, EOF restart - Restart ‘tlmgr shell’ with the original command line; most useful - when developing ‘tlmgr’. + Restart 'tlmgr shell' with the original command line; most useful + when developing 'tlmgr'. load [local|remote] @@ -4336,12 +4577,12 @@ save get [_var_] =item set [_var_ [_val_]] Get the value of _var_, or set it to _val_. Possible _var_ names: - ‘debug-translation’, ‘machine-readable’, ‘no-execute-actions’, - ‘require-verification’, ‘verify-downloads’, ‘repository’, and - ‘prompt’. All except ‘repository’ and ‘prompt’ are booleans, + 'debug-translation', 'machine-readable', 'no-execute-actions', + 'require-verification', 'verify-downloads', 'repository', and + 'prompt'. All except 'repository' and 'prompt' are booleans, taking values 0 and 1, and behave like the corresponding command - line option. The ‘repository’ variable takes a string, and sets - the remote repository location. The ‘prompt’ variable takes a + line option. The 'repository' variable takes a string, and sets + the remote repository location. The 'prompt' variable takes a string, and sets the current default prompt. If _var_ or then _val_ is not specified, it is prompted for. @@ -4369,14 +4610,14 @@ B.6.30 update [_option_...] [_pkg_...] -------------------------------------- Updates the packages given as arguments to the latest version available -at the installation source. Either ‘--all’ or at least one _pkg_ name +at the installation source. Either '--all' or at least one _pkg_ name must be specified. Options: -*–all* +*--all* - Update all installed packages except for ‘tlmgr’ itself. If - updates to ‘tlmgr’ itself are present, this gives an error, unless - also the option ‘--force’ or ‘--self’ is given. (See below.) + Update all installed packages except for 'tlmgr' itself. If + updates to 'tlmgr' itself are present, this gives an error, unless + also the option '--force' or '--self' is given. (See below.) In addition to updating the installed packages, during the update of a collection the local installation is (by default) synchronized @@ -4384,45 +4625,45 @@ must be specified. Options: and removals. This means that if a package has been removed on the server (and - thus has also been removed from the respective collection), ‘tlmgr’ + thus has also been removed from the respective collection), 'tlmgr' will remove the package in the local installation. This is called - “auto-remove” and is announced as such when using the option - ‘--list’. This auto-removal can be suppressed using the option - ‘--no-auto-remove’ (not recommended, see option description). + "auto-remove" and is announced as such when using the option + '--list'. This auto-removal can be suppressed using the option + '--no-auto-remove' (not recommended, see option description). Analogously, if a package has been added to a collection on the server that is also installed locally, it will be added to the - local installation. This is called “auto-install” and is announced - as such when using the option ‘--list’. This auto-installation can - be suppressed using the option ‘--no-auto-install’ (also not + local installation. This is called "auto-install" and is announced + as such when using the option '--list'. This auto-installation can + be suppressed using the option '--no-auto-install' (also not recommended). An exception to the collection dependency checks (including the auto-installation of packages just mentioned) are those that have - been “forcibly removed” by you, that is, you called ‘tlmgr remove - --force’ on them. (See the ‘remove’ action documentation.) To + been "forcibly removed" by you, that is, you called 'tlmgr remove + --force' on them. (See the 'remove' action documentation.) To reinstall any such forcibly removed packages use - ‘--reinstall-forcibly-removed’. + '--reinstall-forcibly-removed'. To reiterate: automatic removals and additions are entirely determined by comparison of collections. Thus, if you manually - install an individual package ‘foo’ which is later removed from the - server, ‘tlmgr’ will not notice and will not remove it locally. + install an individual package 'foo' which is later removed from the + server, 'tlmgr' will not notice and will not remove it locally. (It has to be this way, without major rearchitecture work, because the tlpdb does not record the repository from which packages come from.) If you want to exclude some packages from the current update run - (e.g., due to a slow link), see the ‘--exclude’ option below. + (e.g., due to a slow link), see the '--exclude' option below. -*–self* +*--self* - Update ‘tlmgr’ itself (that is, the infrastructure packages) if + Update 'tlmgr' itself (that is, the infrastructure packages) if updates to it are present. On Windows this includes updates to the private Perl interpreter shipped inside TeX Live. - If this option is given together with either ‘--all’ or a list of - packages, then ‘tlmgr’ will be updated first and, if this update + If this option is given together with either '--all' or a list of + packages, then 'tlmgr' will be updated first and, if this update succeeds, the new version will be restarted to complete the rest of the updates. @@ -4433,26 +4674,26 @@ must be specified. Options: tlmgr update --force --all # update all packages but *not* infrastructure # ... this last at your own risk, not recommended! -*–dry-run* +*--dry-run* Nothing is actually installed; instead, the actions to be performed are written to the terminal. This is a more detailed report than - ‘--list’. + '--list'. -*–list* [_pkg_] +*--list* [_pkg_] Concisely list the packages which would be updated, newly installed, or removed, without actually changing anything. If - ‘--all’ is also given, all available updates are listed. If - ‘--self’ is given, but not ‘--all’, only updates to the critical + '--all' is also given, all available updates are listed. If + '--self' is given, but not '--all', only updates to the critical packages (tlmgr, texlive infrastructure, perl on Windows, etc.) - are listed. If neither ‘--all’ nor ‘--self’ is given, and in - addition no _pkg_ is given, then ‘--all’ is assumed (thus, ‘tlmgr - update --list’ is the same as ‘tlmgr update --list --all’). If - neither ‘--all’ nor ‘--self’ is given, but specific package names + are listed. If neither '--all' nor '--self' is given, and in + addition no _pkg_ is given, then '--all' is assumed (thus, 'tlmgr + update --list' is the same as 'tlmgr update --list --all'). If + neither '--all' nor '--self' is given, but specific package names are given, those packages are checked for updates. -*–exclude* _pkg_ +*--exclude* _pkg_ Exclude _pkg_ from the update process. If this option is given more than once, its arguments accumulate. @@ -4462,37 +4703,37 @@ must be specified. Options: tlmgr update --all --exclude a2ping - will not update ‘a2ping’, ‘a2ping.i386-linux’, or any other - ‘a2ping.’_ARCH_ package. + will not update 'a2ping', 'a2ping.i386-linux', or any other + 'a2ping.'_ARCH_ package. If this option specifies a package that would otherwise be a candidate for auto-installation, auto-removal, or reinstallation of - a forcibly removed package, ‘tlmgr’ quits with an error message. + a forcibly removed package, 'tlmgr' quits with an error message. Excludes are not supported in these circumstances. This option can also be set permanently in the tlmgr config file - with the key ‘update-exclude’. + with the key 'update-exclude'. -*–no-auto-remove* [_pkg_...] +*--no-auto-remove* [_pkg_...] - By default, ‘tlmgr’ tries to remove packages in an existing + By default, 'tlmgr' tries to remove packages in an existing collection which have disappeared on the server, as described above - under ‘--all’. This option prevents such removals, either for all - packages (with ‘--all’), or for just the given _pkg_ names. This + under '--all'. This option prevents such removals, either for all + packages (with '--all'), or for just the given _pkg_ names. This can lead to an inconsistent TeX installation, since packages are not infrequently renamed or replaced by their authors. Therefore this is not recommended. -*–no-auto-install* [_pkg_...] +*--no-auto-install* [_pkg_...] - Under normal circumstances ‘tlmgr’ will install packages which are - new on the server, as described above under ‘--all’. This option + Under normal circumstances 'tlmgr' will install packages which are + new on the server, as described above under '--all'. This option prevents any such automatic installation, either for all packages - (with ‘--all’), or the given _pkg_ names. + (with '--all'), or the given _pkg_ names. - Furthermore, after the ‘tlmgr’ run using this has finished, the + Furthermore, after the 'tlmgr' run using this has finished, the packages that would have been auto-installed _will be considered as - forcibly removed_. So, if ‘foobar’ is the only new package on the + forcibly removed_. So, if 'foobar' is the only new package on the server, then tlmgr update --all --no-auto-install @@ -4505,29 +4746,29 @@ must be specified. Options: Again, since packages are sometimes renamed or replaced, using this option is not recommended. -*–reinstall-forcibly-removed* +*--reinstall-forcibly-removed* - Under normal circumstances ‘tlmgr’ will not install packages that + Under normal circumstances 'tlmgr' will not install packages that have been forcibly removed by the user; that is, removed with - ‘remove --force’, or whose installation was prohibited by - ‘--no-auto-install’ during an earlier update. + 'remove --force', or whose installation was prohibited by + '--no-auto-install' during an earlier update. - This option makes ‘tlmgr’ ignore the forcible removals and + This option makes 'tlmgr' ignore the forcible removals and re-install all such packages. This can be used to completely - synchronize an installation with the server’s idea of what is + synchronize an installation with the server's idea of what is available: tlmgr update --reinstall-forcibly-removed --all -*–backup* +*--backup* -*–backupdir* _directory_ +*--backupdir* _directory_ These two options control the creation of backups of packages _before_ updating; that is, backing up packages as currently installed. If neither option is given, no backup will made. If - ‘--backupdir’ is given and specifies a writable directory then a - backup will be made in that location. If only ‘--backup’ is given, + '--backupdir' is given and specifies a writable directory then a + backup will be made in that location. If only '--backup' is given, then a backup will be made to the directory previously set via the *note option: tlmgr option. action (see below). If both are given then a backup will be made to the specified _directory_. @@ -4536,47 +4777,47 @@ must be specified. Options: to automatically make backups for all packages, and/or keep only a certain number of backups. - ‘tlmgr’ always makes a temporary backup when updating packages, in + 'tlmgr' always makes a temporary backup when updating packages, in case of download or other failure during an update. In contrast, - the purpose of this ‘--backup’ option is to save a persistent + the purpose of this '--backup' option is to save a persistent backup in case the actual _content_ of the update causes problems, e.g., introduces an TeX incompatibility. The *note restore: tlmgr restore. action explains how to restore from a backup. -*–no-depends* +*--no-depends* If you call for updating a package normally all depending packages will also be checked for updates and updated if necessary. This switch suppresses this behavior. -*–no-depends-at-all* +*--no-depends-at-all* See above under *note install: tlmgr install [_option_...] _pkg_.... (and beware). -*–force* +*--force* - Force update of normal packages, without updating ‘tlmgr’ itself - (unless the ‘--self’ option is also given). Not recommended. + Force update of normal packages, without updating 'tlmgr' itself + (unless the '--self' option is also given). Not recommended. - Also, ‘update --list’ is still performed regardless of this option. + Also, 'update --list' is still performed regardless of this option. If the package on the server is older than the package already -installed (e.g., if the selected mirror is out of date), ‘tlmgr’ does +installed (e.g., if the selected mirror is out of date), 'tlmgr' does not downgrade. Also, packages for uninstalled platforms are not installed. - ‘tlmgr’ saves one copy of the main ‘texlive.tlpdb’ file used for an + 'tlmgr' saves one copy of the main 'texlive.tlpdb' file used for an update with a suffix representing the repository url, as in -‘tlpkg/texlive.tlpdb.main.’_long-hash-string_. Thus, even when many -mirrors are used, only one main ‘tlpdb’ backup is kept. For non-main +'tlpkg/texlive.tlpdb.main.'_long-hash-string_. Thus, even when many +mirrors are used, only one main 'tlpdb' backup is kept. For non-main repositories, which do not generally have (m)any mirrors, no pruning of backups is done. This action does not automatically add or remove new symlinks in -system directories; you need to run ‘tlmgr’ *note path: tlmgr path. +system directories; you need to run 'tlmgr' *note path: tlmgr path. yourself if you are using this feature and want new symlinks added. @@ -4585,11 +4826,11 @@ File: tlbuild.info, Node: tlmgr CONFIGURATION FILE FOR TLMGR, Next: tlmgr CRYP B.7 CONFIGURATION FILE FOR TLMGR ================================ -‘tlmgr’ reads two configuration files: one is system-wide, in -‘TEXMFSYSCONFIG/tlmgr/config’, and the other is user-specific, in -‘TEXMFCONFIG/tlmgr/config’. The user-specific one is the default for -the ‘conf tlmgr’ action. (Run ‘kpsewhich -var-value=TEXMFSYSCONFIG’ or -‘... TEXMFCONFIG ...’ to see the actual directory names.) +'tlmgr' reads two configuration files: one is system-wide, in +'TEXMFSYSCONFIG/tlmgr/config', and the other is user-specific, in +'TEXMFCONFIG/tlmgr/config'. The user-specific one is the default for +the 'conf tlmgr' action. (Run 'kpsewhich -var-value=TEXMFSYSCONFIG' or +'... TEXMFCONFIG ...' to see the actual directory names.) A few defaults corresponding to command-line options can be set in these configuration files. In addition, the system-wide file can @@ -4600,43 +4841,43 @@ ignored. All other lines must look like: key = value - where the spaces are optional but the ‘=’ is required. + where the spaces are optional but the '=' is required. The allowed keys are: -‘auto-remove =’ 0 or 1 (default 1), same as command-line option. +'auto-remove =' 0 or 1 (default 1), same as command-line option. -‘gui-expertmode =’ 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings. +'gui-expertmode =' 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings. -‘gui-lang =’ _llcode_, with a language code value as with the command-line option. +'gui-lang =' _llcode_, with a language code value as with the command-line option. -‘no-checksums =’ 0 or 1 (default 0, see below). +'no-checksums =' 0 or 1 (default 0, see below). -‘persistent-downloads =’ 0 or 1 (default 1), same as command-line option. +'persistent-downloads =' 0 or 1 (default 1), same as command-line option. -‘require-verification =’ 0 or 1 (default 0), same as command-line option. +'require-verification =' 0 or 1 (default 0), same as command-line option. -‘tkfontscale =’ _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends. +'tkfontscale =' _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends. -‘update-exclude =’ _comma-separated list of packages_ (no spaces allowed). Same as the command line option ‘--exclude’ for the ‘update’ action. +'update-exclude =' _comma-separated list of packages_ (no spaces allowed). Same as the command line option '--exclude' for the 'update' action. -‘verify-downloads =’ 0 or 1 (default 1), same as command-line option. +'verify-downloads =' 0 or 1 (default 1), same as command-line option. The system-wide config file can contain one additional key: -‘allowed-actions =’ _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of ‘tlmgr’ actions which are allowed to be executed when ‘tlmgr’ is invoked in system mode (that is, without ‘--usermode’). This allows distributors to include ‘tlmgr’ in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn’t make sense to set this. +'allowed-actions =' _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of 'tlmgr' actions which are allowed to be executed when 'tlmgr' is invoked in system mode (that is, without '--usermode'). This allows distributors to include 'tlmgr' in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this. - Finally, the ‘no-checksums’ key needs more explanation. By default, + Finally, the 'no-checksums' key needs more explanation. By default, package checksums computed and stored on the server (in the TLPDB) are compared to checksums computed locally after downloading. -‘no-checksums’ disables this process. The checksum algorithm is +'no-checksums' disables this process. The checksum algorithm is SHA-512. Your system must have one of (looked for in this order) the -Perl ‘Digest::SHA’ module, the ‘openssl’ program -(<https://openssl.org>), the ‘sha512sum’ program (from GNU Coreutils, -<https://www.gnu.org/software/coreutils>), or finally the ‘shasum’ +Perl 'Digest::SHA' module, the 'openssl' program +(<https://openssl.org>), the 'sha512sum' program (from GNU Coreutils, +<https://www.gnu.org/software/coreutils>), or finally the 'shasum' program (just to support old Macs). If none of these are available, a -warning is issued and ‘tlmgr’ proceeds without checking checksums. -‘no-checksums’ avoids the warning. (Incidentally, other SHA +warning is issued and 'tlmgr' proceeds without checking checksums. +'no-checksums' avoids the warning. (Incidentally, other SHA implementations, such as the pure Perl and pure Lua modules, are much too slow to be usable in our context.) @@ -4646,41 +4887,41 @@ File: tlbuild.info, Node: tlmgr CRYPTOGRAPHIC VERIFICATION, Next: tlmgr USER M B.8 CRYPTOGRAPHIC VERIFICATION ============================== -‘tlmgr’ and ‘install-tl’ perform cryptographic verification if possible. +'tlmgr' and 'install-tl' perform cryptographic verification if possible. If verification is performed and successful, the programs report -‘(verified)’ after loading the TLPDB; otherwise, they report ‘(not -verified)’. But either way, by default the installation and/or updates +'(verified)' after loading the TLPDB; otherwise, they report '(not +verified)'. But either way, by default the installation and/or updates proceed normally. - If a program named ‘gpg’ is available (that is, found in ‘PATH’), by + If a program named 'gpg' is available (that is, found in 'PATH'), by default cryptographic signatures will be checked: we require the main -repository be signed, but not any additional repositories. If ‘gpg’ is +repository be signed, but not any additional repositories. If 'gpg' is not available, by default signatures are not checked and no verification -is carried out, but ‘tlmgr’ still proceeds normally. +is carried out, but 'tlmgr' still proceeds normally. The behavior of the verification can be controlled by the command -line and config file option ‘verify-repo’ which takes one of the -following values: ‘none’, ‘main’, or ‘all’. With ‘none’, no -verification whatsoever is attempted. With ‘main’ (the default) -verification is required only for the main repository, and only if ‘gpg’ +line and config file option 'verify-repo' which takes one of the +following values: 'none', 'main', or 'all'. With 'none', no +verification whatsoever is attempted. With 'main' (the default) +verification is required only for the main repository, and only if 'gpg' is available; though attempted for all, missing signatures of subsidiary repositories will not result in an error. Finally, in the case of -‘all’, ‘gpg’ must be available and all repositories need to be signed. +'all', 'gpg' must be available and all repositories need to be signed. In all cases, if a signature is checked and fails to verify, an error is raised. Cryptographic verification requires checksum checking (described just -above) to succeed, and a working GnuPG (‘gpg’) program (see below for +above) to succeed, and a working GnuPG ('gpg') program (see below for search method). Then, unless cryptographic verification has been -disabled, a signature file (‘texlive.tlpdb.*.asc’) of the checksum file +disabled, a signature file ('texlive.tlpdb.*.asc') of the checksum file is downloaded and the signature verified. The signature is created by the TeX Live Distribution GPG key 0x0D5E5D9106BAB6BC, which in turn is -signed by Karl Berry’s key 0x0716748A30D155AD and Norbert Preining’s key +signed by Karl Berry's key 0x0716748A30D155AD and Norbert Preining's key 0x6CACA448860CDC13. All of these keys are obtainable from the standard key servers. - Additional trusted keys can be added using the ‘key’ action. + Additional trusted keys can be added using the 'key' action. * Menu: @@ -4693,13 +4934,13 @@ B.8.1 Configuration of GnuPG invocation --------------------------------------- The executable used for GnuPG is searched as follows: If the environment -variable ‘TL_GNUPG’ is set, it is tested and used; otherwise ‘gpg’ is -checked; finally ‘gpg2’ is checked. +variable 'TL_GNUPG' is set, it is tested and used; otherwise 'gpg' is +checked; finally 'gpg2' is checked. - Further adaptation of the ‘gpg’ invocation can be made using the two -environment variables ‘TL_GNUPGHOME’, which is passed to ‘gpg’ as the -value for ‘--homedir’, and ‘TL_GNUPGARGS’, which replaces the default -options ‘--no-secmem-warning --no-permission-warning’. + Further adaptation of the 'gpg' invocation can be made using the two +environment variables 'TL_GNUPGHOME', which is passed to 'gpg' as the +value for '--homedir', and 'TL_GNUPGARGS', which replaces the default +options '--no-secmem-warning --no-permission-warning'. File: tlbuild.info, Node: tlmgr USER MODE, Next: tlmgr MULTIPLE REPOSITORIES, Prev: tlmgr CRYPTOGRAPHIC VERIFICATION, Up: tlmgr @@ -4707,52 +4948,52 @@ File: tlbuild.info, Node: tlmgr USER MODE, Next: tlmgr MULTIPLE REPOSITORIES, B.9 USER MODE ============= -‘tlmgr’ provides a restricted way, called “user mode”, to manage +'tlmgr' provides a restricted way, called "user mode", to manage arbitrary texmf trees in the same way as the main installation. For example, this allows people without write permissions on the installation location to update/install packages into a tree of their own. - ‘tlmgr’ is switched into user mode with the command line option -‘--usermode’. It does not switch automatically, nor is there any + 'tlmgr' is switched into user mode with the command line option +'--usermode'. It does not switch automatically, nor is there any configuration file setting for it. Thus, this option has to be explicitly given every time user mode is to be activated. - This mode of ‘tlmgr’ works on a user tree, by default the value of -the ‘TEXMFHOME’ variable. This can be overridden with the command line -option ‘--usertree’. In the following when we speak of the user tree we -mean either ‘TEXMFHOME’ or the one given on the command line. + This mode of 'tlmgr' works on a user tree, by default the value of +the 'TEXMFHOME' variable. This can be overridden with the command line +option '--usertree'. In the following when we speak of the user tree we +mean either 'TEXMFHOME' or the one given on the command line. - Not all actions are allowed in user mode; ‘tlmgr’ will warn you and + Not all actions are allowed in user mode; 'tlmgr' will warn you and not carry out any problematic actions. Currently not supported (and -probably will never be) is the ‘platform’ action. The ‘gui’ action is +probably will never be) is the 'platform' action. The 'gui' action is currently not supported, but may be in a future release. - Some ‘tlmgr’ actions don’t need any write permissions and thus work -the same in user mode and normal mode. Currently these are: ‘check’, -‘help’, ‘list’, ‘print-platform’, ‘print-platform-info’, ‘search’, -‘show’, ‘version’. + Some 'tlmgr' actions don't need any write permissions and thus work +the same in user mode and normal mode. Currently these are: 'check', +'help', 'list', 'print-platform', 'print-platform-info', 'search', +'show', 'version'. On the other hand, most of the actions dealing with package management do need write permissions, and thus behave differently in -user mode, as described below: ‘install’, ‘update’, ‘remove’, ‘option’, -‘paper’, ‘generate’, ‘backup’, ‘restore’, ‘uninstall’, ‘symlinks’. - - Before using ‘tlmgr’ in user mode, you have to set up the user tree -with the ‘init-usertree’ action. This creates _usertree_‘/web2c’ and -_usertree_‘/tlpkg/tlpobj’, and a minimal -_usertree_‘/tlpkg/texlive.tlpdb’. At that point, you can tell ‘tlmgr’ -to do the (supported) actions by adding the ‘--usermode’ command line +user mode, as described below: 'install', 'update', 'remove', 'option', +'paper', 'generate', 'backup', 'restore', 'uninstall', 'symlinks'. + + Before using 'tlmgr' in user mode, you have to set up the user tree +with the 'init-usertree' action. This creates _usertree_'/web2c' and +_usertree_'/tlpkg/tlpobj', and a minimal +_usertree_'/tlpkg/texlive.tlpdb'. At that point, you can tell 'tlmgr' +to do the (supported) actions by adding the '--usermode' command line option. - In user mode the file _usertree_‘/tlpkg/texlive.tlpdb’ contains only -the packages that have been installed into the user tree using ‘tlmgr’, -plus additional options from the “virtual” package -‘00texlive.installation’ (similar to the main installation’s -‘texlive.tlpdb’). + In user mode the file _usertree_'/tlpkg/texlive.tlpdb' contains only +the packages that have been installed into the user tree using 'tlmgr', +plus additional options from the "virtual" package +'00texlive.installation' (similar to the main installation's +'texlive.tlpdb'). All actions on packages in user mode can only be carried out on -packages that are known as ‘relocatable’. This excludes all packages +packages that are known as 'relocatable'. This excludes all packages containing executables and a few other core packages. Of the 2500 or so packages currently in TeX Live the vast majority are relocatable and can be installed into a user tree. @@ -4764,6 +5005,7 @@ be installed into a user tree. * tlmgr User mode install:: * tlmgr User mode backup, restore, remove, update:: * tlmgr User mode generate, option, paper:: +* tlmgr User mode logs:: File: tlbuild.info, Node: tlmgr User mode install, Next: tlmgr User mode backup, restore, remove, update, Up: tlmgr USER MODE @@ -4771,22 +5013,22 @@ File: tlbuild.info, Node: tlmgr User mode install, Next: tlmgr User mode back B.9.1 User mode install ----------------------- -In user mode, the ‘install’ action checks that the package and all +In user mode, the 'install' action checks that the package and all dependencies are all either relocated or already installed in the system installation. If this is the case, it unpacks all containers to be -installed into the user tree (to repeat, that’s either ‘TEXMFHOME’ or -the value of ‘--usertree’) and add the respective packages to the user -tree’s ‘texlive.tlpdb’ (creating it if need be). +installed into the user tree (to repeat, that's either 'TEXMFHOME' or +the value of '--usertree') and add the respective packages to the user +tree's 'texlive.tlpdb' (creating it if need be). Currently installing a collection in user mode installs all dependent packages, but in contrast to normal mode, does _not_ install dependent -collections. For example, in normal mode ‘tlmgr install -collection-context’ would install ‘collection-basic’ and other +collections. For example, in normal mode 'tlmgr install +collection-context' would install 'collection-basic' and other collections, while in user mode, _only_ the packages mentioned in -‘collection-context’ are installed. +'collection-context' are installed. If a package shipping map files is installed in user mode, a backup -of the user’s ‘updmap.cfg’ in ‘USERTREE/web2c/’ is made, and then this +of the user's 'updmap.cfg' in 'USERTREE/web2c/' is made, and then this file regenerated from the list of installed packages. @@ -4800,13 +5042,22 @@ installed in the user tree before proceeding; otherwise, they behave just as in normal mode. -File: tlbuild.info, Node: tlmgr User mode generate, option, paper, Prev: tlmgr User mode backup, restore, remove, update, Up: tlmgr USER MODE +File: tlbuild.info, Node: tlmgr User mode generate, option, paper, Next: tlmgr User mode logs, Prev: tlmgr User mode backup, restore, remove, update, Up: tlmgr USER MODE B.9.3 User mode generate, option, paper --------------------------------------- -In user mode, these actions operate only on the user tree’s -configuration files and/or ‘texlive.tlpdb’. +In user mode, these actions operate only on the user tree's +configuration files and/or 'texlive.tlpdb'. + + +File: tlbuild.info, Node: tlmgr User mode logs, Prev: tlmgr User mode generate, option, paper, Up: tlmgr USER MODE + +B.9.4 User mode logs +-------------------- + +In user mode, 'tlmgr.log' and <tlmgr-commands.log> are written in the +'TEXMFVAR/web2c/' directlry instead of 'TEXMFSYSVAR/web2c/'. File: tlbuild.info, Node: tlmgr MULTIPLE REPOSITORIES, Next: tlmgr GUI FOR TLMGR, Prev: tlmgr USER MODE, Up: tlmgr @@ -4821,13 +5072,13 @@ Also, alternative package repositories distribute packages that cannot or should not be included in TeX Live, for whatever reason. The simplest and most reliable method is to temporarily set the -installation source to any repository (with the ‘-repository’ or ‘option -repository’ command line options), and perform your operations. +installation source to any repository (with the '-repository' or 'option +repository' command line options), and perform your operations. When you are using multiple repositories over a sustained length of time, however, explicitly switching between them becomes inconvenient. -Thus, it’s possible to tell ‘tlmgr’ about additional repositories you -want to use. The basic command is ‘tlmgr repository add’. The rest of +Thus, it's possible to tell 'tlmgr' about additional repositories you +want to use. The basic command is 'tlmgr repository add'. The rest of this section explains further. When using multiple repositories, one of them has to be set as the @@ -4840,7 +5091,7 @@ main repository. are _still_ _only_ installed from the main repository. Thus, simply adding a second repository does not actually enable installation of anything from there. You also have to specify which packages should be -taken from the new repository, by specifying so-called “pinning” rules, +taken from the new repository, by specifying so-called "pinning" rules, described next. * Menu: @@ -4853,12 +5104,12 @@ File: tlbuild.info, Node: tlmgr Pinning, Up: tlmgr MULTIPLE REPOSITORIES B.10.1 Pinning -------------- -When a package ‘foo’ is pinned to a repository, a package ‘foo’ in any +When a package 'foo' is pinned to a repository, a package 'foo' in any other repository, even if it has a higher revision number, will not be considered an installable candidate. As mentioned above, by default everything is pinned to the main -repository. Let’s now go through an example of setting up a second +repository. Let's now go through an example of setting up a second repository and enabling updates of a package from it. First, check that we have support for multiple repositories, and have @@ -4868,8 +5119,8 @@ only one enabled (as is the case by default): List of repositories (with tags if set): /var/www/norbert/tlnet - Ok. Let’s add the ‘tlcontrib’ repository (this is a real repository -hosted at <http://contrib.texlive.info>) with the tag ‘tlcontrib’: + Ok. Let's add the 'tlcontrib' repository (this is a real repository +hosted at <http://contrib.texlive.info>) with the tag 'tlcontrib': $ tlmgr repository add http://contrib.texlive.info/current tlcontrib @@ -4880,12 +5131,12 @@ hosted at <http://contrib.texlive.info>) with the tag ‘tlcontrib’: http://contrib.texlive.info/current (tlcontrib) /var/www/norbert/tlnet (main) - Now we specify a pinning entry to get the package ‘classico’ from -‘tlcontrib’: + Now we specify a pinning entry to get the package 'classico' from +'tlcontrib': $ tlmgr pinning add tlcontrib classico - Check that we can find ‘classico’: + Check that we can find 'classico': $ tlmgr show classico package: classico @@ -4893,23 +5144,23 @@ hosted at <http://contrib.texlive.info>) with the tag ‘tlcontrib’: shortdesc: URW Classico fonts ... - - install ‘classico’: + - install 'classico': $ tlmgr install classico tlmgr: package repositories: ... [1/1, ??:??/??:??] install: classico @tlcontrib [737k] - In the output here you can see that the ‘classico’ package has been -installed from the ‘tlcontrib’ repository (‘@tlcontrib’). + In the output here you can see that the 'classico' package has been +installed from the 'tlcontrib' repository ('@tlcontrib'). - Finally, ‘tlmgr pinning’ also supports removing certain or all + Finally, 'tlmgr pinning' also supports removing certain or all packages from a given repository: $ tlmgr pinning remove tlcontrib classico # remove just classico $ tlmgr pinning remove tlcontrib --all # take nothing from tlcontrib - A summary of ‘tlmgr pinning’ actions is given above. + A summary of 'tlmgr pinning' actions is given above. File: tlbuild.info, Node: tlmgr GUI FOR TLMGR, Next: tlmgr MACHINE-READABLE OUTPUT, Prev: tlmgr MULTIPLE REPOSITORIES, Up: tlmgr @@ -4917,12 +5168,12 @@ File: tlbuild.info, Node: tlmgr GUI FOR TLMGR, Next: tlmgr MACHINE-READABLE OU B.11 GUI FOR TLMGR ================== -The graphical user interface for ‘tlmgr’ requires Perl/Tk +The graphical user interface for 'tlmgr' requires Perl/Tk <https://search.cpan.org/search?query=perl%2Ftk>. For Unix-based systems Perl/Tk (as well as Perl of course) has to be installed outside of TL. <https://tug.org/texlive/distro.html#perltk> has a list of invocations for some distros. For Windows the necessary modules are no -longer shipped within TeX Live, so you’ll have to have an external Perl +longer shipped within TeX Live, so you'll have to have an external Perl available that includes them. We are talking here about the GUI built into tlmgr itself, not about @@ -4930,17 +5181,17 @@ the other tlmgr GUIs, which are: tlshell (Tcl/Tk-based), tlcockpit (Java-based) and, only on Macs, TeX Live Utility. These are invoked as separate programs. - The GUI mode of tlmgr is started with the invocation ‘tlmgr gui’; + The GUI mode of tlmgr is started with the invocation 'tlmgr gui'; assuming Tk is loadable, the graphical user interface will be shown. The main window contains a menu bar, the main display, and a status area where messages normally shown on the console are displayed. - Within the main display there are three main parts: the ‘Display -configuration’ area, the list of packages, and the action buttons. + Within the main display there are three main parts: the 'Display +configuration' area, the list of packages, and the action buttons. Also, at the top right the currently loaded repository is shown; this also acts as a button and when clicked will try to load the default -repository. To load a different repository, see the ‘tlmgr’ menu item. +repository. To load a different repository, see the 'tlmgr' menu item. Finally, the status area at the bottom of the window gives additional information about what is going on. @@ -4994,7 +5245,7 @@ Match Selection Select packages to those selected, those not selected, or all. - Here, “selected” means that the checkbox in the beginning of the + Here, "selected" means that the checkbox in the beginning of the line of a package is ticked. Display configuration buttons @@ -5056,7 +5307,7 @@ Below the list of packages are several buttons: Update all installed - This calls ‘tlmgr update --all’, i.e., tries to update all + This calls 'tlmgr update --all', i.e., tries to update all available packages. Below this button is a toggle to allow reinstallation of previously removed packages as part of this action. @@ -5071,20 +5322,20 @@ Update Install - Install the selected packages; acts like ‘tlmgr install’, i.e., + Install the selected packages; acts like 'tlmgr install', i.e., also installs dependencies. Thus, installing a collection installs all its constituent packages. Remove - Removes the selected packages; acts like ‘tlmgr remove’, i.e., it + Removes the selected packages; acts like 'tlmgr remove', i.e., it will also remove dependencies of collections (but not dependencies of normal packages). Backup - Makes a backup of the selected packages; acts like ‘tlmgr backup’. - This action needs the option ‘backupdir’ set (see ‘Options -’ + Makes a backup of the selected packages; acts like 'tlmgr backup'. + This action needs the option 'backupdir' set (see 'Options -' General>). @@ -5095,51 +5346,51 @@ B.11.2 Menu bar The following entries can be found in the menu bar: -‘tlmgr’ menu +'tlmgr' menu The items here load various repositories: the default as specified in the TeX Live database, the default network repository, the repository specified on the command line (if any), and an - arbitrarily manually-entered one. Also has the so-necessary ‘quit’ + arbitrarily manually-entered one. Also has the so-necessary 'quit' operation. -‘Options menu’ +'Options menu' - Provides access to several groups of options: ‘Paper’ - (configuration of default paper sizes), ‘Platforms’ (only on Unix, - configuration of the supported/installed platforms), ‘GUI Language’ - (select language used in the GUI interface), and ‘General’ + Provides access to several groups of options: 'Paper' + (configuration of default paper sizes), 'Platforms' (only on Unix, + configuration of the supported/installed platforms), 'GUI Language' + (select language used in the GUI interface), and 'General' (everything else). - Several toggles are also here. The first is ‘Expert options’, + Several toggles are also here. The first is 'Expert options', which is set by default. If you turn this off, the next time you start the GUI a simplified screen will be shown that display only the most important functionality. This setting is saved in the - configuration file of ‘tlmgr’; see *note CONFIGURATION FILE FOR + configuration file of 'tlmgr'; see *note CONFIGURATION FILE FOR TLMGR: tlmgr CONFIGURATION FILE FOR TLMGR. for details. The other toggles are all off by default: for debugging output, to disable the automatic installation of new packages, and to disable the automatic removal of packages deleted from the server. Playing - with the choices of what is or isn’t installed may lead to an + with the choices of what is or isn't installed may lead to an inconsistent TeX Live installation; e.g., when a package is renamed. -‘Actions menu’ +'Actions menu' Provides access to several actions: update the filename database - (aka ‘ls-R’, ‘mktexlsr’, ‘texhash’), rebuild all formats - (‘fmtutil-sys --all’), update the font map database (‘updmap-sys’), + (aka 'ls-R', 'mktexlsr', 'texhash'), rebuild all formats + ('fmtutil-sys --all'), update the font map database ('updmap-sys'), restore from a backup of a package, and use of symbolic links in system directories (not on Windows). The final action is to remove the entire TeX Live installation (also not on Windows). -‘Help menu’ +'Help menu' Provides access to the TeX Live manual (also on the web at - <https://tug.org/texlive/doc.html>) and the usual “About” box. + <https://tug.org/texlive/doc.html>) and the usual "About" box. File: tlbuild.info, Node: tlmgr GUI options, Prev: tlmgr Menu bar, Up: tlmgr GUI FOR TLMGR @@ -5147,29 +5398,29 @@ File: tlbuild.info, Node: tlmgr GUI options, Prev: tlmgr Menu bar, Up: tlmgr B.11.3 GUI options ------------------ -Some generic Perl/Tk options can be specified with ‘tlmgr gui’ to +Some generic Perl/Tk options can be specified with 'tlmgr gui' to control the display: -‘-background’ _color_ +'-background' _color_ Set background color. -‘-font "’ _fontname_ _fontsize_ ‘"’ +'-font "' _fontname_ _fontsize_ '"' - Set font, e.g., ‘tlmgr gui -font "helvetica 18"’. The argument to - ‘-font’ must be quoted, i.e., passed as a single string. + Set font, e.g., 'tlmgr gui -font "helvetica 18"'. The argument to + '-font' must be quoted, i.e., passed as a single string. -‘-foreground’ _color_ +'-foreground' _color_ Set foreground color. -‘-geometry’ _geomspec_ +'-geometry' _geomspec_ - Set the X geometry, e.g., ‘tlmgr gui -geometry 1024x512-0+0’ + Set the X geometry, e.g., 'tlmgr gui -geometry 1024x512-0+0' creates the window of (approximately) the given size in the upper-right corner of the display. -‘-xrm’ _xresource_ +'-xrm' _xresource_ Pass the arbitrary X resource string _xresource_. @@ -5183,7 +5434,7 @@ File: tlbuild.info, Node: tlmgr MACHINE-READABLE OUTPUT, Next: tlmgr ENVIRONME B.12 MACHINE-READABLE OUTPUT ============================ -With the ‘--machine-readable’ option, ‘tlmgr’ writes to stdout in the +With the '--machine-readable' option, 'tlmgr' writes to stdout in the fixed line-oriented format described here, and the usual informational messages for human consumption are written to stderr (normally they are written to stdout). The idea is that a program can get all the @@ -5201,7 +5452,7 @@ _pkg_..., and *note option: tlmgr option. actions. File: tlbuild.info, Node: tlmgr Machine-readable update and install output, Next: tlmgr Machine-readable option output, Up: tlmgr MACHINE-READABLE OUTPUT -B.12.1 Machine-readable ‘update’ and ‘install’ output +B.12.1 Machine-readable 'update' and 'install' output ----------------------------------------------------- The output format is as follows: @@ -5214,8 +5465,8 @@ The output format is as follows: "end-of-updates" other output from post actions, not in machine readable form - The header section currently has two fields: ‘location-url’ (the -repository source from which updates are being drawn), and ‘total-bytes’ + The header section currently has two fields: 'location-url' (the +repository source from which updates are being drawn), and 'total-bytes' (the total number of bytes to be downloaded). The _localrev_ and _serverrev_ fields for each package are the @@ -5229,83 +5480,83 @@ time since start of installation/updates and the estimated total time. Line endings may be either LF or CRLF depending on the current platform. -‘location-url’ _location_ +'location-url' _location_ - The _location_ may be a url (including ‘file:///foo/bar/...’), or a - directory name (‘/foo/bar’). It is the package repository from + The _location_ may be a url (including 'file:///foo/bar/...'), or a + directory name ('/foo/bar'). It is the package repository from which the new package information was drawn. -‘total-bytes’ _count_ +'total-bytes' _count_ The _count_ is simply a decimal number, the sum of the sizes of all the packages that need updating or installing (which are listed subsequently). - Then comes a line with only the literal string ‘end-of-header’. + Then comes a line with only the literal string 'end-of-header'. - Each following line until a line with literal string ‘end-of-updates’ + Each following line until a line with literal string 'end-of-updates' reports on one package. The fields on each line are separated by a tab. Here are the fields. _pkgname_ The TeX Live package identifier, with a possible platform suffix - for executables. For instance, ‘pdftex’ and ‘pdftex.i386-linux’ + for executables. For instance, 'pdftex' and 'pdftex.i386-linux' are given as two separate packages, one on each line. _status_ The status of the package update. One character, as follows: - ‘d’ + 'd' The package was removed on the server. - ‘f’ + 'f' The package was removed in the local installation, even though - a collection depended on it. (E.g., the user ran ‘tlmgr - remove --force’.) + a collection depended on it. (E.g., the user ran 'tlmgr + remove --force'.) - ‘u’ + 'u' Normal update is needed. - ‘r’ + 'r' Reversed non-update: the locally-installed version is newer than the version on the server. - ‘a’ + 'a' Automatically-determined need for installation, the package is new on the server and is (most probably) part of an installed collection. - ‘i’ + 'i' - Package will be installed and isn’t present in the local + Package will be installed and isn't present in the local installation (action install). - ‘I’ + 'I' Package is already present but will be reinstalled (action install). _localrev_ - The revision number of the installed package, or ‘-’ if it is not + The revision number of the installed package, or '-' if it is not present locally. _serverrev_ - The revision number of the package on the server, or ‘-’ if it is + The revision number of the package on the server, or '-' if it is not present on the server. _size_ The size in bytes of the package on the server. The sum of all the - package sizes is given in the ‘total-bytes’ header field mentioned + package sizes is given in the 'total-bytes' header field mentioned above. _runtime_ @@ -5319,14 +5570,14 @@ _esttot_ File: tlbuild.info, Node: tlmgr Machine-readable option output, Prev: tlmgr Machine-readable update and install output, Up: tlmgr MACHINE-READABLE OUTPUT -B.12.2 Machine-readable ‘option’ output +B.12.2 Machine-readable 'option' output --------------------------------------- The output format is as follows: key "\t" value - If a value is not saved in the database the string ‘(not set)’ is + If a value is not saved in the database the string '(not set)' is shown. If you are developing a program that uses this output, and find that @@ -5338,22 +5589,22 @@ File: tlbuild.info, Node: tlmgr ENVIRONMENT VARIABLES, Next: tlmgr AUTHORS AND B.13 ENVIRONMENT VARIABLES ========================== -‘tlmgr’ uses many of the standard TeX environment variables, as reported -by, e.g., ‘tlmgr conf’ (*note conf: tlmgr conf.). +'tlmgr' uses many of the standard TeX environment variables, as reported +by, e.g., 'tlmgr conf' (*note conf: tlmgr conf.). - In addition, for ease in scripting and debugging, ‘tlmgr’ looks for + In addition, for ease in scripting and debugging, 'tlmgr' looks for the following environment variables. These are not of interest for normal user installations. -‘TEXLIVE_COMPRESSOR’ +'TEXLIVE_COMPRESSOR' This variable allows selecting a different compressor program for backups and intermediate rollback containers. The order of selection is: - 1. If the environment variable ‘TEXLIVE_COMPRESSOR’ is defined, - use it; abort if it doesn’t work. Possible values: ‘lz4’, - ‘gzip’, ‘xz’. The necessary options are added internally. + 1. If the environment variable 'TEXLIVE_COMPRESSOR' is defined, + use it; abort if it doesn't work. Possible values: 'lz4', + 'gzip', 'xz'. The necessary options are added internally. 2. If lz4 is available (either from the system or TL) and working, use that. @@ -5363,28 +5614,28 @@ normal user installations. 4. If xz is available (either from the system or TL) and working, use that. - lz4 and gzip are faster in creating tlmgr’s local backups, hence + lz4 and gzip are faster in creating tlmgr's local backups, hence they are preferred. The unconditional use of xz for the tlnet containers is unaffected, to minimize download sizes. -‘TEXLIVE_DOWNLOADER’ +'TEXLIVE_DOWNLOADER' -‘TL_DOWNLOAD_PROGRAM’ +'TL_DOWNLOAD_PROGRAM' -‘TL_DOWNLOAD_ARGS’ +'TL_DOWNLOAD_ARGS' These options allow selecting different download programs then the ones automatically selected by the installer. The order of selection is: - 1. If the environment variable ‘TEXLIVE_DOWNLOADER’ is defined, - use it; abort if the specified program doesn’t work. Possible - values: ‘lwp’, ‘curl’, ‘wget’. The necessary options are + 1. If the environment variable 'TEXLIVE_DOWNLOADER' is defined, + use it; abort if the specified program doesn't work. Possible + values: 'lwp', 'curl', 'wget'. The necessary options are added internally. - 2. If the environment variable ‘TL_DOWNLOAD_PROGRAM’ is defined - (can be any value), use it together with ‘TL_DOWNLOAD_ARGS’; - abort if it doesn’t work. + 2. If the environment variable 'TL_DOWNLOAD_PROGRAM' is defined + (can be any value), use it together with 'TL_DOWNLOAD_ARGS'; + abort if it doesn't work. 3. If LWP is available and working, use that (by far the most efficient method, as it supports persistent downloads). @@ -5394,27 +5645,27 @@ normal user installations. 5. If wget is available (either from the system or TL) and working, use that. - TL provides ‘wget’ binaries for platforms where necessary, so some + TL provides 'wget' binaries for platforms where necessary, so some download method should always be available. -‘TEXLIVE_PREFER_OWN’ +'TEXLIVE_PREFER_OWN' By default, compression and download programs provided by the - system, i.e., found along ‘PATH’ are preferred over those shipped + system, i.e., found along 'PATH' are preferred over those shipped with TeX Live. This can create problems with systems that are too old, and so can be overridden by setting the environment variable - ‘TEXLIVE_PREFER_OWN’ to 1. In this case, executables shipped with + 'TEXLIVE_PREFER_OWN' to 1. In this case, executables shipped with TL will be preferred. Extra compression/download programs not provided by TL, such as gzip, lwp, and curl, are still checked for on the system and used - if available, per the above. ‘TEXLIVE_PREFER_OWN’ only applies + if available, per the above. 'TEXLIVE_PREFER_OWN' only applies when the program being checked for is shipped with TL, namely the lz4 and xz compressors and wget downloader. - Exception: on Windows, the ‘tar.exe’ shipped with TL is always + Exception: on Windows, the 'tar.exe' shipped with TL is always used, regardless of any setting. @@ -5427,7 +5678,7 @@ 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: tlmgr.pl 62273 2022-02-28 08:52:17Z preining $ + $Id: tlmgr.pl 65998 2023-02-21 01:33:24Z karl $ File: tlbuild.info, Node: Index, Prev: tlmgr, Up: Top @@ -6032,403 +6283,427 @@ Index Tag Table: -Node: Top1212 -Node: Introduction2122 -Node: Overview of build system3996 -Node: Prerequisites6102 -Ref: Prerequisites-Footnote-19272 -Node: Building9593 -Node: Build iteration10988 -Node: Build in parallel12104 -Node: Build distribution12741 -Node: Build one package13401 -Node: Build one engine18256 -Node: Cross compilation20751 -Node: Cross configuring22070 -Node: Cross problems23791 -Node: Installing25529 -Node: Installation directories26577 -Node: Linked scripts28507 -Node: Distro builds30046 -Node: Layout and infrastructure32502 -Node: Build system tools33345 -Node: Top-level directories35668 -Node: Autoconf macros38015 -Node: General setup macros38786 -Node: Macros for programs39693 -Node: Macros for compilers40574 -Node: Macros for libraries42034 -Node: Macros for library and header flags42476 -Node: Macros for Windows44511 -Node: Library modules46202 -Node: png library46707 -Node: zlib library49207 -Node: freetype library49754 -Node: kpathsea library50482 -Node: Program modules51925 -Node: t1utils package52369 -Node: xindy package52946 -Node: xdvik package54150 -Node: asymptote55273 -Node: Extending TeX Live55789 -Node: Adding a new program module56624 -Node: Adding a new engine61657 -Node: Adding a new generic library module63526 -Node: Adding a new TeX-specific library module65877 -Node: Configure options66603 -Node: Global configure options68020 -Node: --disable-native-texlive-build68562 -Node: --prefix --bindir ...69556 -Node: --disable-largefile70112 -Node: --disable-missing70674 -Node: --enable-compiler-warnings=LEVEL71079 -Node: --enable-cxx-runtime-hack71759 -Node: --enable-maintainer-mode72191 -Node: --enable-multiplatform72736 -Node: --enable-shared73341 -Node: --enable-silent-rules73724 -Node: --without-ln-s74200 -Node: --without-x74559 -Node: Program-specific configure options74751 -Node: --enable-PROG --disable-PROG75398 -Node: --disable-all-pkgs75683 -Node: Configure options for texk/web2c76489 -Node: Configure options for texk/bibtex-x79213 -Node: Configure options for texk/dvipdfm-x79796 -Node: Configure options for texk/dvisvgm80616 -Node: Configure options for texk/texlive81533 -Node: Configure options for texk/xdvik81970 -Node: Configure options for utils/xindy82635 -Node: Library-specific configure options83577 -Node: Configure options for kpathsea84566 -Node: Variables for configure85310 -Node: Coding conventions86856 -Node: Declarations and definitions87579 -Node: Const89802 -Node: Continuous integration91746 -Node: Transfer from Subversion to Github92410 -Node: Automatic update of the Git mirror94644 -Node: CI testing on Travis-CI95246 -Node: Releases on Github95975 -Node: install-tl96423 -Node: install-tl NAME96792 -Node: install-tl SYNOPSIS96950 -Node: install-tl DESCRIPTION97166 -Node: install-tl REFERENCES98234 -Node: install-tl OPTIONS98758 -Ref: install-tl *-gui* [[=]_module_]99111 -Ref: install-tl text99323 -Ref: install-tl tcl (or "perltk" or "wizard" or "expert" or nothing)99516 -Ref: install-tl *-no-gui*100156 -Ref: install-tl *-lang* _llcode_100246 -Ref: install-tl *-repository* _url|path_100870 -Ref: install-tl *-select-repository*101767 -Ref: install-tl *-all-options*102195 -Ref: install-tl *-custom-bin* _path_102450 -Ref: install-tl *-debug-fakenet*103292 -Ref: install-tl *-debug-translation*103470 -Ref: install-tl *-force-platform* _platform_103746 -Ref: install-tl *-help*, *--help*, *-?*103996 -Ref: install-tl *-in-place*104427 -Ref: install-tl *-init-from-profile* _profile_file_104976 -Ref: install-tl *-logfile* _file_105245 -Ref: install-tl *-no-cls*105600 -Ref: install-tl *-no-persistent-downloads*105748 -Ref: install-tl *-persistent-downloads*105773 -Ref: install-tl *-no-verify-downloads*106403 -Ref: install-tl *-non-admin*106774 -Ref: install-tl *-portable*106867 -Ref: install-tl *-print-platform*107006 -Ref: install-tl *-profile* _profile_file_107208 -Ref: install-tl *-q*107429 -Ref: install-tl *-scheme* _scheme_107491 -Ref: install-tl *-v*107973 -Ref: install-tl *-version*, *--version*108134 -Node: install-tl PROFILES108272 -Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)111206 -Ref: install-tl instopt_adjustrepo (default 1)111290 -Ref: install-tl instopt_letter (default 0)111435 -Ref: install-tl instopt_portable (default 0)111530 -Ref: install-tl instopt_write18_restricted (default 1)111630 -Node: install-tl ENVIRONMENT VARIABLES113009 -Ref: install-tl TEXLIVE_DOWNLOADER113395 -Ref: install-tl TL_DOWNLOAD_PROGRAM113422 -Ref: install-tl TL_DOWNLOAD_ARGS113446 -Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK113658 -Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE113868 -Ref: install-tl TEXLIVE_INSTALL_NO_RESUME113981 -Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME114137 -Ref: install-tl TEXLIVE_INSTALL_PAPER114262 -Ref: install-tl TEXLIVE_INSTALL_PREFIX114424 -Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG114459 -Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR114491 -Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME114524 -Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL114558 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG114596 -Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR114631 -Ref: install-tl NOPERLDOC115070 -Node: install-tl AUTHORS AND COPYRIGHT115144 -Node: tlmgr115557 -Node: tlmgr NAME116042 -Node: tlmgr SYNOPSIS116174 -Node: tlmgr DESCRIPTION116364 -Node: tlmgr EXAMPLES117467 -Ref: tlmgr tlmgr option repository ctan117726 -Ref: tlmgr tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet117803 -Ref: tlmgr tlmgr update --list118424 -Ref: tlmgr tlmgr update --all118521 -Ref: tlmgr tlmgr info _what_118682 -Node: tlmgr OPTIONS118948 -Ref: tlmgr *--repository* _url|path_119486 -Ref: tlmgr /some/local/dir120700 -Ref: tlmgr file:/some/local/dir120733 -Ref: tlmgr ctan120810 -Ref: tlmgr https://mirror.ctan.org/systems/texlive/tlnet120868 -Ref: tlmgr http://server/path/to/tlnet121217 -Ref: tlmgr https://server/path/to/tlnet121614 -Ref: tlmgr ftp://server/path/to/tlnet122098 -Ref: tlmgr user@machine:/path/to/tlnet122234 -Ref: tlmgr scp://user@machine/path/to/tlnet122279 -Ref: tlmgr ssh://user@machine/path/to/tlnet122324 -Ref: tlmgr *--gui* [_action_]122739 -Ref: tlmgr *--gui-lang* _llcode_123584 -Ref: tlmgr *--command-logfile* _file_124331 -Ref: tlmgr *--debug-translation*124607 -Ref: tlmgr *--machine-readable*124816 -Ref: tlmgr *--no-execute-actions*125086 -Ref: tlmgr *--package-logfile* _file_125281 -Ref: tlmgr *--pause*125545 -Ref: tlmgr *--persistent-downloads*125706 -Ref: tlmgr *--no-persistent-downloads*125736 -Ref: tlmgr *--pin-file*126252 -Ref: tlmgr *--usermode*126476 -Ref: tlmgr *--usertree* _dir_126602 -Ref: tlmgr *--verify-repo=[none|main|all]*126730 -Node: tlmgr ACTIONS127677 -Node: tlmgr help128538 -Node: tlmgr version129037 -Node: tlmgr backup129308 -Ref: tlmgr *backup [_option_...] --all*129481 -Ref: tlmgr *backup [_option_...] _pkg_...*129514 -Ref: tlmgr *--backupdir* _directory_130626 -Ref: tlmgr *--all*130849 -Ref: tlmgr *--clean*[=_N_]131111 -Ref: tlmgr *--dry-run*131448 -Node: tlmgr candidates _pkg_131578 -Node: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all]131933 -Ref: tlmgr *depends*132451 -Ref: tlmgr *executes*132801 -Ref: tlmgr *files*132920 -Ref: tlmgr *runfiles*133060 -Ref: tlmgr *texmfdbs*133197 -Ref: tlmgr - all items in TEXMFDBS have the !! prefix.133449 -Ref: tlmgr - all items in TEXMFBDS have an ls-R file (if they exist at all).133533 -Ref: tlmgr - all items in TEXMF with !! are listed in TEXMFDBS.133610 -Ref: tlmgr - all items in TEXMF with an ls-R file are listed in TEXMFDBS.133697 -Ref: tlmgr *--use-svn*133724 -Node: tlmgr conf133869 -Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*134161 -Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|remove] [_value_]*134227 -Node: tlmgr dump-tlpdb [_option_...] [--json]136738 -Ref: tlmgr *--local*137179 -Ref: tlmgr *--remote*137220 -Ref: tlmgr *--json*137260 -Node: tlmgr generate137851 -Ref: tlmgr *generate [_option_...] language*138047 -Ref: tlmgr *generate [_option_...] language.dat*138086 -Ref: tlmgr *generate [_option_...] language.def*138125 -Ref: tlmgr *generate [_option_...] language.dat.lua*138168 -Ref: tlmgr *--dest* _output_file_140625 -Ref: tlmgr *--localcfg* _local_conf_file_141243 -Ref: tlmgr *--rebuild-sys*141372 -Node: tlmgr gui142215 -Node: tlmgr info142393 -Ref: tlmgr *info [_option_...] _pkg_...*142555 -Ref: tlmgr *info [_option_...] collections*142589 -Ref: tlmgr *info [_option_...] schemes*142619 -Ref: tlmgr *--list*144175 -Ref: tlmgr *--only-installed*144499 -Ref: tlmgr *--only-remote*144689 -Ref: tlmgr *--data item1,item2,...*145011 -Ref: tlmgr *--json* 1146515 -Node: tlmgr init-usertree146926 -Node: tlmgr install [_option_...] _pkg_...147315 -Ref: tlmgr *--dry-run* 1147829 -Ref: tlmgr *--file*147948 -Ref: tlmgr *--force*148172 -Ref: tlmgr *--no-depends*148402 -Ref: tlmgr *--no-depends-at-all*148563 -Ref: tlmgr *--reinstall*148983 -Ref: tlmgr *--with-doc*149363 -Ref: tlmgr *--with-src*149378 -Node: tlmgr key150122 -Ref: tlmgr *key list*150280 -Ref: tlmgr *key add _file_*150298 -Ref: tlmgr *key remove _keyid_*150320 -Node: tlmgr list150946 -Node: tlmgr option151108 -Ref: tlmgr *option [--json] [show]*151265 -Ref: tlmgr *option [--json] showall|help*151298 -Ref: tlmgr *option _key_ [_value_]*151324 -Node: tlmgr paper156091 -Ref: tlmgr *paper [a4|letter]*156240 -Ref: tlmgr *<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*>156318 -Ref: tlmgr *paper --json*156335 -Node: tlmgr path157602 -Ref: tlmgr *path [--w32mode=user|admin] add*157765 -Ref: tlmgr *path [--w32mode=user|admin] remove*157804 -Node: tlmgr pinning159313 -Ref: tlmgr pinning show159562 -Ref: tlmgr pinning add _repo_ _pkgglob_...159639 -Ref: tlmgr pinning remove _repo_ _pkgglob_...159762 -Ref: tlmgr pinning remove _repo_ --all159919 -Node: tlmgr platform159973 -Ref: tlmgr *platform list|add|remove _platform_...*160159 -Ref: tlmgr *platform set _platform_*160186 -Ref: tlmgr *platform set auto*160207 -Ref: tlmgr *--dry-run* 2161126 -Node: tlmgr postaction161245 -Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*161475 -Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*161549 -Ref: tlmgr *--w32mode=[user|admin]*161882 -Ref: tlmgr *--fileassocmode=[1|2]*162316 -Ref: tlmgr *--all* 1162611 -Node: tlmgr print-platform162666 -Node: tlmgr print-platform-info163001 -Node: tlmgr remove [_option_...] _pkg_...163301 -Ref: tlmgr *--all* 2163791 -Ref: tlmgr *--backup*163907 -Ref: tlmgr *--backupdir* _directory_ 1163935 -Ref: tlmgr *--no-depends* 1164344 -Ref: tlmgr *--no-depends-at-all* 1164408 -Ref: tlmgr *--force* 1164516 -Ref: tlmgr *--dry-run* 3165003 -Node: tlmgr repository165392 -Ref: tlmgr *repository list*165580 -Ref: tlmgr *repository list _path|url|tag_*165614 -Ref: tlmgr *repository add _path_ [_tag_]*165647 -Ref: tlmgr *repository remove _path|tag_*165679 -Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*165733 -Ref: tlmgr *repository status*165754 -Ref: tlmgr The tag (which can be the same as the url);167009 -Node: tlmgr restore167491 -Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*167670 -Ref: tlmgr *restore [_option_...] --all*167702 -Ref: tlmgr *--all* 3168412 -Ref: tlmgr *--backupdir* _directory_ 2168628 -Ref: tlmgr *--dry-run* 4168811 -Ref: tlmgr *--force* 2168945 -Ref: tlmgr *--json* 2168995 -Node: tlmgr search169358 -Ref: tlmgr *search [_option_...] _what_*169522 -Ref: tlmgr *search [_option_...] --file _what_*169561 -Ref: tlmgr *search [_option_...] --all _what_*169599 -Ref: tlmgr *--file* 1169821 -Ref: tlmgr *--all* 4169885 -Ref: tlmgr *--global*169976 -Ref: tlmgr *--word*170105 -Node: tlmgr shell170432 -Ref: tlmgr protocol171175 -Ref: tlmgr help 1171243 -Ref: tlmgr version 1171296 -Ref: tlmgr quit, end, bye, byebye, EOF171364 -Ref: tlmgr restart171385 -Ref: tlmgr load [local|remote]171516 -Ref: tlmgr save171586 -Ref: tlmgr get [_var_] =item set [_var_ [_val_]]171709 -Node: tlmgr show172354 -Node: tlmgr uninstall172521 -Node: tlmgr update [_option_...] [_pkg_...]172753 -Ref: tlmgr *--all* 5173130 -Ref: tlmgr *--self*175383 -Ref: tlmgr *--dry-run* 5176161 -Ref: tlmgr *--list* [_pkg_]176344 -Ref: tlmgr *--exclude* _pkg_177075 -Ref: tlmgr *--no-auto-remove* [_pkg_...]177897 -Ref: tlmgr *--no-auto-install* [_pkg_...]178395 -Ref: tlmgr *--reinstall-forcibly-removed*179179 -Ref: tlmgr *--backup* 1179734 -Ref: tlmgr *--backupdir* _directory_ 3179762 -Ref: tlmgr *--no-depends* 2180946 -Ref: tlmgr *--no-depends-at-all* 2181151 -Ref: tlmgr *--force* 3181259 -Node: tlmgr CONFIGURATION FILE FOR TLMGR182286 -Ref: tlmgr auto-remove = 0 or 1 (default 1), same as command-line option.183320 -Ref: tlmgr gui-expertmode = 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.183456 -Ref: tlmgr gui-lang = _llcode_, with a language code value as with the command-line option.183544 -Ref: tlmgr no-checksums = 0 or 1 (default 0, see below).183597 -Ref: tlmgr persistent-downloads = 0 or 1 (default 1), same as command-line option.183676 -Ref: tlmgr require-verification = 0 or 1 (default 0), same as command-line option.183755 -Ref: tlmgr tkfontscale = _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends.183867 -Ref: tlmgr update-exclude = _comma-separated list of packages_ (no spaces allowed). Same as the command line option --exclude for the update action.184024 -Ref: tlmgr verify-downloads = 0 or 1 (default 1), same as command-line option.184099 -Ref: tlmgr allowed-actions = _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode). This allows distributors to include tlmgr in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this.184638 -Node: tlmgr CRYPTOGRAPHIC VERIFICATION185502 -Node: tlmgr Configuration of GnuPG invocation187759 -Node: tlmgr USER MODE188433 -Node: tlmgr User mode install191455 -Node: tlmgr User mode backup, restore, remove, update192643 -Node: tlmgr User mode generate, option, paper193089 -Node: tlmgr MULTIPLE REPOSITORIES193433 -Node: tlmgr Pinning195184 -Node: tlmgr GUI FOR TLMGR197163 -Node: tlmgr Main display198830 -Node: tlmgr Display configuration area199082 -Ref: tlmgr Status199443 -Ref: tlmgr Category199607 -Ref: tlmgr Match199793 -Ref: tlmgr Selection199974 -Ref: tlmgr Display configuration buttons200182 -Node: tlmgr Package list area200365 -Ref: tlmgr a checkbox200949 -Ref: tlmgr package name201085 -Ref: tlmgr local revision (and version)201184 -Ref: tlmgr remote revision (and version)201559 -Ref: tlmgr short description201856 -Node: tlmgr Main display action buttons201901 -Ref: tlmgr Update all installed202167 -Ref: tlmgr Update202543 -Ref: tlmgr Install202593 -Ref: tlmgr Remove202783 -Ref: tlmgr Backup202965 -Node: tlmgr Menu bar203134 -Ref: tlmgr tlmgr menu203361 -Ref: tlmgr Options menu203677 -Ref: tlmgr Actions menu204790 -Ref: tlmgr Help menu205242 -Node: tlmgr GUI options205380 -Ref: tlmgr -background _color_205634 -Ref: tlmgr -font " _fontname_ _fontsize_ "205707 -Ref: tlmgr -foreground _color_205877 -Ref: tlmgr -geometry _geomspec_205933 -Ref: tlmgr -xrm _xresource_206133 -Node: tlmgr MACHINE-READABLE OUTPUT206402 -Node: tlmgr Machine-readable update and install output207224 -Ref: tlmgr location-url _location_208520 -Ref: tlmgr total-bytes _count_208748 -Ref: tlmgr _pkgname_209166 -Ref: tlmgr _status_209384 -Ref: tlmgr d209466 -Ref: tlmgr f209530 -Ref: tlmgr u209717 -Ref: tlmgr r209767 -Ref: tlmgr a209894 -Ref: tlmgr i210076 -Ref: tlmgr I210201 -Ref: tlmgr _localrev_210303 -Ref: tlmgr _serverrev_210414 -Ref: tlmgr _size_210530 -Ref: tlmgr _runtime_210703 -Ref: tlmgr _esttot_210773 -Node: tlmgr Machine-readable option output210806 -Node: tlmgr ENVIRONMENT VARIABLES211326 -Ref: tlmgr TEXLIVE_COMPRESSOR211853 -Ref: tlmgr TEXLIVE_DOWNLOADER212725 -Ref: tlmgr TL_DOWNLOAD_PROGRAM212752 -Ref: tlmgr TL_DOWNLOAD_ARGS212776 -Ref: tlmgr TEXLIVE_PREFER_OWN213838 -Node: tlmgr AUTHORS AND COPYRIGHT214678 -Node: Index215080 +Node: Top1210 +Node: Introduction2120 +Node: Overview of build system3948 +Node: Prerequisites5999 +Ref: Prerequisites-Footnote-18998 +Node: Building9301 +Node: Build iteration10643 +Node: Build in parallel11687 +Node: Build distribution12292 +Node: Build one package12940 +Node: Build one engine17653 +Node: Cross compilation20078 +Node: Cross configuring21357 +Node: Cross problems23034 +Node: Installing24696 +Node: Installation directories25716 +Node: Linked scripts27534 +Node: Distro builds29025 +Node: Layout and infrastructure31401 +Node: Build system tools32232 +Node: Top-level directories34451 +Node: Autoconf macros36687 +Node: General setup macros37449 +Node: Macros for programs38324 +Node: Macros for compilers39125 +Node: Macros for libraries40533 +Node: Macros for library and header flags40959 +Node: Macros for Windows42870 +Node: Library modules44457 +Node: png library44946 +Node: zlib library47294 +Node: freetype library47809 +Node: kpathsea library48505 +Node: Program modules49884 +Node: t1utils package50312 +Node: xindy package50857 +Node: xdvik package51973 +Node: asymptote53032 +Node: Extending TeX Live53536 +Node: Adding a new program module54343 +Node: Adding a new engine59106 +Node: Adding a new generic library module60891 +Node: Adding a new TeX-specific library module63112 +Node: Configure options63810 +Node: Global configure options65191 +Node: --disable-native-texlive-build65733 +Node: --prefix --bindir ...66695 +Node: --disable-largefile67235 +Node: --disable-missing67777 +Node: --enable-compiler-warnings=LEVEL68178 +Node: --enable-cxx-runtime-hack68834 +Node: --enable-maintainer-mode69254 +Node: --enable-multiplatform69783 +Node: --enable-shared70356 +Node: --enable-silent-rules70727 +Node: --without-ln-s71179 +Node: --without-x71526 +Node: Program-specific configure options71714 +Node: --enable-PROG --disable-PROG72357 +Node: --disable-all-pkgs72630 +Node: Configure options for texk/web2c73413 +Node: Configure options for texk/bibtex-x75951 +Node: Configure options for texk/dvipdfm-x76494 +Node: Configure options for texk/dvisvgm77270 +Node: Configure options for texk/texlive78151 +Node: Configure options for texk/xdvik78572 +Node: Configure options for utils/xindy79193 +Node: Library-specific configure options80083 +Node: Configure options for kpathsea81044 +Node: Variables for configure81748 +Node: Coding conventions83174 +Node: Declarations and definitions83889 +Node: Const86063 +Node: Continuous integration87927 +Node: Transfer from Subversion to Github88591 +Node: Automatic update of the Git mirror90753 +Node: CI testing on Travis-CI91335 +Node: Releases on Github92044 +Node: install-tl92484 +Node: install-tl NAME92928 +Node: install-tl SYNOPSIS93108 +Node: install-tl DESCRIPTION93346 +Node: install-tl REFERENCES94543 +Node: install-tl EXAMPLES95152 +Ref: install-tl install-tl --paper=letter95603 +Ref: install-tl install-tl --scheme _scheme_95739 +Ref: install-tl install-tl --no-interaction95894 +Ref: install-tl install-tl --profile _texlive.profile_96046 +Node: install-tl OPTIONS96314 +Ref: install-tl *-gui* [[=]_module_]96811 +Ref: install-tl *-no-gui*96822 +Ref: install-tl text97030 +Ref: install-tl tcl (or "perltk" or "wizard" or "expert" or nothing)97215 +Ref: install-tl *-lang* _llcode_97847 +Ref: install-tl *-repository* _url|path_98471 +Ref: install-tl *-select-repository*99365 +Ref: install-tl *-all-options*99783 +Ref: install-tl *-custom-bin* _path_100038 +Ref: install-tl *-debug-fakenet*100870 +Ref: install-tl *-debug-setup-vars*101084 +Ref: install-tl *-debug-translation*101232 +Ref: install-tl *-force-platform* _platform_101508 +Ref: install-tl *-help*, *--help*, *-?*101766 +Ref: install-tl *-in-place*102179 +Ref: install-tl *-init-from-profile* _profile_file_102724 +Ref: install-tl *-logfile* _file_102993 +Ref: install-tl *-no-cls*103344 +Ref: install-tl *-no-continue*103471 +Ref: install-tl *-no-doc-install*104042 +Ref: install-tl *-no-src-install*104061 +Ref: install-tl *-no-installation*104852 +Ref: install-tl *-no-interaction*105003 +Ref: install-tl *-no-persistent-downloads*105260 +Ref: install-tl *-persistent-downloads*105285 +Ref: install-tl *-no-verify-downloads*105892 +Ref: install-tl *-non-admin*106255 +Ref: install-tl *-paper* a4*|*letter106361 +Ref: install-tl *-portable*106557 +Ref: install-tl *-print-platform*106694 +Ref: install-tl *-profile* _profile_file_106892 +Ref: install-tl *-q*107113 +Ref: install-tl *-scheme* _scheme_107175 +Ref: install-tl *-texdir* _dir_107576 +Ref: install-tl *-texuserdir* _dir_108181 +Ref: install-tl *-texmflocal* _dir_108470 +Ref: install-tl *-texmfhome* _dir_109095 +Ref: install-tl *-texmfsysconfig* _dir_109404 +Ref: install-tl *-texmfsysvar* _dir_109426 +Ref: install-tl *-texmfconfig* _dir_109521 +Ref: install-tl *-texmfvar* _dir_109540 +Ref: install-tl *-v*109748 +Ref: install-tl *-version*, *--version*109904 +Node: install-tl PROFILES110038 +Ref: install-tl instopt_adjustpath (default 0 on Unix, 1 on Windows)113054 +Ref: install-tl instopt_adjustrepo (default 1)113130 +Ref: install-tl instopt_letter (default 0)113267 +Ref: install-tl instopt_portable (default 0)113358 +Ref: install-tl instopt_write18_restricted (default 1)113897 +Node: install-tl ENVIRONMENT VARIABLES115236 +Ref: install-tl NOPERLDOC115599 +Ref: install-tl TEXLIVE_DOWNLOADER115684 +Ref: install-tl TL_DOWNLOAD_PROGRAM115707 +Ref: install-tl TL_DOWNLOAD_ARGS115727 +Ref: install-tl TEXLIVE_INSTALL_ENV_NOCHECK115931 +Ref: install-tl TEXLIVE_INSTALL_NO_CONTEXT_CACHE116133 +Ref: install-tl TEXLIVE_INSTALL_NO_DISKCHECK116245 +Ref: install-tl TEXLIVE_INSTALL_NO_RESUME116661 +Ref: install-tl TEXLIVE_INSTALL_NO_WELCOME116813 +Ref: install-tl TEXLIVE_INSTALL_PAPER116934 +Ref: install-tl TEXLIVE_INSTALL_PREFIX117080 +Ref: install-tl TEXLIVE_INSTALL_TEXMFCONFIG117111 +Ref: install-tl TEXLIVE_INSTALL_TEXMFVAR117139 +Ref: install-tl TEXLIVE_INSTALL_TEXMFHOME117168 +Ref: install-tl TEXLIVE_INSTALL_TEXMFLOCAL117198 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSCONFIG117232 +Ref: install-tl TEXLIVE_INSTALL_TEXMFSYSVAR117263 +Node: install-tl DIRECTORY TREES117701 +Node: install-tl BUGS120285 +Node: install-tl AUTHORS AND COPYRIGHT121165 +Node: tlmgr121563 +Node: tlmgr NAME122048 +Node: tlmgr SYNOPSIS122192 +Node: tlmgr DESCRIPTION122394 +Node: tlmgr EXAMPLES123505 +Ref: tlmgr tlmgr option repository ctan123768 +Ref: tlmgr tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet123841 +Ref: tlmgr tlmgr update --list124446 +Ref: tlmgr tlmgr update --all124539 +Ref: tlmgr tlmgr info _what_124696 +Node: tlmgr OPTIONS124958 +Ref: tlmgr *--repository* _url|path_125491 +Ref: tlmgr /some/local/dir126677 +Ref: tlmgr file:/some/local/dir126706 +Ref: tlmgr ctan126779 +Ref: tlmgr https://mirror.ctan.org/systems/texlive/tlnet126833 +Ref: tlmgr http://server/path/to/tlnet127174 +Ref: tlmgr https://server/path/to/tlnet127555 +Ref: tlmgr ftp://server/path/to/tlnet128023 +Ref: tlmgr user@machine:/path/to/tlnet128155 +Ref: tlmgr scp://user@machine/path/to/tlnet128196 +Ref: tlmgr ssh://user@machine/path/to/tlnet128237 +Ref: tlmgr *--gui* [_action_]128631 +Ref: tlmgr *--gui-lang* _llcode_129445 +Ref: tlmgr *--command-logfile* _file_130187 +Ref: tlmgr *--debug-translation*130454 +Ref: tlmgr *--machine-readable*130658 +Ref: tlmgr *--no-execute-actions*130927 +Ref: tlmgr *--package-logfile* _file_131121 +Ref: tlmgr *--pause*131376 +Ref: tlmgr *--persistent-downloads*131532 +Ref: tlmgr *--no-persistent-downloads*131561 +Ref: tlmgr *--pin-file*132056 +Ref: tlmgr *--usermode*132275 +Ref: tlmgr *--usertree* _dir_132396 +Ref: tlmgr *--verify-repo=[none|main|all]*132523 +Node: tlmgr ACTIONS133422 +Node: tlmgr help134283 +Node: tlmgr version134760 +Node: tlmgr backup135023 +Ref: tlmgr *backup [_option_...] --all*135195 +Ref: tlmgr *backup [_option_...] _pkg_...*135228 +Ref: tlmgr *--backupdir* _directory_136295 +Ref: tlmgr *--all*136513 +Ref: tlmgr *--clean*[=_N_]136766 +Ref: tlmgr *--dry-run*137094 +Node: tlmgr candidates _pkg_137224 +Node: tlmgr check [_option_...] [depends|executes|files|runfiles|texmfdbs|all]137579 +Ref: tlmgr *depends*138093 +Ref: tlmgr *executes*138435 +Ref: tlmgr *files*138550 +Ref: tlmgr *runfiles*138686 +Ref: tlmgr *texmfdbs*138823 +Ref: tlmgr - all items in TEXMFDBS have the !! prefix.139053 +Ref: tlmgr - all items in TEXMFBDS have an ls-R file (if they exist at all).139129 +Ref: tlmgr - all items in TEXMF with !! are listed in TEXMFDBS.139194 +Ref: tlmgr - all items in TEXMF with an ls-R file are listed in TEXMFDBS.139269 +Ref: tlmgr *--use-svn*139295 +Node: tlmgr conf139436 +Ref: tlmgr *conf [texmf|tlmgr|updmap [--conffile _file_] [--delete] [_key_ [_value_]]]*139726 +Ref: tlmgr *conf auxtrees [--conffile _file_] [show|add|remove] [_value_]*139791 +Node: tlmgr dump-tlpdb [_option_...] [--json]142207 +Ref: tlmgr *--local*142643 +Ref: tlmgr *--remote*142683 +Ref: tlmgr *--json*142722 +Node: tlmgr generate143293 +Ref: tlmgr *generate [_option_...] language*143489 +Ref: tlmgr *generate [_option_...] language.dat*143528 +Ref: tlmgr *generate [_option_...] language.def*143567 +Ref: tlmgr *generate [_option_...] language.dat.lua*143610 +Ref: tlmgr *--dest* _output_file_145938 +Ref: tlmgr *--localcfg* _local_conf_file_146515 +Ref: tlmgr *--rebuild-sys*146639 +Node: tlmgr gui147454 +Node: tlmgr info147632 +Ref: tlmgr *info [_option_...] _pkg_...*147794 +Ref: tlmgr *info [_option_...] collections*147828 +Ref: tlmgr *info [_option_...] schemes*147858 +Ref: tlmgr *--list*149389 +Ref: tlmgr *--only-installed*149704 +Ref: tlmgr *--only-remote*149893 +Ref: tlmgr *--data item1,item2,...*150198 +Ref: tlmgr *--json* 1151571 +Node: tlmgr init-usertree151954 +Node: tlmgr install [_option_...] _pkg_...152335 +Ref: tlmgr *--dry-run* 1152844 +Ref: tlmgr *--file*152962 +Ref: tlmgr *--force*153185 +Ref: tlmgr *--no-depends*153406 +Ref: tlmgr *--no-depends-at-all*153566 +Ref: tlmgr *--reinstall*153967 +Ref: tlmgr *--with-doc*154346 +Ref: tlmgr *--with-src*154360 +Node: tlmgr key155088 +Ref: tlmgr *key list*155246 +Ref: tlmgr *key add _file_*155264 +Ref: tlmgr *key remove _keyid_*155286 +Node: tlmgr list155880 +Node: tlmgr option156042 +Ref: tlmgr *option [--json] [show]*156198 +Ref: tlmgr *option [--json] showall|help*156230 +Ref: tlmgr *option _key_ [_value_]*156256 +Node: tlmgr paper160835 +Ref: tlmgr *paper [a4|letter]*160984 +Ref: tlmgr *<[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [_papersize_|--list]*>161061 +Ref: tlmgr *paper --json*161077 +Node: tlmgr path162292 +Ref: tlmgr *path [--w32mode=user|admin] add*162454 +Ref: tlmgr *path [--w32mode=user|admin] remove*162492 +Node: tlmgr pinning163977 +Ref: tlmgr pinning show164218 +Ref: tlmgr pinning add _repo_ _pkgglob_...164291 +Ref: tlmgr pinning remove _repo_ _pkgglob_...164410 +Ref: tlmgr pinning remove _repo_ --all164563 +Node: tlmgr platform164617 +Ref: tlmgr *platform list|add|remove _platform_...*164803 +Ref: tlmgr *platform set _platform_*164830 +Ref: tlmgr *platform set auto*164851 +Ref: tlmgr *--dry-run* 2165729 +Node: tlmgr postaction165848 +Ref: tlmgr *postaction [_option_...] install [shortcut|fileassoc|script] [_pkg_...]*166078 +Ref: tlmgr *postaction [_option_...] remove [shortcut|fileassoc|script] [_pkg_...]*166152 +Ref: tlmgr *--w32mode=[user|admin]*166468 +Ref: tlmgr *--fileassocmode=[1|2]*166885 +Ref: tlmgr *--all* 1167171 +Node: tlmgr print-platform167226 +Node: tlmgr print-platform-info167557 +Node: tlmgr remove [_option_...] _pkg_...167857 +Ref: tlmgr *--all* 2168342 +Ref: tlmgr *--backup*168453 +Ref: tlmgr *--backupdir* _directory_ 1168480 +Ref: tlmgr *--no-depends* 1168885 +Ref: tlmgr *--no-depends-at-all* 1168948 +Ref: tlmgr *--force* 1169055 +Ref: tlmgr *--dry-run* 3169529 +Node: tlmgr repository169906 +Ref: tlmgr *repository list*170094 +Ref: tlmgr *repository list _path|url|tag_*170128 +Ref: tlmgr *repository add _path_ [_tag_]*170161 +Ref: tlmgr *repository remove _path|tag_*170193 +Ref: tlmgr *repository set _path_[#_tag_] [_path_[#_tag_] ...]*170247 +Ref: tlmgr *repository status*170268 +Ref: tlmgr The tag (which can be the same as the url);171495 +Node: tlmgr restore171973 +Ref: tlmgr *restore [_option_...] _pkg_ [_rev_]*172152 +Ref: tlmgr *restore [_option_...] --all*172183 +Ref: tlmgr *--all* 3172884 +Ref: tlmgr *--backupdir* _directory_ 2173099 +Ref: tlmgr *--dry-run* 4173281 +Ref: tlmgr *--force* 2173414 +Ref: tlmgr *--json* 2173461 +Node: tlmgr search173788 +Ref: tlmgr *search [_option_...] _what_*173952 +Ref: tlmgr *search [_option_...] --file _what_*173990 +Ref: tlmgr *search [_option_...] --all _what_*174027 +Ref: tlmgr *--file* 1174248 +Ref: tlmgr *--all* 4174311 +Ref: tlmgr *--global*174401 +Ref: tlmgr *--word*174529 +Node: tlmgr shell174844 +Ref: tlmgr protocol175579 +Ref: tlmgr help 1175643 +Ref: tlmgr version 1175696 +Ref: tlmgr quit, end, bye, byebye, EOF175764 +Ref: tlmgr restart175785 +Ref: tlmgr load [local|remote]175908 +Ref: tlmgr save175978 +Ref: tlmgr get [_var_] =item set [_var_ [_val_]]176101 +Node: tlmgr show176702 +Node: tlmgr uninstall176869 +Node: tlmgr update [_option_...] [_pkg_...]177101 +Ref: tlmgr *--all* 5177473 +Ref: tlmgr *--self*179653 +Ref: tlmgr *--dry-run* 5180418 +Ref: tlmgr *--list* [_pkg_]180596 +Ref: tlmgr *--exclude* _pkg_181286 +Ref: tlmgr *--no-auto-remove* [_pkg_...]182087 +Ref: tlmgr *--no-auto-install* [_pkg_...]182572 +Ref: tlmgr *--reinstall-forcibly-removed*183335 +Ref: tlmgr *--backup* 1183871 +Ref: tlmgr *--backupdir* _directory_ 3183898 +Ref: tlmgr *--no-depends* 2185065 +Ref: tlmgr *--no-depends-at-all* 2185269 +Ref: tlmgr *--force* 3185376 +Node: tlmgr CONFIGURATION FILE FOR TLMGR186367 +Ref: tlmgr auto-remove = 0 or 1 (default 1), same as command-line option.187369 +Ref: tlmgr gui-expertmode = 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.187501 +Ref: tlmgr gui-lang = _llcode_, with a language code value as with the command-line option.187585 +Ref: tlmgr no-checksums = 0 or 1 (default 0, see below).187634 +Ref: tlmgr persistent-downloads = 0 or 1 (default 1), same as command-line option.187709 +Ref: tlmgr require-verification = 0 or 1 (default 0), same as command-line option.187784 +Ref: tlmgr tkfontscale = _floating-point number_ (default 1.0); scaling factor for fonts in the Tk-based frontends.187892 +Ref: tlmgr update-exclude = _comma-separated list of packages_ (no spaces allowed). Same as the command line option --exclude for the update action.188037 +Ref: tlmgr verify-downloads = 0 or 1 (default 1), same as command-line option.188108 +Ref: tlmgr allowed-actions = _action1_[,_action2_,...] The value is a comma-separated list (no spaces) of tlmgr actions which are allowed to be executed when tlmgr is invoked in system mode (that is, without --usermode). This allows distributors to include tlmgr in their packaging, but allow only a restricted set of actions that do not interfere with their distro package manager. For native TeX Live installations, it doesn't make sense to set this.188625 +Node: tlmgr CRYPTOGRAPHIC VERIFICATION189457 +Node: tlmgr Configuration of GnuPG invocation191630 +Node: tlmgr USER MODE192268 +Node: tlmgr User mode install195139 +Node: tlmgr User mode backup, restore, remove, update196285 +Node: tlmgr User mode generate, option, paper196731 +Node: tlmgr User mode logs197098 +Node: tlmgr MULTIPLE REPOSITORIES197396 +Node: tlmgr Pinning199125 +Node: tlmgr GUI FOR TLMGR201048 +Node: tlmgr Main display202697 +Node: tlmgr Display configuration area202949 +Ref: tlmgr Status203310 +Ref: tlmgr Category203474 +Ref: tlmgr Match203660 +Ref: tlmgr Selection203841 +Ref: tlmgr Display configuration buttons204045 +Node: tlmgr Package list area204228 +Ref: tlmgr a checkbox204812 +Ref: tlmgr package name204948 +Ref: tlmgr local revision (and version)205047 +Ref: tlmgr remote revision (and version)205422 +Ref: tlmgr short description205719 +Node: tlmgr Main display action buttons205764 +Ref: tlmgr Update all installed206030 +Ref: tlmgr Update206402 +Ref: tlmgr Install206452 +Ref: tlmgr Remove206638 +Ref: tlmgr Backup206816 +Node: tlmgr Menu bar206973 +Ref: tlmgr tlmgr menu207196 +Ref: tlmgr Options menu207504 +Ref: tlmgr Actions menu208587 +Ref: tlmgr Help menu209015 +Node: tlmgr GUI options209149 +Ref: tlmgr -background _color_209395 +Ref: tlmgr -font " _fontname_ _fontsize_ "209460 +Ref: tlmgr -foreground _color_209618 +Ref: tlmgr -geometry _geomspec_209670 +Ref: tlmgr -xrm _xresource_209862 +Node: tlmgr MACHINE-READABLE OUTPUT210131 +Node: tlmgr Machine-readable update and install output210945 +Ref: tlmgr location-url _location_212221 +Ref: tlmgr total-bytes _count_212437 +Ref: tlmgr _pkgname_212847 +Ref: tlmgr _status_213057 +Ref: tlmgr d213135 +Ref: tlmgr f213195 +Ref: tlmgr u213374 +Ref: tlmgr r213420 +Ref: tlmgr a213543 +Ref: tlmgr i213721 +Ref: tlmgr I213840 +Ref: tlmgr _localrev_213942 +Ref: tlmgr _serverrev_214049 +Ref: tlmgr _size_214161 +Ref: tlmgr _runtime_214330 +Ref: tlmgr _esttot_214400 +Node: tlmgr Machine-readable option output214433 +Node: tlmgr ENVIRONMENT VARIABLES214945 +Ref: tlmgr TEXLIVE_COMPRESSOR215456 +Ref: tlmgr TEXLIVE_DOWNLOADER216304 +Ref: tlmgr TL_DOWNLOAD_PROGRAM216327 +Ref: tlmgr TL_DOWNLOAD_ARGS216347 +Ref: tlmgr TEXLIVE_PREFER_OWN217373 +Node: tlmgr AUTHORS AND COPYRIGHT218197 +Node: Index218595 End Tag Table |