Debian Codegraph @

texmf-dist/doc/texlive/tlbuild/tlbuild.html

raw
1 <!DOCTYPE html>
2 <html>
3 <!-- Created by GNU Texinfo 7.2, https://www.gnu.org/software/texinfo/ -->
4 <head>
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <!-- This file documents the TeX Live build system and more.
7
8 Copyright © 2016-2026 Karl Berry.
9
10 Copyright © 2013-2015 Karl Berry & Peter Breitenlohner.
11
12 Permission is granted to make and distribute verbatim copies of this
13 manual provided the copyright notice and this permission notice are
14 preserved on all copies.
15
16
17 Permission is granted to copy and distribute modified versions of this
18 manual under the conditions for verbatim copying, provided that the
19 entire resulting derived work is distributed under the terms of a
20 permission notice identical to this one.
21
22 Permission is granted to copy and distribute translations of this manual
23 into another language, under the above conditions for modified versions,
24 except that this permission notice may be stated in a translation
25 approved by the TeX Users Group. -->
26 <title>Building TeX Live (2026)</title>
27
28 <meta name="description" content="Building TeX Live (2026)">
29 <meta name="keywords" content="Building TeX Live (2026)">
30 <meta name="resource-type" content="document">
31 <meta name="distribution" content="global">
32 <meta name="Generator" content="makeinfo">
33 <meta name="viewport" content="width=device-width,initial-scale=1">
34
35 <link href="#Top" rel="start" title="Top">
36 <link href="#Index" rel="index" title="Index">
37 <link href="#SEC_Contents" rel="contents" title="Table of Contents">
38 <link href="http://tug.org/texinfohtml" rel="up" title="(dir)">
39 <link href="#Introduction" rel="next" title="Introduction">
40 <style type="text/css">
41 <!--
42 a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
43 a.summary-letter-printindex {text-decoration: none}
44 div.display {margin-left: 3.2em}
45 div.example {margin-left: 3.2em}
46 pre.display-preformatted {font-family: inherit}
47 span.r {font-family: initial; font-weight: normal; font-style: normal}
48 span:hover a.copiable-link {visibility: visible}
49 strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
50 td.printindex-index-entry {vertical-align: top}
51 td.printindex-index-section {vertical-align: top; padding-left: 1em}
52 th.entries-header-printindex {text-align:left}
53 th.sections-header-printindex {text-align:left; padding-left: 1em}
54 ul.mark-bullet {list-style-type: disc}
55 ul.toc-numbered-mark {list-style: none}
56 -->
57 </style>
58
59
60 </head>
61
62 <body lang="en">
63
64
65
66
67
68
69
70
71
72
73 <div class="top-level-extent" id="Top">
74 <div class="nav-panel">
75 <p>
76 Next: <a href="#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="http://tug.org/texinfohtml" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
77 </div>
78 <h1 class="top" id="Building-TeX-Live-_00282026_0029"><span>Building TeX Live (2026)<a class="copiable-link" href="#Building-TeX-Live-_00282026_0029"> &para;</a></span></h1>
79
80 <p>For an overview of this manual, see <a class="pxref" href="#Introduction">Introduction</a>.
81 </p>
82
83 <div class="region-shortcontents" id="SEC_Shortcontents">
84 <h2 class="shortcontents-heading">Short Table of Contents</h2>
85
86 <div class="shortcontents">
87 <ul class="toc-numbered-mark">
88 <li><a id="stoc-Introduction" href="#toc-Introduction">1 Introduction</a></li>
89 <li><a id="stoc-Overview-of-build-system" href="#toc-Overview-of-build-system">2 Overview of build system</a></li>
90 <li><a id="stoc-Prerequisites" href="#toc-Prerequisites">3 Prerequisites</a></li>
91 <li><a id="stoc-Building" href="#toc-Building">4 Building</a></li>
92 <li><a id="stoc-Installing" href="#toc-Installing">5 Installing</a></li>
93 <li><a id="stoc-Layout-and-infrastructure" href="#toc-Layout-and-infrastructure">6 Layout and infrastructure</a></li>
94 <li><a id="stoc-Configure-options" href="#toc-Configure-options">7 Configure options</a></li>
95 <li><a id="stoc-Coding-conventions" href="#toc-Coding-conventions">8 Coding conventions</a></li>
96 <li><a id="stoc-Continuous-integration" href="#toc-Continuous-integration">9 Continuous integration</a></li>
97 <li><a id="stoc-install_002dtl" href="#toc-install_002dtl">Appendix A install-tl</a></li>
98 <li><a id="stoc-tlmgr" href="#toc-tlmgr">Appendix B tlmgr</a></li>
99 <li><a id="stoc-Index" href="#toc-Index" rel="index">Index</a></li>
100 </ul>
101 </div>
102 </div>
103 <div class="region-contents" id="SEC_Contents">
104 <h2 class="contents-heading">Table of Contents</h2>
105
106 <div class="contents">
107
108 <ul class="toc-numbered-mark">
109 <li><a id="toc-Introduction" href="#Introduction">1 Introduction</a></li>
110 <li><a id="toc-Overview-of-build-system" href="#Overview-of-build-system">2 Overview of build system</a></li>
111 <li><a id="toc-Prerequisites" href="#Prerequisites">3 Prerequisites</a></li>
112 <li><a id="toc-Building" href="#Building">4 Building</a>
113 <ul class="toc-numbered-mark">
114 <li><a id="toc-Build-iteration" href="#Build-iteration">4.1 Build iteration</a></li>
115 <li><a id="toc-Build-in-parallel" href="#Build-in-parallel">4.2 Build in parallel</a></li>
116 <li><a id="toc-Build-distribution" href="#Build-distribution">4.3 Build distribution</a></li>
117 <li><a id="toc-Build-one-package" href="#Build-one-package">4.4 Build one package</a></li>
118 <li><a id="toc-Build-one-engine" href="#Build-one-engine">4.5 Build one engine</a></li>
119 <li><a id="toc-Cross-compilation" href="#Cross-compilation">4.6 Cross compilation</a>
120 <ul class="toc-numbered-mark">
121 <li><a id="toc-Cross-configuring" href="#Cross-configuring">4.6.1 Cross configuring</a></li>
122 <li><a id="toc-Cross-problems" href="#Cross-problems">4.6.2 Cross problems</a></li>
123 </ul></li>
124 </ul></li>
125 <li><a id="toc-Installing" href="#Installing">5 Installing</a>
126 <ul class="toc-numbered-mark">
127 <li><a id="toc-Installation-directories" href="#Installation-directories">5.1 Installation directories</a></li>
128 <li><a id="toc-Linked-scripts" href="#Linked-scripts">5.2 Linked scripts</a></li>
129 <li><a id="toc-Distro-builds" href="#Distro-builds">5.3 Distro builds</a></li>
130 </ul></li>
131 <li><a id="toc-Layout-and-infrastructure" href="#Layout-and-infrastructure">6 Layout and infrastructure</a>
132 <ul class="toc-numbered-mark">
133 <li><a id="toc-Build-system-tools" href="#Build-system-tools">6.1 Build system tools</a></li>
134 <li><a id="toc-Top_002dlevel-directories" href="#Top_002dlevel-directories">6.2 Top-level directories</a></li>
135 <li><a id="toc-Autoconf-macros" href="#Autoconf-macros">6.3 Autoconf macros</a>
136 <ul class="toc-numbered-mark">
137 <li><a id="toc-General-setup-macros" href="#General-setup-macros">6.3.1 General setup macros</a></li>
138 <li><a id="toc-Macros-for-programs" href="#Macros-for-programs">6.3.2 Macros for programs</a></li>
139 <li><a id="toc-Macros-for-compilers" href="#Macros-for-compilers">6.3.3 Macros for compilers</a></li>
140 <li><a id="toc-Macros-for-libraries" href="#Macros-for-libraries">6.3.4 Macros for libraries</a></li>
141 <li><a id="toc-Macros-for-library-and-header-flags" href="#Macros-for-library-and-header-flags">6.3.5 Macros for library and header flags</a></li>
142 <li><a id="toc-Macros-for-Windows" href="#Macros-for-Windows">6.3.6 Macros for Windows</a></li>
143 </ul></li>
144 <li><a id="toc-Library-modules" href="#Library-modules">6.4 Library modules</a>
145 <ul class="toc-numbered-mark">
146 <li><a id="toc-The-png-library-in-libs_002flibpng" href="#png-library">6.4.1 The <code class="code">png</code> library in <samp class="file">libs/libpng</samp></a></li>
147 <li><a id="toc-The-zlib-library-in-libs_002fzlib" href="#zlib-library">6.4.2 The <code class="code">zlib</code> library in <samp class="file">libs/zlib</samp></a></li>
148 <li><a id="toc-The-freetype-library-in-libs_002ffreetype2" href="#freetype-library">6.4.3 The <code class="code">freetype</code> library in <samp class="file">libs/freetype2</samp></a></li>
149 <li><a id="toc-The-kpathsea-library-in-texk_002fkpathsea" href="#kpathsea-library">6.4.4 The <code class="code">kpathsea</code> library in <samp class="file">texk/kpathsea</samp></a></li>
150 </ul></li>
151 <li><a id="toc-Program-modules" href="#Program-modules">6.5 Program modules</a>
152 <ul class="toc-numbered-mark">
153 <li><a id="toc-The-t1utils-package-in-utils_002ft1utils" href="#t1utils-package">6.5.1 The <code class="code">t1utils</code> package in <samp class="file">utils/t1utils</samp></a></li>
154 <li><a id="toc-The-xindy-package-in-utils_002fxindy" href="#xindy-package">6.5.2 The <code class="code">xindy</code> package in <samp class="file">utils/xindy</samp></a></li>
155 <li><a id="toc-The-xdvik-package-in-texk_002fxdvik" href="#xdvik-package">6.5.3 The <code class="code">xdvik</code> package in <samp class="file">texk/xdvik</samp></a></li>
156 <li><a id="toc-The-subdirectory-utils_002fasymptote" href="#asymptote">6.5.4 The subdirectory <samp class="file">utils/asymptote</samp></a></li>
157 </ul></li>
158 <li><a id="toc-Extending-TeX-Live" href="#Extending-TeX-Live">6.6 Extending TeX&nbsp;Live</a>
159 <ul class="toc-numbered-mark">
160 <li><a id="toc-Adding-a-new-program-module" href="#Adding-a-new-program-module">6.6.1 Adding a new program module</a></li>
161 <li><a id="toc-Adding-a-new-engine" href="#Adding-a-new-engine">6.6.2 Adding a new engine</a></li>
162 <li><a id="toc-Adding-a-new-generic-library-module" href="#Adding-a-new-generic-library-module">6.6.3 Adding a new generic library module</a></li>
163 <li><a id="toc-Adding-a-new-TeX_002dspecific-library-module" href="#Adding-a-new-TeX_002dspecific-library-module">6.6.4 Adding a new TeX-specific library module</a></li>
164 </ul></li>
165 </ul></li>
166 <li><a id="toc-Configure-options" href="#Configure-options">7 Configure options</a>
167 <ul class="toc-numbered-mark">
168 <li><a id="toc-Global-configure-options" href="#Global-configure-options">7.1 Global configure options</a>
169 <ul class="toc-numbered-mark">
170 <li><a id="toc-_002d_002ddisable_002dnative_002dtexlive_002dbuild" href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild">7.1.1 <code class="code">--disable-native-texlive-build</code></a></li>
171 <li><a id="toc-_002d_002dprefix_002c-_002d_002dbindir_002c-_002e_002e_002e" href="#g_t_002d_002dprefix-_002d_002dbindir-_2026">7.1.2 <code class="code">--prefix</code>, <code class="code">--bindir</code>, &hellip;</a></li>
172 <li><a id="toc-_002d_002ddisable_002dlargefile" href="#g_t_002d_002ddisable_002dlargefile">7.1.3 <code class="code">--disable-largefile</code></a></li>
173 <li><a id="toc-_002d_002ddisable_002dmissing" href="#g_t_002d_002ddisable_002dmissing">7.1.4 <code class="code">--disable-missing</code></a></li>
174 <li><a id="toc-_002d_002denable_002dcompiler_002dwarnings_003dlevel" href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel">7.1.5 <code class="code">--enable-compiler-warnings=</code><var class="var">level</var></a></li>
175 <li><a id="toc-_002d_002denable_002dcxx_002druntime_002dhack" href="#g_t_002d_002denable_002dcxx_002druntime_002dhack">7.1.6 <code class="code">--enable-cxx-runtime-hack</code></a></li>
176 <li><a id="toc-_002d_002denable_002dmaintainer_002dmode" href="#g_t_002d_002denable_002dmaintainer_002dmode">7.1.7 <code class="code">--enable-maintainer-mode</code></a></li>
177 <li><a id="toc-_002d_002denable_002dmultiplatform" href="#g_t_002d_002denable_002dmultiplatform">7.1.8 <code class="code">--enable-multiplatform</code></a></li>
178 <li><a id="toc-_002d_002denable_002dshared" href="#g_t_002d_002denable_002dshared">7.1.9 <code class="code">--enable-shared</code></a></li>
179 <li><a id="toc-_002d_002denable_002dsilent_002drules" href="#g_t_002d_002denable_002dsilent_002drules">7.1.10 <code class="code">--enable-silent-rules</code></a></li>
180 <li><a id="toc-_002d_002dwithout_002dln_002ds" href="#g_t_002d_002dwithout_002dln_002ds">7.1.11 <code class="code">--without-ln-s</code></a></li>
181 <li><a id="toc-_002d_002dwithout_002dx" href="#g_t_002d_002dwithout_002dx">7.1.12 <code class="code">--without-x</code></a></li>
182 </ul></li>
183 <li><a id="toc-Program_002dspecific-configure-options" href="#Program_002dspecific-configure-options">7.2 Program-specific configure options</a>
184 <ul class="toc-numbered-mark">
185 <li><a id="toc-_002d_002denable_002dprog_002c-_002d_002ddisable_002dprog" href="#g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog">7.2.1 <code class="code">--enable-<var class="var">prog</var></code>, <code class="code">--disable-<var class="var">prog</var></code></a></li>
186 <li><a id="toc-_002d_002ddisable_002dall_002dpkgs" href="#g_t_002d_002ddisable_002dall_002dpkgs">7.2.2 <code class="code">--disable-all-pkgs</code></a></li>
187 <li><a id="toc-Configure-options-for-texk_002fweb2c" href="#Configure-options-for-texk_002fweb2c">7.2.3 Configure options for <samp class="file">texk/web2c</samp></a></li>
188 <li><a id="toc-Configure-options-for-texk_002fbibtex_002dx" href="#Configure-options-for-texk_002fbibtex_002dx">7.2.4 Configure options for <samp class="file">texk/bibtex-x</samp></a></li>
189 <li><a id="toc-Configure-options-for-texk_002fdvipdfm_002dx" href="#Configure-options-for-texk_002fdvipdfm_002dx">7.2.5 Configure options for <samp class="file">texk/dvipdfm-x</samp></a></li>
190 <li><a id="toc-Configure-options-for-texk_002fdvisvgm" href="#Configure-options-for-texk_002fdvisvgm">7.2.6 Configure options for <samp class="file">texk/dvisvgm</samp></a></li>
191 <li><a id="toc-Configure-options-for-texk_002ftexlive" href="#Configure-options-for-texk_002ftexlive">7.2.7 Configure options for <samp class="file">texk/texlive</samp></a></li>
192 <li><a id="toc-Configure-options-for-texk_002fxdvik" href="#Configure-options-for-texk_002fxdvik">7.2.8 Configure options for <samp class="file">texk/xdvik</samp></a></li>
193 <li><a id="toc-Configure-options-for-utils_002fxindy" href="#Configure-options-for-utils_002fxindy">7.2.9 Configure options for <samp class="file">utils/xindy</samp></a></li>
194 </ul></li>
195 <li><a id="toc-Library_002dspecific-configure-options" href="#Library_002dspecific-configure-options">7.3 Library-specific configure options</a>
196 <ul class="toc-numbered-mark">
197 <li><a id="toc-Configure-options-for-kpathsea" href="#Configure-options-for-kpathsea">7.3.1 Configure options for <code class="code">kpathsea</code></a></li>
198 </ul></li>
199 <li><a id="toc-Variables-for-configure" href="#Variables-for-configure">7.4 Variables for configure</a></li>
200 </ul></li>
201 <li><a id="toc-Coding-conventions" href="#Coding-conventions">8 Coding conventions</a>
202 <ul class="toc-numbered-mark">
203 <li><a id="toc-Declarations-and-definitions" href="#Declarations-and-definitions">8.1 Declarations and definitions</a></li>
204 <li><a id="toc-Const" href="#Const">8.2 Const</a></li>
205 </ul></li>
206 <li><a id="toc-Continuous-integration" href="#Continuous-integration">9 Continuous integration</a>
207 <ul class="toc-numbered-mark">
208 <li><a id="toc-Transfer-from-Subversion-to-Github" href="#Transfer-from-Subversion-to-Github">9.1 Transfer from Subversion to Github</a></li>
209 <li><a id="toc-Automatic-update-of-the-Git-mirror" href="#Automatic-update-of-the-Git-mirror">9.2 Automatic update of the Git mirror</a></li>
210 <li><a id="toc-CI-testing-on-Travis_002dCI" href="#CI-testing-on-Travis_002dCI">9.3 CI testing on Travis-CI</a></li>
211 <li><a id="toc-Releases-on-Github" href="#Releases-on-Github">9.4 Releases on Github</a></li>
212 </ul></li>
213 <li><a id="toc-install_002dtl" href="#install_002dtl">Appendix A install-tl</a>
214 <ul class="toc-numbered-mark">
215 <li><a id="toc-install_002dtl-NAME" href="#install_002dtl-NAME">A.1 install-tl NAME</a></li>
216 <li><a id="toc-install_002dtl-SYNOPSIS" href="#install_002dtl-SYNOPSIS">A.2 install-tl SYNOPSIS</a></li>
217 <li><a id="toc-install_002dtl-DESCRIPTION" href="#install_002dtl-DESCRIPTION">A.3 install-tl DESCRIPTION</a></li>
218 <li><a id="toc-REFERENCES" href="#install_002dtl-REFERENCES">A.4 REFERENCES</a></li>
219 <li><a id="toc-install_002dtl-EXAMPLES" href="#install_002dtl-EXAMPLES">A.5 install-tl EXAMPLES</a></li>
220 <li><a id="toc-install_002dtl-OPTIONS" href="#install_002dtl-OPTIONS">A.6 install-tl OPTIONS</a></li>
221 <li><a id="toc-PROFILES" href="#install_002dtl-PROFILES">A.7 PROFILES</a></li>
222 <li><a id="toc-ENVIRONMENT-VARIABLES" href="#install_002dtl-ENVIRONMENT-VARIABLES">A.8 ENVIRONMENT VARIABLES</a></li>
223 <li><a id="toc-DIRECTORY-TREES" href="#install_002dtl-DIRECTORY-TREES">A.9 DIRECTORY TREES</a></li>
224 <li><a id="toc-install_002dtl-BUGS" href="#install_002dtl-BUGS">A.10 install-tl BUGS</a></li>
225 <li><a id="toc-AUTHORS-AND-COPYRIGHT" href="#install_002dtl-AUTHORS-AND-COPYRIGHT">A.11 AUTHORS AND COPYRIGHT</a></li>
226 </ul></li>
227 <li><a id="toc-tlmgr" href="#tlmgr">Appendix B tlmgr</a>
228 <ul class="toc-numbered-mark">
229 <li><a id="toc-tlmgr-NAME" href="#tlmgr-NAME">B.1 tlmgr NAME</a></li>
230 <li><a id="toc-tlmgr-SYNOPSIS" href="#tlmgr-SYNOPSIS">B.2 tlmgr SYNOPSIS</a></li>
231 <li><a id="toc-tlmgr-DESCRIPTION" href="#tlmgr-DESCRIPTION">B.3 tlmgr DESCRIPTION</a></li>
232 <li><a id="toc-tlmgr-EXAMPLES" href="#tlmgr-EXAMPLES">B.4 tlmgr EXAMPLES</a></li>
233 <li><a id="toc-tlmgr-OPTIONS" href="#tlmgr-OPTIONS">B.5 tlmgr OPTIONS</a></li>
234 <li><a id="toc-ACTIONS" href="#tlmgr-ACTIONS">B.6 ACTIONS</a>
235 <ul class="toc-numbered-mark">
236 <li><a id="toc-help" href="#tlmgr-help">B.6.1 help</a></li>
237 <li><a id="toc-version" href="#tlmgr-version">B.6.2 version</a></li>
238 <li><a id="toc-backup" href="#tlmgr-backup">B.6.3 backup</a></li>
239 <li><a id="toc-bug-_005bsearch_002dstring_005d" href="#tlmgr-bug-_005bsearch_002dstring_005d">B.6.4 bug [<em class="emph">search-string</em>]</a></li>
240 <li><a id="toc-candidates-pkg" href="#tlmgr-candidates-pkg">B.6.5 candidates <em class="emph">pkg</em></a></li>
241 <li><a id="toc-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d" href="#tlmgr-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d">B.6.6 check [<em class="emph">option</em>...] [depends|executes|files|runfiles|texmfdbs|all]</a></li>
242 <li><a id="toc-conf" href="#tlmgr-conf">B.6.7 conf</a></li>
243 <li><a id="toc-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d" href="#tlmgr-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d">B.6.8 dump-tlpdb [<em class="emph">option</em>...] [--json]</a></li>
244 <li><a id="toc-generate" href="#tlmgr-generate">B.6.9 generate</a></li>
245 <li><a id="toc-gui" href="#tlmgr-gui">B.6.10 gui</a></li>
246 <li><a id="toc-info" href="#tlmgr-info">B.6.11 info</a></li>
247 <li><a id="toc-init_002dusertree" href="#tlmgr-init_002dusertree">B.6.12 init-usertree</a></li>
248 <li><a id="toc-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">B.6.13 install [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a></li>
249 <li><a id="toc-key" href="#tlmgr-key">B.6.14 key</a></li>
250 <li><a id="toc-list" href="#tlmgr-list">B.6.15 list</a></li>
251 <li><a id="toc-option" href="#tlmgr-option">B.6.16 option</a></li>
252 <li><a id="toc-paper" href="#tlmgr-paper">B.6.17 paper</a></li>
253 <li><a id="toc-path" href="#tlmgr-path">B.6.18 path</a></li>
254 <li><a id="toc-pinning" href="#tlmgr-pinning">B.6.19 pinning</a></li>
255 <li><a id="toc-platform" href="#tlmgr-platform">B.6.20 platform</a></li>
256 <li><a id="toc-postaction" href="#tlmgr-postaction">B.6.21 postaction</a></li>
257 <li><a id="toc-print_002dplatform" href="#tlmgr-print_002dplatform">B.6.22 print-platform</a></li>
258 <li><a id="toc-print_002dplatform_002dinfo" href="#tlmgr-print_002dplatform_002dinfo">B.6.23 print-platform-info</a></li>
259 <li><a id="toc-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" href="#tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">B.6.24 remove [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a></li>
260 <li><a id="toc-repository" href="#tlmgr-repository">B.6.25 repository</a></li>
261 <li><a id="toc-restore" href="#tlmgr-restore">B.6.26 restore</a></li>
262 <li><a id="toc-search" href="#tlmgr-search">B.6.27 search</a></li>
263 <li><a id="toc-shell" href="#tlmgr-shell">B.6.28 shell</a></li>
264 <li><a id="toc-show" href="#tlmgr-show">B.6.29 show</a></li>
265 <li><a id="toc-uninstall" href="#tlmgr-uninstall">B.6.30 uninstall</a></li>
266 <li><a id="toc-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d" href="#tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d">B.6.31 update [<em class="emph">option</em>...] [<em class="emph">pkg</em>...]</a></li>
267 </ul></li>
268 <li><a id="toc-CONFIGURATION-FILE-FOR-TLMGR" href="#tlmgr-CONFIGURATION-FILE-FOR-TLMGR">B.7 CONFIGURATION FILE FOR TLMGR</a></li>
269 <li><a id="toc-CRYPTOGRAPHIC-VERIFICATION" href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION">B.8 CRYPTOGRAPHIC VERIFICATION</a>
270 <ul class="toc-numbered-mark">
271 <li><a id="toc-Configuration-of-GnuPG-invocation" href="#tlmgr-Configuration-of-GnuPG-invocation">B.8.1 Configuration of GnuPG invocation</a></li>
272 </ul></li>
273 <li><a id="toc-USER-MODE" href="#tlmgr-USER-MODE">B.9 USER MODE</a>
274 <ul class="toc-numbered-mark">
275 <li><a id="toc-User-mode-install" href="#tlmgr-User-mode-install">B.9.1 User mode install</a></li>
276 <li><a id="toc-User-mode-backup_002c-restore_002c-remove_002c-update" href="#tlmgr-User-mode-backup_002c-restore_002c-remove_002c-update">B.9.2 User mode backup, restore, remove, update</a></li>
277 <li><a id="toc-User-mode-generate_002c-option_002c-paper" href="#tlmgr-User-mode-generate_002c-option_002c-paper">B.9.3 User mode generate, option, paper</a></li>
278 <li><a id="toc-User-mode-logs" href="#tlmgr-User-mode-logs">B.9.4 User mode logs</a></li>
279 </ul></li>
280 <li><a id="toc-MULTIPLE-REPOSITORIES" href="#tlmgr-MULTIPLE-REPOSITORIES">B.10 MULTIPLE REPOSITORIES</a>
281 <ul class="toc-numbered-mark">
282 <li><a id="toc-Pinning" href="#tlmgr-Pinning">B.10.1 Pinning</a></li>
283 </ul></li>
284 <li><a id="toc-GUI-FOR-TLMGR" href="#tlmgr-GUI-FOR-TLMGR">B.11 GUI FOR TLMGR</a>
285 <ul class="toc-numbered-mark">
286 <li><a id="toc-Main-display" href="#tlmgr-Main-display">B.11.1 Main display</a>
287 <ul class="toc-numbered-mark">
288 <li><a id="toc-Display-configuration-area" href="#tlmgr-Display-configuration-area">B.11.1.1 Display configuration area</a></li>
289 <li><a id="toc-Package-list-area" href="#tlmgr-Package-list-area">B.11.1.2 Package list area</a></li>
290 <li><a id="toc-Main-display-action-buttons" href="#tlmgr-Main-display-action-buttons">B.11.1.3 Main display action buttons</a></li>
291 </ul></li>
292 <li><a id="toc-Menu-bar" href="#tlmgr-Menu-bar">B.11.2 Menu bar</a></li>
293 <li><a id="toc-GUI-options" href="#tlmgr-GUI-options">B.11.3 GUI options</a></li>
294 </ul></li>
295 <li><a id="toc-MACHINE_002dREADABLE-OUTPUT" href="#tlmgr-MACHINE_002dREADABLE-OUTPUT">B.12 MACHINE-READABLE OUTPUT</a>
296 <ul class="toc-numbered-mark">
297 <li><a id="toc-Machine_002dreadable-update-and-install-output" href="#tlmgr-Machine_002dreadable-update-and-install-output">B.12.1 Machine-readable <code class="code">update</code> and <code class="code">install</code> output</a></li>
298 <li><a id="toc-Machine_002dreadable-option-output" href="#tlmgr-Machine_002dreadable-option-output">B.12.2 Machine-readable <code class="code">option</code> output</a></li>
299 </ul></li>
300 <li><a id="toc-ENVIRONMENT-VARIABLES-1" href="#tlmgr-ENVIRONMENT-VARIABLES">B.13 ENVIRONMENT VARIABLES</a></li>
301 <li><a id="toc-AUTHORS-AND-COPYRIGHT-1" href="#tlmgr-AUTHORS-AND-COPYRIGHT">B.14 AUTHORS AND COPYRIGHT</a></li>
302 </ul></li>
303 <li><a id="toc-Index" href="#Index" rel="index">Index</a></li>
304 </ul>
305 </div>
306 </div>
307 <hr>
308 <div class="chapter-level-extent" id="Introduction">
309 <div class="nav-panel">
310 <p>
311 Next: <a href="#Overview-of-build-system" accesskey="n" rel="next">Overview of build system</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Building TeX Live (2026)</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
312 </div>
313 <h2 class="chapter" id="Introduction-1"><span>1 Introduction<a class="copiable-link" href="#Introduction-1"> &para;</a></span></h2>
314
315 <a class="index-entry-id" id="index-introduction"></a>
316
317 <p>This manual (dated January 2026) corresponds to the TeX&nbsp;Live
318 2026 release.
319 </p>
320 <p>This manual is aimed at system installers and programmers, and focuses
321 on how to configure, build, and develop the TeX&nbsp;Live (TL) sources. It is
322 also available as plain text files in the source tree:
323 <samp class="file">source/README.*</samp>.
324 </p>
325 <p>The main <samp class="file">source/README</samp> file in the TL source tree provides
326 maximally-terse information for doing a build, and portability
327 information for different systems, along with
328 <samp class="file">source/doc/README.solaris</samp>.
329 </p>
330 <p>For information on acquiring the TL sources, see
331 <a class="url" href="https://tug.org/texlive/svn">https://tug.org/texlive/svn</a>. The canonical source repository
332 uses Subversion, and we have no plans to change this.
333 </p>
334 <p>This manual does not duplicate the information found in other TL
335 documentation resources, such as:
336 </p>
337 <ul class="itemize mark-bullet">
338 <li>The TeX&nbsp;Live web pages: <a class="url" href="https://tug.org/texlive">https://tug.org/texlive</a>.
339
340 </li><li>The web page describing how to build the binaries which
341 are distributed with TeX&nbsp;Live: <a class="url" href="https://tug.org/texlive/build.html">https://tug.org/texlive/build.html</a>.
342
343 </li><li>The TeX&nbsp;Live user manual: <a class="url" href="https://tug.org/texlive/doc.html">https://tug.org/texlive/doc.html</a>, or
344 run <code class="code">texdoc texlive</code>.
345
346 </li><li>Other TeX-related Texinfo manuals (see <cite class="cite"><a data-manual="web2c" href="https://tug.org/texinfohtml/web2c.html#Top">Web2c</a></cite>,
347 <cite class="cite"><a data-manual="kpathsea" href="https://tug.org/texinfohtml/kpathsea.html#Top">Kpathsea</a></cite>, etc.):
348 <a class="url" href="https://tug.org/texinfohtml/">https://tug.org/texinfohtml/</a>, or check the &lsquo;<samp class="samp">TeX</samp>&rsquo; category in
349 the GNU Info system.
350
351 </li><li>Package documentation:
352 <a class="url" href="https://tug.org/texlive/Contents/live/doc.html">https://tug.org/texlive/Contents/live/doc.html</a>, or the
353 <samp class="file">doc.html</samp> file at the top level of the installed TL.
354
355 </li></ul>
356
357 <p>As an exception, the full documentation for <code class="code">install-tl</code> and
358 <code class="code">tlmgr</code> is included here as appendices, simply because it is easy
359 to do so. The same text is available online (linked from
360 <a class="url" href="https://tug.org/texlive/doc.html">https://tug.org/texlive/doc.html</a>, or by invoking the program
361 with &lsquo;<samp class="samp">--help</samp>&rsquo; (or look at the end of the source).
362 </p>
363
364 <hr>
365 </div>
366 <div class="chapter-level-extent" id="Overview-of-build-system">
367 <div class="nav-panel">
368 <p>
369 Next: <a href="#Prerequisites" accesskey="n" rel="next">Prerequisites</a>, Previous: <a href="#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
370 </div>
371 <h2 class="chapter" id="Overview-of-build-system-1"><span>2 Overview of build system<a class="copiable-link" href="#Overview-of-build-system-1"> &para;</a></span></h2>
372
373 <a class="index-entry-id" id="index-build-system_002c-design-of"></a>
374
375 <a class="index-entry-id" id="index-Autoconf"></a>
376 <a class="index-entry-id" id="index-Automake"></a>
377 <a class="index-entry-id" id="index-Libtool"></a>
378 <a class="index-entry-id" id="index-tests_002c-running"></a>
379 <p>The TeX&nbsp;Live build system was redesigned in 2009 to consistently use
380 Autoconf, Automake, and Libtool. Thus, running<br>&nbsp;&nbsp;&nbsp;<code class="code">configure
381 &amp;&amp; make &amp;&amp; make check &amp;&amp; make install</code><br>or the essentially-equivalent
382 top-level <code class="code">Build</code> script suffices to build and install the TL
383 programs. The <code class="code">make check</code> clause performs various tests of the
384 generated programs&mdash;not strictly required but strongly recommended.
385 Running <code class="code">configure --help</code> will display a comprehensive list of
386 all <code class="code">configure</code> options.
387 </p>
388 <p>The main components of the TL build system are:
389 </p>
390 <dl class="table">
391 <dt><samp class="file">libs/<var class="var">lib</var></samp></dt>
392 <dd><p>Generic libraries.
393 </p>
394 </dd>
395 <dt><samp class="file">texk/<var class="var">lib</var></samp></dt>
396 <dd><p>TeX-specific libraries in subdirectories, notably
397 <var class="var">lib</var>=<code class="code">kpathsea</code>. (The other one is <samp class="file">texk/ptexenc</samp>.)
398 </p>
399 </dd>
400 <dt><samp class="file">texk/<var class="var">prog</var></samp></dt>
401 <dd><p>TeX-specific programs (that use Kpathsea).
402 </p>
403 </dd>
404 <dt><samp class="file">utils/<var class="var">prog</var></samp></dt>
405 <dd><p>Other programs (that don&rsquo;t use Kpathsea).
406 </p>
407 </dd>
408 </dl>
409
410 <a class="index-entry-id" id="index-kpse_002dpkgs_002em4"></a>
411 <p>The primary design goal of the build system is modularity. Each
412 program and library module (or package) specifies its own requirements
413 and properties, such as required libraries, whether an installed
414 (system) version of a library can be used, <code class="code">configure</code> options to
415 be seen at the top level, and more. An explicit list of all available
416 modules is kept in a single central place: <samp class="file">m4/kpse-pkgs.m4</samp>.
417 </p>
418 <p>A second, related goal is to configure and build each library before
419 configuring any other (program or library) module which uses that
420 library. This allows checking for properties and features of a
421 library built as part of the TL tree in much the same way as for a
422 system version of that library.
423 </p>
424 <p>All generic libraries and several programs are maintained
425 independently. The corresponding modules use (most of) the
426 distributed source tree and document any modifications of that source.
427 </p>
428 <p>All this is for the sake of simplifying both upgrading of modules and
429 integrating new modules into the TL build system. (Despite all
430 efforts, neither task is easy.)
431 </p>
432 <hr>
433 </div>
434 <div class="chapter-level-extent" id="Prerequisites">
435 <div class="nav-panel">
436 <p>
437 Next: <a href="#Building" accesskey="n" rel="next">Building</a>, Previous: <a href="#Overview-of-build-system" accesskey="p" rel="prev">Overview of build system</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
438 </div>
439 <h2 class="chapter" id="Prerequisites-1"><span>3 Prerequisites<a class="copiable-link" href="#Prerequisites-1"> &para;</a></span></h2>
440
441 <a class="index-entry-id" id="index-prerequisites-for-building"></a>
442 <a class="index-entry-id" id="index-requirements-for-building"></a>
443
444 <a class="index-entry-id" id="index-compilers_002c-C-and-C_002b_002b11"></a>
445 <p>Overall, building the TeX&nbsp;Live programs, when using all libraries from
446 the TL source tree, requires C and C++11 compilers, GNU <code class="code">make</code>,
447 and Python.
448 </p>
449 <ul class="itemize mark-bullet">
450 <li>If <code class="code">make</code> from your <code class="code">PATH</code> is not GNU <code class="code">make</code>, you can
451 set the <code class="code">MAKE</code> environment variable to whatever is necessary.
452
453 <a class="index-entry-id" id="index-GNU-make_002c-required"></a>
454 <a class="index-entry-id" id="index-gmake_002c-required"></a>
455 <a class="index-entry-id" id="index-FreeType_002c-requires-gmake"></a>
456 <a class="index-entry-id" id="index-_0024_0040-target-in-normal-make-rules"></a>
457 <p>GNU <code class="code">make</code> is required only because of third-party libraries,
458 notably FreeType. Automake/Autoconf output in general, and the
459 TL-maintained directories, work with any reasonable
460 <code class="code">make</code>.<a class="footnote" id="DOCF1" href="#FOOT1"><sup>1</sup></a>
461 </p>
462 </li><li><a class="index-entry-id" id="index-C_002b_002b11_002c-required"></a>
463 <a class="index-entry-id" id="index-dvisvgm_002c-requires-C_002b_002b11"></a>
464 <a class="index-entry-id" id="index-HarfBuzz_002c-requires-C_002b_002b11"></a>
465 <a class="index-entry-id" id="index-ICU_002c-requires-C_002b_002b11"></a>
466 A C++11 compiler is similarly required because of the third-party
467 libraries ICU and HarfBuzz (at least); the program <code class="code">dvisvgm</code> also
468 requires C++11. It is possible to build what remains with older
469 compilers, but you have to remove the C++11-dependent sources.
470 See <a class="xref" href="#Build-one-package">Build one package</a>.
471
472 </li><li><a class="index-entry-id" id="index-Python_002c-required-by-ICU"></a>
473 Python is required by ICU tests. (If you know how to disable these
474 tests and thus eliminate the requirement, please write.)
475
476 </li></ul>
477
478 <p>A few programs in the tree have additional requirements:
479 </p>
480 <dl class="table">
481 <dt><a id="index-perl_002c-required-by-web2c_002c-etc_002e"></a><span><samp class="file">web2c</samp><a class="copiable-link" href="#index-perl_002c-required-by-web2c_002c-etc_002e"> &para;</a></span></dt>
482 <dd><p>requires <code class="code">perl</code> for some tests run by <code class="code">make check</code>.
483 Incidentally, the TeX Live installer (<code class="code">install-tl</code>) and
484 manager (<code class="code">tlmgr</code>) are also written in Perl, but this does not
485 matter for compiling the sources.
486 </p>
487 </dd>
488 <dt><a id="index-X11-development_002c-required-by-X-clients"></a><span><samp class="file">xdvik</samp><a class="copiable-link" href="#index-X11-development_002c-required-by-X-clients"> &para;</a></span></dt>
489 <dt><samp class="file">xpdfopen</samp></dt>
490 <dd><p>require X11 headers and libraries, typically in devel(opment) packages
491 that are not installed by default.
492 </p>
493 </dd>
494 <dt><a class="index-entry-id" id="index-ApplicationServices-Mac-framework_002c-required-by-xetex"></a>
495 <a class="index-entry-id" id="index-Cocoa-Mac-framework_002c-required-by-xetex"></a>
496 <a id="index-fontconfig-library_002c-required-by-xetex"></a><span><samp class="file">xetex</samp><a class="copiable-link" href="#index-fontconfig-library_002c-required-by-xetex"> &para;</a></span></dt>
497 <dd><p>requires <samp class="file">fontconfig</samp> (again both headers and library), or, for
498 MacOS only, the <code class="code">ApplicationServices</code> and <code class="code">Cocoa</code>
499 frameworks.
500 </p>
501 </dd>
502 <dt><a class="index-entry-id" id="index-libsigsegv_002c-required-by-xindy"></a>
503 <a id="index-clisp_002c-required-by-xindy"></a><span><samp class="file">xindy</samp><a class="copiable-link" href="#index-clisp_002c-required-by-xindy"> &para;</a></span></dt>
504 <dd><p>requires GNU <code class="code">clisp</code>, <code class="code">libsigsegv</code>, and <code class="code">libiconv</code>;
505 additionally, to build the rules and/or documentation: <code class="code">perl</code>,
506 <code class="code">latex</code>, <code class="code">pdflatex</code>.
507 </p>
508 </dd>
509 </dl>
510
511 <p>Lacking the required tools, building these
512 programs must avoided, e.g.,<br>
513 <code class="code">configure --without-x --disable-xetex --disable-xindy</code>
514 </p>
515 <p>Modifying source files induces more requirements, as one might expect:
516 </p>
517 <ul class="itemize mark-bullet">
518 <li>Modification of any <code class="code">.y</code> or <code class="code">.l</code> source files requires
519 <samp class="file">bison</samp> or <samp class="file">flex</samp> to update the corresponding C sources.
520
521 </li><li>Modification of the sources for <code class="code">.info</code> files requires
522 <code class="code">makeinfo</code>.
523
524 </li><li>Modification of any part of the build system (M4 macros,
525 <samp class="file">configure.ac</samp>, <samp class="file">Makefile.am</samp>, or their fragments) requires
526 GNU M4, GNU Autoconf, GNU Automake, and GNU Libtool to update the
527 generated files. Furthermore, to reliably reproduce the build files,
528 the latest original GNU releases of these tools must be used, not any
529 distro packaging of them. See <a class="xref" href="#Build-system-tools">Build system tools</a>, for more
530 discussion.
531
532 </li></ul>
533
534 <p>If you haven&rsquo;t modified any source files, and infrastructure tools
535 such as <code class="code">autoconf</code> or <code class="code">makeinfo</code> are still being run, check
536 your timestamps&mdash;notably, <code class="code">use-commit-times</code> must be set to
537 <code class="code">yes</code> in your Subversion configuration (see <a class="pxref" href="#Build-system-tools">Build system tools</a>). No infrastructure tools are needed to do a normal build
538 (barring bugs).
539 </p>
540 <hr>
541 </div>
542 <div class="chapter-level-extent" id="Building">
543 <div class="nav-panel">
544 <p>
545 Next: <a href="#Installing" accesskey="n" rel="next">Installing</a>, Previous: <a href="#Prerequisites" accesskey="p" rel="prev">Prerequisites</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
546 </div>
547 <h2 class="chapter" id="Building-1"><span>4 Building<a class="copiable-link" href="#Building-1"> &para;</a></span></h2>
548
549 <a class="index-entry-id" id="index-building"></a>
550 <a class="index-entry-id" id="index-overall-build-process"></a>
551
552 <a class="index-entry-id" id="index-Build-script"></a>
553 <p>The top-level <samp class="file">Build</samp> script is intended to simplify building the
554 binaries distributed with TeX&nbsp;Live itself&mdash;we call this the &ldquo;native&rdquo;
555 TL build. It runs <code class="code">configure &amp;&amp; make world</code>, which builds
556 everything in a subdirectory of the main source tree (default
557 <samp class="file">Work/</samp>), installs everything in another subdirectory (default
558 <samp class="file">inst/</samp>), and finally runs <code class="code">make check</code>. The exact
559 directory and command names can be specified via environment variables
560 and a few leading options. All remaining arguments (assignments or
561 options) are passed to the <samp class="file">configure</samp> script. Please take a
562 look at the <samp class="file">./Build</samp> source file for more information; it is a
563 straightforward shell script.
564 </p>
565 <a class="index-entry-id" id="index-source-directory-building_002c-not-supported"></a>
566 <a class="index-entry-id" id="index-build-directory_002c-required"></a>
567 <p>An alternative, and the one we will mainly discuss here, is to run
568 <code class="code">configure</code> and <code class="code">make</code> in a suitable empty subdirectory.
569 Building in the source directory itself is not supported (sorry).
570 </p>
571
572 <ul class="mini-toc">
573 <li><a href="#Build-iteration" accesskey="1">Build iteration</a></li>
574 <li><a href="#Build-in-parallel" accesskey="2">Build in parallel</a></li>
575 <li><a href="#Build-distribution" accesskey="3">Build distribution</a></li>
576 <li><a href="#Build-one-package" accesskey="4">Build one package</a></li>
577 <li><a href="#Build-one-engine" accesskey="5">Build one engine</a></li>
578 <li><a href="#Cross-compilation" accesskey="6">Cross compilation</a></li>
579 </ul>
580 <hr>
581 <div class="section-level-extent" id="Build-iteration">
582 <div class="nav-panel">
583 <p>
584 Next: <a href="#Build-in-parallel" accesskey="n" rel="next">Build in parallel</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
585 </div>
586 <h3 class="section" id="Build-iteration-1"><span>4.1 Build iteration<a class="copiable-link" href="#Build-iteration-1"> &para;</a></span></h3>
587
588 <a class="index-entry-id" id="index-build-iteration"></a>
589 <a class="index-entry-id" id="index-iteration-through-sources_002c-by-configure-and-make"></a>
590
591 <p>Running the top-level <samp class="file">configure</samp> script configures the top level
592 and the subdirectories <samp class="file">libs</samp>, <samp class="file">utils</samp>, and <samp class="file">texk</samp>.
593 Running <code class="code">make</code> at the top level first iterates over the
594 TeX-specific libraries, and then runs <code class="code">make</code> in <samp class="file">libs</samp>,
595 <samp class="file">utils</samp>, and <samp class="file">texk</samp> to iterate over the generic libraries,
596 utility programs, and TeX-specific programs, respectively. These
597 iterations consist of two steps:
598 </p>
599 <ol class="enumerate">
600 <li> For each library or program module not yet configured, run
601 <code class="code">configure</code>, adding the configure option <code class="code">--disable-build</code>
602 if the module need not be built, otherwise running <code class="code">make all</code>.
603
604 </li><li> For each library or program module that must be built, run
605 <code class="code">make</code> for the selected target(s): <code class="code">default</code> or
606 <code class="code">all</code> to (re-)build, <code class="code">check</code> to run tests, <code class="code">install</code>,
607 etc.
608
609 </li></ol>
610
611 <p>Running the top-level <code class="code">make</code> a second time iterates again over
612 all the library and program modules, and finds (should find) nothing
613 to be done.
614 </p>
615 <hr>
616 </div>
617 <div class="section-level-extent" id="Build-in-parallel">
618 <div class="nav-panel">
619 <p>
620 Next: <a href="#Build-distribution" accesskey="n" rel="next">Build distribution</a>, Previous: <a href="#Build-iteration" accesskey="p" rel="prev">Build iteration</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
621 </div>
622 <h3 class="section" id="Build-in-parallel-1"><span>4.2 Build in parallel<a class="copiable-link" href="#Build-in-parallel-1"> &para;</a></span></h3>
623
624 <a class="index-entry-id" id="index-building-in-parallel"></a>
625 <a class="index-entry-id" id="index-parallel-build"></a>
626 <a class="index-entry-id" id="index-cache-for-configure"></a>
627
628 <a class="index-entry-id" id="index-dependencies_002c-with-several-output-files"></a>
629 <a class="index-entry-id" id="index-_002dj-make-option"></a>
630 <p>The TL build system carefully formulates dependencies as well as
631 <code class="code">make</code> rules when a tool (such as <code class="code">tangle</code>, <code class="code">ctangle</code>,
632 and <code class="code">convert</code>) creates several output files. This allows for
633 parallel builds (<code class="code">make -j <var class="var">n</var></code> with <em class="math"><var class="var">n</var>&gt;1</em> or even
634 <code class="code">make -j</code>) that can considerably speed up the TL build.
635 </p>
636 <a class="index-entry-id" id="index-TL_005fMAKE_005fFLAGS"></a>
637 <p>If you&rsquo;re using TL&rsquo;s <code class="code">Build</code> script, you can enable <code class="code">-j</code>
638 with the environment variable <code class="code">TL_MAKE_FLAGS</code>, as in:
639 &lsquo;<samp class="samp">env TL_MAKE_FLAGS=-j`nproc` ./Build</samp>&rsquo;.
640 </p>
641 <a class="index-entry-id" id="index-cache-file_002c-for-configure"></a>
642 <a class="index-entry-id" id="index-_002dC-configure-option"></a>
643 <p>Independently, a noticeable speed-up can also be gained by using a
644 configure cache file, i.e., specifying the <code class="code">configure</code> option
645 <code class="code">-C</code> (recommended).
646 </p>
647 <hr>
648 </div>
649 <div class="section-level-extent" id="Build-distribution">
650 <div class="nav-panel">
651 <p>
652 Next: <a href="#Build-one-package" accesskey="n" rel="next">Build one package</a>, Previous: <a href="#Build-in-parallel" accesskey="p" rel="prev">Build in parallel</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
653 </div>
654 <h3 class="section" id="Build-distribution-1"><span>4.3 Build distribution<a class="copiable-link" href="#Build-distribution-1"> &para;</a></span></h3>
655
656 <a class="index-entry-id" id="index-building-a-distribution"></a>
657 <a class="index-entry-id" id="index-distribution-tarball_002c-making"></a>
658
659 <a class="index-entry-id" id="index-dist-and-distcheck-targets-for-make"></a>
660 <p>Running <code class="code">make dist</code> or related targets at the top level outputs an
661 error message and fails. We no longer try to keep <code class="code">make dist</code>
662 working, although it could be restored if there is some use for it.
663 </p>
664 <p>The <code class="code">dist</code> target used to create a tarball
665 <samp class="file">tex-live-<var class="var">yyyy</var>-<var class="var">mm</var>-<var class="var">dd</var>.tar.xz</samp> from the TL source
666 tree, and <code class="code">distcheck</code> also verifies that this tarball suffices to
667 build and install all of TL.
668 </p>
669 <p>However, the result was not a complete or even usable TeX system,
670 since all the support files are lacking. We do not actually
671 distribute any such tarball, and have no plans to do so.
672 </p>
673 <p>See <a class="xref" href="#Installing">Installing</a>, for more information on what to do with the results
674 of a build.
675 </p>
676 <hr>
677 </div>
678 <div class="section-level-extent" id="Build-one-package">
679 <div class="nav-panel">
680 <p>
681 Next: <a href="#Build-one-engine" accesskey="n" rel="next">Build one engine</a>, Previous: <a href="#Build-distribution" accesskey="p" rel="prev">Build distribution</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
682 </div>
683 <h3 class="section" id="Build-one-package-1"><span>4.4 Build one package<a class="copiable-link" href="#Build-one-package-1"> &para;</a></span></h3>
684
685 <a class="index-entry-id" id="index-build-one-package"></a>
686 <a class="index-entry-id" id="index-one-package_002c-building"></a>
687
688 <a class="index-entry-id" id="index-_002d_002ddisable_002dall_002dpackages"></a>
689 <a class="index-entry-id" id="index-build-on-demand"></a>
690 <p>To build one package, the basic idea is to use the <code class="code">configure</code>
691 option <code class="code">--disable-all-pkgs</code> (see <a class="pxref" href="#g_t_002d_002ddisable_002dall_002dpkgs"><code class="code">--disable-all-pkgs</code></a>).
692 Then all program and library modules are configured but none are made.
693 However, the <samp class="file">Makefile</samp>s still contain all build rules and
694 dependencies and can be invoked to build an individual program or
695 library, first building any required libraries.
696 </p>
697 <p>Here is an example from start to finish for working on
698 <code class="code">dvipdfm-x</code>. Unfortunately, this does not suffice for building
699 the TeX engines; see the next section.
700 </p>
701 <div class="example">
702 <pre class="example-preformatted">mkdir mydir &amp;&amp; cd mydir # new working directory
703
704 # Get sources (<a class="url" href="https://tug.org/texlive/svn">https://tug.org/texlive/svn</a>), e.g.:
705 rsync -a --delete --exclude=.svn --exclude=Work \
706 tug.org::tldevsrc/Build/source/ .
707
708 # Create build directory:
709 mkdir Work &amp;&amp; cd Work
710
711 # Do the configure:
712 ../configure --disable-all-pkgs --enable-dvipdfm-x \
713 -C CFLAGS=-g CXXFLAGS=-g &gt;&amp;outc || echo fail
714
715 # Do the make:
716 make &gt;&amp;outm || echo fail
717
718 # Run the tests:
719 cd texk/dvipdfm-x
720 make check
721
722 # Run the new binary in the build tree, finding support files
723 # in a separate tree for a TeX Live release YYYY
724 # (Bourne shell syntax):
725 TEXMFROOT=/usr/local/texlive/YYYY \
726 TEXMFCNF=$TEXMFROOT/texmf-dist/web2c \
727 ./xdvipdfmx ...
728 </pre></div>
729
730 <a class="index-entry-id" id="index-TEXMFROOT-for-running-standalone"></a>
731 <a class="index-entry-id" id="index-TEXMFCNF-for-running-standalone"></a>
732
733 <p>Then you can modify source files in <samp class="file">mydir/texk/dvipdfm-x</samp> and
734 rerun <code class="code">make</code> in <samp class="file">mydir/Work/texk/dvipdfm-x</samp> to rebuild; that
735 build directory is where the binary ends up and where you can run a
736 debugger, etc.
737 </p>
738 <p>The second line of the <code class="code">configure</code> invocation shows examples of
739 extra things you likely want to specify if you intend to hack the
740 sources (and not just build binaries): the <code class="code">-C</code> speeds
741 <code class="code">configure</code> by enabling a cache file, and the <code class="code">CFLAGS</code> and
742 <code class="code">CXXFLAGS</code> settings eliminate compiler optimization for debugging
743 purposes.
744 </p>
745 <p>Of course, you need to actually look at the output and check that
746 things are working. There are many <code class="code">configure</code> options you can
747 tweak as desired; check the output from <code class="code">configure --help</code>. It
748 is also a good idea to run <code class="code">make check</code> after making any changes,
749 to ensure that whatever tests have been written still pass.
750 </p>
751 <h4 class="subsubheading" id="Reducing-source-download-size"><span>Reducing source download size<a class="copiable-link" href="#Reducing-source-download-size"> &para;</a></span></h4>
752
753 <a class="index-entry-id" id="index-size-of-source-tree"></a>
754 <p>The above retrieves the entire TL source tree (several
755 hundred megabytes). It is natural to ask if this is really necessary.
756 Strictly speaking, the answer is no, but it is vastly more convenient
757 to do so. If you cut down the source tree, you must also give
758 additional <code class="code">configure</code> flags to individually disable using system
759 versions of libraries, or the intricacies of the dependencies (such as
760 <code class="code">teckit</code> requiring <code class="code">zlib</code>) will have undesired side effects.
761 For an example of this approach, see the <code class="code">build-pdftex.sh</code> script
762 in the <code class="code">pdftex</code> development source (details at
763 <a class="url" href="http://pdftex.org">http://pdftex.org</a>), which is indeed such a cut-down TL source
764 tree.
765 </p>
766 <h4 class="subsubheading" id="GCC-used-by-default"><span>GCC used by default<a class="copiable-link" href="#GCC-used-by-default"> &para;</a></span></h4>
767
768 <a class="index-entry-id" id="index-CC_003dc_002dcompiler"></a>
769 <a class="index-entry-id" id="index-CXX_003dc_002b_002b_002dcompiler"></a>
770 <a class="index-entry-id" id="index-OBJCXX_003dobjc_002dcompiler"></a>
771 <a class="index-entry-id" id="index-gcc_002c-default-compilers"></a>
772 <p>By default, the <code class="code">gcc</code> compilers will be used if present;
773 otherwise, individual packages may use something different. You can
774 explicitly specify the compilers to be used with the environment
775 variables <code class="code">CC</code>, <code class="code">CXX</code>, and <code class="code">OBJCXX</code>.
776 </p>
777 <h4 class="subsubheading" id="Removing-C_002b11-dependency"><span>Removing C+11 dependency<a class="copiable-link" href="#Removing-C_002b11-dependency"> &para;</a></span></h4>
778
779 <a class="index-entry-id" id="index-C_002b_002b11_002c-removing-dependent-sources"></a>
780 <p>Some libraries and programs require C++11; one such is XeTeX. If you
781 want to build with an older compiler lacking such support, you need to
782 (re)move those source directories; unfortunately, specifying
783 <code class="code">--disable</code> for them does not suffice. It&rsquo;s also necessary to
784 specify <code class="code">--disable-xetex</code> explicitly. Specifically, before
785 running <code class="code">configure --disable-xetex ...</code>:
786 </p>
787 <div class="example">
788 <pre class="example-preformatted">rm -rf libs/icu libs/graphite2 texk/dvisvgm texk/web2c/xetexdir
789 </pre></div>
790
791 <a class="index-entry-id" id="index-_002d_002denable_002dmissing-to-ignore-dependencies"></a>
792 <p>Also, even with <code class="code">--disable-all-pkgs</code>, dependencies are (currently)
793 checked. One notable case: if a (non-MacOS) system does not have
794 <code class="code">fontconfig</code>, XeTeX cannot be built (see <a class="pxref" href="#Prerequisites">Prerequisites</a>),
795 and <code class="code">configure</code> will terminate even with <code class="code">--disable-xetex</code>.
796 To proceed without such dependencies, specify <code class="code">--enable-missing</code>
797 also.
798 </p>
799 <p>As of 2022, HarfBuzz also requires C++11. Therefore even more would
800 have to be disabled and removed, notably including <code class="code">luahbtex</code>,
801 the standard engine used for LuaLaTeX. Removing that would not
802 be acceptable for builds intended for distribution; but perhaps for
803 testing the above information could still be useful.
804 </p>
805 <a class="index-entry-id" id="index-removing-build-directories"></a>
806 <a class="index-entry-id" id="index-configure-problems_002c-work-around-by-removing"></a>
807 <p>In general, the TL <code class="code">configure</code> will run in all directories.
808 Therefore a general workaround for build problems is to remove failing
809 directories from the tree, and also specify the relevant
810 <code class="code">--disable-...</code> option(s).
811 </p>
812 <p>Patches to improve all this would be most welcome.
813 </p>
814 <hr>
815 </div>
816 <div class="section-level-extent" id="Build-one-engine">
817 <div class="nav-panel">
818 <p>
819 Next: <a href="#Cross-compilation" accesskey="n" rel="next">Cross compilation</a>, Previous: <a href="#Build-one-package" accesskey="p" rel="prev">Build one package</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
820 </div>
821 <h3 class="section" id="Build-one-engine-1"><span>4.5 Build one engine<a class="copiable-link" href="#Build-one-engine-1"> &para;</a></span></h3>
822
823 <a class="index-entry-id" id="index-build-one-engine"></a>
824 <a class="index-entry-id" id="index-one-engine_002c-building"></a>
825 <a class="index-entry-id" id="index-engine_002c-building-one"></a>
826
827 <p>Unfortunately, there is one common case where the steps in the
828 preceding section to build one package (see <a class="pxref" href="#Build-one-package">Build one package</a>) do
829 not suffice: wanting to build one, or a subset, of the TeX engines
830 (or other Web2c programs).
831 </p>
832 <p>The simplest way to do this is to disable everything and then
833 explicitly specify what to make. For example, to build only the
834 original TeX:
835 </p>
836 <div class="example">
837 <pre class="example-preformatted">cd Work # top build directory
838 ../configure --without-x --disable-shared --disable-all-pkgs \
839 --enable-tex --disable-synctex --disable-xetex \
840 --enable-missing -C CFLAGS=-g CXXFLAGS=-g
841 make
842 cd texk/web2c # cd engine build directory
843 make tex # must specify target
844 </pre></div>
845
846 <p>The first <code class="code">make</code> run will configure everything, and even build
847 the libraries, even though the packages are disabled.
848 </p>
849 <p>The source tree can be cut down to just what is needed for the given
850 engine (the separate pdfTeX and LuaTeX source repositories do
851 this, for example), but see caveats in previous section. When the
852 <code class="code">--disable-xetex</code> and <code class="code">--enable-missing</code> options are needed
853 is also explained in the previous section.
854 </p>
855 <p>If you want to debug an X-related program or shared library setup, or
856 other variants, change the <code class="code">configure</code> options
857 accordingly. Either <code class="code">../Build</code> or <code class="code">../configure</code> can be run.
858 </p>
859 <p>Then it is necessary to again specify the target engine (<code class="code">tex</code>,
860 in the above) in the <code class="code">make</code>.
861 </p>
862 <p>All these complications are rather unfortunate. Patches are welcome.
863 </p>
864 <h4 class="subsubheading" id="Testing-one-engine"><span>Testing one engine<a class="copiable-link" href="#Testing-one-engine"> &para;</a></span></h4>
865
866 <p>To run only the tests for a given engine, say <code class="code">hitex</code>:
867 </p>
868 <div class="example">
869 <pre class="example-preformatted">make -C $ww check SUBDIRS=. TESTS='$(hitex_tests)'
870 </pre></div>
871
872 <p>where <code class="code">$ww</code> is the web2c build directory, that is,
873 <samp class="file">ww=/.../Build/source/Work/texk/web2c</samp>.
874 </p>
875 <p>It&rsquo;s also possible to run individual tests the same way, using the test
876 name exactly as specified in the <samp class="file">.am</samp> file:
877 </p>
878 <div class="example">
879 <pre class="example-preformatted">make -C $ww check SUBDIRS=. TESTS=hitexdir/tests/hello.test
880 </pre></div>
881
882 <p>Without the <code class="code">SUBDIRS=.</code>, errors like this will show up, since
883 <code class="code">make</code> will descend into every directory.
884 </p>
885 <div class="example">
886 <pre class="example-preformatted">fatal: making test-suite.log: failed to create hitexdir/tests/hello.test
887 </pre></div>
888
889 <a class="index-entry-id" id="index-_002d_002dno_002dprint_002ddirectory-GNU-make-option"></a>
890 <p>If you get tired of looking at the &lsquo;<samp class="samp">Entering</samp>&rsquo;/&lsquo;<samp class="samp">Leaving
891 directory</samp>&rsquo; lines, you can add the (GNU) make option
892 <code class="code">--no-print-dir</code>.
893 </p>
894 <p>You may find it useful to put lengthy incantations like this into a
895 trivial shell script with a short name (say, <code class="code">hitch</code>). Then you
896 just run <code class="code">hitch</code> and edit the file when necessary to change
897 the options.
898 </p>
899 <hr>
900 </div>
901 <div class="section-level-extent" id="Cross-compilation">
902 <div class="nav-panel">
903 <p>
904 Previous: <a href="#Build-one-engine" accesskey="p" rel="prev">Build one engine</a>, Up: <a href="#Building" accesskey="u" rel="up">Building</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
905 </div>
906 <h3 class="section" id="Cross-compilation-1"><span>4.6 Cross compilation<a class="copiable-link" href="#Cross-compilation-1"> &para;</a></span></h3>
907
908 <a class="index-entry-id" id="index-cross-compilation"></a>
909 <p>In a cross compilation a <em class="dfn">build</em> system is used to create
910 binaries to be executed on a <em class="dfn">host</em> system with different
911 hardware and/or operating system.
912 </p>
913 <a class="index-entry-id" id="index-native-cross-compilation"></a>
914 <p>In simple cases, the build system can execute binaries for the host
915 system. This typically occurs for bi-arch systems where, e.g.,
916 <code class="code">i386-linux</code> binaries can run on <code class="code">x86_64-linux</code> systems and
917 <code class="code">win32</code> binaries can run on <code class="code">win64</code> systems. Although
918 sometimes called &ldquo;native cross&rdquo;, technically this is not cross
919 compilation at all. In most such cases it suffices to specify
920 suitable compiler flags. It might be useful to add the configure
921 option <code class="code">--build=<var class="var">host</var></code> to get the correct canonical host
922 name, but note that this should <em class="emph">not</em> be <code class="code">--host=<var class="var">host</var></code>
923 (see <a data-manual="autoconf" href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Hosts-and-Cross_002dCompilation">Hosts and Cross-Compilation</a> in <cite class="cite">GNU Autoconf</cite>).
924 </p>
925 <p>In order to build, e.g., 32-bit binaries with <code class="command">clang</code> on a 64-bit
926 MacOS system one could use:
927 </p>
928 <div class="example">
929 <pre class="example-preformatted">TL_BUILD_ENV=&quot;CC='clang -arch i386' \
930 CXX='clang++ -arch i386' \
931 OBJCXX='clang++ -arch i386'&quot; \
932 ./Build --build=i386-apple-darwin
933 </pre></div>
934
935
936 <ul class="mini-toc">
937 <li><a href="#Cross-configuring" accesskey="1">Cross configuring</a></li>
938 <li><a href="#Cross-problems" accesskey="2">Cross problems</a></li>
939 </ul>
940 <hr>
941 <div class="subsection-level-extent" id="Cross-configuring">
942 <div class="nav-panel">
943 <p>
944 Next: <a href="#Cross-problems" accesskey="n" rel="next">Cross problems</a>, Up: <a href="#Cross-compilation" accesskey="u" rel="up">Cross compilation</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
945 </div>
946 <h4 class="subsection" id="Cross-configuring-1"><span>4.6.1 Cross configuring<a class="copiable-link" href="#Cross-configuring-1"> &para;</a></span></h4>
947
948 <a class="index-entry-id" id="index-cross-compilation-configuring"></a>
949 <a class="index-entry-id" id="index-configuring_002c-for-cross-compilation"></a>
950
951 <a class="index-entry-id" id="index-_002d_002dhost_003dhost"></a>
952 <a class="index-entry-id" id="index-_002d_002dbuild_003dhost"></a>
953 <p>In a standard cross compilation, binaries for the host system cannot
954 execute on the build system and it is necessary to specify the
955 configure options <code class="code">--host=<var class="var">host</var></code> and
956 <code class="code">--build=<var class="var">build</var></code> with two different values.
957 </p>
958 <p>Building binaries requires suitable &ldquo;cross&rdquo; tools, e.g., compiler,
959 linker, and archiver, and perhaps a &ldquo;cross&rdquo; version of
960 <code class="code">pkg-config</code> and similar to locate host system libraries.
961 Autoconf expects that these cross tools are given by their usual
962 variables or found under their usual name prefixed with
963 <code class="code"><var class="var">host</var>-</code>. Here a list of such tools and corresponding
964 variables:
965 </p>
966 <div class="example">
967 <pre class="example-preformatted"><code class="code">ar</code> AR
968 <code class="code">freetype-config</code> FT2_CONFIG
969 <code class="code">g++</code> CXX
970 <code class="code">gcc</code> CC
971 <code class="code">icu-config</code> ICU_CONFIG
972 <code class="code">objdump</code> OBJDUMP
973 <code class="code">pkg-config</code> PKG_CONFIG
974 <code class="code">ranlib</code> RANLIB
975 <code class="code">strip</code> STRIP
976 </pre></div>
977
978 <a class="index-entry-id" id="index-mingw32"></a>
979 <p>In order to, e.g., build <code class="code">mingw32</code> binaries on
980 <code class="code">x86_64-linux</code> with a cross compiler found as
981 <samp class="file">i386-pc-mingw32-gcc</samp> one would specify
982 </p>
983 <div class="example">
984 <pre class="example-preformatted">--host=i386-pc-mingw32 --build=x86_64-linux-gnu
985 </pre></div>
986
987 <p>or perhaps
988 </p>
989 <div class="example">
990 <pre class="example-preformatted">--host=mingw32 --build=x86_64-linux CC=i386-pc-mingw32-gcc
991 </pre></div>
992
993 <p>but this latter, especially, might require adding <code class="code">CXX</code> and others.
994 </p>
995 <p>Configure arguments such as <code class="code">CFLAGS=&hellip;</code> refer to the cross
996 compiler. If necessary, you can specify compilers and flags for the
997 few auxiliary C and C++ programs required for the build process as
998 configure arguments
999 </p>
1000 <a class="index-entry-id" id="index-BUILDCC_002c-BUILDCFLAGS_002c-_002e_002e_002e"></a>
1001 <div class="example">
1002 <pre class="example-preformatted">BUILDCC=...
1003 BUILDCPPFLAGS=...
1004 BUILDCFLAGS=...
1005 BUILDCXX=...
1006 BUILDCXXFLAGS=...
1007 BUILDLDFLAGS=...
1008 </pre></div>
1009
1010 <hr>
1011 </div>
1012 <div class="subsection-level-extent" id="Cross-problems">
1013 <div class="nav-panel">
1014 <p>
1015 Previous: <a href="#Cross-configuring" accesskey="p" rel="prev">Cross configuring</a>, Up: <a href="#Cross-compilation" accesskey="u" rel="up">Cross compilation</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1016 </div>
1017 <h4 class="subsection" id="Cross-problems-1"><span>4.6.2 Cross problems<a class="copiable-link" href="#Cross-problems-1"> &para;</a></span></h4>
1018
1019 <a class="index-entry-id" id="index-cross-compilation-problems"></a>
1020
1021 <p>The fact that binaries for the host system cannot be executed on the
1022 build system causes some problems.
1023 </p>
1024 <p>One problem is that configure tests using <code class="code">AC_RUN_IFELSE</code> can
1025 compile and link the test program but cannot execute it. Such tests
1026 should be avoided if possible and otherwise must supply a pessimistic
1027 test result.
1028 </p>
1029 <a class="index-entry-id" id="index-squeeze"></a>
1030 <a class="index-entry-id" id="index-web2c-program"></a>
1031 <a class="index-entry-id" id="index-freetype-cross-compiling"></a>
1032 <a class="index-entry-id" id="index-CC_005fBUILD"></a>
1033 <p>Another problem arises if the build process must execute some
1034 (auxiliary or installable) programs. Auxiliary programs can be placed
1035 into a subdirectory that is configured natively as is done for
1036 <samp class="file">texk/web2c/web2c</samp>, <samp class="file">texk/dvipsk/squeeze</samp>, and
1037 <samp class="file">texk/xdvik/squeeze</samp>. The module <samp class="file">libs/freetype2</samp> uses the
1038 value of <code class="code">CC_BUILD</code>, <samp class="file"><var class="var">build</var>-gcc</samp>, <samp class="file">gcc</samp>, or
1039 <samp class="file">cc</samp> as the compiler for the auxiliary program.
1040 </p>
1041 <a class="index-entry-id" id="index-ICU-cross-compiling"></a>
1042 <p>The situation for installable programs needed by the build process is
1043 somewhat different. A rather expensive possibility, chosen for the ICU
1044 libraries in module <samp class="file">libs/icu</samp>, is to first compile natively for
1045 the build system and in a second step to use these (uninstalled)
1046 programs during the cross compilation.
1047 </p>
1048 <a class="index-entry-id" id="index-tangle"></a>
1049 <a class="index-entry-id" id="index-ctangle"></a>
1050 <a class="index-entry-id" id="index-otangle"></a>
1051 <a class="index-entry-id" id="index-tie"></a>
1052 <p>This approach would also be possible for the tools such as
1053 <samp class="file">tangle</samp> used in the module <samp class="file">texk/web2c</samp> to build the WEB
1054 programs, but that would require first building a native
1055 <code class="code">kpathsea</code> library. To avoid this complication, cross
1056 compilation of programs written in (C)WEB requires sufficiently recent
1057 installed versions of <samp class="file">tangle</samp>, <samp class="file">ctangle</samp>, <samp class="file">otangle</samp>,
1058 and <samp class="file">tie</samp>.
1059 </p>
1060 <a class="index-entry-id" id="index-xindy-cross-compiling-requires-clisp"></a>
1061 <p>Building <code class="code">xindy</code> requires running the host system <code class="code">clisp</code>
1062 binary, thus cross compilation is painful, but possible.
1063 </p>
1064 <hr>
1065 </div>
1066 </div>
1067 </div>
1068 <div class="chapter-level-extent" id="Installing">
1069 <div class="nav-panel">
1070 <p>
1071 Next: <a href="#Layout-and-infrastructure" accesskey="n" rel="next">Layout and infrastructure</a>, Previous: <a href="#Building" accesskey="p" rel="prev">Building</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1072 </div>
1073 <h2 class="chapter" id="Installing-1"><span>5 Installing<a class="copiable-link" href="#Installing-1"> &para;</a></span></h2>
1074
1075 <a class="index-entry-id" id="index-installing"></a>
1076 <p>This section discusses the results of <code class="code">make install</code> in the
1077 source tree.
1078 </p>
1079 <a class="index-entry-id" id="index-support-files_002c-separate-from-build"></a>
1080 <a class="index-entry-id" id="index-texlive_002etlpdb_002c-TeX-Live-database"></a>
1081 <a class="index-entry-id" id="index-install_002dtl_002c-TeX-Live-installer"></a>
1082 <a class="index-entry-id" id="index-plain_002etex_002c-not-in-source-tree"></a>
1083 <p>The main consideration is that <code class="code">make install</code> is nothing like
1084 enough to make a usable TeX installation. It creates the compiled
1085 binaries, but (thousands of) support files are also needed; just as a
1086 first example, <samp class="file">plain.tex</samp> is not installed. All the support
1087 files are maintained completely independently and are not present in
1088 the TL <samp class="file">Build/source</samp> tree of sources to be compiled.
1089 </p>
1090 <p>Thus, perhaps the simplest way to get a running TeX system after
1091 building new binaries from these sources is to do a normal
1092 installation of TeX Live, and then use the new binaries as a
1093 so-called &ldquo;custom&rdquo; platform
1094 (<a class="url" href="https://tug.org/texlive/custom-bin.html">https://tug.org/texlive/custom-bin.html</a>).
1095 </p>
1096 <p>Alternatively, the best general basis for dealing with them, for
1097 example if you&rsquo;re trying to figure out how to support TeX in a
1098 general distro, is the TeX&nbsp;Live (plain text) database in
1099 <samp class="file">Master/tlpkg/texlive.tlpdb</samp>, and/or the TeX&nbsp;Live installer,
1100 <code class="code">install-tl</code>.
1101 </p>
1102 <p>More information is under <samp class="file">Master/tlpkg</samp> and at
1103 <a class="url" href="https://tug.org/texlive/distro.html">https://tug.org/texlive/distro.html</a> and
1104 <a class="url" href="https://tug.org/texlive/build.html#deploy">https://tug.org/texlive/build.html#deploy</a>.
1105 </p>
1106
1107 <ul class="mini-toc">
1108 <li><a href="#Installation-directories" accesskey="1">Installation directories</a></li>
1109 <li><a href="#Linked-scripts" accesskey="2">Linked scripts</a></li>
1110 <li><a href="#Distro-builds" accesskey="3">Distro builds</a></li>
1111 </ul>
1112 <hr>
1113 <div class="section-level-extent" id="Installation-directories">
1114 <div class="nav-panel">
1115 <p>
1116 Next: <a href="#Linked-scripts" accesskey="n" rel="next">Linked scripts</a>, Up: <a href="#Installing" accesskey="u" rel="up">Installing</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1117 </div>
1118 <h3 class="section" id="Installation-directories-1"><span>5.1 Installation directories<a class="copiable-link" href="#Installation-directories-1"> &para;</a></span></h3>
1119
1120 <a class="index-entry-id" id="index-installation-directories"></a>
1121 <a class="index-entry-id" id="index-directories_002c-for-installation"></a>
1122 <a class="index-entry-id" id="index-paths_002c-for-installation"></a>
1123
1124 <p>Running <code class="code">make install</code> (or <code class="code">make install-strip</code>) installs
1125 executables in <code class="code"><var class="var">bindir</var></code>, libraries in <code class="code"><var class="var">libdir</var></code>,
1126 headers in <code class="code"><var class="var">includedir</var></code>, general data (including &ldquo;linked
1127 scripts&rdquo;, see <a class="pxref" href="#Linked-scripts">Linked scripts</a>) in
1128 <code class="code"><var class="var">datarootdir</var>/texmf-dist</code>, man pages in <code class="code"><var class="var">mandir</var></code>,
1129 and Info files in <code class="code"><var class="var">infodir</var></code>.
1130 </p>
1131 <p>The values of these directories are determined by <code class="code">configure</code>
1132 and can be specified explicitly as options such as
1133 <code class="code">--prefix=<var class="var">prefix</var></code> or <code class="code">--bindir=<var class="var">bindir</var></code>;
1134 otherwise, they are given by their usual Autoconf defaults:
1135 </p>
1136 <div class="example">
1137 <pre class="example-preformatted"><var class="var">prefix</var> /usr/local
1138 <var class="var">exec_prefix</var> <var class="var">prefix</var>
1139 <var class="var">bindir</var> <var class="var">exec_prefix</var>/bin
1140 <var class="var">libdir</var> <var class="var">exec_prefix</var>/lib
1141 <var class="var">includedir</var> <var class="var">prefix</var>/include
1142 <var class="var">datarootdir</var> <var class="var">prefix</var>/share
1143 <var class="var">mandir</var> <var class="var">datarootdir</var>/man
1144 <var class="var">infodir</var> <var class="var">datarootdir</var>/info
1145 </pre></div>
1146
1147 <p>except possibly modified as follows:
1148 </p>
1149 <ul class="itemize mark-bullet">
1150 <li>If the option <code class="code">--enable-multiplatform</code> is given,
1151 <code class="code">/<var class="var">platform</var></code> (i.e., the canonical platform name) is appended
1152 to <code class="code"><var class="var">bindir</var></code> and <code class="code"><var class="var">libdir</var></code>. This is implied for a
1153 native TL build.
1154
1155 </li><li><div class="raggedright"><p class="raggedright-paragraph">In a native TL build, <code class="code"><var class="var">datarootdir</var></code> is set to
1156 <code class="code"><var class="var">prefix</var></code>, <code class="code"><var class="var">infodir</var></code> is set to
1157 <code class="code"><var class="var">prefix</var>/texmf-dist/doc/info</code>, and <code class="code"><var class="var">mandir</var></code> to
1158 <code class="code"><var class="var">prefix</var>/texmf-dist/doc/man</code>, corresponding to the
1159 directories used in the TL distribution.
1160 </p></div>
1161 </li></ul>
1162
1163 <p>The top-level <samp class="file">configure</samp> script displays all these
1164 installation paths.
1165 </p>
1166 <p>For the native TL build, the <code class="code">Build</code> script leaves the binaries
1167 in <samp class="file">./inst/bin/<var class="var">std-system-triplet</var></samp>. The new binaries are
1168 not directly usable from that location; they need to be copied to
1169 <samp class="file">Master/bin/<var class="var">tl-platform</var></samp>. The other files and directories
1170 that end up in <samp class="file">./inst/</samp> are ignored.
1171 </p>
1172 <hr>
1173 </div>
1174 <div class="section-level-extent" id="Linked-scripts">
1175 <div class="nav-panel">
1176 <p>
1177 Next: <a href="#Distro-builds" accesskey="n" rel="next">Distro builds</a>, Previous: <a href="#Installation-directories" accesskey="p" rel="prev">Installation directories</a>, Up: <a href="#Installing" accesskey="u" rel="up">Installing</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1178 </div>
1179 <h3 class="section" id="Linked-scripts-1"><span>5.2 Linked scripts<a class="copiable-link" href="#Linked-scripts-1"> &para;</a></span></h3>
1180
1181 <a class="index-entry-id" id="index-linked-scripts"></a>
1182 <a class="index-entry-id" id="index-scripts_002c-linked-and-not-maintained"></a>
1183 <a class="index-entry-id" id="index-symbolic-links_002c-used-for-scripts"></a>
1184
1185 <a class="index-entry-id" id="index-symlinks_002c-used-for-scripts"></a>
1186 <a class="index-entry-id" id="index-wrapper-binary-for-scripts-on-Windows"></a>
1187 <a class="index-entry-id" id="index-Windows_002c-invoking-scripts-on"></a>
1188 <p>Quite a few of the executables in TeX&nbsp;Live are architecture-independent
1189 shell, Perl, or other interpreted scripts, rather than compiled
1190 binaries. A few are maintained as part of the TL source tree, but
1191 most are maintained independently in their own packages, with copies
1192 under <samp class="file">texk/texlive/linked_scripts</samp>.
1193 </p>
1194 <p>These so-called <em class="dfn">linked scripts</em> are installed under
1195 <code class="code"><var class="var">datarootdir</var>/texmf-dist/scripts</code>; for Unix-like systems a
1196 symbolic link is made in <code class="code"><var class="var">bindir</var></code>. For example, a symlink
1197 points from <code class="code"><var class="var">bindir</var>/fmtutil</code> to
1198 <code class="code"><var class="var">datarootdir</var>/texmf-dist/scripts/texlive/fmtutil.pl</code>. The
1199 symlink is relative, so the installation root can be anywhere.
1200 </p>
1201 <a class="index-entry-id" id="index-wrapper-for-scripts_002c-on-Windows"></a>
1202 <p>For Windows, we cannot portably use symlinks, so a standard wrapper
1203 binary (copied to, e.g., <code class="code"><var class="var">bindir</var>/fmtutil.exe</code>) serves the
1204 same purpose (the source for the wrapper is in
1205 <samp class="file">texk/texlive/windows_wrapper</samp>).
1206 </p>
1207 <p>One reason for all this is to avoid having many copies of the same
1208 script; a more important reason is that it guarantees the scripts will
1209 stay in sync across the different supported operating systems.
1210 </p>
1211 <a class="index-entry-id" id="index-asymptote"></a>
1212 <a class="index-entry-id" id="index-biber"></a>
1213 <a class="index-entry-id" id="index-xindy"></a>
1214 <a class="index-entry-id" id="index-xz"></a>
1215 <a class="index-entry-id" id="index-wget"></a>
1216 <p>Most important of all, we want the <code class="code"><var class="var">bindir</var></code> resulting from
1217 <code class="code">make install</code> in the TL source tree to be as close as possible
1218 to what&rsquo;s in thej TL distribution. At present, there are a few
1219 exceptions&mdash;Asymptote, Biber, Xindy&mdash;and each one creates
1220 considerable extra work. We don&rsquo;t want to add more. (See
1221 <a class="url" href="https://tug.org/texlive/build.html">https://tug.org/texlive/build.html</a> for information about
1222 building those exceptions, as well as the <code class="code">xz</code> and <code class="code">wget</code>
1223 programs that are used in the TL infrastructure.)
1224 </p>
1225 <a class="index-entry-id" id="index-scripts_002dtargets_002elst"></a>
1226 <p>As part of the <code class="code">make install</code> in the <samp class="file">linked_scripts</samp>
1227 directory, a file <samp class="file">scripts-targets.lst</samp> is created to record all
1228 the links that are created this way, so that distros and others can
1229 reproduce them. The file has one line per link. The first word is the
1230 target of the link (e.g.,
1231 &lsquo;<samp class="samp">texmf-dist/scripts/texlive/fmtutil.pl</samp>&rsquo;), and the second word
1232 is the name of the link to be placed in the bindir (e.g.,
1233 &lsquo;<samp class="samp">fmtutil</samp>&rsquo;). Determining the relative link target (how many
1234 &lsquo;<samp class="samp">../</samp>&rsquo;s) is left to the users of this file, since it varies among
1235 distributions. It can be assumed there is no whitespace in these filenames.
1236 </p>
1237 <p>A few links are within bindir; in that case, the first word of the
1238 line is just a base name, e.g., the file &lsquo;<samp class="samp">fmtutil mktexfmt</samp>&rsquo; means
1239 that doing the equivalent of <code class="code">ln -s fmtutil mktexfmt</code> in the bindir.
1240 </p>
1241 <p>Be aware that although extensions are usually stripped (as with
1242 <code class="code">fmtutil</code>), there are exceptions, such as
1243 <code class="code">memoize-extract.pl</code> and <code class="code">listings-ext.sh</code>.
1244 </p>
1245 <p>The <samp class="file">scripts-targets.lst</samp> file started being created as of the
1246 TeX&nbsp;Live 2025 release. Historically, another file <samp class="file">scripts.lst</samp> has
1247 been (and still is) created, containing only the link targets, and
1248 using a Bourne shell syntax.
1249 </p>
1250 <hr>
1251 </div>
1252 <div class="section-level-extent" id="Distro-builds">
1253 <div class="nav-panel">
1254 <p>
1255 Previous: <a href="#Linked-scripts" accesskey="p" rel="prev">Linked scripts</a>, Up: <a href="#Installing" accesskey="u" rel="up">Installing</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1256 </div>
1257 <h3 class="section" id="Distro-builds-1"><span>5.3 Distro builds<a class="copiable-link" href="#Distro-builds-1"> &para;</a></span></h3>
1258
1259 <a class="index-entry-id" id="index-distro_002c-building-for"></a>
1260 <a class="index-entry-id" id="index-operating-system-distribution_002c-building-for"></a>
1261 <a class="index-entry-id" id="index-system-distribution_002c-building-for"></a>
1262
1263 <a class="index-entry-id" id="index-GNU_002fLinux-distro"></a>
1264 <a class="index-entry-id" id="index-BSD-distro"></a>
1265 <p>Although they use the same code base, building for the native TL
1266 distribution as shipped by the TeX user groups is typically quite
1267 different from a &ldquo;distro&rdquo; build needed by, e.g., a full GNU/Linux or
1268 BSD operating system distribution.
1269 </p>
1270 <a class="index-entry-id" id="index-shared-libraries_002c-using-vs_002e-avoiding"></a>
1271 <p>The native TL distribution uses shared libraries only when absolutely
1272 necessary (<samp class="file">libc</samp>, <samp class="file">libm</samp>, X11 libraries, and
1273 <samp class="file">libfontconfig</samp>). In contrast, a distro typically wants to use
1274 as many shared libraries as possible from elsewhere on the system,
1275 including TeX-specific libraries such as <samp class="file">libkpathsea</samp> (even
1276 though Kpathsea has never officially been released as a shared
1277 library). In addition, the installation paths will, in general, be
1278 completely different.
1279 </p>
1280 <p>Here are the <code class="code">configure</code> options that distro builds are likely to
1281 find most relevant:
1282 </p>
1283 <dl class="table">
1284 <dt><code class="code">--disable-native-texlive-build</code></dt>
1285 <dd><p>This must be specified to avoid interference from the many tweaks we
1286 do for the native TL build.
1287 </p>
1288 </dd>
1289 <dt><code class="code">--with-banner-add=/<var class="var">SomeDistro</var></code></dt>
1290 <dd><p>This isn&rsquo;t technically required, but is strongly recommended, so your
1291 build and your distro can be distinguished from others.
1292 </p>
1293 </dd>
1294 <dt><code class="code">--enable-shared</code></dt>
1295 <dd><p>Build shared versions of the TeX-specific libraries (uses
1296 <code class="code">libtool</code>).
1297 </p>
1298 </dd>
1299 <dt><code class="code">--disable-static</code></dt>
1300 <dd><p>Do not build the static versions of the TeX-specific libraries.
1301 </p>
1302 </dd>
1303 <dt><code class="code">--with-system-<var class="var">lib</var></code></dt>
1304 <dd><p>Look for and use a system version of the library <var class="var">lib</var>.
1305 <code class="code">configure --help</code> will give you the list of possibilities.
1306 </p>
1307 </dd>
1308 <dt><code class="code">--with-<var class="var">lib</var>-includes=<var class="var">dir</var></code></dt>
1309 <dt><code class="code">--with-<var class="var">lib</var>-libdir=<var class="var">dir</var></code></dt>
1310 <dd><p>If needed, allows you to specify where the headers/code are for the
1311 given library <var class="var">lib</var>.
1312 </p>
1313 </dd>
1314 <dt><code class="code">--prefix=/usr</code></dt>
1315 <dt><code class="code">--prefix=/opt/TeXLive</code></dt>
1316 <dd><p>Or whatever your convention is. The default is <samp class="file">/usr/local</samp> and
1317 you shouldn&rsquo;t install there for a distro.
1318 </p>
1319 </dd>
1320 <dt><code class="code">--libdir=\${exec_prefix}/lib64</code></dt>
1321 <dd><p>May be needed for 64-bit bi-architecture (GNU/Linux) systems.
1322 </p>
1323 </dd>
1324 </dl>
1325
1326 <a class="index-entry-id" id="index-Preining_002c-Norbert"></a>
1327 <a class="index-entry-id" id="index-adapting-TeX-Live-for-distros"></a>
1328 <p>You will need to take care of the support files mentioned above
1329 (see <a class="pxref" href="#Installing">Installing</a>), and many other issues, such as font maps,
1330 languages, and formats, independently of the build. Norbert Preining
1331 has written a detailed article on adapting TL for distros:
1332 <a class="url" href="https://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf">https://tug.org/TUGboat/tb34-3/tb108preining-distro.pdf</a>. (If the
1333 article needs updating in the future, perhaps we will merge it into
1334 this document.)
1335 </p>
1336 <hr>
1337 </div>
1338 </div>
1339 <div class="chapter-level-extent" id="Layout-and-infrastructure">
1340 <div class="nav-panel">
1341 <p>
1342 Next: <a href="#Configure-options" accesskey="n" rel="next">Configure options</a>, Previous: <a href="#Installing" accesskey="p" rel="prev">Installing</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1343 </div>
1344 <h2 class="chapter" id="Layout-and-infrastructure-1"><span>6 Layout and infrastructure<a class="copiable-link" href="#Layout-and-infrastructure-1"> &para;</a></span></h2>
1345
1346 <a class="index-entry-id" id="index-layout-of-sources"></a>
1347 <a class="index-entry-id" id="index-source-tree"></a>
1348
1349 <p>The TeX&nbsp;Live source tree is the subtree rooted at <samp class="file">Build/source</samp> of
1350 the complete TL distribution and contains the sources for all executables
1351 distributed by TL, as well as <code class="code">configure</code> scripts and <code class="code">make</code>
1352 rules to build and install them together with some of their support
1353 files.
1354 </p>
1355
1356 <ul class="mini-toc">
1357 <li><a href="#Build-system-tools" accesskey="1">Build system tools</a></li>
1358 <li><a href="#Top_002dlevel-directories" accesskey="2">Top-level directories</a></li>
1359 <li><a href="#Autoconf-macros" accesskey="3">Autoconf macros</a></li>
1360 <li><a href="#Library-modules" accesskey="4">Library modules</a></li>
1361 <li><a href="#Program-modules" accesskey="5">Program modules</a></li>
1362 <li><a href="#Extending-TeX-Live" accesskey="6">Extending TeX&nbsp;Live</a></li>
1363 </ul>
1364 <hr>
1365 <div class="section-level-extent" id="Build-system-tools">
1366 <div class="nav-panel">
1367 <p>
1368 Next: <a href="#Top_002dlevel-directories" accesskey="n" rel="next">Top-level directories</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1369 </div>
1370 <h3 class="section" id="Build-system-tools-1"><span>6.1 Build system tools<a class="copiable-link" href="#Build-system-tools-1"> &para;</a></span></h3>
1371
1372 <a class="index-entry-id" id="index-tools_002c-for-building"></a>
1373 <a class="index-entry-id" id="index-GNU-tools_002c-needed-for-building"></a>
1374 <a class="index-entry-id" id="index-infrastructure_002c-tools-needed-for"></a>
1375
1376 <p>As mentioned above (see <a class="pxref" href="#Prerequisites">Prerequisites</a>), a normal build has few
1377 requirements. On the other hand, if you want to modify the TeX&nbsp;Live
1378 infrastructure sources, such as <samp class="file">configure.ac</samp> or
1379 <samp class="file">Makefile.am</samp> files, you will need to have several additional
1380 tools installed.
1381 </p>
1382 <p>In general, the TL build system uses the latest released versions of
1383 the GNU build tools, installed directly from the original GNU releases
1384 (e.g., by building them with <code class="code">configure --prefix=/usr/local/gnu</code>
1385 and having <code class="env">PATH</code> start with <samp class="file">/usr/local/gnu/bin</samp>). We have
1386 found that trying to use the versions of these tools packaged for
1387 distros causes many extra hassles, so don&rsquo;t do that, tempting as it
1388 may be.
1389 </p>
1390 <p>Currently the versions we use are:
1391 </p>
1392 <div class="display">
1393 <pre class="display-preformatted">autoconf (GNU Autoconf) 2.72
1394 automake (GNU automake) 1.18.1
1395 bison (GNU Bison) 3.8.2
1396 flex 2.6.0
1397 ltmain.sh (GNU libtool) 2.5.4
1398 m4 (GNU M4) 1.4.21
1399 makeinfo (GNU texinfo) 7.2
1400 </pre></div>
1401
1402 <a class="index-entry-id" id="index-reautoconf"></a>
1403 <a class="index-entry-id" id="index-_002d_002denable_002dmaintainer_002dmode"></a>
1404 <p>These versions should be used to update the generated files (e.g.,
1405 <samp class="file">configure</samp> or <samp class="file">Makefile.in</samp>) in all or parts of the TL tree
1406 after their dependencies have been changed. This can be done
1407 explicitly with the top-level <code class="code">reautoconf</code> script or implicitly
1408 by using the configure option <code class="code">--enable-maintainer-mode</code>.
1409 </p>
1410 <p>It has often turned out that the bison and flex versions are not
1411 critical; however, the autotools versions are. If you don&rsquo;t have the
1412 given versions, get them before modifying the build infrastructure.
1413 </p>
1414 <a class="index-entry-id" id="index-Subversion-repository"></a>
1415 <a class="index-entry-id" id="index-timestamps_002c-in-repository"></a>
1416 <a class="index-entry-id" id="index-use_002dcommit_002dtimes_002c-Subversion"></a>
1417 <p>The files in the Subversion repository (see
1418 <a class="url" href="https://tug.org/texlive/svn">https://tug.org/texlive/svn</a>) are all up to date (barring
1419 bugs). For this to be reflected by their timestamps in your checkout,
1420 be sure to set <samp class="file">use-commit-times=yes</samp> in
1421 <samp class="file">~/.subversion/config</samp> or the equivalent.
1422 </p>
1423 <a class="index-entry-id" id="index-touching-files-to-avoid-rerunning"></a>
1424 <a class="index-entry-id" id="index-make-_002dt"></a>
1425 <p>If timestamps are wrong, you may also be able to avoid unnecessary
1426 runs of <code class="code">bison</code>, <code class="code">flex</code>, or <code class="code">makeinfo</code> with
1427 <code class="code">touch</code> of the generated (<samp class="file">.c</samp>, <samp class="file">.h</samp>, or <samp class="file">.info</samp>)
1428 files. With <code class="code">--enable-maintainer-mode</code> it may also be necessary
1429 to <code class="code">touch</code> first <samp class="file">aclocal.m4</samp>, then <samp class="file">configure</samp> and
1430 <samp class="file">config.h.in</samp> (or <samp class="file">c-auto.in</samp>), and finally all
1431 <samp class="file">Makefile.in</samp> files.
1432 </p>
1433 <hr>
1434 </div>
1435 <div class="section-level-extent" id="Top_002dlevel-directories">
1436 <div class="nav-panel">
1437 <p>
1438 Next: <a href="#Autoconf-macros" accesskey="n" rel="next">Autoconf macros</a>, Previous: <a href="#Build-system-tools" accesskey="p" rel="prev">Build system tools</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1439 </div>
1440 <h3 class="section" id="Top_002dlevel-directories-1"><span>6.2 Top-level directories<a class="copiable-link" href="#Top_002dlevel-directories-1"> &para;</a></span></h3>
1441
1442 <a class="index-entry-id" id="index-directories_002c-top_002dlevel"></a>
1443 <a class="index-entry-id" id="index-top_002dlevel-directories"></a>
1444
1445 <p>Here is a brief description of the top-level directories in the TeX&nbsp;Live
1446 source tree.
1447 </p>
1448 <p>As mentioned at the beginning of see <a class="pxref" href="#Overview-of-build-system">Overview of build system</a>, the main source directories are <samp class="file">texk/</samp>
1449 (TeX-specific programs and libraries), <samp class="file">utils/</samp> (additional
1450 programs), and <samp class="file">libs/</samp> (generic libraries).
1451 </p>
1452 <a class="index-entry-id" id="index-am_002f-top_002dlevel-directory"></a>
1453 <a class="index-entry-id" id="index-m4_002f-top_002dlevel-directory"></a>
1454 <p>In addition, the top-level directories <samp class="file">am/</samp> and <samp class="file">m4/</samp>
1455 contain <samp class="file">Makefile.am</samp> fragments and Autoconf macros,
1456 respectively, used in many places. Specifically, the file
1457 <samp class="file">m4/kpse-pkgs.m4</samp> contains lists of all program and library
1458 modules; missing modules are silently ignored. (This helps in
1459 creating cut-down source trees.)
1460 </p>
1461 <p>Each module contributes fragments (in separate files) defining its
1462 capabilities and requirements to the <samp class="file">configure.ac</samp> scripts at
1463 the top-level and in the subdirectories <samp class="file">libs</samp>, <samp class="file">utils</samp>, and
1464 <samp class="file">texk</samp>. The fragments from program modules supply
1465 <code class="code">configure</code> options to disable or enable building them; those
1466 from library modules specify if an installed (system) version of that
1467 library can be used. This ultimately determines which modules need to
1468 be built&mdash;although all modules must be configured for the benefit of
1469 <samp class="file">make</samp> targets such as <code class="code">dist</code> or <code class="code">distcheck</code>.
1470 </p>
1471 <a class="index-entry-id" id="index-build_002daux_002f-top_002dlevel-directory"></a>
1472 <a class="index-entry-id" id="index-config_002eguess_002c-config_002esub_002c-_002e_002e_002e"></a>
1473 <a class="index-entry-id" id="index-Gnulib_002c-used-for-common-files"></a>
1474 <p>The top-level <samp class="file">build-aux/</samp> directory contains the common files
1475 <samp class="file">compile</samp>, <samp class="file">config.guess</samp>, <samp class="file">config.sub</samp>,
1476 <samp class="file">depcomp</samp>, etc.&nbsp;used by most packages. These are taken from the
1477 GNU Gnulib sources (<a class="url" href="https://www.gnu.org/software/gnulib">https://www.gnu.org/software/gnulib</a>), which
1478 in turn synchronizes with any ultimate upstream repository. There are
1479 independent copies of some of these in a few other places, e.g.,
1480 <samp class="file">libs/freetype2/freetype-*/builds/unix/</samp>. The <code class="code">reautoconf</code>
1481 script does not touch those, but a TL cron job keeps them in sync
1482 (nightly).
1483 </p>
1484 <a class="index-entry-id" id="index-Work_002f-top_002dlevel-directory"></a>
1485 <a class="index-entry-id" id="index-inst_002f-top_002dlevel-directory"></a>
1486 <p>When the top-level <samp class="file">./Build</samp> script is used to build TL, two more
1487 two more top-level directories appear: <samp class="file">Work/</samp> for the build tree,
1488 and <samp class="file">inst/</samp> for the install tree (from <code class="code">make install</code>).
1489 These names (and everything else about <samp class="file">Build</samp>&rsquo;s operation) can
1490 be changed by setting environment variables before running it; see the
1491 script source.
1492 </p>
1493 <hr>
1494 </div>
1495 <div class="section-level-extent" id="Autoconf-macros">
1496 <div class="nav-panel">
1497 <p>
1498 Next: <a href="#Library-modules" accesskey="n" rel="next">Library modules</a>, Previous: <a href="#Top_002dlevel-directories" accesskey="p" rel="prev">Top-level directories</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1499 </div>
1500 <h3 class="section" id="Autoconf-macros-1"><span>6.3 Autoconf macros<a class="copiable-link" href="#Autoconf-macros-1"> &para;</a></span></h3>
1501
1502 <a class="index-entry-id" id="index-autoconf-macros"></a>
1503
1504
1505
1506 <p>Here we describe a few of the Autoconf macros used in several
1507 modules&mdash;many more are defined in the sources; see the top-level
1508 <code class="code">m4/</code> directory. These general macros are supplemented by
1509 module-specific macros in directories such as <samp class="file">texk/dvipng/m4/</samp>;
1510 some of those are described in following sections (see <a class="pxref" href="#Library-modules">Library modules</a> and <a class="ref" href="#Program-modules">Program modules</a>).
1511 </p>
1512
1513 <ul class="mini-toc">
1514 <li><a href="#General-setup-macros" accesskey="1">General setup macros</a></li>
1515 <li><a href="#Macros-for-programs" accesskey="2">Macros for programs</a></li>
1516 <li><a href="#Macros-for-compilers" accesskey="3">Macros for compilers</a></li>
1517 <li><a href="#Macros-for-libraries" accesskey="4">Macros for libraries</a></li>
1518 <li><a href="#Macros-for-library-and-header-flags" accesskey="5">Macros for library and header flags</a></li>
1519 <li><a href="#Macros-for-Windows" accesskey="6">Macros for Windows</a></li>
1520 </ul>
1521 <hr>
1522 <div class="subsection-level-extent" id="General-setup-macros">
1523 <div class="nav-panel">
1524 <p>
1525 Next: <a href="#Macros-for-programs" accesskey="n" rel="next">Macros for programs</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1526 </div>
1527 <h4 class="subsection" id="General-setup-macros-1"><span>6.3.1 General setup macros<a class="copiable-link" href="#General-setup-macros-1"> &para;</a></span></h4>
1528
1529 <a class="index-entry-id" id="index-general-setup-macros"></a>
1530 <a class="index-entry-id" id="index-setup-macros_002c-general"></a>
1531 <a class="index-entry-id" id="index-macros_002c-general-setup"></a>
1532 <p>The TL sources use two general setup macros:
1533 </p>
1534 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1535 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fBASIC"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_BASIC</strong> <var class="def-var-arguments">(<var class="var">name</var>, [<var class="var">more-options</var>])</var><a class="copiable-link" href="#index-KPSE_005fBASIC"> &para;</a></span></dt>
1536 <dd><p>Initialize the basic TL infrastructure for module <var class="var">name</var>:<br>&nbsp;&nbsp;&nbsp;<code class="code">AM_INIT_AUTOMAKE([foreign <var class="var">more-options</var>])</code><br>&nbsp;&nbsp;&nbsp;<code class="code">AM_MAINTAINER_MODE</code><br>&nbsp;&nbsp;&nbsp;<code class="code">KPSE_COMPILER_WARNINGS</code><br>
1537 and make sure the C compiler understands function prototypes. This is
1538 used for all generic library and program modules.
1539 </p></dd></dl>
1540
1541 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1542 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOMMON"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COMMON</strong> <var class="def-var-arguments">(<var class="var">name</var>, [<var class="var">more-options</var>])</var><a class="copiable-link" href="#index-KPSE_005fCOMMON"> &para;</a></span></dt>
1543 <dd><p>Like <code class="code">KPSE_BASIC</code> but add:<br>&nbsp;&nbsp;&nbsp;<code class="code">LT_PREREQ([2.2.6])</code><br>&nbsp;&nbsp;&nbsp;<code class="code">LT_INIT([win32-dll])</code><br>&nbsp;&nbsp;&nbsp;<code class="code">AC_SYS_LARGEFILE</code><br>&nbsp;&nbsp;&nbsp;<code class="code">AC_FUNC_FSEEKO</code><br>along with checks for frequently used functions,
1544 headers, types, and structures. This is used for TeX-specific
1545 modules.
1546 </p></dd></dl>
1547
1548 <hr>
1549 </div>
1550 <div class="subsection-level-extent" id="Macros-for-programs">
1551 <div class="nav-panel">
1552 <p>
1553 Next: <a href="#Macros-for-compilers" accesskey="n" rel="next">Macros for compilers</a>, Previous: <a href="#General-setup-macros" accesskey="p" rel="prev">General setup macros</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1554 </div>
1555 <h4 class="subsection" id="Macros-for-programs-1"><span>6.3.2 Macros for programs<a class="copiable-link" href="#Macros-for-programs-1"> &para;</a></span></h4>
1556
1557 <a class="index-entry-id" id="index-macros_002c-for-programs"></a>
1558 <p>Macros for program checks:
1559 </p>
1560 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1561 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCHECK_005fLATEX"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_CHECK_LATEX</strong><a class="copiable-link" href="#index-KPSE_005fCHECK_005fLATEX"> &para;</a></span></dt>
1562 <dd><p>Set <code class="code">LATEX</code> to the first of <code class="code">latex</code>, <code class="code">elatex</code>, or
1563 <code class="code">lambda</code> which exists in <code class="code">PATH</code>, or to <code class="code">no</code> if none of
1564 them exists. Call <code class="code">AC_SUBST</code> for <code class="code">LATEX</code>. The result of
1565 this test can be overridden by setting the <code class="code">LATEX</code> environment
1566 variable or the cache variable <code class="code">ac_cv_prog_LATEX</code>.
1567 </p></dd></dl>
1568
1569 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1570 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCHECK_005fPDFLATEX"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_CHECK_PDFLATEX</strong><a class="copiable-link" href="#index-KPSE_005fCHECK_005fPDFLATEX"> &para;</a></span></dt>
1571 <dd><p>Check for <code class="code">pdflatex</code> in <code class="code">PATH</code> and set <code class="code">PDFLATEX</code>.
1572 </p></dd></dl>
1573
1574 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1575 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCHECK_005fPERL"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_CHECK_PERL</strong><a class="copiable-link" href="#index-KPSE_005fCHECK_005fPERL"> &para;</a></span></dt>
1576 <dd><p>Check for <code class="code">perl</code> or <code class="code">perl5</code> in <code class="code">PATH</code> and set
1577 <code class="code">PERL</code>.
1578 </p></dd></dl>
1579
1580 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1581 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fPROG_005fLEX"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_PROG_LEX</strong><a class="copiable-link" href="#index-KPSE_005fPROG_005fLEX"> &para;</a></span></dt>
1582 <dd><p>Call <code class="code">AC_PROG_LEX</code> and add the flag <code class="code">-l</code> for <code class="code">flex</code>.
1583 </p></dd></dl>
1584
1585 <hr>
1586 </div>
1587 <div class="subsection-level-extent" id="Macros-for-compilers">
1588 <div class="nav-panel">
1589 <p>
1590 Next: <a href="#Macros-for-libraries" accesskey="n" rel="next">Macros for libraries</a>, Previous: <a href="#Macros-for-programs" accesskey="p" rel="prev">Macros for programs</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1591 </div>
1592 <h4 class="subsection" id="Macros-for-compilers-1"><span>6.3.3 Macros for compilers<a class="copiable-link" href="#Macros-for-compilers-1"> &para;</a></span></h4>
1593
1594 <a class="index-entry-id" id="index-macros_002c-for-compilers"></a>
1595
1596 <p>Macros for compiler-related checks:
1597 </p>
1598 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1599 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOMPILER_005fWARNINGS"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COMPILER_WARNINGS</strong><a class="copiable-link" href="#index-KPSE_005fCOMPILER_005fWARNINGS"> &para;</a></span></dt>
1600 <dd><a class="index-entry-id" id="index-WARNING_005fC_005bXX_005dFLAGS"></a>
1601 <p>When using the (Objective) C/C++ compiler, set
1602 <code class="code">WARNING_[OBJ]C[XX]FLAGS</code> to suitable warning flags (depending on
1603 the value given to or implied for <code class="code">--enable-compiler-warnings</code>).
1604 Call <code class="code">AC_SUBST</code> for them. At present this assumes GNU compiler
1605 warning options, but could be extended to others if necessary.
1606 </p>
1607 <a class="index-entry-id" id="index-kpse_005fcv_005fwarning_005fcflags"></a>
1608 <p>This macro caches its results in the <code class="code">kpse_cv_warning_cflags</code>,
1609 &hellip; variables.
1610 </p></dd></dl>
1611
1612 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1613 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOMPILER_005fVISIBILITY"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COMPILER_VISIBILITY</strong><a class="copiable-link" href="#index-KPSE_005fCOMPILER_005fVISIBILITY"> &para;</a></span></dt>
1614 <dd><a class="index-entry-id" id="index-_002dfvisibility_003dhidden"></a>
1615 <a class="index-entry-id" id="index-_002dfvisibility_002dinlines_002dhidden"></a>
1616 <p>When using the C or C++ compiler, try to set
1617 <code class="code">VISIBILITY_C[XX]FLAGS</code> to flags to hide external symbols. Call
1618 <code class="code">AC_SUBST</code> for this variable. This tests for the compiler option
1619 <code class="code">-fvisibility=hidden</code> and, except for C,
1620 <code class="code">-fvisibility-inlines-hidden</code>. Reports or patches for additional
1621 tests are welcome.
1622 </p>
1623 <a class="index-entry-id" id="index-kpse_005fcv_005fvisibility_005fc_005bxx_005dflags"></a>
1624 <p>This macro caches its results in the <code class="code">kpse_cv_visibility_cflags</code>
1625 or <code class="code">kpse_cv_visibility_cxxflags</code> variable.
1626 </p></dd></dl>
1627
1628 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1629 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCXX_005fHACK"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_CXX_HACK</strong><a class="copiable-link" href="#index-KPSE_005fCXX_005fHACK"> &para;</a></span></dt>
1630 <dd><a class="index-entry-id" id="index-static-linking-for-C_002b_002b"></a>
1631 <a class="index-entry-id" id="index-linking-C_002b_002b-libraries-statically"></a>
1632 <a class="index-entry-id" id="index-_002d_002denable_002dcxx_002druntime_002dhack"></a>
1633 <a class="index-entry-id" id="index-libstc_002b_002b_002c-statically-linking"></a>
1634 <p>Provide the configure option <code class="code">--enable-cxx-runtime-hack</code>. If
1635 enabled and when using <code class="code">g++</code>, try to statically link with
1636 <samp class="file">libstdc++</samp>, notably improving portability of the resulting
1637 binary.
1638 </p>
1639 <a class="index-entry-id" id="index-kpse_005fcv_005fcxx_005fhack"></a>
1640 <p>This macro caches its result in the <code class="code">kpse_cv_cxx_hack</code> variable.
1641 </p></dd></dl>
1642
1643 <hr>
1644 </div>
1645 <div class="subsection-level-extent" id="Macros-for-libraries">
1646 <div class="nav-panel">
1647 <p>
1648 Next: <a href="#Macros-for-library-and-header-flags" accesskey="n" rel="next">Macros for library and header flags</a>, Previous: <a href="#Macros-for-compilers" accesskey="p" rel="prev">Macros for compilers</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1649 </div>
1650 <h4 class="subsection" id="Macros-for-libraries-1"><span>6.3.4 Macros for libraries<a class="copiable-link" href="#Macros-for-libraries-1"> &para;</a></span></h4>
1651
1652 <a class="index-entry-id" id="index-macros_002c-for-libraries"></a>
1653 <p>One macro for a library check:
1654 </p>
1655 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1656 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fLARGEFILE"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_LARGEFILE</strong> <var class="def-var-arguments">(<var class="var">variable</var>, [<var class="var">extra-define</var>])</var><a class="copiable-link" href="#index-KPSE_005fLARGEFILE"> &para;</a></span></dt>
1657 <dd><p>Call <code class="code">AC_SYS_LARGEFILE</code> and <code class="code">AC_FUNC_FSEEKO</code> and append
1658 suitable <code class="code">-D</code> flags (optionally including
1659 <code class="code">-D<var class="var">extra-define</var></code>) to <var class="var">variable</var>.
1660 </p></dd></dl>
1661
1662 <hr>
1663 </div>
1664 <div class="subsection-level-extent" id="Macros-for-library-and-header-flags">
1665 <div class="nav-panel">
1666 <p>
1667 Next: <a href="#Macros-for-Windows" accesskey="n" rel="next">Macros for Windows</a>, Previous: <a href="#Macros-for-libraries" accesskey="p" rel="prev">Macros for libraries</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1668 </div>
1669 <h4 class="subsection" id="Macros-for-library-and-header-flags-1"><span>6.3.5 Macros for library and header flags<a class="copiable-link" href="#Macros-for-library-and-header-flags-1"> &para;</a></span></h4>
1670
1671 <a class="index-entry-id" id="index-macros_002c-for-library-and-header-flags"></a>
1672 <a class="index-entry-id" id="index-flags_002c-macros-for-library-and-header"></a>
1673 <a class="index-entry-id" id="index-KPSE_005fLIB_005fFLAGS"></a>
1674 <p>Each library module <samp class="file">libs/<var class="var">lib</var></samp> or <samp class="file">texk/<var class="var">lib</var></samp> is
1675 supplemented by a macro <code class="code">KPSE_<var class="var">LIB</var>_FLAGS</code> (all uppercase)
1676 that provides make variables for that library. E.g., for
1677 <samp class="file">libs/libpng</samp>:
1678 </p>
1679 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1680 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fLIBPNG_005fFLAGS"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_LIBPNG_FLAGS</strong><a class="copiable-link" href="#index-KPSE_005fLIBPNG_005fFLAGS"> &para;</a></span></dt>
1681 <dd><p>Provide the configure option <code class="code">--with-system-libpng</code>. Set and
1682 <code class="code">AC_SUBST</code> <code class="code">make</code> variables for modules using this library (either
1683 an installed version or from the TeX&nbsp;Live tree):
1684 </p>
1685 <table class="multitable">
1686 <tbody><tr><td><code class="code">LIBPNG_INCLUDES</code></td><td>for use in <code class="code">CPPFLAGS</code>,</td></tr>
1687 <tr><td><code class="code">LIBPNG_LIBS</code></td><td>for use in <code class="code">LDADD</code>,</td></tr>
1688 <tr><td><code class="code">LIBPNG_DEPEND</code></td><td>for use as a Makefile dependency,</td></tr>
1689 <tr><td><code class="code">LIBPNG_RULE</code></td><td>for the <code class="code">make</code> rules to rebuild the library.</td></tr>
1690 </tbody>
1691 </table>
1692 </dd></dl>
1693
1694 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1695 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fADD_005fFLAGS"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_ADD_FLAGS</strong> <var class="def-var-arguments">(<var class="var">name</var>)</var><a class="copiable-link" href="#index-KPSE_005fADD_005fFLAGS"> &para;</a></span></dt>
1696 <dd><p>Temporarily extend <code class="code">CPPFLAGS</code> and <code class="code">LIBS</code> with the values required
1697 for the library module <code class="code"><var class="var">name</var></code>.
1698 </p></dd></dl>
1699
1700 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1701 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fRESTORE_005fFLAGS"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_RESTORE_FLAGS</strong><a class="copiable-link" href="#index-KPSE_005fRESTORE_005fFLAGS"> &para;</a></span></dt>
1702 <dd><p>Restore <code class="code">CPPFLAGS</code> and <code class="code">LIBS</code> to their original values.
1703 </p></dd></dl>
1704
1705 <p>As an example, the <samp class="file">configure.ac</samp> file for a hypothetical program
1706 <samp class="file">utils/foo</samp> using <samp class="file">libpng</samp>, and hence <samp class="file">zlib</samp>, would
1707 contain
1708 </p><div class="example">
1709 <pre class="example-preformatted">KPSE_ZLIB_FLAGS
1710 KPSE_LIBPNG_FLAGS
1711 </pre></div>
1712
1713 <p>and its <samp class="file">Makefile.am</samp> would be along these lines:
1714 </p><div class="example">
1715 <pre class="example-preformatted">bin_PROGRAMS = foo
1716 AM_CPPFLAGS = ${LIBPNG_INCLUDES} ${ZLIB_INCLUDES}
1717 foo_LDADD = ${LIBPNG_LIBS} ${ZLIB_LIBS}
1718 foo_DEPENDENCIES = ${ZLIB_DEPEND} ${LIBPNG_DEPEND}
1719 ## Rebuild libz
1720 @ZLIB_RULE@
1721 ## Rebuild libpng
1722 @LIBPNG_RULE@
1723 </pre></div>
1724
1725 <p>If it were necessary to examine whether certain <samp class="file">zlib</samp> or
1726 <samp class="file">libpng</samp> features were available, <samp class="file">configure.ac</samp> should be
1727 continued this way:
1728 </p><div class="example">
1729 <pre class="example-preformatted">KPSE_ADD_FLAGS([zlib])
1730 ... # <span class="r">tests for <samp class="file">zlib</samp> features, if any</span>
1731 KPSE_ADD_FLAGS([libpng])
1732 ... # <span class="r">tests for <samp class="file">libpng</samp> features</span>
1733 KPSE_RESTORE_FLAGS # <span class="r">restore <code class="code">CPPFLAGS</code> and <code class="code">LIBS</code></span>
1734 </pre></div>
1735
1736 <hr>
1737 </div>
1738 <div class="subsection-level-extent" id="Macros-for-Windows">
1739 <div class="nav-panel">
1740 <p>
1741 Previous: <a href="#Macros-for-library-and-header-flags" accesskey="p" rel="prev">Macros for library and header flags</a>, Up: <a href="#Autoconf-macros" accesskey="u" rel="up">Autoconf macros</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1742 </div>
1743 <h4 class="subsection" id="Macros-for-Windows-1"><span>6.3.6 Macros for Windows<a class="copiable-link" href="#Macros-for-Windows-1"> &para;</a></span></h4>
1744
1745 <a class="index-entry-id" id="index-macros_002c-for-Windows"></a>
1746 <a class="index-entry-id" id="index-Windows_002c-macros-for"></a>
1747 <p>Windows differs in several aspects from Unix-like systems, many of
1748 them due to the lack of symbolic links.
1749 </p>
1750 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1751 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCHECK_005fWIN32"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_CHECK_WIN32</strong><a class="copiable-link" href="#index-KPSE_005fCHECK_005fWIN32"> &para;</a></span></dt>
1752 <dd><a class="index-entry-id" id="index-kpse_005fcv_005fhave_005fwin32"></a>
1753 <p>Check if compiling for a Windows system. The result is either
1754 <code class="code">no</code> for Unix-like systems (including Cygwin), <code class="code">mingw32</code> for
1755 Windows with GCC, or <code class="code">native</code> for Windows with MSVC. The result
1756 is cached in the <code class="code">kpse_cv_have_win32</code> variable.
1757 </p></dd></dl>
1758
1759 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1760 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOND_005fWIN32"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COND_WIN32</strong><a class="copiable-link" href="#index-KPSE_005fCOND_005fWIN32"> &para;</a></span></dt>
1761 <dd><a class="index-entry-id" id="index-WIN32_002c-Automake-conditional"></a>
1762 <p>Call <code class="code">KPSE_CHECK_WIN32</code> and define the Automake conditional
1763 <code class="code">WIN32</code> (<code class="code">true</code> if the value of <code class="code">kpse_cv_have_win32</code> is
1764 not <code class="code">no</code>).
1765 </p></dd></dl>
1766
1767 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1768 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOND_005fMINGW32"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COND_MINGW32</strong><a class="copiable-link" href="#index-KPSE_005fCOND_005fMINGW32"> &para;</a></span></dt>
1769 <dd><a class="index-entry-id" id="index-MINGW32_002c-Automake-conditional"></a>
1770 <p>Call <code class="code">KPSE_COND_WIN32</code> and define the Automake conditional
1771 <code class="code">MINGW32</code> (<code class="code">true</code> if the value of <code class="code">kpse_cv_have_win32</code> is
1772 <code class="code">mingw32</code>).
1773 </p></dd></dl>
1774
1775 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1776 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fCOND_005fWIN32_005fWRAP"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_COND_WIN32_WRAP</strong><a class="copiable-link" href="#index-KPSE_005fCOND_005fWIN32_005fWRAP"> &para;</a></span></dt>
1777 <dd><a class="index-entry-id" id="index-WIN32_005fWRAP_002c-Automake-conditional"></a>
1778 <a class="index-entry-id" id="index-runscript_002eexe"></a>
1779 <p>Call <code class="code">KPSE_COND_WIN32</code> and define the Automake conditional
1780 <code class="code">WIN32_WRAP</code> (<code class="code">true</code> if the standard Windows wrapper
1781 (<samp class="file">texk/texlive/windows_wrapper/runscript.exe</samp>) exists. This wrapper
1782 is used on Windows instead of symlinks for the &ldquo;linked scripts&rdquo;
1783 (see <a class="pxref" href="#Linked-scripts">Linked scripts</a>).
1784 </p></dd></dl>
1785
1786 <dl class="first-deffn first-defmac-alias-first-deffn def-block">
1787 <dt class="deffn defmac-alias-deffn def-line" id="index-KPSE_005fWIN32_005fCALL"><span class="category-def">Macro: </span><span><strong class="def-name">KPSE_WIN32_CALL</strong><a class="copiable-link" href="#index-KPSE_005fWIN32_005fCALL"> &para;</a></span></dt>
1788 <dd><a class="index-entry-id" id="index-callexe_002ec"></a>
1789 <p>Call <code class="code">KPSE_COND_WIN32</code> and check whether the file
1790 <samp class="file">texk/texlive/windows_wrapper/callexe.c</samp> exists; if it does, create a
1791 symlink in the build tree. Compiling <samp class="file">callexe.c</samp> with
1792 <code class="code">-DEXEPROG='&quot;<var class="var">foo</var>.exe&quot;'</code> and installing <samp class="file">callexe.exe</samp>
1793 as <code class="code"><var class="var">bar</var>.exe</code> is used on Windows instead of a symlink
1794 <code class="code"><var class="var">bar</var>-&gt;<var class="var">foo</var></code> for Unix-like systems.
1795 </p></dd></dl>
1796
1797 <hr>
1798 </div>
1799 </div>
1800 <div class="section-level-extent" id="Library-modules">
1801 <div class="nav-panel">
1802 <p>
1803 Next: <a href="#Program-modules" accesskey="n" rel="next">Program modules</a>, Previous: <a href="#Autoconf-macros" accesskey="p" rel="prev">Autoconf macros</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1804 </div>
1805 <h3 class="section" id="Library-modules-1"><span>6.4 Library modules<a class="copiable-link" href="#Library-modules-1"> &para;</a></span></h3>
1806
1807 <a class="index-entry-id" id="index-library-modules"></a>
1808 <a class="index-entry-id" id="index-modules_002c-for-libraries"></a>
1809 <p>Here we discuss some specifics for a few of the libraries in TL, both
1810 for the details themselves, and as a way of illuminating the general
1811 structure and variation.
1812 </p>
1813
1814 <ul class="mini-toc">
1815 <li><a href="#png-library" accesskey="1">The <code class="code">png</code> library in <samp class="file">libs/libpng</samp></a></li>
1816 <li><a href="#zlib-library" accesskey="2">The <code class="code">zlib</code> library in <samp class="file">libs/zlib</samp></a></li>
1817 <li><a href="#freetype-library" accesskey="3">The <code class="code">freetype</code> library in <samp class="file">libs/freetype2</samp></a></li>
1818 <li><a href="#kpathsea-library" accesskey="4">The <code class="code">kpathsea</code> library in <samp class="file">texk/kpathsea</samp></a></li>
1819 </ul>
1820 <hr>
1821 <div class="subsection-level-extent" id="png-library">
1822 <div class="nav-panel">
1823 <p>
1824 Next: <a href="#zlib-library" accesskey="n" rel="next">The <code class="code">zlib</code> library in <samp class="file">libs/zlib</samp></a>, Up: <a href="#Library-modules" accesskey="u" rel="up">Library modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1825 </div>
1826 <h4 class="subsection" id="The-png-library-in-libs_002flibpng"><span>6.4.1 The <code class="code">png</code> library in <samp class="file">libs/libpng</samp><a class="copiable-link" href="#The-png-library-in-libs_002flibpng"> &para;</a></span></h4>
1827
1828 <a class="index-entry-id" id="index-png-library"></a>
1829 <a class="index-entry-id" id="index-libpng-library"></a>
1830 <p>The &ldquo;generic&rdquo; <code class="code">png</code> library uses the source tree in the
1831 subdirectory <samp class="file">libpng-src/</samp>, with all modifications for TL
1832 recorded in <samp class="file">TLpatches/*</samp>. The <samp class="file">configure.ac</samp> fragment
1833 <samp class="file">ac/withenable.ac</samp> contains
1834 </p>
1835 <div class="example">
1836 <pre class="example-preformatted">KPSE_WITH_LIB([libpng], [zlib])
1837 </pre></div>
1838
1839 <p>to specify the module name and indicate the dependency on
1840 <code class="code">zlib</code>. A third literal argument &lsquo;<code class="code">tree</code>&rsquo; would specify that
1841 the library from the TeX&nbsp;Live tree cannot be replaced by a system
1842 version. That not being the case here, a second fragment
1843 <samp class="file">ac/libpng.ac</samp> contains
1844 </p>
1845 <a class="index-entry-id" id="index-KPSE_005fTRY_005fLIB"></a>
1846 <div class="example">
1847 <pre class="example-preformatted">KPSE_TRY_LIB([libpng],
1848 [#include &lt;png.h&gt;],
1849 [png_structp png; png_voidp io; png_rw_ptr fn;
1850 png_set_read_fn(png, io, fn);])
1851 </pre></div>
1852
1853 <p>thus providing the simple C code
1854 </p>
1855 <div class="example">
1856 <pre class="example-preformatted">#include &lt;png.h&gt;
1857 int main ()
1858 { png_structp png; png_voidp io; png_rw_ptr fn;
1859 png_set_read_fn(png, io, fn);
1860 return 0; }
1861 </pre></div>
1862
1863 <a class="index-entry-id" id="index-KPSE_005fTRY_005fLIBXX"></a>
1864 <p>which Autoconf uses to verify the usability of a system
1865 version with C code. The analogous macro <code class="code">KPSE_TRY_LIBXX</code> would
1866 check using C++. These fragments are included by the
1867 <samp class="file">configure.ac</samp> at the top level of TL
1868 (<code class="code">Build/source/configure.ac</code>).
1869 </p>
1870 <a class="index-entry-id" id="index-proxy-build-system"></a>
1871 <p>For this library, like many other modules, a proxy build system for TL
1872 is used, consisting of our own <samp class="file">configure.ac</samp>,
1873 <samp class="file">Makefile.am</samp>, <samp class="file">include/Makefile.am</samp>; the distributed build
1874 system is not used. (Consequently, a few generated files and
1875 auxiliary scripts are removed from the distributed source tree.)
1876 </p>
1877 <p>The public headers <samp class="file">png.h</samp>, <samp class="file">pngconf.h</samp>, and
1878 <samp class="file">pnglibconf.h</samp> are &ldquo;installed&rdquo; (as symlinks) under
1879 <samp class="file">include/</samp> in the build tree exactly as they are for a system
1880 version under, e.g., <samp class="file">/usr/include/</samp>.
1881 </p>
1882 <a class="index-entry-id" id="index-kpse_002dlibpng_002dflags_002em4"></a>
1883 <a class="index-entry-id" id="index-KPSE_005fLIBPNG_005fFLAGS-1"></a>
1884 <p>The module is supplemented by the file <samp class="file">m4/kpse-libpng-flags.m4</samp>
1885 that defines the M4 macro <code class="code">KPSE_LIBPNG_FLAGS</code> used by all modules
1886 depending on this library in their <samp class="file">configure.ac</samp> to generate the
1887 <code class="code">make</code> variables <code class="code">LIBPNG_INCLUDES</code> for use in
1888 <code class="code">CPPFLAGS</code>, <code class="code">LIBPNG_LIBS</code> for use in <code class="code">LDADD</code>,
1889 <code class="code">LIBPNG_DEPEND</code> for use as dependencies, and <code class="code">LIBPNG_RULE</code>
1890 for the <code class="code">make</code> rules to rebuild the library.
1891 </p>
1892 <p><samp class="file">m4/kpse-libpng-flags.m4</samp> also supplies the configure option
1893 <code class="code">--with-system-libpng</code>, which then uses <code class="code">pkg-config</code> to
1894 determine the flags required for the system library.
1895 </p>
1896 <hr>
1897 </div>
1898 <div class="subsection-level-extent" id="zlib-library">
1899 <div class="nav-panel">
1900 <p>
1901 Next: <a href="#freetype-library" accesskey="n" rel="next">The <code class="code">freetype</code> library in <samp class="file">libs/freetype2</samp></a>, Previous: <a href="#png-library" accesskey="p" rel="prev">The <code class="code">png</code> library in <samp class="file">libs/libpng</samp></a>, Up: <a href="#Library-modules" accesskey="u" rel="up">Library modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1902 </div>
1903 <h4 class="subsection" id="The-zlib-library-in-libs_002fzlib"><span>6.4.2 The <code class="code">zlib</code> library in <samp class="file">libs/zlib</samp><a class="copiable-link" href="#The-zlib-library-in-libs_002fzlib"> &para;</a></span></h4>
1904
1905 <a class="index-entry-id" id="index-zlib-library"></a>
1906
1907 <a class="index-entry-id" id="index-kpse_002dzlib_002dflags_002em4"></a>
1908 <p>This generic library is very much analogous to <code class="code">libpng</code>, but
1909 without the dependency on any other library. The file
1910 <samp class="file">m4/kpse-zlib-flags.m4</samp> supplies the configure option
1911 <code class="code">--with-system-zlib</code>, as well as <code class="code">--with-zlib-includes</code> and
1912 <code class="code">--with-zlib-libdir</code> to specify non-standard locations of the
1913 <code class="code">zlib</code> headers and/or library.
1914 </p>
1915 <hr>
1916 </div>
1917 <div class="subsection-level-extent" id="freetype-library">
1918 <div class="nav-panel">
1919 <p>
1920 Next: <a href="#kpathsea-library" accesskey="n" rel="next">The <code class="code">kpathsea</code> library in <samp class="file">texk/kpathsea</samp></a>, Previous: <a href="#zlib-library" accesskey="p" rel="prev">The <code class="code">zlib</code> library in <samp class="file">libs/zlib</samp></a>, Up: <a href="#Library-modules" accesskey="u" rel="up">Library modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1921 </div>
1922 <h4 class="subsection" id="The-freetype-library-in-libs_002ffreetype2"><span>6.4.3 The <code class="code">freetype</code> library in <samp class="file">libs/freetype2</samp><a class="copiable-link" href="#The-freetype-library-in-libs_002ffreetype2"> &para;</a></span></h4>
1923
1924 <a class="index-entry-id" id="index-freetype-library"></a>
1925 <a class="index-entry-id" id="index-wrapper-build-system"></a>
1926
1927 <p>This module uses a wrapper build system. In contrast to the proxy
1928 build described earlier, the wrapper build has an almost trivial
1929 <samp class="file">configure.ac</samp> and a <samp class="file">Makefile.am</samp> which invokes the
1930 <code class="code">configure</code> and <code class="code">make</code> in the distributed source, followed
1931 by <code class="code">make install</code> with the TL build tree as destination. In
1932 other words, this actually uses the build system provided by upstream
1933 (possibly patched).
1934 </p>
1935 <a class="index-entry-id" id="index-freetype_002dconfig"></a>
1936 <p>The flags required for the system library are obtained through
1937 <code class="code">freetype-config</code>.
1938 </p>
1939 <hr>
1940 </div>
1941 <div class="subsection-level-extent" id="kpathsea-library">
1942 <div class="nav-panel">
1943 <p>
1944 Previous: <a href="#freetype-library" accesskey="p" rel="prev">The <code class="code">freetype</code> library in <samp class="file">libs/freetype2</samp></a>, Up: <a href="#Library-modules" accesskey="u" rel="up">Library modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1945 </div>
1946 <h4 class="subsection" id="The-kpathsea-library-in-texk_002fkpathsea"><span>6.4.4 The <code class="code">kpathsea</code> library in <samp class="file">texk/kpathsea</samp><a class="copiable-link" href="#The-kpathsea-library-in-texk_002fkpathsea"> &para;</a></span></h4>
1947
1948 <a class="index-entry-id" id="index-kpathsea-library"></a>
1949
1950 <p>This is one of the TeX-specific libraries that are maintained as
1951 part of TeX&nbsp;Live (see <cite class="cite"><a data-manual="kpathsea" href="https://tug.org/texinfohtml/kpathsea.html#Top">Kpathsea
1952 <span class="r">(<a class="url" href="tug.org/kpathsea">tug.org/kpathsea</a>)</span></a></cite>); the other is <code class="code">ptexenc</code>. These
1953 TeX libraries are Libtool libraries (static and/or shared) and are
1954 installed by <code class="code">make install</code> together with the programs. They
1955 are, however, not part of the TL DVD as distributed by TeX user
1956 groups, and have never been officially released for standalone use.
1957 </p>
1958 <a class="index-entry-id" id="index-_002d_002dwith_002dsystem_002dkpathsea"></a>
1959 <p>It is possible, and probably useful for distro builds (see <a class="pxref" href="#Distro-builds">Distro builds</a>), to specify the configure option
1960 <code class="code">--with-system-kpathsea</code> in order to use a system version of the
1961 library. Programs outside the TL tree should use <code class="code">pkg-config</code>
1962 for the required flags.
1963 </p>
1964 <a class="index-entry-id" id="index-kpathsea_002eac"></a>
1965 <a class="index-entry-id" id="index-mktex_002eac"></a>
1966 <a class="index-entry-id" id="index-_002d_002denable_002dmktextfm_002ddefault"></a>
1967 <a class="index-entry-id" id="index-mktextfm"></a>
1968 <p>In addition to <samp class="file">kpathsea/ac/withenable.ac</samp> and
1969 <samp class="file">kpathsea/ac/kpathsea.ac</samp> here there is a third fragment
1970 <samp class="file">kpathsea.ac/mktex.ac</samp>, included by both <samp class="file">withenable.ac</samp> and
1971 <samp class="file">configure.ac</samp>, which supplies configure options such as
1972 <code class="code">--enable-mktextfm-default</code>. These determine the compile time
1973 default of whether or not to run <code class="code">mktextfm</code> (and similar) to
1974 generate a missing <samp class="file">.tfm</samp> (or whatever) file. In any case,
1975 however, the command line options <code class="code">-mktex=tfm</code> or
1976 <code class="code">-no-mktex=tfm</code> for the TeX-like engines override this
1977 default.
1978 </p>
1979 <hr>
1980 </div>
1981 </div>
1982 <div class="section-level-extent" id="Program-modules">
1983 <div class="nav-panel">
1984 <p>
1985 Next: <a href="#Extending-TeX-Live" accesskey="n" rel="next">Extending TeX&nbsp;Live</a>, Previous: <a href="#Library-modules" accesskey="p" rel="prev">Library modules</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
1986 </div>
1987 <h3 class="section" id="Program-modules-1"><span>6.5 Program modules<a class="copiable-link" href="#Program-modules-1"> &para;</a></span></h3>
1988
1989 <a class="index-entry-id" id="index-program-modules"></a>
1990 <a class="index-entry-id" id="index-modules_002c-for-programs"></a>
1991 <p>As with libraries (see <a class="pxref" href="#Library-modules">Library modules</a>), here we discuss the
1992 details for a few of the programs in TL.
1993 </p>
1994
1995 <ul class="mini-toc">
1996 <li><a href="#t1utils-package" accesskey="1">The <code class="code">t1utils</code> package in <samp class="file">utils/t1utils</samp></a></li>
1997 <li><a href="#xindy-package" accesskey="2">The <code class="code">xindy</code> package in <samp class="file">utils/xindy</samp></a></li>
1998 <li><a href="#xdvik-package" accesskey="3">The <code class="code">xdvik</code> package in <samp class="file">texk/xdvik</samp></a></li>
1999 <li><a href="#asymptote" accesskey="4">The subdirectory <samp class="file">utils/asymptote</samp></a></li>
2000 </ul>
2001 <hr>
2002 <div class="subsection-level-extent" id="t1utils-package">
2003 <div class="nav-panel">
2004 <p>
2005 Next: <a href="#xindy-package" accesskey="n" rel="next">The <code class="code">xindy</code> package in <samp class="file">utils/xindy</samp></a>, Up: <a href="#Program-modules" accesskey="u" rel="up">Program modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2006 </div>
2007 <h4 class="subsection" id="The-t1utils-package-in-utils_002ft1utils"><span>6.5.1 The <code class="code">t1utils</code> package in <samp class="file">utils/t1utils</samp><a class="copiable-link" href="#The-t1utils-package-in-utils_002ft1utils"> &para;</a></span></h4>
2008
2009 <a class="index-entry-id" id="index-t1utils-package"></a>
2010
2011 <p>Here we use the distributed source tree <samp class="file">t1utils-src</samp> with
2012 modifications documented in <samp class="file">TLpatches/*</samp> and a proxy build
2013 system consisting of <samp class="file">configure.ac</samp> and <samp class="file">Makefile.am</samp>. The
2014 fragment <samp class="file">ac/withenable.ac</samp> contains
2015 </p>
2016 <div class="example">
2017 <pre class="example-preformatted">KPSE_ENABLE_PROG([t1utils])
2018 </pre></div>
2019
2020 <p>specifying the module name without any dependencies, and
2021 supplies the configure option <code class="code">--disable-t1utils</code>.
2022 </p>
2023 <hr>
2024 </div>
2025 <div class="subsection-level-extent" id="xindy-package">
2026 <div class="nav-panel">
2027 <p>
2028 Next: <a href="#xdvik-package" accesskey="n" rel="next">The <code class="code">xdvik</code> package in <samp class="file">texk/xdvik</samp></a>, Previous: <a href="#t1utils-package" accesskey="p" rel="prev">The <code class="code">t1utils</code> package in <samp class="file">utils/t1utils</samp></a>, Up: <a href="#Program-modules" accesskey="u" rel="up">Program modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2029 </div>
2030 <h4 class="subsection" id="The-xindy-package-in-utils_002fxindy"><span>6.5.2 The <code class="code">xindy</code> package in <samp class="file">utils/xindy</samp><a class="copiable-link" href="#The-xindy-package-in-utils_002fxindy"> &para;</a></span></h4>
2031
2032 <a class="index-entry-id" id="index-xindy-1"></a>
2033
2034 <p>This module uses the distributed source tree <samp class="file">xindy-src/</samp> with
2035 modifications documented in <samp class="file">TLpatches/*</samp>, and a wrapper
2036 <samp class="file">configure.ac</samp> and <samp class="file">Makefile.am</samp> that descends into
2037 <samp class="file">xindy-src</samp>.
2038 </p>
2039 <p>The <code class="code">xindy</code> build requires a <samp class="file">make</samp> that supports a
2040 <code class="code">VPATH</code> build, can handle all needed targets, and does not refer
2041 to <code class="code">${top_srcdir}</code> or <code class="code">${top_builddir}</code>. The fragment
2042 <code class="code">xindy/ac/withenable.ac</code> contains
2043 </p>
2044 <div class="example">
2045 <pre class="example-preformatted">KPSE_ENABLE_PROG([xindy], , [disable])
2046 m4_include(kpse_TL[utils/xindy/ac/xindy.ac])
2047 m4_include(kpse_TL[utils/xindy/ac/clisp.ac])
2048 </pre></div>
2049
2050 <p>where <code class="code">disable</code> in the third argument indicates that
2051 <code class="code">xindy</code> is only built if explicitly enabled by the user with
2052 <code class="code">configure --enable-xindy</code> (the need for <code class="code">clisp</code> makes it
2053 too painful to enable by default).
2054 </p>
2055 <p>The additional fragments <samp class="file">ac/xindy.ac</samp> and <samp class="file">ac/clisp.ac</samp>
2056 specify more <code class="code">configure</code> options to be seen at the top level,
2057 with <samp class="file">ac/xindy.ac</samp> also included by <samp class="file">configure.ac</samp>.
2058 </p>
2059 <hr>
2060 </div>
2061 <div class="subsection-level-extent" id="xdvik-package">
2062 <div class="nav-panel">
2063 <p>
2064 Next: <a href="#asymptote" accesskey="n" rel="next">The subdirectory <samp class="file">utils/asymptote</samp></a>, Previous: <a href="#xindy-package" accesskey="p" rel="prev">The <code class="code">xindy</code> package in <samp class="file">utils/xindy</samp></a>, Up: <a href="#Program-modules" accesskey="u" rel="up">Program modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2065 </div>
2066 <h4 class="subsection" id="The-xdvik-package-in-texk_002fxdvik"><span>6.5.3 The <code class="code">xdvik</code> package in <samp class="file">texk/xdvik</samp><a class="copiable-link" href="#The-xdvik-package-in-texk_002fxdvik"> &para;</a></span></h4>
2067
2068 <a class="index-entry-id" id="index-xdvik"></a>
2069
2070 <p>This package is maintained as part of the TeX&nbsp;Live tree with sources in
2071 its own directory (<samp class="file">texk/xdvik/</samp>). The fragment
2072 <code class="code">xdvik/ac/withenable.ac</code> contains
2073 </p>
2074 <div class="example">
2075 <pre class="example-preformatted">dnl extra_dirs = texk/xdvik/squeeze
2076 KPSE_ENABLE_PROG([xdvik], [kpathsea freetype2], [x])
2077 m4_include(kpse_TL[texk/xdvik/ac/xdvik.ac])
2078 </pre></div>
2079
2080 <a class="index-entry-id" id="index-squeeze_002fconfigure_002eac"></a>
2081 <a class="index-entry-id" id="index-cross-compilation_002c-with-host-binary"></a>
2082 <p>thus specifying dependencies on the <code class="code">kpathsea</code>,
2083 <code class="code">freetype</code>, and X11 libraries. The M4 comment (following
2084 <code class="code">dnl</code>) signals the subsidiary <samp class="file">squeeze/configure.ac</samp>. This
2085 is needed because the main executable <samp class="file">xdvi-bin</samp> (to be installed
2086 as, e.g., <samp class="file">xdvi-xaw</samp>) is for the <code class="code">host</code> system whereas the
2087 auxiliary program <samp class="file">squeeze/squeeze</samp> has to run on the
2088 <code class="code">build</code> system; in a cross compilation, these differ.
2089 </p>
2090 <a class="index-entry-id" id="index-_002d_002dwith_002dxdvi_002dx_002dtoolkit"></a>
2091 <p>The additional fragment <code class="code">ac/xdvik.ac</code> is also included by
2092 <samp class="file">configure.ac</samp> and supplies the configure option
2093 <code class="code">--with-xdvi-x-toolkit</code> also seen at the top level.
2094 </p>
2095 <hr>
2096 </div>
2097 <div class="subsection-level-extent" id="asymptote">
2098 <div class="nav-panel">
2099 <p>
2100 Previous: <a href="#xdvik-package" accesskey="p" rel="prev">The <code class="code">xdvik</code> package in <samp class="file">texk/xdvik</samp></a>, Up: <a href="#Program-modules" accesskey="u" rel="up">Program modules</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2101 </div>
2102 <h4 class="subsection" id="The-subdirectory-utils_002fasymptote"><span>6.5.4 The subdirectory <samp class="file">utils/asymptote</samp><a class="copiable-link" href="#The-subdirectory-utils_002fasymptote"> &para;</a></span></h4>
2103
2104 <a class="index-entry-id" id="index-asymptote-1"></a>
2105 <a class="index-entry-id" id="index-xasy"></a>
2106
2107 <a class="index-entry-id" id="index-OpenGL_002c-required-for-Asymptote"></a>
2108 <p>This subdirectory contains the sources for <samp class="file">asy</samp> and <samp class="file">xasy</samp>
2109 but due to its complexity and prerequisites (e.g., OpenGL) it is
2110 not part of the TL build system. These programs must be built and
2111 installed independently, but are included on the TL DVD together with
2112 their support files. See <a class="url" href="https://tug.org/texlive/build.html#asymptote">https://tug.org/texlive/build.html#asymptote</a>.
2113 </p>
2114 <hr>
2115 </div>
2116 </div>
2117 <div class="section-level-extent" id="Extending-TeX-Live">
2118 <div class="nav-panel">
2119 <p>
2120 Previous: <a href="#Program-modules" accesskey="p" rel="prev">Program modules</a>, Up: <a href="#Layout-and-infrastructure" accesskey="u" rel="up">Layout and infrastructure</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2121 </div>
2122 <h3 class="section" id="Extending-TeX-Live-1"><span>6.6 Extending TeX&nbsp;Live<a class="copiable-link" href="#Extending-TeX-Live-1"> &para;</a></span></h3>
2123
2124 <a class="index-entry-id" id="index-extending-TeX-Live"></a>
2125 <a class="index-entry-id" id="index-adding-to-TeX-Live"></a>
2126
2127 <p>This section outlines the basic process for adding new packages to the
2128 TL build system.
2129 </p>
2130 <p>A new package directory <samp class="file">foo</samp> should be placed under
2131 <samp class="file">Build/source/texk/</samp> if it uses Kpathsea (or another
2132 TeX-specific library), or under <samp class="file">Build/source/utils</samp> if it
2133 does not.
2134 </p>
2135 <p>The new directory should normally have the original sources, modified
2136 only with changes necessary for TL, in a subdirectory
2137 <samp class="file">foo/foo-src</samp>. The changes should be documented in
2138 <samp class="file">foo/TLpatches/*</samp>, and also be submitted upstream whenever
2139 reasonable. In addition, <samp class="file">foo/</samp> will need the usual Automake
2140 build-related files (<samp class="file">configure.ac</samp>, <samp class="file">Makefile.am</samp>, etc.
2141 Please maintain <samp class="file">foo/ChangeLog</samp> for all TL changes.
2142 </p>
2143 <a class="index-entry-id" id="index-new-package-using-Autoconf-only"></a>
2144 <a class="index-entry-id" id="index-Autoconf_002c-new-package-using-only"></a>
2145 <p>It is also possible to add a package which is configured with Autoconf
2146 (or another <code class="code">make</code>-based system) and not Automake. The package
2147 must still support the standard <code class="code">make</code> variables and targets, and
2148 <code class="code">VPATH</code> builds (see <a data-manual="automake" href="https://www.gnu.org/software/automake/manual/automake.html#VPATH-Builds">VPATH Builds</a> in <cite class="cite">GNU Automake</cite>).
2149 For Autoconf-only packages, it is probably not sensible to use a
2150 <code class="code">foo-src</code> subdirectory.
2151 </p>
2152
2153 <ul class="mini-toc">
2154 <li><a href="#Adding-a-new-program-module" accesskey="1">Adding a new program module</a></li>
2155 <li><a href="#Adding-a-new-engine" accesskey="2">Adding a new engine</a></li>
2156 <li><a href="#Adding-a-new-generic-library-module" accesskey="3">Adding a new generic library module</a></li>
2157 <li><a href="#Adding-a-new-TeX_002dspecific-library-module" accesskey="4">Adding a new TeX-specific library module</a></li>
2158 </ul>
2159 <hr>
2160 <div class="subsection-level-extent" id="Adding-a-new-program-module">
2161 <div class="nav-panel">
2162 <p>
2163 Next: <a href="#Adding-a-new-engine" accesskey="n" rel="next">Adding a new engine</a>, Up: <a href="#Extending-TeX-Live" accesskey="u" rel="up">Extending TeX&nbsp;Live</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2164 </div>
2165 <h4 class="subsection" id="Adding-a-new-program-module-1"><span>6.6.1 Adding a new program module<a class="copiable-link" href="#Adding-a-new-program-module-1"> &para;</a></span></h4>
2166
2167 <a class="index-entry-id" id="index-adding-a-new-program"></a>
2168 <a class="index-entry-id" id="index-program-module_002c-adding"></a>
2169
2170 <a class="index-entry-id" id="index-kpse_005ftexk_005fpkgs"></a>
2171 <p>A TeX-specific program module in a subdirectory
2172 <samp class="file">texk/<var class="var">prog</var></samp> may use the TeX-specific libraries and is
2173 included by adding its name <samp class="file"><var class="var">prog</var></samp> to the M4 list
2174 <code class="code">kpse_texk_pkgs</code> defined in <samp class="file">m4/kpse-pkgs.m4</samp>.
2175 </p>
2176 <a class="index-entry-id" id="index-kpse_005futils_005fpkgs"></a>
2177 <p>A generic program module in a subdirectory <samp class="file">utils/<var class="var">prog</var></samp>
2178 must not use the TeX-specific libraries, notably Kpathsea, and is
2179 included by adding its name <samp class="file"><var class="var">prog</var></samp> to the M4 list
2180 <code class="code">kpse_utils_pkgs</code> in <samp class="file">m4/kpse-pkgs.m4</samp>.
2181 </p>
2182 <a class="index-entry-id" id="index-withenable_002eac_002c-for-new-modules"></a>
2183 <a class="index-entry-id" id="index-KPSE_005fENABLE_005fPROG"></a>
2184 <p>In either case, the subdirectory <samp class="file">texk/<var class="var">prog</var></samp> or
2185 <samp class="file">utils/<var class="var">prog</var></samp> must include a file
2186 <samp class="file">ac/withenable.ac</samp> which contains a call to the M4 macro
2187 <code class="code">KPSE_ENABLE_PROG</code> defined in <samp class="file">m4/kpse-setup.m4</samp> with
2188 <code class="code"><var class="var">prog</var></code> as the mandatory first argument and three optional
2189 arguments:
2190 </p>
2191 <ol class="enumerate">
2192 <li> a list of required libraries from the TL tree;
2193
2194 </li><li> a list of options: <code class="code">disable</code> if this module is not to be
2195 built without the configure option <code class="code">--enable-<var class="var">prog</var></code>,
2196 <code class="code">native</code> if cross compilation is not possible, <code class="code">x</code> if the
2197 program requires X11 libraries;
2198
2199 </li><li> a comment added to the help text for the <code class="code">configure</code>
2200 option <code class="code">--enable-<var class="var">prog</var></code> or <code class="code">--disable-<var class="var">prog</var></code>.
2201 </li></ol>
2202
2203 <p>If the module requires specific <code class="code">configure</code> options to be seen at
2204 the top level, they should be defined in an additional fragment
2205 <samp class="file">ac/<var class="var">prog</var>.ac</samp> included from <samp class="file">ac/withenable.ac</samp> and
2206 <samp class="file">configure.ac</samp>.
2207 </p>
2208 <a class="index-entry-id" id="index-newprog_002dsrc_002c-original-source-subdirectory"></a>
2209 <p>Usually, the new program is maintained somewhere outside of TeX&nbsp;Live. In
2210 that case, as above, we put the upstream sources into a subdirectory
2211 <samp class="file"><var class="var">prog</var>-src</samp> (e.g., <samp class="file">utils/newprog/newprog-src</samp>). We do
2212 not typically run <code class="code">configure</code> in this original <code class="code">...-src</code>
2213 directory, but only in our own directory; but we do compile using the
2214 source files in <code class="code">...-src</code>.
2215 </p>
2216 <p>So, to summarize the files that must (usually) be created inside a new
2217 TL source directory (<samp class="file">texk/newprog</samp> or <samp class="file">utils/newprog</samp>):
2218 </p>
2219 <dl class="ftable">
2220 <dt><a id="index-ac_002fwithenable_002eac"></a><span><samp class="file">ac/withenable.ac</samp><a class="copiable-link" href="#index-ac_002fwithenable_002eac"> &para;</a></span></dt>
2221 <dd><p>The <code class="code">KPSE_ENABLE_PROG</code> call just explained.
2222 </p>
2223 </dd>
2224 <dt><a id="index-configure_002eac"></a><span><samp class="file">configure.ac</samp><a class="copiable-link" href="#index-configure_002eac"> &para;</a></span></dt>
2225 <dt><a id="index-Makefile_002eam"></a><span><samp class="file">Makefile.am</samp><a class="copiable-link" href="#index-Makefile_002eam"> &para;</a></span></dt>
2226 <dd><p>By merging the contents of the original <samp class="file">configure.ac</samp> (if
2227 provided) and a comparable program already in TL. In the above
2228 example, one line that will be needed in <samp class="file">configure.ac</samp> (can be
2229 added before the <code class="code">AC_CONFIG_FILES</code> at the end) is:
2230 </p>
2231 <div class="example">
2232 <pre class="example-preformatted">AC_SUBST([NEWPROG_TREE], [newprog-src])
2233 </pre></div>
2234
2235 <p>and then use <code class="code">@NEWPROG_TREE@</code> in
2236 <code class="code">Makefile.am</code> where needed.
2237 </p>
2238 <p>In general, there is no magic recipe for this part of the job. It&rsquo;s
2239 necessary to think about what needs to be done in the original vs.
2240 in TeX&nbsp;Live. It&rsquo;s useful to look at the setup for the most comparable
2241 programs already in TL that you can find. It&rsquo;s also useful to grep the
2242 entire <samp class="file">Build/source</samp> tree for whatever you can think of to
2243 investigate how something is done. Most of the TL-specific macros are
2244 defined in <samp class="file">Build/source/m4/*</samp>.
2245 </p>
2246 </dd>
2247 <dt><a id="index-TLpatches_002fTL_002dChanges"></a><span><samp class="file">TLpatches/TL-Changes</samp><a class="copiable-link" href="#index-TLpatches_002fTL_002dChanges"> &para;</a></span></dt>
2248 <dd><p>First actions taken after getting the original source tree; typically
2249 removal of derived or unused common files.
2250 </p>
2251 </dd>
2252 <dt><a id="index-TLpatches_002fpatch_002d_002e_002e_002e"></a><span><samp class="file">TLpatches/patch-...</samp><a class="copiable-link" href="#index-TLpatches_002fpatch_002d_002e_002e_002e"> &para;</a></span></dt>
2253 <dd><p>If any changes are needed to the original sources, record the patches
2254 here so they can be applied next time. Also, send them upstream so
2255 that we don&rsquo;t have to maintain them forever.
2256 </p>
2257 </dd>
2258 <dt><a id="index-ChangeLog"></a><span><samp class="file">ChangeLog</samp><a class="copiable-link" href="#index-ChangeLog"> &para;</a></span></dt>
2259 <dd><p>Record all TL-specific changes, now and in the future.
2260 </p>
2261 </dd>
2262 </dl>
2263
2264 <a class="index-entry-id" id="index-autoreconf_002c-for-new-program"></a>
2265 <p>After populating the new TL source directory (<samp class="file">.../newprog/</samp>, in
2266 the above), run GNU <code class="code">autoreconf</code> there (see <a class="pxref" href="#Build-system-tools">Build system tools</a>). Once that works, if you are the one who&rsquo;s eventually going
2267 to commit the new package, <code class="code">svn add</code> the necessary files,
2268 including the generated <samp class="file">Makefile.in aclocal.m4 configure</samp>, and
2269 <code class="code">svn:ignore</code> the Automake cache <samp class="file">autom4te.cache</samp>. (This is
2270 so people checking out the TL source tree do not have to run any
2271 autotools, but can simply run <code class="code">configure</code>.)
2272 </p>
2273 <p>To reiterate: do not fail to commit the generated <samp class="file">configure</samp> and
2274 other files. The m4 code in <samp class="file">kpse-pkgs.m4</samp> uses the existence of
2275 <samp class="file">configure</samp> to determine whether to descend into (and configure)
2276 a given subdirectory.
2277 </p>
2278 <a class="index-entry-id" id="index-reautoconf_002c-for-new-program"></a>
2279 <p>Then, run the TL tool <code class="code">reautoconf</code> in the top-level TL
2280 <code class="code">Build/source/</code> directory, to incorporate the new program into
2281 the build tree. It is good to then rebuild the whole tree (e.g., using
2282 TL&rsquo;s <samp class="file">Build/Build</samp> script) to get all the necessary files generated.
2283 </p>
2284 <p>It will probably fail. So then you need to keep at it until the
2285 program compiles and tests successfully. The most efficient way is to
2286 rerun <code class="code">autoreconf</code> as needed in the new source directory
2287 (<code class="code">Build/source/.../newprog</code>), then <code class="code">make</code> in the
2288 corresponding build directory (<code class="code">Build/work/.../newprog</code>), then
2289 <code class="code">make check</code>, etc. In the end, also make sure that the whole tree
2290 builds from scratch.
2291 </p>
2292 <p>After final success, don&rsquo;t forget to commit. (Or email the TL
2293 maintainers with the patch.)
2294 </p>
2295 <hr>
2296 </div>
2297 <div class="subsection-level-extent" id="Adding-a-new-engine">
2298 <div class="nav-panel">
2299 <p>
2300 Next: <a href="#Adding-a-new-generic-library-module" accesskey="n" rel="next">Adding a new generic library module</a>, Previous: <a href="#Adding-a-new-program-module" accesskey="p" rel="prev">Adding a new program module</a>, Up: <a href="#Extending-TeX-Live" accesskey="u" rel="up">Extending TeX&nbsp;Live</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2301 </div>
2302 <h4 class="subsection" id="Adding-a-new-engine-1"><span>6.6.2 Adding a new engine<a class="copiable-link" href="#Adding-a-new-engine-1"> &para;</a></span></h4>
2303
2304 <a class="index-entry-id" id="index-adding-a-new-engine"></a>
2305 <a class="index-entry-id" id="index-engine_002c-adding-new"></a>
2306
2307 <p>Adding a new TeX engine is not completely different from adding a
2308 program, but it&rsquo;s not all that similar, either. In this case, the main
2309 work is done by creating a new subdirectory of <samp class="file">texk/web2c/</samp> for
2310 the engine. The subdirectory is conventionally named ending in
2311 <samp class="file">dir</samp>, like <samp class="file">pdftexdir</samp> and <samp class="file">xetexdir</samp>, to avoid
2312 clashes with executable names.
2313 </p>
2314 <p>The source files for the new engine should be put in this
2315 <samp class="file"><var class="var">newengine</var>dir</samp> subdirectory. Also, a file
2316 <samp class="file"><var class="var">newengine</var>dir/am/<var class="var">newengine</var>.am</samp> (e.g.,
2317 <samp class="file">pdftexdir/am/pdftex.am</samp> is needed with the Makefile fragment
2318 needed to build it.
2319 </p>
2320 <p>The overall <samp class="file">web2c/Makefile.am</samp> needs to have an <samp class="file">include</samp>
2321 statement added to insert that <samp class="file"><var class="var">newengine</var>.am</samp> file.
2322 </p>
2323 <p>In <samp class="file">web2c/ac/web2c.ac</samp>, a line needs to be added in the
2324 definition of the <code class="code">kpse_tex_progs</code> variable to include it in the
2325 build. That line specifies whether the new engine is built by default,
2326 and the additional libraries requires.
2327 </p>
2328 <p>For examples of building engines in CWEB, you can check the existing
2329 <samp class="file">hitexdir</samp> and <samp class="file">mplibdir</samp> directories; these are somewhat
2330 simpler than LuaTeX. Of course, every engine will have its own
2331 unique features and requirements, so existing examples will only take
2332 you so far.
2333 </p>
2334 <p>Web2c is built as one &ldquo;package&rdquo;, with each subdirectory&rsquo;s <samp class="file">.am</samp>
2335 fragment inserted with an Automake <code class="code">include</code>. This means that,
2336 for instance, <code class="code">$(srcdir)</code> is <samp class="file">.../web2c</samp>, not
2337 <samp class="file">.../webdir/enginedir</samp>. It is a difficult setup to come to terms
2338 with, but the alternative is to recurse into each engine subdirectory,
2339 and that would be far worse (see <a data-manual="automake" href="https://www.gnu.org/software/automake/manual/automake.html#Directories">Directories</a> in <cite class="cite">GNU
2340 Automake</cite>).
2341 </p>
2342 <hr>
2343 </div>
2344 <div class="subsection-level-extent" id="Adding-a-new-generic-library-module">
2345 <div class="nav-panel">
2346 <p>
2347 Next: <a href="#Adding-a-new-TeX_002dspecific-library-module" accesskey="n" rel="next">Adding a new TeX-specific library module</a>, Previous: <a href="#Adding-a-new-engine" accesskey="p" rel="prev">Adding a new engine</a>, Up: <a href="#Extending-TeX-Live" accesskey="u" rel="up">Extending TeX&nbsp;Live</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2348 </div>
2349 <h4 class="subsection" id="Adding-a-new-generic-library-module-1"><span>6.6.3 Adding a new generic library module<a class="copiable-link" href="#Adding-a-new-generic-library-module-1"> &para;</a></span></h4>
2350
2351 <a class="index-entry-id" id="index-adding-a-new-generic-library"></a>
2352 <a class="index-entry-id" id="index-generic-library-module_002c-adding"></a>
2353 <a class="index-entry-id" id="index-library-module_002c-generic_002c-adding"></a>
2354
2355 <a class="index-entry-id" id="index-kpse_005flibs_005fpkgs"></a>
2356 <p>A generic library module in a subdirectory <samp class="file">libs/<var class="var">lib</var></samp> must
2357 not depend on TeX-specific libraries, by definition. It is
2358 included by adding its name <samp class="file"><var class="var">lib</var></samp> to the M4 macro
2359 <code class="code">kpse_libs_pkgs</code> in <samp class="file">m4/kpse-pkgs.m4</samp>&mdash;before any other
2360 libraries from the TeX&nbsp;Live tree on which it depends.
2361 </p>
2362 <a class="index-entry-id" id="index-KPSE_005fWITH_005fLIB"></a>
2363 <p>As with program modules, the subdirectory <samp class="file">libs/<var class="var">lib</var></samp> must
2364 contain the sources and build system for the library (and any
2365 installable support programs) and a fragment <samp class="file">ac/withenable.ac</samp>
2366 that contains the M4 macro <code class="code">KPSE_WITH_LIB</code> defined in
2367 <samp class="file">m4/kpse-setup.m4</samp> with <code class="code"><var class="var">lib</var></code> as the mandatory first
2368 argument and two optional arguments: a list of required libraries from
2369 the TL tree, and a list of options: for libraries, currently there is
2370 only one&mdash;specify <code class="code">tree</code> if this library cannot be replaced by a
2371 system version.
2372 </p>
2373 <a class="index-entry-id" id="index-KPSE_005fTRY_005fLIB-1"></a>
2374 <a class="index-entry-id" id="index-KPSE_005fTRY_005fLIBXX-1"></a>
2375 <p>If a system version can be used, a second fragment
2376 <samp class="file">ac/<var class="var">lib</var>.ac</samp> is needed, containing the M4 macro
2377 <code class="code">KPSE_TRY_LIB</code> (or <code class="code">KPSE_TRY_LIBXX</code>) with <code class="code"><var class="var">lib</var></code>
2378 as the mandatory first argument and two additional arguments for the
2379 Autoconf macro <code class="code">AC_LANG_PROGRAM</code> used to compile and link a small
2380 C (or C++) program as sanity check for using the system library.
2381 </p>
2382 <a class="index-entry-id" id="index-KPSE_005fLIB_005fFLAGS-1"></a>
2383 <p>In addition a file <samp class="file">m4/kpse-<var class="var">lib</var>-flags</samp> (at the top level)
2384 must define the M4 macro <code class="code">KPSE_<var class="var">LIB</var>_FLAGS</code> (all uppercase)
2385 setting up the <code class="code">make</code> variables <code class="code"><var class="var">LIB</var>_INCLUDES</code>,
2386 <code class="code"><var class="var">LIB</var>_LIBS</code>, <code class="code"><var class="var">LIB</var>_DEPEND</code>, and
2387 <code class="code"><var class="var">LIB</var>_RULE</code> with the values required for <code class="code">CPPFLAGS</code>,
2388 <code class="code">LDADD</code>, dependencies, and a (multi-line) <code class="code">make</code> rule to
2389 rebuild the library when necessary. All of that is needed for the
2390 library from the TL tree and, if supported, for a system version.
2391 </p>
2392 <a class="index-entry-id" id="index-_002d_002dwith_002dsystem_002dlib"></a>
2393 <a class="index-entry-id" id="index-KPSE_005fLIB_005fSYSTEM_005fFLAGS"></a>
2394 <a class="index-entry-id" id="index-KPSE_005fALL_005fSYSTEM_005fFLAGS"></a>
2395 <p>If a system library is allowed, <code class="code">KPSE_<var class="var">LIB</var>_FLAGS</code> also
2396 provides the configure option <code class="code">--with-system-<var class="var">lib</var></code> and uses
2397 the additional M4 macro <code class="code">KPSE_<var class="var">LIB</var>_SYSTEM_FLAGS</code> to generate
2398 the <code class="code">make</code> variables for a system library. In addition, the
2399 definition of the M4 macro <code class="code">KPSE_ALL_SYSTEM_FLAGS</code> in
2400 <samp class="file">m4/kpse-pkgs.m4</samp> must be extended by the line:<br>&nbsp;&nbsp;&nbsp;<code class="code">AC_REQUIRE([KPSE_<var class="var">LIB</var>_SYSTEM_FLAGS])</code>
2401 </p>
2402 <hr>
2403 </div>
2404 <div class="subsection-level-extent" id="Adding-a-new-TeX_002dspecific-library-module">
2405 <div class="nav-panel">
2406 <p>
2407 Previous: <a href="#Adding-a-new-generic-library-module" accesskey="p" rel="prev">Adding a new generic library module</a>, Up: <a href="#Extending-TeX-Live" accesskey="u" rel="up">Extending TeX&nbsp;Live</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2408 </div>
2409 <h4 class="subsection" id="Adding-a-new-TeX_002dspecific-library-module-1"><span>6.6.4 Adding a new TeX-specific library module<a class="copiable-link" href="#Adding-a-new-TeX_002dspecific-library-module-1"> &para;</a></span></h4>
2410
2411 <a class="index-entry-id" id="index-adding-a-new-TeX_002dspecific-library"></a>
2412 <a class="index-entry-id" id="index-TeX_002dspecific-library-module_002c-adding"></a>
2413 <a class="index-entry-id" id="index-library-module_002c-TeX_002dspecific_002c-adding"></a>
2414
2415 <p>A TeX-specific library module in a subdirectory
2416 <samp class="file">texk/<var class="var">lib</var></samp> may depend on other TeX-specific libraries
2417 but must not depend on any generic library from the TL tree. It is
2418 included in the same general ways as a generic library (see the
2419 previous section), with these modifications:
2420 </p>
2421 <ul class="itemize mark-bullet">
2422 <li><a class="index-entry-id" id="index-kpse_005ftexlibs_005fpkgs"></a>
2423 The library name <code class="code"><var class="var">lib</var></code> is added to the M4 macro
2424 <code class="code">kpse_texlibs_pkgs</code>, which is also in <samp class="file">m4/kpse-pkgs.m4</samp>.
2425
2426 </li><li><a class="index-entry-id" id="index-KPSE_005fWITH_005fTEXLIB"></a>
2427 The fragment <code class="code">ac/withenable.ac</code> must use <code class="code">KPSE_WITH_TEXLIB</code>.
2428 </li></ul>
2429
2430 <hr>
2431 </div>
2432 </div>
2433 </div>
2434 <div class="chapter-level-extent" id="Configure-options">
2435 <div class="nav-panel">
2436 <p>
2437 Next: <a href="#Coding-conventions" accesskey="n" rel="next">Coding conventions</a>, Previous: <a href="#Layout-and-infrastructure" accesskey="p" rel="prev">Layout and infrastructure</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2438 </div>
2439 <h2 class="chapter" id="Configure-options-1"><span>7 Configure options<a class="copiable-link" href="#Configure-options-1"> &para;</a></span></h2>
2440
2441 <a class="index-entry-id" id="index-configure-options"></a>
2442
2443 <p>Corresponding to the large number of program and library modules there
2444 are a large number <code class="code">configure</code> options, most of which are
2445 described here. The command<br>&nbsp;&nbsp;&nbsp;<code class="code">configure --help</code><br>at the
2446 top level gives an exhaustive list of all global options and a few
2447 important module-specific ones, whereas, e.g.,<br>&nbsp;&nbsp;&nbsp;<code class="code">texk/lcdf-typetools/configure --help</code><br> also displays the
2448 <code class="code">lcdf-typetools</code> specific options, which are not shown at the
2449 top level.
2450 </p>
2451 <a class="index-entry-id" id="index-environment-variables_002c-for-configure"></a>
2452 <p>The help text also mentions several influential environment variables,
2453 but for TeX&nbsp;Live it is better to specify them as assignments on the
2454 command line.
2455 </p>
2456 <p>The <samp class="file">./Build</samp> script used to make the binaries shipped with TeX&nbsp;Live
2457 invokes the top-level <code class="code">configure</code> with a few additional options
2458 (see <a class="pxref" href="#Building">Building</a>). The defaults discussed below are those for the
2459 actual <code class="code">configure</code> script; invoking <code class="code">configure</code> via
2460 <samp class="file">./Build</samp> yields different results.
2461 </p>
2462 <p>Defaults for most options are set at the top level and propagated
2463 explicitly to all subdirectories. Options specified on the command
2464 line are checked for consistency but never modified.
2465 </p>
2466
2467 <ul class="mini-toc">
2468 <li><a href="#Global-configure-options" accesskey="1">Global configure options</a></li>
2469 <li><a href="#Program_002dspecific-configure-options" accesskey="2">Program-specific configure options</a></li>
2470 <li><a href="#Library_002dspecific-configure-options" accesskey="3">Library-specific configure options</a></li>
2471 <li><a href="#Variables-for-configure" accesskey="4">Variables for configure</a></li>
2472 </ul>
2473 <hr>
2474 <div class="section-level-extent" id="Global-configure-options">
2475 <div class="nav-panel">
2476 <p>
2477 Next: <a href="#Program_002dspecific-configure-options" accesskey="n" rel="next">Program-specific configure options</a>, Up: <a href="#Configure-options" accesskey="u" rel="up">Configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2478 </div>
2479 <h3 class="section" id="Global-configure-options-1"><span>7.1 Global configure options<a class="copiable-link" href="#Global-configure-options-1"> &para;</a></span></h3>
2480
2481 <a class="index-entry-id" id="index-global-configure-options"></a>
2482 <a class="index-entry-id" id="index-configure-options_002c-global"></a>
2483 <p>Here are the global configure options.
2484 </p>
2485
2486 <ul class="mini-toc">
2487 <li><a href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild" accesskey="1"><code class="code">--disable-native-texlive-build</code></a></li>
2488 <li><a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026" accesskey="2"><code class="code">--prefix</code>, <code class="code">--bindir</code>, &hellip;</a></li>
2489 <li><a href="#g_t_002d_002ddisable_002dlargefile" accesskey="3"><code class="code">--disable-largefile</code></a></li>
2490 <li><a href="#g_t_002d_002ddisable_002dmissing" accesskey="4"><code class="code">--disable-missing</code></a></li>
2491 <li><a href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel" accesskey="5"><code class="code">--enable-compiler-warnings=</code><var class="var">level</var></a></li>
2492 <li><a href="#g_t_002d_002denable_002dcxx_002druntime_002dhack" accesskey="6"><code class="code">--enable-cxx-runtime-hack</code></a></li>
2493 <li><a href="#g_t_002d_002denable_002dmaintainer_002dmode" accesskey="7"><code class="code">--enable-maintainer-mode</code></a></li>
2494 <li><a href="#g_t_002d_002denable_002dmultiplatform" accesskey="8"><code class="code">--enable-multiplatform</code></a></li>
2495 <li><a href="#g_t_002d_002denable_002dshared" accesskey="9"><code class="code">--enable-shared</code></a></li>
2496 <li><a href="#g_t_002d_002denable_002dsilent_002drules"><code class="code">--enable-silent-rules</code></a></li>
2497 <li><a href="#g_t_002d_002dwithout_002dln_002ds"><code class="code">--without-ln-s</code></a></li>
2498 <li><a href="#g_t_002d_002dwithout_002dx"><code class="code">--without-x</code></a></li>
2499 </ul>
2500 <hr>
2501 <div class="subsection-level-extent" id="g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild">
2502 <div class="nav-panel">
2503 <p>
2504 Next: <a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026" accesskey="n" rel="next"><code class="code">--prefix</code>, <code class="code">--bindir</code>, &hellip;</a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2505 </div>
2506 <h4 class="subsection" id="g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild-1"><span>7.1.1 <code class="code">--disable-native-texlive-build</code><a class="copiable-link" href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild-1"> &para;</a></span></h4>
2507
2508 <a class="index-entry-id" id="index-_002d_002ddisable_002dnative_002dtexlive_002dbuild"></a>
2509 <p>If enabled (the default), build for a TL binary distribution as
2510 shipped by the TeX user groups. This requires GNU <code class="code">make</code> and
2511 implies <code class="code">--enable-multiplatform</code> and
2512 <code class="code">--enable-cxx-runtime-hack</code> (unless they are explicitly disabled),
2513 and enforces <code class="code">--disable-shared</code>.
2514 </p>
2515 <p>If building TL for a GNU/Linux or other distribution, this should be
2516 disabled and system versions of most libraries should be used
2517 (see <a class="pxref" href="#Distro-builds">Distro builds</a>).
2518 </p>
2519 <a class="index-entry-id" id="index-_002d_002denable_002dtexlive_002dbuild"></a>
2520 <p>A related option, <code class="code">--enable-texlive-build</code>, is automatically
2521 passed to all subdirectories (and cannot be disabled). Subdirectories
2522 that can also be built independently from the TL tree (such as
2523 <samp class="file">utils/xindy</samp> and <samp class="file">texk/dvipng</samp>) but cooperate with TL can
2524 use this option to enable TL-specific adaptations, such as
2525 installation paths.
2526 </p>
2527 <hr>
2528 </div>
2529 <div class="subsection-level-extent" id="g_t_002d_002dprefix-_002d_002dbindir-_2026">
2530 <div class="nav-panel">
2531 <p>
2532 Next: <a href="#g_t_002d_002ddisable_002dlargefile" accesskey="n" rel="next"><code class="code">--disable-largefile</code></a>, Previous: <a href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild" accesskey="p" rel="prev"><code class="code">--disable-native-texlive-build</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2533 </div>
2534 <h4 class="subsection" id="g_t_002d_002dprefix_002c-_002d_002dbindir_002c-_002e_002e_002e"><span>7.1.2 <code class="code">--prefix</code>, <code class="code">--bindir</code>, &hellip;<a class="copiable-link" href="#g_t_002d_002dprefix_002c-_002d_002dbindir_002c-_002e_002e_002e"> &para;</a></span></h4>
2535
2536 <a class="index-entry-id" id="index-_002d_002dprefix-configure-option"></a>
2537 <a class="index-entry-id" id="index-_002d_002dbindir-configure-option"></a>
2538 <p>These standard Autoconf options specify various installation
2539 directories as usual. For the complete list, see <a class="pxref" href="#Installation-directories">Installation directories</a>.
2540 </p>
2541 <a class="index-entry-id" id="index-DESTDIR"></a>
2542 <p>Also as usual, all values are prefixed by the value of <code class="code">DESTDIR</code>,
2543 if set, on the <code class="code">make</code> command line (see <a data-manual="automake" href="https://www.gnu.org/software/automake/manual/automake.html#Staged-Installs">Installation in a temporary location</a> in <cite class="cite">GNU Automake</cite>).
2544 </p>
2545 <hr>
2546 </div>
2547 <div class="subsection-level-extent" id="g_t_002d_002ddisable_002dlargefile">
2548 <div class="nav-panel">
2549 <p>
2550 Next: <a href="#g_t_002d_002ddisable_002dmissing" accesskey="n" rel="next"><code class="code">--disable-missing</code></a>, Previous: <a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026" accesskey="p" rel="prev"><code class="code">--prefix</code>, <code class="code">--bindir</code>, &hellip;</a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2551 </div>
2552 <h4 class="subsection" id="g_t_002d_002ddisable_002dlargefile-1"><span>7.1.3 <code class="code">--disable-largefile</code><a class="copiable-link" href="#g_t_002d_002ddisable_002dlargefile-1"> &para;</a></span></h4>
2553
2554 <a class="index-entry-id" id="index-_002d_002ddisable_002dlargefile"></a>
2555 <a class="index-entry-id" id="index-large-file-support"></a>
2556 <a class="index-entry-id" id="index-LFS-_0028large-file-support_0029"></a>
2557 <p>Omit large file support (LFS), which is needed on most 32-bit Unix
2558 systems for files with 2GB or more. Regardless of this option, the
2559 size of <code class="code">DVI</code> and <code class="code">GF</code> files must always be <em class="math">&lt;2</em>GB, due
2560 to the file format specifications.
2561 </p>
2562 <a class="index-entry-id" id="index-size-of-PDF-and-PS-files"></a>
2563 <a class="index-entry-id" id="index-PDF-files_002c-size-of"></a>
2564 <a class="index-entry-id" id="index-PostScript-files_002c-size-of"></a>
2565 <p>With LFS, there is no fixed limit on the size of PDF files created by
2566 <samp class="file">pdftex</samp> or PostScript files created by <samp class="file">dvips</samp>.
2567 </p>
2568 <hr>
2569 </div>
2570 <div class="subsection-level-extent" id="g_t_002d_002ddisable_002dmissing">
2571 <div class="nav-panel">
2572 <p>
2573 Next: <a href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel" accesskey="n" rel="next"><code class="code">--enable-compiler-warnings=</code><var class="var">level</var></a>, Previous: <a href="#g_t_002d_002ddisable_002dlargefile" accesskey="p" rel="prev"><code class="code">--disable-largefile</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2574 </div>
2575 <h4 class="subsection" id="g_t_002d_002ddisable_002dmissing-1"><span>7.1.4 <code class="code">--disable-missing</code><a class="copiable-link" href="#g_t_002d_002ddisable_002dmissing-1"> &para;</a></span></h4>
2576
2577 <a class="index-entry-id" id="index-_002d_002ddisable_002dmissing"></a>
2578 <p>Immediately terminate the build process if a requested program or feature
2579 must be disabled, e.g., due to missing libraries. This can help when
2580 figuring out a specific (sub)set of modules to enable.
2581 </p>
2582 <hr>
2583 </div>
2584 <div class="subsection-level-extent" id="g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel">
2585 <div class="nav-panel">
2586 <p>
2587 Next: <a href="#g_t_002d_002denable_002dcxx_002druntime_002dhack" accesskey="n" rel="next"><code class="code">--enable-cxx-runtime-hack</code></a>, Previous: <a href="#g_t_002d_002ddisable_002dmissing" accesskey="p" rel="prev"><code class="code">--disable-missing</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2588 </div>
2589 <h4 class="subsection" id="g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel-1"><span>7.1.5 <code class="code">--enable-compiler-warnings=</code><var class="var">level</var><a class="copiable-link" href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel-1"> &para;</a></span></h4>
2590
2591 <a class="index-entry-id" id="index-_002d_002denable_002dcompiler_002dwarnings_003dlevel"></a>
2592 <p>Enable various levels of compiler warnings for C, C++, and/or
2593 Objective&nbsp;C: the <var class="var">level</var> value can be one of: <code class="code">no min
2594 yes max all</code>. The default is <code class="code">yes</code> in <code class="code">maintainer-mode</code>
2595 (see below) and <code class="code">min</code> otherwise. This option defines the
2596 variables <code class="code">WARNING_[OBJ]C[XX]FLAGS</code>, but these variables are not
2597 consistently used in all library and program modules. At present,
2598 these warning flags assume options from the GNU compilers.
2599 </p>
2600 <hr>
2601 </div>
2602 <div class="subsection-level-extent" id="g_t_002d_002denable_002dcxx_002druntime_002dhack">
2603 <div class="nav-panel">
2604 <p>
2605 Next: <a href="#g_t_002d_002denable_002dmaintainer_002dmode" accesskey="n" rel="next"><code class="code">--enable-maintainer-mode</code></a>, Previous: <a href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel" accesskey="p" rel="prev"><code class="code">--enable-compiler-warnings=</code><var class="var">level</var></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2606 </div>
2607 <h4 class="subsection" id="g_t_002d_002denable_002dcxx_002druntime_002dhack-1"><span>7.1.6 <code class="code">--enable-cxx-runtime-hack</code><a class="copiable-link" href="#g_t_002d_002denable_002dcxx_002druntime_002dhack-1"> &para;</a></span></h4>
2608
2609 <p>If enabled (as it is for the native TL build), when using <code class="code">g++</code>,
2610 try to statically link with <code class="code">libstdc++</code>, thus improving
2611 portability of the resulting binary. See <a class="xref" href="#Macros-for-compilers">Macros for compilers</a>.
2612 </p>
2613 <hr>
2614 </div>
2615 <div class="subsection-level-extent" id="g_t_002d_002denable_002dmaintainer_002dmode">
2616 <div class="nav-panel">
2617 <p>
2618 Next: <a href="#g_t_002d_002denable_002dmultiplatform" accesskey="n" rel="next"><code class="code">--enable-multiplatform</code></a>, Previous: <a href="#g_t_002d_002denable_002dcxx_002druntime_002dhack" accesskey="p" rel="prev"><code class="code">--enable-cxx-runtime-hack</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2619 </div>
2620 <h4 class="subsection" id="g_t_002d_002denable_002dmaintainer_002dmode-1"><span>7.1.7 <code class="code">--enable-maintainer-mode</code><a class="copiable-link" href="#g_t_002d_002denable_002dmaintainer_002dmode-1"> &para;</a></span></h4>
2621
2622 <a class="index-entry-id" id="index-_002d_002denable_002dmaintainer_002dmode-1"></a>
2623 <p>Enable <samp class="file">make</samp> rules and dependencies not useful (and sometimes
2624 confusing) to the casual user. This requires current versions of the
2625 GNU build tools (see <a class="pxref" href="#Build-system-tools">Build system tools</a>), as it automatically
2626 rebuilds infrastructure files as needed. See <a data-manual="automake" href="https://www.gnu.org/software/automake/manual/automake.html#maintainer_002dmode"><code class="code">missing</code> and <code class="code">AM_MAINTAINER_MODE</code></a> in <cite class="cite">GNU Automake</cite>.
2627 </p>
2628 <hr>
2629 </div>
2630 <div class="subsection-level-extent" id="g_t_002d_002denable_002dmultiplatform">
2631 <div class="nav-panel">
2632 <p>
2633 Next: <a href="#g_t_002d_002denable_002dshared" accesskey="n" rel="next"><code class="code">--enable-shared</code></a>, Previous: <a href="#g_t_002d_002denable_002dmaintainer_002dmode" accesskey="p" rel="prev"><code class="code">--enable-maintainer-mode</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2634 </div>
2635 <h4 class="subsection" id="g_t_002d_002denable_002dmultiplatform-1"><span>7.1.8 <code class="code">--enable-multiplatform</code><a class="copiable-link" href="#g_t_002d_002denable_002dmultiplatform-1"> &para;</a></span></h4>
2636
2637 <a class="index-entry-id" id="index-_002d_002denable_002dmultiplatform"></a>
2638 <a class="index-entry-id" id="index-exec_005fprefix"></a>
2639 <a class="index-entry-id" id="index-_002d_002dbindir-configure-option-1"></a>
2640 <a class="index-entry-id" id="index-_002d_002dlibdir-configure-option"></a>
2641 <p>If enabled (as it is for the native TL build) and
2642 <code class="code">--bindir=<var class="var">dir</var></code> or <code class="code">--libdir=<var class="var">dir</var></code> are not
2643 specified, install executables and libraries in per-platform
2644 subdirectories of <samp class="file"><var class="var">eprefix</var>/bin</samp> and
2645 <samp class="file"><var class="var">eprefix</var>/lib</samp> where <var class="var">eprefix</var> is the value given or
2646 implied for <code class="code">exec_prefix</code>. In any case, the values for
2647 <code class="code">bindir</code> and <code class="code">libdir</code> are automatically propagated to all
2648 subdirectories.
2649 </p>
2650 <hr>
2651 </div>
2652 <div class="subsection-level-extent" id="g_t_002d_002denable_002dshared">
2653 <div class="nav-panel">
2654 <p>
2655 Next: <a href="#g_t_002d_002denable_002dsilent_002drules" accesskey="n" rel="next"><code class="code">--enable-silent-rules</code></a>, Previous: <a href="#g_t_002d_002denable_002dmultiplatform" accesskey="p" rel="prev"><code class="code">--enable-multiplatform</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2656 </div>
2657 <h4 class="subsection" id="g_t_002d_002denable_002dshared-1"><span>7.1.9 <code class="code">--enable-shared</code><a class="copiable-link" href="#g_t_002d_002denable_002dshared-1"> &para;</a></span></h4>
2658
2659 <a class="index-entry-id" id="index-_002d_002denable_002dshared"></a>
2660 <p>Build shared versions of the TeX-specific libraries such as
2661 <samp class="file">libkpathsea</samp>. This is not allowed for a native TL build (i.e.,
2662 <code class="code">--disable-native-texlive-build</code> must also be specified).
2663 </p>
2664 <hr>
2665 </div>
2666 <div class="subsection-level-extent" id="g_t_002d_002denable_002dsilent_002drules">
2667 <div class="nav-panel">
2668 <p>
2669 Next: <a href="#g_t_002d_002dwithout_002dln_002ds" accesskey="n" rel="next"><code class="code">--without-ln-s</code></a>, Previous: <a href="#g_t_002d_002denable_002dshared" accesskey="p" rel="prev"><code class="code">--enable-shared</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2670 </div>
2671 <h4 class="subsection" id="g_t_002d_002denable_002dsilent_002drules-1"><span>7.1.10 <code class="code">--enable-silent-rules</code><a class="copiable-link" href="#g_t_002d_002denable_002dsilent_002drules-1"> &para;</a></span></h4>
2672
2673 <a class="index-entry-id" id="index-_002d_002denable_002dsilent_002drules"></a>
2674 <a class="index-entry-id" id="index-make-rules_002c-verbose-vs_002e-silent"></a>
2675 <p>Enable the use of less verbose build rules. When using GNU
2676 <code class="code">make</code> (or any <code class="code">make</code> implementation supporting nested
2677 variable expansions), you can specify <code class="code">V=1</code> on the <code class="code">make</code>
2678 command line to get more verbosity, or <code class="code">V=0</code> to get less,
2679 regardless of this option.
2680 </p>
2681 <hr>
2682 </div>
2683 <div class="subsection-level-extent" id="g_t_002d_002dwithout_002dln_002ds">
2684 <div class="nav-panel">
2685 <p>
2686 Next: <a href="#g_t_002d_002dwithout_002dx" accesskey="n" rel="next"><code class="code">--without-x</code></a>, Previous: <a href="#g_t_002d_002denable_002dsilent_002drules" accesskey="p" rel="prev"><code class="code">--enable-silent-rules</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2687 </div>
2688 <h4 class="subsection" id="g_t_002d_002dwithout_002dln_002ds-1"><span>7.1.11 <code class="code">--without-ln-s</code><a class="copiable-link" href="#g_t_002d_002dwithout_002dln_002ds-1"> &para;</a></span></h4>
2689
2690 <a class="index-entry-id" id="index-_002d_002dwithout_002dln_002ds"></a>
2691 <p>Required when using a system without a working <code class="code">ln -s</code> to build
2692 binaries for a Unix-like system. However, <code class="code">make install</code> will
2693 not create anything useful, and might fail.
2694 </p>
2695 <hr>
2696 </div>
2697 <div class="subsection-level-extent" id="g_t_002d_002dwithout_002dx">
2698 <div class="nav-panel">
2699 <p>
2700 Previous: <a href="#g_t_002d_002dwithout_002dln_002ds" accesskey="p" rel="prev"><code class="code">--without-ln-s</code></a>, Up: <a href="#Global-configure-options" accesskey="u" rel="up">Global configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2701 </div>
2702 <h4 class="subsection" id="g_t_002d_002dwithout_002dx-1"><span>7.1.12 <code class="code">--without-x</code><a class="copiable-link" href="#g_t_002d_002dwithout_002dx-1"> &para;</a></span></h4>
2703
2704 <a class="index-entry-id" id="index-_002d_002dwithout_002dx"></a>
2705 <p>Disable all programs using the X Window System.
2706 </p>
2707 <hr>
2708 </div>
2709 </div>
2710 <div class="section-level-extent" id="Program_002dspecific-configure-options">
2711 <div class="nav-panel">
2712 <p>
2713 Next: <a href="#Library_002dspecific-configure-options" accesskey="n" rel="next">Library-specific configure options</a>, Previous: <a href="#Global-configure-options" accesskey="p" rel="prev">Global configure options</a>, Up: <a href="#Configure-options" accesskey="u" rel="up">Configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2714 </div>
2715 <h3 class="section" id="Program_002dspecific-configure-options-1"><span>7.2 Program-specific configure options<a class="copiable-link" href="#Program_002dspecific-configure-options-1"> &para;</a></span></h3>
2716
2717 <a class="index-entry-id" id="index-program_002dspecific-configure-options"></a>
2718 <a class="index-entry-id" id="index-configure-options_002c-program_002dspecific"></a>
2719 <p>Here are (some of) the program-specific <code class="code">configure</code> options.
2720 </p>
2721
2722 <ul class="mini-toc">
2723 <li><a href="#g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog" accesskey="1"><code class="code">--enable-<var class="var">prog</var></code>, <code class="code">--disable-<var class="var">prog</var></code></a></li>
2724 <li><a href="#g_t_002d_002ddisable_002dall_002dpkgs" accesskey="2"><code class="code">--disable-all-pkgs</code></a></li>
2725 <li><a href="#Configure-options-for-texk_002fweb2c" accesskey="3">Configure options for <samp class="file">texk/web2c</samp></a></li>
2726 <li><a href="#Configure-options-for-texk_002fbibtex_002dx" accesskey="4">Configure options for <samp class="file">texk/bibtex-x</samp></a></li>
2727 <li><a href="#Configure-options-for-texk_002fdvipdfm_002dx" accesskey="5">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></li>
2728 <li><a href="#Configure-options-for-texk_002fdvisvgm" accesskey="6">Configure options for <samp class="file">texk/dvisvgm</samp></a></li>
2729 <li><a href="#Configure-options-for-texk_002ftexlive" accesskey="7">Configure options for <samp class="file">texk/texlive</samp></a></li>
2730 <li><a href="#Configure-options-for-texk_002fxdvik" accesskey="8">Configure options for <samp class="file">texk/xdvik</samp></a></li>
2731 <li><a href="#Configure-options-for-utils_002fxindy" accesskey="9">Configure options for <samp class="file">utils/xindy</samp></a></li>
2732 </ul>
2733 <hr>
2734 <div class="subsection-level-extent" id="g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog">
2735 <div class="nav-panel">
2736 <p>
2737 Next: <a href="#g_t_002d_002ddisable_002dall_002dpkgs" accesskey="n" rel="next"><code class="code">--disable-all-pkgs</code></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2738 </div>
2739 <h4 class="subsection" id="g_t_002d_002denable_002dprog_002c-_002d_002ddisable_002dprog"><span>7.2.1 <code class="code">--enable-<var class="var">prog</var></code>, <code class="code">--disable-<var class="var">prog</var></code><a class="copiable-link" href="#g_t_002d_002denable_002dprog_002c-_002d_002ddisable_002dprog"> &para;</a></span></h4>
2740
2741 <a class="index-entry-id" id="index-_002d_002denable_002dprog"></a>
2742 <a class="index-entry-id" id="index-_002d_002ddisable_002dprog"></a>
2743 <p>Do or do not build and install the program(s) of module <code class="code"><var class="var">prog</var></code>.
2744 </p>
2745 <hr>
2746 </div>
2747 <div class="subsection-level-extent" id="g_t_002d_002ddisable_002dall_002dpkgs">
2748 <div class="nav-panel">
2749 <p>
2750 Next: <a href="#Configure-options-for-texk_002fweb2c" accesskey="n" rel="next">Configure options for <samp class="file">texk/web2c</samp></a>, Previous: <a href="#g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog" accesskey="p" rel="prev"><code class="code">--enable-<var class="var">prog</var></code>, <code class="code">--disable-<var class="var">prog</var></code></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2751 </div>
2752 <h4 class="subsection" id="g_t_002d_002ddisable_002dall_002dpkgs-1"><span>7.2.2 <code class="code">--disable-all-pkgs</code><a class="copiable-link" href="#g_t_002d_002ddisable_002dall_002dpkgs-1"> &para;</a></span></h4>
2753
2754 <a class="index-entry-id" id="index-_002d_002ddisable_002dall_002dpkgs"></a>
2755 <p>Do not build any program modules by default&mdash;only those explicitly
2756 enabled. This is useful when one wants to work on only a single
2757 program, which is specified with an additional <code class="code">--enable</code> option,
2758 e.g., <code class="code">--enable-dvipdfm-x</code>. It&rsquo;s still simplest to check out and
2759 configure the whole source tree, but at least only the program you are
2760 interested in, and its dependencies, are built. See <a class="xref" href="#Build-one-package">Build one package</a>.
2761 </p>
2762 <p>Without this option, all modules are built except those that are
2763 explicitly disabled or specify <code class="code">disable</code> in their
2764 <samp class="file">ac/withenable.ac</samp> fragment.
2765 </p>
2766 <hr>
2767 </div>
2768 <div class="subsection-level-extent" id="Configure-options-for-texk_002fweb2c">
2769 <div class="nav-panel">
2770 <p>
2771 Next: <a href="#Configure-options-for-texk_002fbibtex_002dx" accesskey="n" rel="next">Configure options for <samp class="file">texk/bibtex-x</samp></a>, Previous: <a href="#g_t_002d_002ddisable_002dall_002dpkgs" accesskey="p" rel="prev"><code class="code">--disable-all-pkgs</code></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2772 </div>
2773 <h4 class="subsection" id="Configure-options-for-texk_002fweb2c-1"><span>7.2.3 Configure options for <samp class="file">texk/web2c</samp><a class="copiable-link" href="#Configure-options-for-texk_002fweb2c-1"> &para;</a></span></h4>
2774
2775 <a class="index-entry-id" id="index-configure-options_002c-for-web2c"></a>
2776
2777 <a class="index-entry-id" id="index-_002d_002dwith_002dbanner_002dadd_003dstr"></a>
2778 <p><code class="code">--with-banner-add=<var class="var">str</var></code><br>Add <code class="code"><var class="var">str</var></code> to the
2779 default version string (which is &lsquo;<code class="code">TeX Live <var class="var">year</var></code>&rsquo; or
2780 &lsquo;<code class="code">Web2C <var class="var">year</var></code>&rsquo;) appended to banner lines. This is ignored
2781 for a native TL build, but distro builds should specify, e.g.,
2782 <code class="code">/<var class="var">SomeDistro</var></code>.
2783 </p>
2784 <a class="index-entry-id" id="index-_002d_002dwith_002deditor_003dcmd"></a>
2785 <p><code class="code">--with-editor=<var class="var">cmd</var></code><br>Specify the command
2786 <code class="code"><var class="var">cmd</var></code> to invoke from the <code class="code">e</code> option of TeX and friends,
2787 replacing the default <code class="code">vi +%d '%s'</code> for Unix or <code class="code">texworks
2788 --position=%d &quot;%s&quot;</code> for Windows.
2789 </p>
2790 <a class="index-entry-id" id="index-_002d_002dwith_002dfontconfig_002dincludes_003ddir"></a>
2791 <a class="index-entry-id" id="index-_002d_002dwith_002dfontconfig_002dlibdir_003ddir"></a>
2792 <p><code class="code">--with-fontconfig-includes=<var class="var">dir</var></code>,
2793 <code class="code">--with-fontconfig-libdir=<var class="var">dir</var></code><br>Building XeTeX on
2794 non-Mac systems requires the <code class="code">fontconfig</code> library headers and
2795 code. If one or both of these options are given, the required flags
2796 are derived from them; otherwise, they are determined via
2797 <samp class="file">pkg-config</samp> (if present).
2798 </p>
2799 <a class="index-entry-id" id="index-X-toolkit"></a>
2800 <a class="index-entry-id" id="index-libXt"></a>
2801 <a class="index-entry-id" id="index-Xlib"></a>
2802 <p><code class="code">--with-mf-x-toolkit</code><br>Use the X toolkit (<samp class="file">libXt</samp>) for
2803 Metafont (the default is to use the lowest-level <samp class="file">Xlib</samp> support;
2804 it seems this has the best chance of working across X installations
2805 nowadays).
2806 </p>
2807 <a class="index-entry-id" id="index-_002d_002ddisable_002ddump_002dshare"></a>
2808 <a class="index-entry-id" id="index-LittleEndian-architectures"></a>
2809 <p><code class="code">--disable-dump-share</code><br>Make the <code class="code">fmt</code>/<code class="code">base</code>
2810 dump files architecture dependent (somewhat faster on LittleEndian
2811 architectures).
2812 </p>
2813 <a class="index-entry-id" id="index-_002d_002ddisable_002dipc"></a>
2814 <a class="index-entry-id" id="index-interprocess-communication"></a>
2815 <p><code class="code">--disable-ipc</code><br>Disable TeX&rsquo;s <code class="code">--ipc</code> option.
2816 </p>
2817 <a class="index-entry-id" id="index-_002d_002ddisable_002dmf_002dnowin"></a>
2818 <a class="index-entry-id" id="index-mf_002dnowin"></a>
2819 <p><code class="code">--disable-mf-nowin</code><br>Do not build a separate
2820 non-graphically-capable Metafont (<samp class="file">mf-nowin</samp>).
2821 </p>
2822 <a class="index-entry-id" id="index-_002d_002ddisable_002dtex"></a>
2823 <a class="index-entry-id" id="index-_002d_002denable_002detex"></a>
2824 <a class="index-entry-id" id="index-web2c_002eac"></a>
2825 <p><code class="code">--disable-tex</code>, <code class="code">--enable-etex</code>, &hellip;<br>Do not or
2826 do build the various TeX, Metafont, and MetaPost engines (defaults are
2827 defined in the fragment <samp class="file">texk/web2c/ac/web2c.ac</samp>).
2828 </p>
2829 <a class="index-entry-id" id="index-_002d_002ddisable_002dweb_002dprogs"></a>
2830 <p><code class="code">--disable-web-progs</code><br>Do not build the original WEB programs
2831 <samp class="file">bibtex</samp>, &hellip;, <samp class="file">weave</samp>. Useful if, e.g., you only want
2832 to (re)build some engines.
2833 </p>
2834 <a class="index-entry-id" id="index-_002d_002denable_002dauto_002dcore"></a>
2835 <a class="index-entry-id" id="index-preloaded-binaries"></a>
2836 <p><code class="code">--enable-auto-core</code><br>This option causes TeX and Metafont
2837 to produce a core dump when a particular hacky filename is
2838 encountered, for use in creating preloaded binaries. This is rarely
2839 done nowadays.
2840 </p>
2841 <a class="index-entry-id" id="index-_002d_002denable_002dlibtool_002dhack"></a>
2842 <a class="index-entry-id" id="index-libtool_002c-hack-for-avoiding-excessive-linking"></a>
2843 <a class="index-entry-id" id="index-libfontconfig_002c-hack-for-avoiding-linking-dependencies"></a>
2844 <a class="index-entry-id" id="index-libexpat_002c-dependency-of-libfontconfig"></a>
2845 <p><code class="code">--enable-libtool-hack</code><br>
2846 If enabled (which is the default for all platforms), prevents
2847 <code class="code">libtool</code> from linking explicitly with dependencies of
2848 <samp class="file">libfontconfig</samp> such as <samp class="file">libexpat</samp>.
2849 </p>
2850 <a class="index-entry-id" id="index-_002d_002denable_002d_002awin-for-Metafont-window-support"></a>
2851 <p><code class="code">--enable-*win</code><br>Include various types of non-X window
2852 support for Metafont (EPSF output, <code class="code">mftalk</code>, old graphics
2853 terminals, &hellip;).
2854 </p>
2855 <a class="index-entry-id" id="index-_002d_002denable_002dtex_002dsynctex"></a>
2856 <a class="index-entry-id" id="index-_002d_002ddisable_002detex_002dsynctex"></a>
2857 <a class="index-entry-id" id="index-synctex"></a>
2858 <p><code class="code">--enable-tex-synctex</code>, <code class="code">--disable-etex-synctex</code>,
2859 &hellip;<br>Build the TeX engines with or without <code class="code">SyncTeX</code>
2860 support; ignored for a native TeX&nbsp;Live build. Defaults are defined in
2861 <samp class="file">texk/web2c/ac/web2c.ac</samp> (see <a class="pxref" href="#Autoconf-macros">Autoconf macros</a>).
2862 </p>
2863 <a class="index-entry-id" id="index-_002d_002ddisable_002dsynctex"></a>
2864 <a class="index-entry-id" id="index-synctex-1"></a>
2865 <p><code class="code">--disable-synctex</code>
2866 <br>Do not build the <code class="code">SyncTeX</code> library and tool.
2867 </p>
2868 <hr>
2869 </div>
2870 <div class="subsection-level-extent" id="Configure-options-for-texk_002fbibtex_002dx">
2871 <div class="nav-panel">
2872 <p>
2873 Next: <a href="#Configure-options-for-texk_002fdvipdfm_002dx" accesskey="n" rel="next">Configure options for <samp class="file">texk/dvipdfm-x</samp></a>, Previous: <a href="#Configure-options-for-texk_002fweb2c" accesskey="p" rel="prev">Configure options for <samp class="file">texk/web2c</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2874 </div>
2875 <h4 class="subsection" id="Configure-options-for-texk_002fbibtex_002dx-1"><span>7.2.4 Configure options for <samp class="file">texk/bibtex-x</samp><a class="copiable-link" href="#Configure-options-for-texk_002fbibtex_002dx-1"> &para;</a></span></h4>
2876
2877 <a class="index-entry-id" id="index-configure-options_002c-for-bibtex_002dx"></a>
2878 <a class="index-entry-id" id="index-bibtex8"></a>
2879 <a class="index-entry-id" id="index-bibtexu"></a>
2880 <a class="index-entry-id" id="index-bibtex_002dx"></a>
2881 <p>The programs <code class="code">bibtex8</code> and <code class="code">bibtexu</code> have been merged into the
2882 module <code class="code">bibtex-x</code> (extended BibTeX).
2883 </p>
2884 <a class="index-entry-id" id="index-_002d_002ddisable_002dbibtex8"></a>
2885 <p><code class="code">--disable-bibtex8</code><br>Do not build the <samp class="file">bibtex8</samp> program.
2886 </p>
2887 <a class="index-entry-id" id="index-_002d_002ddisable_002dbibtexu"></a>
2888 <p><code class="code">--disable-bibtexu</code><br>Do not build the <samp class="file">bibtexu</samp> program
2889 (building <samp class="file">bibtexu</samp> requires <code class="code">ICU</code> libraries).
2890 </p>
2891 <hr>
2892 </div>
2893 <div class="subsection-level-extent" id="Configure-options-for-texk_002fdvipdfm_002dx">
2894 <div class="nav-panel">
2895 <p>
2896 Next: <a href="#Configure-options-for-texk_002fdvisvgm" accesskey="n" rel="next">Configure options for <samp class="file">texk/dvisvgm</samp></a>, Previous: <a href="#Configure-options-for-texk_002fbibtex_002dx" accesskey="p" rel="prev">Configure options for <samp class="file">texk/bibtex-x</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2897 </div>
2898 <h4 class="subsection" id="Configure-options-for-texk_002fdvipdfm_002dx-1"><span>7.2.5 Configure options for <samp class="file">texk/dvipdfm-x</samp><a class="copiable-link" href="#Configure-options-for-texk_002fdvipdfm_002dx-1"> &para;</a></span></h4>
2899
2900 <a class="index-entry-id" id="index-configure-options_002c-for-dvipdfm_002dx"></a>
2901 <a class="index-entry-id" id="index-dvipdfm_002dx"></a>
2902 <a class="index-entry-id" id="index-dvipdfmx"></a>
2903 <a class="index-entry-id" id="index-xdvipdfmx"></a>
2904
2905 <p>The former modules <code class="code">dvipdfmx</code> (extended DVI to PDF converter) and
2906 <code class="code">xdvipdfmx</code> (the same, as used by XeTeX) have been merged into
2907 <code class="code">dvipdfm-x</code> at the source level. Two separate binaries are still
2908 created by default. In addition, <samp class="file">dvipdfm</samp> is created as a
2909 symlink to <samp class="file">dvipdfmx</samp>, with backward-compatible (very slightly
2910 different) behavior.
2911 </p>
2912 <a class="index-entry-id" id="index-_002d_002ddisable_002ddvipdfmx"></a>
2913 <p><code class="code">--disable-dvipdfmx</code><br>Do not build the <samp class="file">dvipdfmx</samp>
2914 program or make the <samp class="file">dvipdfm</samp> symlink.
2915 </p>
2916 <a class="index-entry-id" id="index-_002d_002ddisable_002dxdvipdfmx"></a>
2917 <p><code class="code">--disable-xdvipdfmx</code><br>Do not build the <samp class="file">xdvipdfmx</samp>
2918 program.
2919 </p>
2920 <hr>
2921 </div>
2922 <div class="subsection-level-extent" id="Configure-options-for-texk_002fdvisvgm">
2923 <div class="nav-panel">
2924 <p>
2925 Next: <a href="#Configure-options-for-texk_002ftexlive" accesskey="n" rel="next">Configure options for <samp class="file">texk/texlive</samp></a>, Previous: <a href="#Configure-options-for-texk_002fdvipdfm_002dx" accesskey="p" rel="prev">Configure options for <samp class="file">texk/dvipdfm-x</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2926 </div>
2927 <h4 class="subsection" id="Configure-options-for-texk_002fdvisvgm-1"><span>7.2.6 Configure options for <samp class="file">texk/dvisvgm</samp><a class="copiable-link" href="#Configure-options-for-texk_002fdvisvgm-1"> &para;</a></span></h4>
2928
2929 <a class="index-entry-id" id="index-configure-options_002c-for-dvisvgm"></a>
2930 <a class="index-entry-id" id="index-dvisvgm"></a>
2931
2932 <a class="index-entry-id" id="index-_002d_002dwith_002dsystem_002dlibgs"></a>
2933 <p><code class="code">--with-system-libgs</code><br>Build <samp class="file">dvisvgm</samp> using installed
2934 Ghostscript (<code class="code">gs</code>) headers and library (not allowed for a native
2935 TL build). The default is to load the <code class="code">gs</code> library at runtime if
2936 possible, else to disable support for PostScript specials.
2937 </p>
2938 <a class="index-entry-id" id="index-_002d_002dwithout_002dlibgs"></a>
2939 <p><code class="code">--without-libgs</code><br>Build <samp class="file">dvisvgm</samp> without PostScript
2940 support at all. Because the dynamic loading just mentioned defeats all
2941 attempts at static linking, the result can crash due to library
2942 incompatibilities, e.g., on CentOS 5.
2943 </p>
2944 <a class="index-entry-id" id="index-_002d_002dwith_002dlibgs_002dincludes_002c-_002dlibdir"></a>
2945 <p><code class="code">--with-libgs-includes=<var class="var">dir</var></code>,
2946 <code class="code">--with-libgs-libdir=<var class="var">dir</var></code><br>Specify non-standard locations
2947 of the Ghostscript headers and library.
2948 </p>
2949 <hr>
2950 </div>
2951 <div class="subsection-level-extent" id="Configure-options-for-texk_002ftexlive">
2952 <div class="nav-panel">
2953 <p>
2954 Next: <a href="#Configure-options-for-texk_002fxdvik" accesskey="n" rel="next">Configure options for <samp class="file">texk/xdvik</samp></a>, Previous: <a href="#Configure-options-for-texk_002fdvisvgm" accesskey="p" rel="prev">Configure options for <samp class="file">texk/dvisvgm</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2955 </div>
2956 <h4 class="subsection" id="Configure-options-for-texk_002ftexlive-1"><span>7.2.7 Configure options for <samp class="file">texk/texlive</samp><a class="copiable-link" href="#Configure-options-for-texk_002ftexlive-1"> &para;</a></span></h4>
2957
2958 <a class="index-entry-id" id="index-configure-options_002c-for-texk_002ftexlive"></a>
2959 <a class="index-entry-id" id="index-_002d_002ddisable_002dlinked_002dscripts"></a>
2960 <p><code class="code">--disable-linked-scripts</code><br>Do not install the &ldquo;linked
2961 scripts&rdquo; (see <a class="pxref" href="#Linked-scripts">Linked scripts</a>), except for the TL scripts required
2962 to run <code class="code">texlinks</code>.
2963 </p>
2964 <hr>
2965 </div>
2966 <div class="subsection-level-extent" id="Configure-options-for-texk_002fxdvik">
2967 <div class="nav-panel">
2968 <p>
2969 Next: <a href="#Configure-options-for-utils_002fxindy" accesskey="n" rel="next">Configure options for <samp class="file">utils/xindy</samp></a>, Previous: <a href="#Configure-options-for-texk_002ftexlive" accesskey="p" rel="prev">Configure options for <samp class="file">texk/texlive</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
2970 </div>
2971 <h4 class="subsection" id="Configure-options-for-texk_002fxdvik-1"><span>7.2.8 Configure options for <samp class="file">texk/xdvik</samp><a class="copiable-link" href="#Configure-options-for-texk_002fxdvik-1"> &para;</a></span></h4>
2972
2973 <a class="index-entry-id" id="index-configure-options_002c-for-xdvik"></a>
2974 <a class="index-entry-id" id="index-xdvik-1"></a>
2975
2976 <a class="index-entry-id" id="index-_002d_002dwith_002dgs_003dfilename"></a>
2977 <a class="index-entry-id" id="index-Ghostscript-location-for-Xdvik"></a>
2978 <p><code class="code">--with-gs=<var class="var">filename</var></code><br>Hardwire the location of Ghostscript
2979 (<samp class="file">gs</samp>) as called by Xdvik.
2980 </p>
2981 <a class="index-entry-id" id="index-_002d_002dwith_002dxdvi_002dx_002dtoolkit_003dkit"></a>
2982 <a class="index-entry-id" id="index-motif"></a>
2983 <a class="index-entry-id" id="index-xaw"></a>
2984 <p><code class="code">--with-xdvi-x-toolkit=<var class="var">kit</var></code><br>Use toolkit
2985 <code class="code"><var class="var">kit</var></code> for <samp class="file">xdvik</samp>, one of: <code class="code">motif xaw xaw3d
2986 neXtaw</code>. The default is <code class="code">motif</code> if available, else <code class="code">xaw</code>.
2987 </p>
2988 <a class="index-entry-id" id="index-_002d_002denable_002dxi2_002dscrolling"></a>
2989 <a class="index-entry-id" id="index-XInput"></a>
2990 <a class="index-entry-id" id="index-scrolling_002c-smooth"></a>
2991 <p><code class="code">--enable-xi2-scrolling</code><br>Use XInput 2.1 &ldquo;smooth scrolling&rdquo;
2992 if available (default: yes, except for a native TL build).
2993 </p>
2994 <hr>
2995 </div>
2996 <div class="subsection-level-extent" id="Configure-options-for-utils_002fxindy">
2997 <div class="nav-panel">
2998 <p>
2999 Previous: <a href="#Configure-options-for-texk_002fxdvik" accesskey="p" rel="prev">Configure options for <samp class="file">texk/xdvik</samp></a>, Up: <a href="#Program_002dspecific-configure-options" accesskey="u" rel="up">Program-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3000 </div>
3001 <h4 class="subsection" id="Configure-options-for-utils_002fxindy-1"><span>7.2.9 Configure options for <samp class="file">utils/xindy</samp><a class="copiable-link" href="#Configure-options-for-utils_002fxindy-1"> &para;</a></span></h4>
3002
3003 <a class="index-entry-id" id="index-configure-options_002c-for-xindy"></a>
3004 <a class="index-entry-id" id="index-xindy-2"></a>
3005
3006 <a class="index-entry-id" id="index-_002d_002denable_002dxindy_002drules"></a>
3007 <p><code class="code">--enable-xindy-rules</code><br>Build and install <code class="code">xindy</code> rules
3008 (default: yes, except for a native TL build).
3009 </p>
3010 <a class="index-entry-id" id="index-_002d_002denable_002dxindy_002ddocs"></a>
3011 <p><code class="code">--enable-xindy-docs</code><br>Build and install <code class="code">xindy</code>
3012 documentation (default: yes, except for a native TL build).
3013 </p>
3014 <a class="index-entry-id" id="index-_002d_002dwith_002dclisp_002druntime_003dfilename"></a>
3015 <a class="index-entry-id" id="index-lisp_002erun_002c-lisp_002eexe"></a>
3016 <a class="index-entry-id" id="index-CLISP"></a>
3017 <p><code class="code">--with-clisp-runtime=<var class="var">filename</var></code><br>Specifies the
3018 full path for the Clisp runtime file (<samp class="file">lisp.run</samp> or
3019 <samp class="file">lisp.exe</samp>) to be installed. When specified as <code class="code">default</code>
3020 (the default for a native TL build) the path is determined by the
3021 Clisp executable; the value <code class="code">system</code> (not allowed for a native TL
3022 build, but the default otherwise) indicates that <samp class="file">xindy</samp> will use
3023 the installed version of <samp class="file">clisp</samp> (which must be identical to the
3024 one used to build <samp class="file">xindy</samp>).
3025 </p>
3026 <hr>
3027 </div>
3028 </div>
3029 <div class="section-level-extent" id="Library_002dspecific-configure-options">
3030 <div class="nav-panel">
3031 <p>
3032 Next: <a href="#Variables-for-configure" accesskey="n" rel="next">Variables for configure</a>, Previous: <a href="#Program_002dspecific-configure-options" accesskey="p" rel="prev">Program-specific configure options</a>, Up: <a href="#Configure-options" accesskey="u" rel="up">Configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3033 </div>
3034 <h3 class="section" id="Library_002dspecific-configure-options-1"><span>7.3 Library-specific configure options<a class="copiable-link" href="#Library_002dspecific-configure-options-1"> &para;</a></span></h3>
3035
3036 <a class="index-entry-id" id="index-library_002dspecific-configure-options"></a>
3037 <a class="index-entry-id" id="index-configure-options_002c-library_002dspecific"></a>
3038 <p>Here are (some of) the library-specific <code class="code">configure</code> options,
3039 starting with this generic one:
3040 </p>
3041 <a class="index-entry-id" id="index-_002d_002dwith_002dsystem_002dlib-1"></a>
3042 <p><code class="code">--with-system-<var class="var">lib</var></code>
3043 </p>
3044 <p>Use an installed (system) version of the library <code class="code"><var class="var">lib</var></code>;
3045 this option exists for most libraries, but is not allowed for a native
3046 TL build. Using a system version implies also using the system
3047 versions of all libraries that <var class="var">lib</var> depends on.
3048 </p>
3049 <a class="index-entry-id" id="index-_002d_002dwith_002dlib_002dincludes_003ddir_002c-_002dlibdir"></a>
3050 <p>For many libraries <code class="code">--with-<var class="var">lib</var>-includes=<var class="var">dir</var></code> and
3051 <code class="code">--with-<var class="var">lib</var>-libdir=<var class="var">dir</var></code> can specify non-standard
3052 search locations; others use <samp class="file">pkg-config</samp> or similar to determine
3053 the required flags.
3054 </p>
3055 <p>The top-level <samp class="file">configure</samp> script performs a consistency check for all
3056 required system libraries and bails out if tests fail.
3057 </p>
3058
3059 <ul class="mini-toc">
3060 <li><a href="#Configure-options-for-kpathsea" accesskey="1">Configure options for <code class="code">kpathsea</code></a></li>
3061 </ul>
3062 <hr>
3063 <div class="subsection-level-extent" id="Configure-options-for-kpathsea">
3064 <div class="nav-panel">
3065 <p>
3066 Up: <a href="#Library_002dspecific-configure-options" accesskey="u" rel="up">Library-specific configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3067 </div>
3068 <h4 class="subsection" id="Configure-options-for-kpathsea-1"><span>7.3.1 Configure options for <code class="code">kpathsea</code><a class="copiable-link" href="#Configure-options-for-kpathsea-1"> &para;</a></span></h4>
3069
3070 <a class="index-entry-id" id="index-configure-options_002c-for-kpathsea"></a>
3071
3072 <p><code class="code">--enable-<var class="var">cmd</var>-default</code>,
3073 <code class="code">--disable-<var class="var">cmd</var>-default</code><br>Determine the compile time default
3074 for whether or not to run <var class="var">cmd</var>, which is one of:
3075 </p><dl class="table">
3076 <dt><code class="code">mkocp</code></dt>
3077 <dd><p>(Omega compiled translation process file)
3078 </p></dd>
3079 <dt><code class="code">mkofm</code></dt>
3080 <dd><p>(Omega font metrics file)
3081 </p></dd>
3082 <dt><code class="code">mktexfmt</code></dt>
3083 <dd><p>(format/base dump file)
3084 </p></dd>
3085 <dt><code class="code">mktexmf</code></dt>
3086 <dd><p>(Metafont source)
3087 </p></dd>
3088 <dt><code class="code">mktexpk</code></dt>
3089 <dd><p>(PK bitmap font)
3090 </p></dd>
3091 <dt><code class="code">mktextex</code></dt>
3092 <dd><p>(TeX source)
3093 </p></dd>
3094 <dt><code class="code">mktextfm</code></dt>
3095 <dd><p>(TFM file)
3096 </p></dd>
3097 </dl>
3098
3099 <p>to generate the specified type of file dynamically.
3100 The default can be overridden by the user in any case
3101 (see <a class="pxref" href="#kpathsea-library">The <code class="code">kpathsea</code> library in <samp class="file">texk/kpathsea</samp></a>).
3102 </p>
3103 <hr>
3104 </div>
3105 </div>
3106 <div class="section-level-extent" id="Variables-for-configure">
3107 <div class="nav-panel">
3108 <p>
3109 Previous: <a href="#Library_002dspecific-configure-options" accesskey="p" rel="prev">Library-specific configure options</a>, Up: <a href="#Configure-options" accesskey="u" rel="up">Configure options</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3110 </div>
3111 <h3 class="section" id="Variables-for-configure-1"><span>7.4 Variables for configure<a class="copiable-link" href="#Variables-for-configure-1"> &para;</a></span></h3>
3112
3113 <a class="index-entry-id" id="index-variables-for-configure"></a>
3114 <a class="index-entry-id" id="index-configure-variables"></a>
3115
3116 <p>The values for these variables can be specified as <code class="code">configure</code>
3117 arguments of the form <code class="code"><var class="var">VAR</var>=<var class="var">value</var></code>. They can also be
3118 defined in the environment, but that might not work for cross
3119 compilations.
3120 </p>
3121 <dl class="vtable">
3122 <dt><a id="index-CC"></a><span><code class="code">CC</code><a class="copiable-link" href="#index-CC"> &para;</a></span></dt>
3123 <dt><a id="index-CXX"></a><span><code class="code">CXX</code><a class="copiable-link" href="#index-CXX"> &para;</a></span></dt>
3124 <dt><a id="index-CPPFLAGS"></a><span><code class="code">CPPFLAGS</code><a class="copiable-link" href="#index-CPPFLAGS"> &para;</a></span></dt>
3125 <dd><p>And plenty more. As usual with Autoconf, these variables specify the
3126 name (or full path) of compilers, preprocessor flags, and similar.
3127 See <a data-manual="autoconf" href="https://www.gnu.org/software/autoconf/manual/autoconf.html#Preset-Output-Variables">Preset Output Variables</a> in <cite class="cite">GNU Autoconf</cite>.
3128 </p>
3129 </dd>
3130 <dt><a id="index-CLISP-1"></a><span><code class="code">CLISP</code><a class="copiable-link" href="#index-CLISP-1"> &para;</a></span></dt>
3131 <dd><a class="index-entry-id" id="index-clisp"></a>
3132 <p>Name (or full path) of the <samp class="file">clisp</samp> executable, used to build
3133 <code class="code">xindy</code>.
3134 </p>
3135 </dd>
3136 <dt><a id="index-FT2_005fCONFIG"></a><span><code class="code">FT2_CONFIG</code><a class="copiable-link" href="#index-FT2_005fCONFIG"> &para;</a></span></dt>
3137 <dt><a id="index-ICU_005fCONFIG"></a><span><code class="code">ICU_CONFIG</code><a class="copiable-link" href="#index-ICU_005fCONFIG"> &para;</a></span></dt>
3138 <dt><a id="index-PKG_005fCONFIG"></a><span><code class="code">PKG_CONFIG</code><a class="copiable-link" href="#index-PKG_005fCONFIG"> &para;</a></span></dt>
3139 <dd><a class="index-entry-id" id="index-freetype_002dconfig-1"></a>
3140 <a class="index-entry-id" id="index-icu_002dconfig"></a>
3141 <a class="index-entry-id" id="index-libfreetype"></a>
3142 <a class="index-entry-id" id="index-ICU-libraries"></a>
3143 <p>These specify the name (or path) for the <samp class="file">freetype-config</samp>,
3144 <samp class="file">icu-config</samp>, and <samp class="file">pkg-config</samp> commands used to determine the
3145 flags required for system versions of <samp class="file">libfreetype</samp>, the ICU
3146 libraries, and other libraries, respectively.
3147 </p>
3148 </dd>
3149 <dt><a id="index-KPSEWHICH"></a><span><code class="code">KPSEWHICH</code><a class="copiable-link" href="#index-KPSEWHICH"> &para;</a></span></dt>
3150 <dd><a class="index-entry-id" id="index-kpsewhich"></a>
3151 <p>Name (or path) of an installed <samp class="file">kpsewhich</samp> binary, used by
3152 <code class="code">make check</code> to determine the location of, e.g.,
3153 <samp class="file">cmbx10.tfm</samp>.
3154 </p>
3155 </dd>
3156 <dt><a id="index-MAKE"></a><span><code class="code">MAKE</code><a class="copiable-link" href="#index-MAKE"> &para;</a></span></dt>
3157 <dt><a id="index-SED"></a><span><code class="code">SED</code><a class="copiable-link" href="#index-SED"> &para;</a></span></dt>
3158 <dd><p>And more. Name (or path) of the <code class="code">make</code>, <code class="code">sed</code>, and similar
3159 programs; used at the top level and propagated to all subdirectories.
3160 </p>
3161 </dd>
3162 <dt><a id="index-PERL"></a><span><code class="code">PERL</code><a class="copiable-link" href="#index-PERL"> &para;</a></span></dt>
3163 <dt><a id="index-LATEX"></a><span><code class="code">LATEX</code><a class="copiable-link" href="#index-LATEX"> &para;</a></span></dt>
3164 <dt><a id="index-PDFLATEX"></a><span><code class="code">PDFLATEX</code><a class="copiable-link" href="#index-PDFLATEX"> &para;</a></span></dt>
3165 <dd><p>Name (or full path) for the <samp class="file">perl</samp>, <samp class="file">latex</samp>, and <samp class="file">pdflatex</samp>
3166 commands used, e.g., to build the <code class="code">xindy</code> documentation.
3167 </p>
3168 </dd>
3169 </dl>
3170
3171 <hr>
3172 </div>
3173 </div>
3174 <div class="chapter-level-extent" id="Coding-conventions">
3175 <div class="nav-panel">
3176 <p>
3177 Next: <a href="#Continuous-integration" accesskey="n" rel="next">Continuous integration</a>, Previous: <a href="#Configure-options" accesskey="p" rel="prev">Configure options</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3178 </div>
3179 <h2 class="chapter" id="Coding-conventions-1"><span>8 Coding conventions<a class="copiable-link" href="#Coding-conventions-1"> &para;</a></span></h2>
3180
3181 <a class="index-entry-id" id="index-coding-conventions"></a>
3182 <a class="index-entry-id" id="index-conventions_002c-coding"></a>
3183
3184 <p>Ideally, building all of TeX&nbsp;Live with
3185 <code class="code">--enable-compiler-warnings=max</code> should produce no (GCC) compiler
3186 warnings at all. In spite of considerable efforts into that direction
3187 we are still far from that goal and there are reasons that we may
3188 never fully reach it. Below are some rules about declarations of
3189 functions or variables and the use of <code class="code">const</code>. These rules
3190 should be applied to the code maintained in the TeX&nbsp;Live tree and for
3191 other packages whose maintainers are willing to accept patches.
3192 </p>
3193
3194 <ul class="mini-toc">
3195 <li><a href="#Declarations-and-definitions" accesskey="1">Declarations and definitions</a></li>
3196 <li><a href="#Const" accesskey="2">Const</a></li>
3197 </ul>
3198 <hr>
3199 <div class="section-level-extent" id="Declarations-and-definitions">
3200 <div class="nav-panel">
3201 <p>
3202 Next: <a href="#Const" accesskey="n" rel="next">Const</a>, Up: <a href="#Coding-conventions" accesskey="u" rel="up">Coding conventions</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3203 </div>
3204 <h3 class="section" id="Declarations-and-definitions-1"><span>8.1 Declarations and definitions<a class="copiable-link" href="#Declarations-and-definitions-1"> &para;</a></span></h3>
3205
3206 <a class="index-entry-id" id="index-declarations-and-definitions_002c-in-source-code"></a>
3207 <a class="index-entry-id" id="index-source-code-declarations"></a>
3208 <a class="index-entry-id" id="index-ANSI-C"></a>
3209 <a class="index-entry-id" id="index-declarations-before-statements_002c-avoiding"></a>
3210 <a class="index-entry-id" id="index-C_002c-ANSI_002c-required"></a>
3211 <a class="index-entry-id" id="index-C99_002c-avoided"></a>
3212
3213 <h4 class="subsubheading" id="C-standards"><span>C standards<a class="copiable-link" href="#C-standards"> &para;</a></span></h4>
3214
3215 <p>The TeX&nbsp;Live build system no longer supports pre-ANSI C compilers. Thus
3216 all function prototypes and definitions must conform to the ANSI C
3217 standard (including <code class="code">void</code> in the declaration of C functions with
3218 no parameters). On the other hand, TL is built for a wide variety of
3219 systems, not all of which support the C99 standard. Therefore using
3220 C99 features should be avoided if that can easily be done. In
3221 particular, C code must not contain declarations after statements or
3222 C++-style comments.
3223 </p>
3224 <a class="index-entry-id" id="index-chktex"></a>
3225 <a class="index-entry-id" id="index-stpcpy"></a>
3226 <p>If some C99 (or later) constructs must be used, the module should
3227 verify that they are available and otherwise provide an alternative.
3228 For example, the module <samp class="file">texk/chktex</samp> uses the C99 function
3229 <code class="code">stpcpy()</code> that may or may not be available on a particular
3230 system. It uses <code class="code">AC_CHECK_DECLS([stpcpy])</code> in
3231 <samp class="file">configure.ac</samp> to test this, and provides a perhaps
3232 less efficient alternative (in the file <samp class="file">Utility.h</samp>):
3233 </p>
3234 <div class="example">
3235 <pre class="example-preformatted">#if !(defined HAVE_DECL_STPCPY &amp;&amp; HAVE_DECL_STPCPY)
3236 static inline char *stpcpy(char *dest, const char *src)
3237 {
3238 return strcpy(dest, src) + strlen(src);
3239 }
3240 #endif
3241 </pre></div>
3242
3243 <h4 class="subsubheading" id="Static-functions"><span>Static functions<a class="copiable-link" href="#Static-functions"> &para;</a></span></h4>
3244
3245 <a class="index-entry-id" id="index-static-functions"></a>
3246 <p>Functions used in only one file should be declared <code class="code">static</code>; they
3247 require no prototype except in forward declarations.
3248 </p>
3249 <h4 class="subsubheading" id="Extern-functions"><span>Extern functions<a class="copiable-link" href="#Extern-functions"> &para;</a></span></h4>
3250
3251 <a class="index-entry-id" id="index-extern-functions"></a>
3252 <p>Functions not declared <code class="code">static</code>, usually because they are used in
3253 several files, require an (<code class="code">extern</code>) prototype in exactly one
3254 header file, which is included in the file defining the function and
3255 in all files using that function&mdash;this is the only way to guarantee
3256 consistency between definition and use. There should be no
3257 <code class="code">extern</code> declarations sprinkled throughout the C code (with or
3258 without comments as to where that function is defined).
3259 </p>
3260 <h4 class="subsubheading" id="Variable-declarations"><span>Variable declarations<a class="copiable-link" href="#Variable-declarations"> &para;</a></span></h4>
3261
3262 <a class="index-entry-id" id="index-variable-declarations_002c-in-source-code"></a>
3263 <p>The declaration of global variables follows analogous rules: they are
3264 either declared <code class="code">static</code> if used in only one file or declared
3265 <code class="code">extern</code> in exactly one header and instantiated in exactly one
3266 file.
3267 </p>
3268 <hr>
3269 </div>
3270 <div class="section-level-extent" id="Const">
3271 <div class="nav-panel">
3272 <p>
3273 Previous: <a href="#Declarations-and-definitions" accesskey="p" rel="prev">Declarations and definitions</a>, Up: <a href="#Coding-conventions" accesskey="u" rel="up">Coding conventions</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3274 </div>
3275 <h3 class="section" id="Const-1"><span>8.2 Const<a class="copiable-link" href="#Const-1"> &para;</a></span></h3>
3276
3277 <a class="index-entry-id" id="index-const"></a>
3278
3279 <p>The <code class="code">const</code> feature of C is valuable, but easy to mis-use.
3280 </p>
3281 <h4 class="subsubheading" id="Function-parameters"><span>Function parameters<a class="copiable-link" href="#Function-parameters"> &para;</a></span></h4>
3282
3283 <p>Ideally, a function parameter not modified by the function should be
3284 declared as <code class="code">const</code>. This is important in particular for strings
3285 (<code class="code">char*</code>) because the actual arguments are often string literals.
3286 It is perfectly legitimate and safe to use a type <code class="code">char*</code> value
3287 for a type <code class="code">const char*</code> variable (in an assignment, as
3288 initializer, as function argument, or as return value). It is equally
3289 safe to use a type <code class="code">char**</code> value for a type <code class="code">const
3290 char*const*</code> variable, but not for a type <code class="code">const char**</code> variable
3291 since that might cause modification of a quantity supposed to be
3292 constant.
3293 </p>
3294 <a class="index-entry-id" id="index-X11-headers_002c-and-const"></a>
3295 <a class="index-entry-id" id="index-libfreetype_002c-and-const"></a>
3296 <p>Getting all <code class="code">const</code> qualifiers right can get quite involved but
3297 can almost always be done. There are only a couple notable
3298 exceptions: the X11 headers are full of declarations that ought to use
3299 <code class="code">const</code> but do not; at one time, <samp class="file">libfreetype</samp> also did not
3300 fully specify <code class="code">const</code>, but this has not been checked recently.
3301 </p>
3302 <h4 class="subsubheading" id="What-must-be-avoided-with-const"><span>What must be avoided with <code class="code">const</code><a class="copiable-link" href="#What-must-be-avoided-with-const"> &para;</a></span></h4>
3303
3304 <a class="index-entry-id" id="index-warning_002c-discards-qualifiers"></a>
3305 <a class="index-entry-id" id="index-discards-qualifiers-warning"></a>
3306 <p>The GCC compiler warnings &ldquo;assignment discards qualifiers&hellip;&rdquo;
3307 and analogous warnings for &ldquo;initialization&rdquo;, &ldquo;passing arg&rdquo;, or
3308 &ldquo;return&rdquo; must be strenuously avoided in our own code. The only
3309 exception is when they are caused by X11 declarations or other third
3310 party code.
3311 </p>
3312 <h4 class="subsubheading" id="What-should-be-avoided-with-const"><span>What should be avoided with <code class="code">const</code><a class="copiable-link" href="#What-should-be-avoided-with-const"> &para;</a></span></h4>
3313
3314 <a class="index-entry-id" id="index-type-cast-from-const_002c-avoiding"></a>
3315 <p>A type cast, e.g., from <code class="code">const char*</code> to <code class="code">char*</code> does not
3316 solve any problems; depending on warning options, it may only hide
3317 them. Therefore such casts should be avoided whenever possible and
3318 otherwise must be carefully analyzed to make sure that they cannot
3319 cause the modification of quantities supposed to be constant.
3320 </p>
3321 <hr>
3322 </div>
3323 </div>
3324 <div class="chapter-level-extent" id="Continuous-integration">
3325 <div class="nav-panel">
3326 <p>
3327 Next: <a href="#install_002dtl" accesskey="n" rel="next">install-tl</a>, Previous: <a href="#Coding-conventions" accesskey="p" rel="prev">Coding conventions</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3328 </div>
3329 <h2 class="chapter" id="Continuous-integration-1"><span>9 Continuous integration<a class="copiable-link" href="#Continuous-integration-1"> &para;</a></span></h2>
3330
3331 <a class="index-entry-id" id="index-continuous-integration"></a>
3332 <a class="index-entry-id" id="index-Travis_002dCI"></a>
3333
3334 <p>The TeX&nbsp;Live sources are subjected to continuous integration testing on
3335 Travis-CI (<a class="url" href="https://travis-ci.org/TeX-Live/texlive-source">https://travis-ci.org/TeX-Live/texlive-source</a>) via a
3336 git-svn mirror of the sources that is pushed to Github
3337 (<a class="url" href="https://github.com/TeX-Live/texlive-source">https://github.com/TeX-Live/texlive-source</a>). The git-svn mirror
3338 is updated (currently) at 30 minute intervals, and only the last
3339 commit pushed is tested on Travis-CI.
3340 </p>
3341
3342 <ul class="mini-toc">
3343 <li><a href="#Transfer-from-Subversion-to-Github" accesskey="1">Transfer from Subversion to Github</a></li>
3344 <li><a href="#Automatic-update-of-the-Git-mirror" accesskey="2">Automatic update of the Git mirror</a></li>
3345 <li><a href="#CI-testing-on-Travis_002dCI" accesskey="3">CI testing on Travis-CI</a></li>
3346 <li><a href="#Releases-on-Github" accesskey="4">Releases on Github</a></li>
3347 </ul>
3348 <hr>
3349 <div class="section-level-extent" id="Transfer-from-Subversion-to-Github">
3350 <div class="nav-panel">
3351 <p>
3352 Next: <a href="#Automatic-update-of-the-Git-mirror" accesskey="n" rel="next">Automatic update of the Git mirror</a>, Up: <a href="#Continuous-integration" accesskey="u" rel="up">Continuous integration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3353 </div>
3354 <h3 class="section" id="Transfer-from-Subversion-to-Github-1"><span>9.1 Transfer from Subversion to Github<a class="copiable-link" href="#Transfer-from-Subversion-to-Github-1"> &para;</a></span></h3>
3355
3356 <a class="index-entry-id" id="index-git_002dsvn"></a>
3357 <p>The git-svn program (<a class="url" href="https://git-scm.com/docs/git-svn">https://git-scm.com/docs/git-svn</a>) is used
3358 to check out the subtree <code class="code">Build/source</code> of the canonical
3359 Subversion repository. The author index file used is not maintained
3360 in either Git or Subversion but can be provided on request.
3361 </p>
3362
3363 <p>The initial checkout was done by invoking
3364 </p><div class="example">
3365 <pre class="example-preformatted">git svn --authors-file usermap clone \
3366 svn://<var class="var">user</var>@tug.org/texlive/trunk/Build/source
3367 </pre></div>
3368
3369 <p>where the <code class="code">usermap</code> file maps Subversion user names to
3370 name and emails of the authors. Anonymous checkout is also possible:
3371 </p><div class="example">
3372 <pre class="example-preformatted">git svn --authors-file usermap clone \
3373 svn://tug.org/texlive/trunk/Build/source
3374 </pre></div>
3375
3376 <p>In the following, we will use <em class="emph">admin</em> to refer to a user who has
3377 read/write access to the TeX&nbsp;Live subversion repository, and is also an
3378 administrator of the &lsquo;<code class="code">TeX-Live</code>&rsquo; team at Github. The above
3379 initial checkout has been carried out by <em class="emph">admin</em> on the server
3380 <code class="code">texlive.info</code>.
3381 </p>
3382 <p>On Github, a new git repository named <code class="code">texlive-source</code> was
3383 created by <em class="emph">admin</em> within the <code class="code">TeX-Live</code> &ldquo;organization&rdquo;
3384 (<a class="url" href="https://github.com/TeX-Live">https://github.com/TeX-Live</a>). The remote was added to the
3385 checkout with <code class="code">git remote add origin
3386 [email protected]:TeX-Live/texlive-source.git</code>.
3387 </p>
3388 <p>To automate the update on Github, a new ssh key was generated and
3389 added to the <code class="code">texlive-source</code> repository on Github as deployment
3390 key. Thus, pushes using this key can only go to the
3391 <code class="code">texlive-source</code> repository and not anywhere else.
3392 </p>
3393 <p>The usage of <code class="code">git-svn</code> requires a strict discipline to keep a
3394 linear history in the master branch. Since we are aiming at a pure
3395 mirror facility on Github, we have decided to further restrict the
3396 <code class="code">master</code> branch of the <code class="code">texlive-source</code> repository on Github
3397 to changes by <em class="emph">admin</em>.
3398 </p>
3399 <p>This setup allows other developers to branch off <code class="code">master</code> and
3400 push their branches to the Github repository, but all updates need to
3401 come from the local <code class="code">master</code> (not the one on Github) to
3402 Subversion, back to <code class="code">master</code> on <code class="code">texlive.info</code>, and from
3403 there to Github.
3404 </p>
3405 <hr>
3406 </div>
3407 <div class="section-level-extent" id="Automatic-update-of-the-Git-mirror">
3408 <div class="nav-panel">
3409 <p>
3410 Next: <a href="#CI-testing-on-Travis_002dCI" accesskey="n" rel="next">CI testing on Travis-CI</a>, Previous: <a href="#Transfer-from-Subversion-to-Github" accesskey="p" rel="prev">Transfer from Subversion to Github</a>, Up: <a href="#Continuous-integration" accesskey="u" rel="up">Continuous integration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3411 </div>
3412 <h3 class="section" id="Automatic-update-of-the-Git-mirror-1"><span>9.2 Automatic update of the Git mirror<a class="copiable-link" href="#Automatic-update-of-the-Git-mirror-1"> &para;</a></span></h3>
3413
3414 <p><em class="emph">admin</em> has installed a cron job on <code class="code">texlive.info</code> running
3415 every 30 minute which essentially runs <code class="code">git svn rebase</code> and
3416 <code class="code">git push</code> in the <code class="code">master</code> branch of the checkout. The first
3417 command fetches the changes from the Subversion repository and updates
3418 the <code class="code">master</code> branch with them, and the second pushes changes (if
3419 any) to Github.
3420 </p>
3421 <hr>
3422 </div>
3423 <div class="section-level-extent" id="CI-testing-on-Travis_002dCI">
3424 <div class="nav-panel">
3425 <p>
3426 Next: <a href="#Releases-on-Github" accesskey="n" rel="next">Releases on Github</a>, Previous: <a href="#Automatic-update-of-the-Git-mirror" accesskey="p" rel="prev">Automatic update of the Git mirror</a>, Up: <a href="#Continuous-integration" accesskey="u" rel="up">Continuous integration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3427 </div>
3428 <h3 class="section" id="CI-testing-on-Travis_002dCI-1"><span>9.3 CI testing on Travis-CI<a class="copiable-link" href="#CI-testing-on-Travis_002dCI-1"> &para;</a></span></h3>
3429
3430 <a class="index-entry-id" id="index-travis_002eyml"></a>
3431 <p>The <code class="code">source</code> tree of TeX&nbsp;Live contains a top-level file
3432 <code class="code">.travis.yml</code> which controls the automatic testing on
3433 Travis-CI. <em class="emph">admin</em> has registered with Travis-CI and allowed
3434 access to the Github&rsquo;s <code class="code">TeX-Live</code> organization&rsquo;s
3435 <code class="code">texlive-source</code> repository. The default settings are to build
3436 the last commit of each push. No further action is necessary on
3437 Travis-CI.
3438 </p>
3439 <p>If changes have been pushed via the cron job above, Travis-CI will
3440 automatically checkout the last pushed commit and try building it.
3441 </p>
3442 <hr>
3443 </div>
3444 <div class="section-level-extent" id="Releases-on-Github">
3445 <div class="nav-panel">
3446 <p>
3447 Previous: <a href="#CI-testing-on-Travis_002dCI" accesskey="p" rel="prev">CI testing on Travis-CI</a>, Up: <a href="#Continuous-integration" accesskey="u" rel="up">Continuous integration</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3448 </div>
3449 <h3 class="section" id="Releases-on-Github-1"><span>9.4 Releases on Github<a class="copiable-link" href="#Releases-on-Github-1"> &para;</a></span></h3>
3450
3451 <p>Given a git checkout of <code class="code">texlive-source</code>:
3452 </p>
3453 <div class="example">
3454 <pre class="example-preformatted">git pull
3455 git tag build-svnNNNN
3456 git push --tags
3457 </pre></div>
3458
3459 <p>and the result will appear at
3460 <a class="url" href="https://github.com/TeX-Live/texlive-source/releases">https://github.com/TeX-Live/texlive-source/releases</a>.
3461 Releases can also be made manually from that web page (see
3462 <code class="code">tl-update-bindir</code> for hints).
3463 </p>
3464 <hr>
3465 </div>
3466 </div>
3467 <div class="appendix-level-extent" id="install_002dtl">
3468 <div class="nav-panel">
3469 <p>
3470 Next: <a href="#tlmgr" accesskey="n" rel="next">tlmgr</a>, Previous: <a href="#Continuous-integration" accesskey="p" rel="prev">Continuous integration</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3471 </div>
3472 <h2 class="appendix" id="install_002dtl-1"><span>Appendix A install-tl<a class="copiable-link" href="#install_002dtl-1"> &para;</a></span></h2>
3473
3474 <ul class="mini-toc">
3475 <li><a href="#install_002dtl-NAME" accesskey="1">install-tl NAME</a></li>
3476 <li><a href="#install_002dtl-SYNOPSIS" accesskey="2">install-tl SYNOPSIS</a></li>
3477 <li><a href="#install_002dtl-DESCRIPTION" accesskey="3">install-tl DESCRIPTION</a></li>
3478 <li><a href="#install_002dtl-REFERENCES" accesskey="4">REFERENCES</a></li>
3479 <li><a href="#install_002dtl-EXAMPLES" accesskey="5">install-tl EXAMPLES</a></li>
3480 <li><a href="#install_002dtl-OPTIONS" accesskey="6">install-tl OPTIONS</a></li>
3481 <li><a href="#install_002dtl-PROFILES" accesskey="7">PROFILES</a></li>
3482 <li><a href="#install_002dtl-ENVIRONMENT-VARIABLES" accesskey="8">ENVIRONMENT VARIABLES</a></li>
3483 <li><a href="#install_002dtl-DIRECTORY-TREES" accesskey="9">DIRECTORY TREES</a></li>
3484 <li><a href="#install_002dtl-BUGS">install-tl BUGS</a></li>
3485 <li><a href="#install_002dtl-AUTHORS-AND-COPYRIGHT">AUTHORS AND COPYRIGHT</a></li>
3486 </ul>
3487 <hr>
3488 <div class="appendixsec-level-extent" id="install_002dtl-NAME">
3489 <div class="nav-panel">
3490 <p>
3491 Next: <a href="#install_002dtl-SYNOPSIS" accesskey="n" rel="next">install-tl SYNOPSIS</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3492 </div>
3493 <h3 class="appendixsec" id="install_002dtl-NAME-1"><span>A.1 install-tl NAME<a class="copiable-link" href="#install_002dtl-NAME-1"> &para;</a></span></h3>
3494
3495 <p>install-tl - TeX Live cross-platform installer
3496 </p>
3497 <hr>
3498 </div>
3499 <div class="appendixsec-level-extent" id="install_002dtl-SYNOPSIS">
3500 <div class="nav-panel">
3501 <p>
3502 Next: <a href="#install_002dtl-DESCRIPTION" accesskey="n" rel="next">install-tl DESCRIPTION</a>, Previous: <a href="#install_002dtl-NAME" accesskey="p" rel="prev">install-tl NAME</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3503 </div>
3504 <h3 class="appendixsec" id="install_002dtl-SYNOPSIS-1"><span>A.2 install-tl SYNOPSIS<a class="copiable-link" href="#install_002dtl-SYNOPSIS-1"> &para;</a></span></h3>
3505
3506 <p>install-tl [<em class="emph">option</em>]...
3507 </p>
3508 <p>install-tl-windows.bat [<em class="emph">option</em>]...
3509 </p>
3510 <hr>
3511 </div>
3512 <div class="appendixsec-level-extent" id="install_002dtl-DESCRIPTION">
3513 <div class="nav-panel">
3514 <p>
3515 Next: <a href="#install_002dtl-REFERENCES" accesskey="n" rel="next">REFERENCES</a>, Previous: <a href="#install_002dtl-SYNOPSIS" accesskey="p" rel="prev">install-tl SYNOPSIS</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3516 </div>
3517 <h3 class="appendixsec" id="install_002dtl-DESCRIPTION-1"><span>A.3 install-tl DESCRIPTION<a class="copiable-link" href="#install_002dtl-DESCRIPTION-1"> &para;</a></span></h3>
3518
3519 <p>This installer creates a runnable TeX Live installation from various
3520 media, including over the network, from local hard disk, a DVD, etc. The
3521 installer works on all platforms supported by TeX Live. For information
3522 on initially downloading TeX Live, see
3523 <a class="url" href="https://tug.org/texlive/acquire.html">https://tug.org/texlive/acquire.html</a>.
3524 </p>
3525 <p>The basic idea of TeX Live installation is for you to choose one of the
3526 top-level <em class="emph">schemes</em>, each of which is defined as a different set of
3527 <em class="emph">collections</em> and <em class="emph">packages</em>, where a collection is a set of packages,
3528 and a package is what contains actual files. Each package is in exactly
3529 one collection, while schemes can contain any combination of packages
3530 and collections.
3531 </p>
3532 <p>Within the installer, you can choose a scheme, and further customize the
3533 set of collections to install, but not the set of the packages. To work
3534 at the package level, use <code class="code">tlmgr</code> (reference just below) after the
3535 initial installation is complete.
3536 </p>
3537 <p>The default is <code class="code">scheme-full</code>, which installs everything, and this is
3538 highly recommended.
3539 </p>
3540 <hr>
3541 </div>
3542 <div class="appendixsec-level-extent" id="install_002dtl-REFERENCES">
3543 <div class="nav-panel">
3544 <p>
3545 Next: <a href="#install_002dtl-EXAMPLES" accesskey="n" rel="next">install-tl EXAMPLES</a>, Previous: <a href="#install_002dtl-DESCRIPTION" accesskey="p" rel="prev">install-tl DESCRIPTION</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3546 </div>
3547 <h3 class="appendixsec" id="REFERENCES"><span>A.4 REFERENCES<a class="copiable-link" href="#REFERENCES"> &para;</a></span></h3>
3548
3549 <p>Post-installation configuration, package updates, and more, are
3550 handled through <strong class="strong">tlmgr</strong>(1), the TeX Live Manager
3551 (<a class="url" href="https://tug.org/texlive/tlmgr.html">https://tug.org/texlive/tlmgr.html</a>).
3552 </p>
3553 <p>The most up-to-date version of this installer documentation is on the
3554 Internet at <a class="url" href="https://tug.org/texlive/doc/install-tl.html">https://tug.org/texlive/doc/install-tl.html</a>.
3555 </p>
3556 <p>For step-by-step instructions, see
3557 <a class="url" href="https://tug.org/texlive/quickinstall.html">https://tug.org/texlive/quickinstall.html</a>.
3558 </p>
3559 <p>For the full documentation of TeX Live, see
3560 <a class="url" href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.
3561 </p>
3562 <hr>
3563 </div>
3564 <div class="appendixsec-level-extent" id="install_002dtl-EXAMPLES">
3565 <div class="nav-panel">
3566 <p>
3567 Next: <a href="#install_002dtl-OPTIONS" accesskey="n" rel="next">install-tl OPTIONS</a>, Previous: <a href="#install_002dtl-REFERENCES" accesskey="p" rel="prev">REFERENCES</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3568 </div>
3569 <h3 class="appendixsec" id="install_002dtl-EXAMPLES-1"><span>A.5 install-tl EXAMPLES<a class="copiable-link" href="#install_002dtl-EXAMPLES-1"> &para;</a></span></h3>
3570
3571 <p>With no options, <code class="code">install-tl</code> drops you into an interactive menu where
3572 essentially all default settings can be changed. With options, you can
3573 initialize the settings in various ways, or perform the installation
3574 without interaction. Some examples:
3575 </p>
3576 <dl class="table">
3577 <dt><code class="code">install-tl --paper=letter</code></dt>
3578 <dd><a class="anchor" id="install_002dtl-install_002dtl-_002d_002dpaper_003dletter"></a>
3579 <p>Initialize paper size setting. The only values allowed are <code class="code">letter</code> and
3580 (the default) <code class="code">a4</code>.
3581 </p>
3582 </dd>
3583 <dt><code class="code">install-tl --scheme</code> <em class="emph">scheme</em></dt>
3584 <dd><a class="anchor" id="install_002dtl-install_002dtl-_002d_002dscheme-scheme"></a>
3585 <p>Initialize the installation scheme; the default is <code class="code">full</code>. For a list
3586 of schemes, see the interactive <code class="code">S</code> menu.
3587 </p>
3588 </dd>
3589 <dt><code class="code">install-tl --no-interaction</code></dt>
3590 <dd><a class="anchor" id="install_002dtl-install_002dtl-_002d_002dno_002dinteraction"></a>
3591 <p>Perform the installation immediately after parsing options, without
3592 entering the interactive menu.
3593 </p>
3594 </dd>
3595 <dt><code class="code">install-tl --profile</code> <em class="emph">texlive.profile</em></dt>
3596 <dd><a class="anchor" id="install_002dtl-install_002dtl-_002d_002dprofile-texlive_002eprofile"></a>
3597 <p>Install, without interaction, according to the given TL profile file;
3598 see <a class="ref" href="#install_002dtl-PROFILES">PROFILES</a> below. To initialize from the profile and then enter the
3599 interactive menu, add <code class="code">--init-from-profile</code>.
3600 </p>
3601 </dd>
3602 </dl>
3603
3604 <p>Full documentation follows.
3605 </p>
3606 <hr>
3607 </div>
3608 <div class="appendixsec-level-extent" id="install_002dtl-OPTIONS">
3609 <div class="nav-panel">
3610 <p>
3611 Next: <a href="#install_002dtl-PROFILES" accesskey="n" rel="next">PROFILES</a>, Previous: <a href="#install_002dtl-EXAMPLES" accesskey="p" rel="prev">install-tl EXAMPLES</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
3612 </div>
3613 <h3 class="appendixsec" id="install_002dtl-OPTIONS-1"><span>A.6 install-tl OPTIONS<a class="copiable-link" href="#install_002dtl-OPTIONS-1"> &para;</a></span></h3>
3614
3615 <p>As usual, all options can be specified in any order, and with either a
3616 leading <code class="code">-</code> or <code class="code">--</code>. An argument value can be separated from its
3617 option by either a space or <code class="code">=</code>.
3618 </p>
3619 <p>The options relating to customization of the installation can also be
3620 selected in the interactive installation menus (GUI or text).
3621 </p>
3622 <dl class="table">
3623 <dt><strong class="strong">-gui</strong> [[=]<em class="emph">module</em>]</dt>
3624 <dd><a class="anchor" id="install_002dtl-_002dgui-_005b_005b_003d_005dmodule_005d"></a>
3625 </dd>
3626 <dt><strong class="strong">-no-gui</strong></dt>
3627 <dd><a class="anchor" id="install_002dtl-_002dno_002dgui"></a>
3628 <p>If no <em class="emph">module</em> is given, starts the Tcl/Tk (see below) GUI installer.
3629 </p>
3630 <p>If <em class="emph">module</em> is given loads the given installer module. Currently the
3631 following modules are supported:
3632 </p>
3633 <dl class="table">
3634 <dt><code class="code">text</code></dt>
3635 <dd><a class="anchor" id="install_002dtl-text"></a>
3636 <p>The text mode user interface (default on Unix systems, including Macs).
3637 Same as the <code class="code">-no-gui</code> option.
3638 </p>
3639 </dd>
3640 <dt><code class="code">tcl</code> (or &quot;perltk&quot; or &quot;wizard&quot; or &quot;expert&quot; or nothing)</dt>
3641 <dd><a class="anchor" id="install_002dtl-tcl-_0028or-_0022perltk_0022-or-_0022wizard_0022-or-_0022expert_0022-or-nothing_0029"></a>
3642 <p>The Tcl/Tk user interface (default on Windows). It starts
3643 with a small number of configuration options, roughly equivalent
3644 to what the former wizard option offers, but a button <code class="code">Advanced</code>
3645 takes you to a screen with roughly the same options as the former
3646 <code class="code">perltk</code> interface.
3647 </p>
3648 </dd>
3649 </dl>
3650
3651 <p>The default GUI requires Tcl/Tk. This was standard on Macs, but has been
3652 removed in the latest macOS releases. It&rsquo;s often already installed on
3653 GNU/Linux, or can be easily installed through a distro package manager.
3654 For Windows, TeX Live provides a Tcl/Tk runtime.
3655 </p>
3656 </dd>
3657 <dt><strong class="strong">-lang</strong> <em class="emph">llcode</em></dt>
3658 <dd><a class="anchor" id="install_002dtl-_002dlang-llcode"></a>
3659 <p>By default, the Tcl GUI uses the language detection built into
3660 Tcl/Tk. If that fails you can select a different language by
3661 giving this option with a language code (based on ISO 639-1).
3662 Currently supported (but not necessarily completely translated) are:
3663 English (en, default), Czech (cs), German (de), French (fr), Italian
3664 (it), Japanese (ja), Dutch (nl), Polish (pl), Brazilian Portuguese
3665 (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl), Serbian (sr),
3666 Ukrainian (uk), Vietnamese (vi), simplified Chinese (zh_CN), and
3667 traditional Chinese (zh_TW).
3668 </p>
3669 </dd>
3670 <dt><strong class="strong">-repository</strong> <em class="emph">url|path</em></dt>
3671 <dd><a class="anchor" id="install_002dtl-_002drepository-url_007cpath"></a>
3672 <p>Specify the package repository to be used as the source of the
3673 installation. In short, this can be a directory name or a url using
3674 http(s), ftp, or scp. The documentation for <code class="code">tlmgr</code> has the details
3675 (<a class="url" href="https://tug.org/texlive/doc/tlmgr.html#OPTIONS">https://tug.org/texlive/doc/tlmgr.html#OPTIONS</a>).
3676 </p>
3677 <p>For installation, the default is to pick a mirror automatically, using
3678 <a class="url" href="https://mirror.ctan.org/systems/texlive/tlnet">https://mirror.ctan.org/systems/texlive/tlnet</a>; the chosen mirror is
3679 then used for the entire download. You can use the special argument
3680 <code class="code">ctan</code> as an abbreviation for this. (See <a class="url" href="https://ctan.org">https://ctan.org</a> for more
3681 about CTAN and its mirrors.)
3682 </p>
3683 <p>After installation is complete, you can use that installation as the
3684 repository for another installation. If you chose to install less than
3685 the full scheme containing all packages, the list of available schemes
3686 will be adjusted accordingly.
3687 </p>
3688 </dd>
3689 <dt><strong class="strong">-select-repository</strong></dt>
3690 <dd><a class="anchor" id="install_002dtl-_002dselect_002drepository"></a>
3691 <p>This option allows you to choose a particular mirror from the current
3692 list of active CTAN mirrors. This option is supported in the <code class="code">text</code>
3693 and <code class="code">gui</code> installer modes, and will also offer to install
3694 from local media if available, or from a repository specified on the
3695 command line. It&rsquo;s useful when the (default) automatic redirection does
3696 not choose a good host for you.
3697 </p>
3698 </dd>
3699 <dt><strong class="strong">-all-options</strong></dt>
3700 <dd><a class="anchor" id="install_002dtl-_002dall_002doptions"></a>
3701 <p>Normally options not relevant to the current platform are not shown
3702 (e.g., when running on Unix, Windows-specific options are omitted).
3703 Giving this command line option allows configuring such &quot;foreign&quot;
3704 settings.
3705 </p>
3706 </dd>
3707 <dt><strong class="strong">-custom-bin</strong> <em class="emph">path</em></dt>
3708 <dd><a class="anchor" id="install_002dtl-_002dcustom_002dbin-path"></a>
3709 <p>If you have built your own set of TeX Live binaries (e.g., because
3710 precompiled binaries were not provided by TL for your platform), this
3711 option allows you to specify the <em class="emph">path</em> to a directory where the
3712 binaries for the current system are present. The installation will
3713 continue as usual, but at the end all files from <em class="emph">path</em> are copied over
3714 to <code class="code">bin/custom/</code> under your installation directory and this
3715 <code class="code">bin/custom/</code> directory is what will be added to the path for the
3716 post-install actions. To install multiple custom binary sets, manually
3717 rename <code class="code">custom</code> before doing each.
3718 </p>
3719 <p>For more information on custom binaries, see
3720 <a class="url" href="https://tug.org/texlive/custom-bin.html">https://tug.org/texlive/custom-bin.html</a>. For general information on
3721 building TeX Live, see <a class="url" href="https://tug.org/texlive/build.html">https://tug.org/texlive/build.html</a>.
3722 </p>
3723 </dd>
3724 <dt><strong class="strong">-debug-fakenet</strong></dt>
3725 <dd><a class="anchor" id="install_002dtl-_002ddebug_002dfakenet"></a>
3726 <p>Pretend we&rsquo;re doing a network install. This is for the sole purpose of
3727 testing the code to handle broken downloads, via moving package files
3728 aside in a tlnet mirror hierarchy.
3729 </p>
3730 </dd>
3731 <dt><strong class="strong">-debug-setup-vars</strong></dt>
3732 <dd><a class="anchor" id="install_002dtl-_002ddebug_002dsetup_002dvars"></a>
3733 <p>Print final values of directory variables; for more debugging
3734 information on how they were set, also specify <code class="code">-v</code>.
3735 </p>
3736 </dd>
3737 <dt><strong class="strong">-debug-translation</strong></dt>
3738 <dd><a class="anchor" id="install_002dtl-_002ddebug_002dtranslation"></a>
3739 <p>In the former Perl/Tk GUI modes, this option reported any missing,
3740 or more likely untranslated, messages to standard error. Not yet
3741 implemented for the Tcl interface. Helpful for translators to see
3742 what remains to be done.
3743 </p>
3744 </dd>
3745 <dt><strong class="strong">-force-platform</strong> <em class="emph">platform</em></dt>
3746 <dd><a class="anchor" id="install_002dtl-_002dforce_002dplatform-platform"></a>
3747 <p>Instead of auto-detecting the current platform, use <em class="emph">platform</em>.
3748 Binaries for this platform must be present in <code class="code">bin/</code><em class="emph">platform</em><code class="code">/</code> and
3749 they must be runnable, or installation will fail. <code class="code">-force-arch</code> is a
3750 synonym.
3751 </p>
3752 </dd>
3753 <dt><strong class="strong">-help</strong>, <strong class="strong">--help</strong>, <strong class="strong">-?</strong></dt>
3754 <dd><a class="anchor" id="install_002dtl-_002dhelp_002c-_002d_002dhelp_002c-_002d_003f"></a>
3755 <p>Display this help and exit. (This help is also on the web at
3756 <a class="url" href="https://tug.org/texlive/doc/install-tl.html">https://tug.org/texlive/doc/install-tl.html</a>). Sometimes the <code class="code">perldoc</code>
3757 and/or <code class="code">PAGER</code> programs on the system have problems, possibly resulting
3758 in control characters being literally output. This can&rsquo;t always be
3759 detected, but you can set the <code class="code">NOPERLDOC</code> environment variable and
3760 <code class="code">perldoc</code> will not be used.
3761 </p>
3762 </dd>
3763 <dt><strong class="strong">-in-place</strong></dt>
3764 <dd><a class="anchor" id="install_002dtl-_002din_002dplace"></a>
3765 <p>This is a quick-and-dirty installation option in case you already have
3766 an rsync or svn checkout of TeX Live. It will use the checkout as-is
3767 and will just do the necessary post-install. Be warned that the file
3768 <code class="code">tlpkg/texlive.tlpdb</code> may be rewritten, that removal has to be done
3769 manually, and that the only realistic way to maintain this installation
3770 is to redo it from time to time. This option is not available via the
3771 installer interfaces. USE AT YOUR OWN RISK.
3772 </p>
3773 </dd>
3774 <dt><strong class="strong">-init-from-profile</strong> <em class="emph">profile_file</em></dt>
3775 <dd><a class="anchor" id="install_002dtl-_002dinit_002dfrom_002dprofile-profile_005ffile"></a>
3776 <p>Similar to <strong class="strong">-profile</strong> (see <a class="ref" href="#install_002dtl-PROFILES">PROFILES</a> below), but only initializes
3777 the installation configuration from <em class="emph">profile_file</em> and then starts a
3778 normal interactive session. Environment variables are not ignored.
3779 </p>
3780 </dd>
3781 <dt><strong class="strong">-logfile</strong> <em class="emph">file</em></dt>
3782 <dd><a class="anchor" id="install_002dtl-_002dlogfile-file"></a>
3783 <p>Write both all messages (informational, debugging, warnings) to <em class="emph">file</em>,
3784 in addition to standard output or standard error.
3785 </p>
3786 <p>If this option is not given, the installer will create a log file
3787 in the root of the writable installation tree,
3788 for example, <code class="code">/usr/local/texlive/YYYY/install-tl.log</code> for the <em class="emph">YYYY</em>
3789 release.
3790 </p>
3791 </dd>
3792 <dt><strong class="strong">-no-cls</strong></dt>
3793 <dd><a class="anchor" id="install_002dtl-_002dno_002dcls"></a>
3794 <p>For the text mode installer only: do not clear the screen when entering
3795 a new menu. For debugging.
3796 </p>
3797 </dd>
3798 <dt><strong class="strong">-no-continue</strong></dt>
3799 <dd><a class="anchor" id="install_002dtl-_002dno_002dcontinue"></a>
3800 <p>Quit early on installation failure of a non-core package.
3801 </p>
3802 <p>By default, a few core packages are installed first; then, a failed
3803 installation of any other (non-core) package is noted, but does not stop
3804 the installation. Any such failed packages are retried, once.
3805 </p>
3806 <p>If the retry also fails, by default the installer proceeds to completion
3807 anyway, with the idea that it was a transient network problem and
3808 reinstallation will succeed later. If this option is specified, and the
3809 retry fails, the installer aborts.
3810 </p>
3811 </dd>
3812 <dt><strong class="strong">-no-doc-install</strong></dt>
3813 <dd><a class="anchor" id="install_002dtl-_002dno_002ddoc_002dinstall"></a>
3814 </dd>
3815 <dt><strong class="strong">-no-src-install</strong></dt>
3816 <dd><a class="anchor" id="install_002dtl-_002dno_002dsrc_002dinstall"></a>
3817 <p>Do not install the documentation resp. source package files, both for
3818 the immediate installation and for future updates. After installation,
3819 inclusion of the doc/src files can be re-enabled via <code class="code">tlmgr</code>:
3820 </p>
3821 <pre class="verbatim"> tlmgr option docfiles 1
3822 tlmgr option srcfiles 1
3823 </pre>
3824 <p>If you later find that you want the doc/src files for a package that has
3825 been installed without them, you can get them like this (using the
3826 <code class="code">fontspec</code> package as the example):
3827 </p>
3828 <pre class="verbatim"> tlmgr install --reinstall --with-doc --with-src fontspec
3829 </pre>
3830 <p>The source files mentioned here are those relating to TeX packages, such
3831 as <code class="code">.dtx</code> files. The sources that are compiled to make the binaries are
3832 available separately: see <a class="url" href="https://tug.org/texlive/svn/">https://tug.org/texlive/svn/</a>.
3833 </p>
3834 </dd>
3835 <dt><strong class="strong">-no-installation</strong></dt>
3836 <dd><a class="anchor" id="install_002dtl-_002dno_002dinstallation"></a>
3837 <p>Do not perform any installation. This is for debugging the
3838 initialization and setup routines without touching the disk.
3839 </p>
3840 </dd>
3841 <dt><strong class="strong">-no-interaction</strong></dt>
3842 <dd><a class="anchor" id="install_002dtl-_002dno_002dinteraction"></a>
3843 <p>Do not enter the interactive menu; immediately perform the installation
3844 after initialization and option parsing. Also omit the check for a
3845 previous installation and asking about importing previous settings.
3846 </p>
3847 </dd>
3848 <dt><strong class="strong">-no-persistent-downloads</strong></dt>
3849 <dd><a class="anchor" id="install_002dtl-_002dno_002dpersistent_002ddownloads"></a>
3850 </dd>
3851 <dt><strong class="strong">-persistent-downloads</strong></dt>
3852 <dd><a class="anchor" id="install_002dtl-_002dpersistent_002ddownloads"></a>
3853 <p>For network installs, activating this option makes the installer try to
3854 set up a persistent connection using the <code class="code">LWP</code> Perl module. This
3855 opens only one connection between your computer and the server per
3856 session and reuses it, instead of initiating a new download for each
3857 package, which typically yields a significant speed-up.
3858 </p>
3859 <p>This option is turned on by default, and the installation program will
3860 fall back to using <code class="code">wget</code> if this is not possible. To disable usage of
3861 LWP and persistent connections, use <code class="code">-no-persistent-downloads</code>.
3862 </p>
3863 </dd>
3864 <dt><strong class="strong">-no-verify-downloads</strong></dt>
3865 <dd><a class="anchor" id="install_002dtl-_002dno_002dverify_002ddownloads"></a>
3866 <p>By default, if a GnuPG <code class="code">gpg</code> binary is found in PATH, downloads are
3867 verified against a cryptographic signature. This option disables such
3868 verification. The full description is in the Crytographic Verification
3869 section of the <code class="code">tlmgr</code> documentation, e.g.,
3870 <a class="url" href="https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION">https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION</a>
3871 </p>
3872 </dd>
3873 <dt><strong class="strong">-non-admin</strong></dt>
3874 <dd><a class="anchor" id="install_002dtl-_002dnon_002dadmin"></a>
3875 <p>For Windows only: configure for the current user, not for all users.
3876 </p>
3877 </dd>
3878 <dt><strong class="strong">-paper</strong> <code class="code">a4</code><strong class="strong">|</strong><code class="code">letter</code></dt>
3879 <dd><a class="anchor" id="install_002dtl-_002dpaper-a4_007cletter"></a>
3880 <p>Set the default paper size for all TeX Live programs, as specified.
3881 The default is <code class="code">a4</code>. The paper size can be set after installation with
3882 the <code class="code">tlmgr paper</code> command.
3883 </p>
3884 </dd>
3885 <dt><strong class="strong">-portable</strong></dt>
3886 <dd><a class="anchor" id="install_002dtl-_002dportable"></a>
3887 <p>Install for portable use, e.g., on a USB stick. See the
3888 <code class="code">instopt_portable</code> description below for details.
3889 </p>
3890 </dd>
3891 <dt><strong class="strong">-print-platform</strong></dt>
3892 <dd><a class="anchor" id="install_002dtl-_002dprint_002dplatform"></a>
3893 <p>Print the TeX Live identifier for the detected platform
3894 (hardware/operating system) combination to standard output, and exit.
3895 <code class="code">-print-arch</code> is a synonym.
3896 </p>
3897 </dd>
3898 <dt><strong class="strong">-profile</strong> <em class="emph">profile_file</em></dt>
3899 <dd><a class="anchor" id="install_002dtl-_002dprofile-profile_005ffile"></a>
3900 <p>Load <em class="emph">profile_file</em> and do the installation with no user interaction,
3901 that is, a batch (unattended) install. Environment variables are
3902 ignored. See <a class="ref" href="#install_002dtl-PROFILES">PROFILES</a> below.
3903 </p>
3904 </dd>
3905 <dt><strong class="strong">-q</strong></dt>
3906 <dd><a class="anchor" id="install_002dtl-_002dq"></a>
3907 <p>Omit normal informational messages.
3908 </p>
3909 </dd>
3910 <dt><strong class="strong">-scheme</strong> <em class="emph">scheme</em></dt>
3911 <dd><a class="anchor" id="install_002dtl-_002dscheme-scheme"></a>
3912 <p>Schemes are the highest level of package grouping in TeX Live; the
3913 default is to use the <code class="code">full</code> scheme, which includes everything. This
3914 option overrides that default. The <em class="emph">scheme</em> argument value may
3915 optionally have a prefix <code class="code">scheme-</code>. The list of supported scheme names
3916 depends on what your package repository provides; see the interactive
3917 menu list.
3918 </p>
3919 </dd>
3920 <dt><strong class="strong">-texdir</strong> <em class="emph">dir</em></dt>
3921 <dd><a class="anchor" id="install_002dtl-_002dtexdir-dir"></a>
3922 <p>Specify the system installation directory; the default is
3923 <code class="code">/usr/local/texlive/YYYY</code> for release YYYY. Specifying this option also
3924 causes the <code class="code">TEXMFLOCAL</code>, <code class="code">TEXMFSYSCONFIG</code>, and <code class="code">TEXMFSYSVAR</code>
3925 directories to be set as subdirectories of <em class="emph">dir</em>, so they don&rsquo;t have to
3926 be set individually.
3927 </p>
3928 <p>There is a brief summary of these directories trees at <a class="ref" href="#install_002dtl-DIRECTORY-TREES">DIRECTORY
3929 TREES</a> below; for details on the trees set up by default, and their
3930 intended usage, see the main TeX Live documentation at
3931 <a class="url" href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.
3932 </p>
3933 </dd>
3934 <dt><strong class="strong">-texuserdir</strong> <em class="emph">dir</em></dt>
3935 <dd><a class="anchor" id="install_002dtl-_002dtexuserdir-dir"></a>
3936 <p>Specify the user installation directory; the default is
3937 <code class="code">~/.texliveYYYY</code> (except on Macs, where there is no leading dot).
3938 Specifying this also causes the <code class="code">TEXMFHOME</code>, <code class="code">TEXMFCONFIG</code>, and
3939 <code class="code">TEXMFVAR</code> directories to be set as subdirectories of <em class="emph">dir</em>.
3940 </p>
3941 </dd>
3942 <dt><strong class="strong">-texmflocal</strong> <em class="emph">dir</em></dt>
3943 <dd><a class="anchor" id="install_002dtl-_002dtexmflocal-dir"></a>
3944 <p>Specify the <code class="code">TEXMFLOCAL</code> directory; the default is
3945 <code class="code">/usr/local/texlive/texmf-local</code>, that is, one level up from the main
3946 installation. This is so locally-installed packages can be easily used
3947 across releases, which is usually desirable. Specifying the <code class="code">-texdir</code>
3948 option changes this, putting <code class="code">TEXMFLOCAL</code> under the main tree. The
3949 <code class="code">-texmflocal</code> option can be used to specify an explicit directory.
3950 </p>
3951 <p>Anything installed here must follow the TeX directory structure (TDS),
3952 e.g., <code class="code">TEXMFHOME/tex/latex/mypkg/mypkg.sty</code>. TDS reference:
3953 <a class="url" href="https://tug.org/tds">https://tug.org/tds</a>.
3954 </p>
3955 </dd>
3956 <dt><strong class="strong">-texmfhome</strong> <em class="emph">dir</em></dt>
3957 <dd><a class="anchor" id="install_002dtl-_002dtexmfhome-dir"></a>
3958 <p>Specify the <code class="code">TEXMFHOME</code> directory; the default is <code class="code">~/texmf</code>, except on
3959 Macs, where it is <code class="code">~/Library/texmf</code>. Analogously to <code class="code">TEXMFLOCAL</code>, the
3960 <code class="code">-texuserdir</code> option changes this default.
3961 </p>
3962 <p>Also as with <code class="code">TEXMFLOCAL</code>, anything installed here must follow the TDS.
3963 </p>
3964 </dd>
3965 <dt><strong class="strong">-texmfsysconfig</strong> <em class="emph">dir</em></dt>
3966 <dd><a class="anchor" id="install_002dtl-_002dtexmfsysconfig-dir"></a>
3967 </dd>
3968 <dt><strong class="strong">-texmfsysvar</strong> <em class="emph">dir</em></dt>
3969 <dd><a class="anchor" id="install_002dtl-_002dtexmfsysvar-dir"></a>
3970 <p>Specify the <code class="code">TEXMFSYSCONFIG</code> and <code class="code">TEXMFSYSVAR</code> system directories.
3971 </p>
3972 </dd>
3973 <dt><strong class="strong">-texmfconfig</strong> <em class="emph">dir</em></dt>
3974 <dd><a class="anchor" id="install_002dtl-_002dtexmfconfig-dir"></a>
3975 </dd>
3976 <dt><strong class="strong">-texmfvar</strong> <em class="emph">dir</em></dt>
3977 <dd><a class="anchor" id="install_002dtl-_002dtexmfvar-dir"></a>
3978 <p>Specify the <code class="code">TEXMFCONFIG</code> and <code class="code">TEXMFVAR</code> user directories.
3979 The defaults are <code class="code">~/.texliveYYYY/texmf-{config,var}</code>, except on Macs,
3980 where the leading dot is omitted (<code class="code">~/texliveYYYY/...</code>).
3981 </p>
3982 </dd>
3983 <dt><strong class="strong">-v</strong></dt>
3984 <dd><a class="anchor" id="install_002dtl-_002dv"></a>
3985 <p>Include verbose debugging messages; repeat for maximum debugging: <code class="code">-v
3986 -v</code>. (Further repeats are accepted but ignored.)
3987 </p>
3988 </dd>
3989 <dt><strong class="strong">-version</strong>, <strong class="strong">--version</strong></dt>
3990 <dd><a class="anchor" id="install_002dtl-_002dversion_002c-_002d_002dversion"></a>
3991 <p>Output version information and exit. If <code class="code">-v</code> is also given, the
3992 versions of the TeX Live modules used are also reported.
3993 </p>
3994 </dd>
3995 </dl>
3996
3997 <hr>
3998 </div>
3999 <div class="appendixsec-level-extent" id="install_002dtl-PROFILES">
4000 <div class="nav-panel">
4001 <p>
4002 Next: <a href="#install_002dtl-ENVIRONMENT-VARIABLES" accesskey="n" rel="next">ENVIRONMENT VARIABLES</a>, Previous: <a href="#install_002dtl-OPTIONS" accesskey="p" rel="prev">install-tl OPTIONS</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4003 </div>
4004 <h3 class="appendixsec" id="PROFILES"><span>A.7 PROFILES<a class="copiable-link" href="#PROFILES"> &para;</a></span></h3>
4005
4006 <p>A <em class="emph">profile</em> file normally contains all the values needed to perform an
4007 installation. After a normal installation has finished, a profile for
4008 that exact installation is written to the file <code class="code">tlpkg/texlive.profile</code>.
4009 In addition, from the text menu one can select <code class="code">P</code> to save the current
4010 setup as a profile at any time. These are small text files; feel free to
4011 peruse and edit them according to your needs.
4012 </p>
4013 <p>Such a profile file can be given as the argument to <code class="code">-profile</code>, for
4014 example to redo the exact same installation on a different system.
4015 Alternatively, you can use a custom profile, most easily created by
4016 starting from a generated one and changing values. An empty profile
4017 file will cause the installer to use the defaults.
4018 </p>
4019 <p>As mentioned above, the installer only supports selection by scheme and
4020 collections, not individual packages, so packages cannot be specified in
4021 profile files either. Use <code class="code">tlmgr</code> to work at the package level.
4022 </p>
4023 <p>Within a profile file, each line consists of
4024 </p>
4025 <p><em class="emph">variable</em> [<em class="emph">value</em>]
4026 </p>
4027 <p>except for comment lines starting with <code class="code">#</code>. The possible variable
4028 names are listed below. Values, when present, are either <code class="code">0</code> or <code class="code">1</code>
4029 for booleans, or strings (which must be specified without any quote
4030 characters). Leading whitespace is ignored.
4031 </p>
4032 <p>If the variable <code class="code">selected_scheme</code> is defined and <em class="emph">no</em> collection
4033 variables at all are defined, then the collections required by the
4034 specified scheme (which might change over time) are installed, without
4035 explicitly listing them. This eases maintenance of profile files. If any
4036 collections are specified in a profile, though, then the scheme is
4037 ignored and all desired collections must be given explicitly.
4038 </p>
4039 <p>For example, a line
4040 </p>
4041 <pre class="verbatim"> selected_scheme scheme-small
4042 </pre>
4043 <p>along with definitions for the installation directories (given below
4044 under &quot;path options&quot;) suffices to install the &quot;small&quot; scheme with all
4045 default options. The schemes are described in the <code class="code">S</code> menu in the
4046 text installer, or equivalent.
4047 </p>
4048 <p>In addition to <code class="code">selected_scheme</code>, here are the other variable names
4049 supported in a profile:
4050 </p>
4051 <p><strong class="strong">collection options</strong> (prefix <code class="code">collection-</code>)
4052 </p>
4053 <p>Collections are specified with a variable name with the prefix
4054 <code class="code">collection-</code> followed by a collection name; there is no value. For
4055 instance, <code class="code">collection-basic</code>. The collections are described in the
4056 <code class="code">C</code> menu.
4057 </p>
4058 <p>Schemes and collections (and packages) are ultimately defined by the
4059 files in the <code class="code">tlpkg/tlpsrc/</code> source directory.
4060 </p>
4061 <p><strong class="strong">path options</strong>
4062 </p>
4063 <p>It is best to define all of these, even though they may not be used in a
4064 given installation, so as to avoid unintentionally getting a default
4065 value that could cause problems later.
4066 </p>
4067 <pre class="verbatim"> TEXDIR
4068 TEXMFLOCAL
4069 TEXMFSYSCONFIG
4070 TEXMFSYSVAR
4071 TEXMFCONFIG
4072 TEXMFVAR
4073 TEXMFHOME
4074 </pre>
4075 <p><strong class="strong">installer options</strong> (prefix <code class="code">instopt_</code>)
4076 </p>
4077 <dl class="table">
4078 <dt><code class="code">instopt_adjustpath</code> (default 0 on Unix, 1 on Windows)</dt>
4079 <dd><a class="anchor" id="install_002dtl-instopt_005fadjustpath-_0028default-0-on-Unix_002c-1-on-Windows_0029"></a>
4080 <p>Adjust <code class="code">PATH</code> environment variable.
4081 </p>
4082 </dd>
4083 <dt><code class="code">instopt_adjustrepo</code> (default 1)</dt>
4084 <dd><a class="anchor" id="install_002dtl-instopt_005fadjustrepo-_0028default-1_0029"></a>
4085 <p>Set remote repository to a multiplexed CTAN mirror after installation;
4086 see <code class="code">-repository</code> above.
4087 </p>
4088 </dd>
4089 <dt><code class="code">instopt_letter</code> (default 0)</dt>
4090 <dd><a class="anchor" id="install_002dtl-instopt_005fletter-_0028default-0_0029"></a>
4091 <p>Set letter size paper as the default, instead of a4.
4092 </p>
4093 </dd>
4094 <dt><code class="code">instopt_portable</code> (default 0)</dt>
4095 <dd><a class="anchor" id="install_002dtl-instopt_005fportable-_0028default-0_0029"></a>
4096 <p>Install for portable use, e.g., on a USB stick, without touching the
4097 host system. Specifically, this forces the user directories
4098 <code class="code">TEXMFHOME</code>, <code class="code">TEXMFCONFIG</code>, <code class="code">TEXMFVAR</code> to be identical to the system
4099 directories <code class="code">TEXMFLOCAL</code>, <code class="code">TEXMFSYSCONFIG</code>, <code class="code">TEXMFSYSVAR</code>,
4100 respectively (regardless of other options and environment variable.)
4101 </p>
4102 <p>In addition, on Windows, it disables the desktop integration, path
4103 adjustment, and file associations actions usually performed.
4104 </p>
4105 </dd>
4106 <dt><code class="code">instopt_write18_restricted</code> (default 1)</dt>
4107 <dd><a class="anchor" id="install_002dtl-instopt_005fwrite18_005frestricted-_0028default-1_0029"></a>
4108 <p>Enable <code class="code">\write18</code> for a restricted set of programs.
4109 </p>
4110 </dd>
4111 </dl>
4112
4113 <p><strong class="strong">tlpdb options</strong> (prefix <code class="code">tlpdbopt_</code>)
4114 </p>
4115 <p>The definitive list is given in <code class="code">tlpkg/TeXLive/TLConfig.pm</code>, in the hash
4116 <code class="code">%TeXLive::TLConfig::TLPDBOptions</code>, together with explanations. All
4117 items given there <em class="emph">except</em> for <code class="code">tlpdbopt_location</code> can be specified.
4118 Here is the current list:
4119 </p>
4120 <pre class="verbatim"> tlpdbopt_autobackup
4121 tlpdbopt_backupdir
4122 tlpdbopt_create_formats
4123 tlpdbopt_desktop_integration
4124 tlpdbopt_file_assocs
4125 tlpdbopt_generate_updmap
4126 tlpdbopt_install_docfiles
4127 tlpdbopt_install_srcfiles
4128 tlpdbopt_post_code
4129 tlpdbopt_sys_bin
4130 tlpdbopt_sys_info
4131 tlpdbopt_sys_man
4132 tlpdbopt_w32_multi_user
4133 </pre>
4134 <p><strong class="strong">platform options</strong> (prefix <code class="code">binary_</code>)
4135 </p>
4136 <p>For each supported platform in TeX Live (directories under <code class="code">bin/</code>), the
4137 variable <code class="code">binary_</code><em class="emph">PLATFORM</em> can be set with value 1. For example:
4138 </p>
4139 <pre class="verbatim"> binary_x86_64-linux 1
4140 </pre>
4141 <p>If no <code class="code">binary_</code> settings are made, the default is whatever the
4142 current machine is running.
4143 </p>
4144 <p>In releases before 2017, many profile variables had different
4145 names (not documented here; see the <code class="code">install-tl</code> source). They are
4146 accepted and transformed to the names given above. When a profile is
4147 written, the names above are always used.
4148 </p>
4149 <p>For more details on all of the above options, consult the TeX Live
4150 installation manual, linked from <a class="url" href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.
4151 </p>
4152 <hr>
4153 </div>
4154 <div class="appendixsec-level-extent" id="install_002dtl-ENVIRONMENT-VARIABLES">
4155 <div class="nav-panel">
4156 <p>
4157 Next: <a href="#install_002dtl-DIRECTORY-TREES" accesskey="n" rel="next">DIRECTORY TREES</a>, Previous: <a href="#install_002dtl-PROFILES" accesskey="p" rel="prev">PROFILES</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4158 </div>
4159 <h3 class="appendixsec" id="ENVIRONMENT-VARIABLES"><span>A.8 ENVIRONMENT VARIABLES<a class="copiable-link" href="#ENVIRONMENT-VARIABLES"> &para;</a></span></h3>
4160
4161 <p>For ease in scripting and debugging, <code class="code">install-tl</code> looks for the
4162 following environment variables. They are not of interest for normal
4163 user installations.
4164 </p>
4165 <dl class="table">
4166 <dt><code class="code">NOPERLDOC</code></dt>
4167 <dd><a class="anchor" id="install_002dtl-NOPERLDOC"></a>
4168 <p>Don&rsquo;t try to run the <code class="code">--help</code> message through <code class="code">perldoc</code>.
4169 </p>
4170 </dd>
4171 <dt><code class="code">TEXLIVE_DOWNLOADER</code></dt>
4172 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fDOWNLOADER"></a>
4173 </dd>
4174 <dt><code class="code">TL_DOWNLOAD_PROGRAM</code></dt>
4175 <dd><a class="anchor" id="install_002dtl-TL_005fDOWNLOAD_005fPROGRAM"></a>
4176 </dd>
4177 <dt><code class="code">TL_DOWNLOAD_ARGS</code></dt>
4178 <dd><a class="anchor" id="install_002dtl-TL_005fDOWNLOAD_005fARGS"></a>
4179 </dd>
4180 <dt><code class="code">TEXLIVE_PREFER_OWN</code></dt>
4181 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fPREFER_005fOWN"></a>
4182 <p>These override the normal choice of the download and other utility
4183 programs; see the <code class="code">tlmgr</code> documentation, e.g.,
4184 <a class="url" href="https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES">https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES</a>.
4185 </p>
4186 </dd>
4187 <dt><code class="code">TEXLIVE_INSTALL_ENV_NOCHECK</code></dt>
4188 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fENV_005fNOCHECK"></a>
4189 <p>Omit the check for environment variables containing the string <code class="code">tex</code>.
4190 People developing TeX-related software are likely to have many such
4191 variables.
4192 </p>
4193 </dd>
4194 <dt><code class="code">TEXLIVE_INSTALL_NO_CONTEXT_CACHE</code></dt>
4195 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fNO_005fCONTEXT_005fCACHE"></a>
4196 <p>Omit creating the ConTeXt cache. This is useful for redistributors.
4197 </p>
4198 </dd>
4199 <dt><code class="code">TEXLIVE_INSTALL_NO_DISKCHECK</code></dt>
4200 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fNO_005fDISKCHECK"></a>
4201 <p>If set to 1, omit free disk space check. By default, if a
4202 POSIX-compliant <code class="code">df</code> program (supporting <code class="code">-Pk</code>) is available, the
4203 installer checks for available disk space in the selected installation
4204 location, and will abort installation if there is insufficient disk
4205 space, plus a margin of 100MB. An equivalent check is made on Windows
4206 (not involving <code class="code">df</code>).
4207 </p>
4208 </dd>
4209 <dt><code class="code">TEXLIVE_INSTALL_NO_RESUME</code></dt>
4210 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fNO_005fRESUME"></a>
4211 <p>Omit check for installing on top of a previous installation and then
4212 asking about importing previous settings.
4213 </p>
4214 </dd>
4215 <dt><code class="code">TEXLIVE_INSTALL_NO_WELCOME</code></dt>
4216 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fNO_005fWELCOME"></a>
4217 <p>Omit printing the welcome message after successful installation, e.g.,
4218 when testing.
4219 </p>
4220 </dd>
4221 <dt><code class="code">TEXLIVE_INSTALL_PAPER</code></dt>
4222 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fPAPER"></a>
4223 <p>Set the default paper size for all relevant programs; must be either
4224 <code class="code">letter</code> or <code class="code">a4</code>. The default is <code class="code">a4</code>.
4225 </p>
4226 </dd>
4227 <dt><code class="code">TEXLIVE_INSTALL_PREFIX</code></dt>
4228 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fPREFIX"></a>
4229 </dd>
4230 <dt><code class="code">TEXLIVE_INSTALL_TEXMFCONFIG</code></dt>
4231 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFCONFIG"></a>
4232 </dd>
4233 <dt><code class="code">TEXLIVE_INSTALL_TEXMFVAR</code></dt>
4234 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFVAR"></a>
4235 </dd>
4236 <dt><code class="code">TEXLIVE_INSTALL_TEXMFHOME</code></dt>
4237 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFHOME"></a>
4238 </dd>
4239 <dt><code class="code">TEXLIVE_INSTALL_TEXMFLOCAL</code></dt>
4240 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFLOCAL"></a>
4241 </dd>
4242 <dt><code class="code">TEXLIVE_INSTALL_TEXMFSYSCONFIG</code></dt>
4243 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFSYSCONFIG"></a>
4244 </dd>
4245 <dt><code class="code">TEXLIVE_INSTALL_TEXMFSYSVAR</code></dt>
4246 <dd><a class="anchor" id="install_002dtl-TEXLIVE_005fINSTALL_005fTEXMFSYSVAR"></a>
4247 <p>Specify the respective directories. <code class="code">TEXLIVE_INSTALL_PREFIX</code> defaults
4248 to <code class="code">/usr/local/texlive</code>. All the defaults can be seen by running the
4249 installer interactively and then typing <code class="code">D</code> for the directory menu.
4250 </p>
4251 <p>The various command line options for specifying directories override
4252 these environment variables; since specifying both is usually
4253 accidental, a warning is given if the values are different.
4254 </p>
4255 </dd>
4256 </dl>
4257
4258 <hr>
4259 </div>
4260 <div class="appendixsec-level-extent" id="install_002dtl-DIRECTORY-TREES">
4261 <div class="nav-panel">
4262 <p>
4263 Next: <a href="#install_002dtl-BUGS" accesskey="n" rel="next">install-tl BUGS</a>, Previous: <a href="#install_002dtl-ENVIRONMENT-VARIABLES" accesskey="p" rel="prev">ENVIRONMENT VARIABLES</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4264 </div>
4265 <h3 class="appendixsec" id="DIRECTORY-TREES"><span>A.9 DIRECTORY TREES<a class="copiable-link" href="#DIRECTORY-TREES"> &para;</a></span></h3>
4266
4267 <p>There are a plethora of ways to specify the plethora of directory trees
4268 used by TeX Live. By far the simplest, and recommended, approach is not
4269 to change anything. The defaults suffice for the vast majority of
4270 installations.
4271 </p>
4272 <p>But, for the sake of explanation, here is a table of the trees and the
4273 command line options that change them. The first group of three are
4274 system directories, and the second group of three are user directories;
4275 the two groups are quite analogous.
4276 </p>
4277 <pre class="verbatim"> +----------------+--------------------------------------+--------------+------------------+
4278 | tree | default | group change | single change |
4279 +----------------+--------------------------------------+--------------+------------------+
4280 | TEXMFLOCAL | /usr/local/texlive/texmf-local | --texdir | --texmflocal |
4281 | TEXMFSYSVAR | /usr/local/texlive/YYYY/texmf-var | --texdir | --texmfsysvar |
4282 | TEXMFSYSCONFIG | /usr/local/texlive/YYYY/texmf-config | --texdir | --texmfsysconfig |
4283 +----------------+--------------------------------------+--------------+------------------+
4284 | TEXMFHOME | ~/texmf | --texuserdir | --texmfhome |
4285 | TEXMFVAR | ~/.texliveYYYY/texmf-var | --texuserdir | --texmfvar |
4286 | TEXMFCONFIG | ~/.texliveYYYY/texmf-config | --texuserdir | --texmfconfig |
4287 +----------------+--------------------------------------+--------------+------------------+
4288 </pre>
4289 <p>In addition, as mentioned in the previous section, each tree has an
4290 environment variable <code class="code">TEXLIVE_INSTALL_</code><em class="emph">tree</em> which overrides the
4291 default; command line and profile settings both override environment
4292 variable settings.
4293 </p>
4294 <p>The defaults vary slightly on Macs, as explained above in <a class="ref" href="#install_002dtl-OPTIONS">OPTIONS</a>.
4295 </p>
4296 <p>For the user trees, the default value uses <code class="code">~</code>, and this is left as a
4297 literal <code class="code">~</code> in <code class="code">texmf.cnf</code>. That way, each user can have their own
4298 <code class="code">TEXMFHOME</code>, etc., as intended. On the other hand, for the system
4299 trees, if <code class="code">~</code> is used during the installation, this is assumed to
4300 simply be a typing shorthand, and the expanded home directory is written
4301 in <code class="code">texmf.cnf</code>, since it doesn&rsquo;t make sense to have user-specific
4302 system directories.
4303 </p>
4304 <p>For more on the directory trees and their intended usage, see the main
4305 TeX Live documentation at <a class="url" href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a>.
4306 </p>
4307 <hr>
4308 </div>
4309 <div class="appendixsec-level-extent" id="install_002dtl-BUGS">
4310 <div class="nav-panel">
4311 <p>
4312 Next: <a href="#install_002dtl-AUTHORS-AND-COPYRIGHT" accesskey="n" rel="next">AUTHORS AND COPYRIGHT</a>, Previous: <a href="#install_002dtl-DIRECTORY-TREES" accesskey="p" rel="prev">DIRECTORY TREES</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4313 </div>
4314 <h3 class="appendixsec" id="install_002dtl-BUGS-1"><span>A.10 install-tl BUGS<a class="copiable-link" href="#install_002dtl-BUGS-1"> &para;</a></span></h3>
4315
4316 <p>The <code class="code">install-tl</code> script copies itself into the installed tree.
4317 Usually, it can be run from there, using the installed tree as the
4318 source for another installation. Occasionally, however, there may be
4319 incompatibilities in the code of the new <code class="code">install-tl</code> and the
4320 infrastructure, resulting in (probably) inscrutable Perl errors. The
4321 way forward is to run <code class="code">install-tl</code> out of the installer package
4322 (<code class="code">install-tl-unx.tar.gz</code> or <code class="code">install-tl.zip</code>) instead of the
4323 installation. Feel free to also report the issue; usually the code
4324 can be easily synced up again.
4325 </p>
4326 <p>By the way, do not try to use <code class="code">install-tl</code> to adjust options or
4327 installed packages in an existing installed tree. Use <code class="code">tlmgr</code> instead.
4328 </p>
4329 <hr>
4330 </div>
4331 <div class="appendixsec-level-extent" id="install_002dtl-AUTHORS-AND-COPYRIGHT">
4332 <div class="nav-panel">
4333 <p>
4334 Previous: <a href="#install_002dtl-BUGS" accesskey="p" rel="prev">install-tl BUGS</a>, Up: <a href="#install_002dtl" accesskey="u" rel="up">install-tl</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4335 </div>
4336 <h3 class="appendixsec" id="AUTHORS-AND-COPYRIGHT"><span>A.11 AUTHORS AND COPYRIGHT<a class="copiable-link" href="#AUTHORS-AND-COPYRIGHT"> &para;</a></span></h3>
4337
4338 <p>This script and its documentation were written for the TeX Live
4339 distribution (<a class="url" href="https://tug.org/texlive">https://tug.org/texlive</a>) and both are licensed under the
4340 GNU General Public License Version 2 or later.
4341 </p>
4342 <p>$Id: install-tl 75865 2025-07-22 20:56:23Z karl $
4343 </p>
4344 <hr>
4345 </div>
4346 </div>
4347 <div class="appendix-level-extent" id="tlmgr">
4348 <div class="nav-panel">
4349 <p>
4350 Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#install_002dtl" accesskey="p" rel="prev">install-tl</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4351 </div>
4352 <h2 class="appendix" id="tlmgr-1"><span>Appendix B tlmgr<a class="copiable-link" href="#tlmgr-1"> &para;</a></span></h2>
4353
4354 <ul class="mini-toc">
4355 <li><a href="#tlmgr-NAME" accesskey="1">tlmgr NAME</a></li>
4356 <li><a href="#tlmgr-SYNOPSIS" accesskey="2">tlmgr SYNOPSIS</a></li>
4357 <li><a href="#tlmgr-DESCRIPTION" accesskey="3">tlmgr DESCRIPTION</a></li>
4358 <li><a href="#tlmgr-EXAMPLES" accesskey="4">tlmgr EXAMPLES</a></li>
4359 <li><a href="#tlmgr-OPTIONS" accesskey="5">tlmgr OPTIONS</a></li>
4360 <li><a href="#tlmgr-ACTIONS" accesskey="6">ACTIONS</a></li>
4361 <li><a href="#tlmgr-CONFIGURATION-FILE-FOR-TLMGR" accesskey="7">CONFIGURATION FILE FOR TLMGR</a></li>
4362 <li><a href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION" accesskey="8">CRYPTOGRAPHIC VERIFICATION</a></li>
4363 <li><a href="#tlmgr-USER-MODE" accesskey="9">USER MODE</a></li>
4364 <li><a href="#tlmgr-MULTIPLE-REPOSITORIES">MULTIPLE REPOSITORIES</a></li>
4365 <li><a href="#tlmgr-GUI-FOR-TLMGR">GUI FOR TLMGR</a></li>
4366 <li><a href="#tlmgr-MACHINE_002dREADABLE-OUTPUT">MACHINE-READABLE OUTPUT</a></li>
4367 <li><a href="#tlmgr-ENVIRONMENT-VARIABLES">ENVIRONMENT VARIABLES</a></li>
4368 <li><a href="#tlmgr-AUTHORS-AND-COPYRIGHT">AUTHORS AND COPYRIGHT</a></li>
4369 </ul>
4370 <hr>
4371 <div class="appendixsec-level-extent" id="tlmgr-NAME">
4372 <div class="nav-panel">
4373 <p>
4374 Next: <a href="#tlmgr-SYNOPSIS" accesskey="n" rel="next">tlmgr SYNOPSIS</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4375 </div>
4376 <h3 class="appendixsec" id="tlmgr-NAME-1"><span>B.1 tlmgr NAME<a class="copiable-link" href="#tlmgr-NAME-1"> &para;</a></span></h3>
4377
4378 <p>tlmgr - the native TeX Live Manager
4379 </p>
4380 <hr>
4381 </div>
4382 <div class="appendixsec-level-extent" id="tlmgr-SYNOPSIS">
4383 <div class="nav-panel">
4384 <p>
4385 Next: <a href="#tlmgr-DESCRIPTION" accesskey="n" rel="next">tlmgr DESCRIPTION</a>, Previous: <a href="#tlmgr-NAME" accesskey="p" rel="prev">tlmgr NAME</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4386 </div>
4387 <h3 class="appendixsec" id="tlmgr-SYNOPSIS-1"><span>B.2 tlmgr SYNOPSIS<a class="copiable-link" href="#tlmgr-SYNOPSIS-1"> &para;</a></span></h3>
4388
4389 <p>tlmgr [<em class="emph">option</em>...] <em class="emph">action</em> [<em class="emph">option</em>...] [<em class="emph">operand</em>...]
4390 </p>
4391 <hr>
4392 </div>
4393 <div class="appendixsec-level-extent" id="tlmgr-DESCRIPTION">
4394 <div class="nav-panel">
4395 <p>
4396 Next: <a href="#tlmgr-EXAMPLES" accesskey="n" rel="next">tlmgr EXAMPLES</a>, Previous: <a href="#tlmgr-SYNOPSIS" accesskey="p" rel="prev">tlmgr SYNOPSIS</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4397 </div>
4398 <h3 class="appendixsec" id="tlmgr-DESCRIPTION-1"><span>B.3 tlmgr DESCRIPTION<a class="copiable-link" href="#tlmgr-DESCRIPTION-1"> &para;</a></span></h3>
4399
4400 <p><strong class="strong">tlmgr</strong> manages an existing TeX Live installation, both packages and
4401 configuration options. For information on initially downloading and
4402 installing TeX Live, see <a class="url" href="https://tug.org/texlive/acquire.html">https://tug.org/texlive/acquire.html</a>.
4403 </p>
4404 <p>The most up-to-date version of this documentation (updated nightly from
4405 the development sources) is available at
4406 <a class="url" href="https://tug.org/texlive/tlmgr.html">https://tug.org/texlive/tlmgr.html</a>, along with procedures for updating
4407 <code class="code">tlmgr</code> itself and information about test versions.
4408 </p>
4409 <p>TeX Live is organized into a few top-level <em class="emph">schemes</em>, each of which is
4410 specified as a different set of <em class="emph">collections</em> and <em class="emph">packages</em>, where a
4411 collection is a set of packages, and a package is what contains actual
4412 files. Schemes typically contain a mix of collections and packages, but
4413 each package is included in exactly one collection, no more and no less.
4414 A TeX Live installation can be customized and managed at any level.
4415 </p>
4416 <p>See <a class="url" href="https://tug.org/texlive/doc">https://tug.org/texlive/doc</a> for all the TeX Live documentation
4417 available.
4418 </p>
4419 <hr>
4420 </div>
4421 <div class="appendixsec-level-extent" id="tlmgr-EXAMPLES">
4422 <div class="nav-panel">
4423 <p>
4424 Next: <a href="#tlmgr-OPTIONS" accesskey="n" rel="next">tlmgr OPTIONS</a>, Previous: <a href="#tlmgr-DESCRIPTION" accesskey="p" rel="prev">tlmgr DESCRIPTION</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4425 </div>
4426 <h3 class="appendixsec" id="tlmgr-EXAMPLES-1"><span>B.4 tlmgr EXAMPLES<a class="copiable-link" href="#tlmgr-EXAMPLES-1"> &para;</a></span></h3>
4427
4428 <p>After successfully installing TeX Live, here are a few common operations
4429 with <code class="code">tlmgr</code>:
4430 </p>
4431 <dl class="table">
4432 <dt><code class="code">tlmgr option repository ctan</code></dt>
4433 <dd><a class="anchor" id="tlmgr-tlmgr-option-repository-ctan"></a>
4434 </dd>
4435 <dt><code class="code">tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet</code></dt>
4436 <dd><a class="anchor" id="tlmgr-tlmgr-option-repository-https_003a_002f_002fmirror_002ectan_002eorg_002fsystems_002ftexlive_002ftlnet"></a>
4437 <p>Tell <code class="code">tlmgr</code> to use a nearby CTAN mirror for future updates; useful if
4438 you installed TeX Live from the DVD image and want to have continuing
4439 updates. The two commands are equivalent; <code class="code">ctan</code> is just an alias for
4440 the given url.
4441 </p>
4442 <p>Caveat: <code class="code">mirror.ctan.org</code> resolves to many different hosts, and they
4443 are not perfectly synchronized; we recommend updating only daily (at
4444 most), and not more often. You can choose a particular mirror if
4445 problems; the list of all CTAN mirrors with the status of each is at
4446 <a class="url" href="https://ctan.org/mirrors/mirmon">https://ctan.org/mirrors/mirmon</a>.
4447 </p>
4448 </dd>
4449 <dt><code class="code">tlmgr update --list</code></dt>
4450 <dd><a class="anchor" id="tlmgr-tlmgr-update-_002d_002dlist"></a>
4451 <p>Report what would be updated without actually updating anything.
4452 </p>
4453 </dd>
4454 <dt><code class="code">tlmgr update --all</code></dt>
4455 <dd><a class="anchor" id="tlmgr-tlmgr-update-_002d_002dall"></a>
4456 <p>Make your local TeX installation correspond to what is in the package
4457 repository (typically useful when updating from CTAN).
4458 </p>
4459 </dd>
4460 <dt><code class="code">tlmgr info</code> <em class="emph">what</em></dt>
4461 <dd><a class="anchor" id="tlmgr-tlmgr-info-what"></a>
4462 <p>Display detailed information about a package <em class="emph">what</em>, such as the installation
4463 status and description, of searches for <em class="emph">what</em> in all packages.
4464 </p>
4465 </dd>
4466 <dt><code class="code">tlmgr bug</code> <em class="emph">what</em></dt>
4467 <dd><a class="anchor" id="tlmgr-tlmgr-bug-what"></a>
4468 <p>Display available bug-reporting information for <em class="emph">what</em>, a package or
4469 file name.
4470 </p>
4471 </dd>
4472 </dl>
4473
4474 <p>For all the capabilities and details of <code class="code">tlmgr</code>, please read the
4475 following voluminous information.
4476 </p>
4477 <hr>
4478 </div>
4479 <div class="appendixsec-level-extent" id="tlmgr-OPTIONS">
4480 <div class="nav-panel">
4481 <p>
4482 Next: <a href="#tlmgr-ACTIONS" accesskey="n" rel="next">ACTIONS</a>, Previous: <a href="#tlmgr-EXAMPLES" accesskey="p" rel="prev">tlmgr EXAMPLES</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4483 </div>
4484 <h3 class="appendixsec" id="tlmgr-OPTIONS-1"><span>B.5 tlmgr OPTIONS<a class="copiable-link" href="#tlmgr-OPTIONS-1"> &para;</a></span></h3>
4485
4486 <p>The following options to <code class="code">tlmgr</code> are global options, not specific to
4487 any action. All options, whether global or action-specific, can be
4488 given anywhere on the command line, and in any order. The first
4489 non-option argument will be the main action. In all cases,
4490 <code class="code">--</code><em class="emph">option</em> and <code class="code">-</code><em class="emph">option</em> are equivalent, and an <code class="code">=</code> is optional
4491 between an option name and its value.
4492 </p>
4493 <dl class="table">
4494 <dt><strong class="strong">--repository</strong> <em class="emph">url|path</em></dt>
4495 <dd><a class="anchor" id="tlmgr-_002d_002drepository-url_007cpath"></a>
4496 <p>Specify the package repository from which packages should be installed
4497 or updated, either a local directory or network location, as below. This
4498 overridesthe default package repository found in the installation&rsquo;s TeX
4499 Live Package Database (a.k.a. the TLPDB, which is given entirely in the
4500 file <code class="code">tlpkg/texlive.tlpdb</code>).
4501 </p>
4502 <p>This <code class="code">--repository</code> option changes the location only for the current
4503 run; to make a permanent change, use <code class="code">option repository</code> (see the
4504 <a class="ref" href="#tlmgr-option">option</a> action).
4505 </p>
4506 <p>As an example, you can choose a particular CTAN mirror with something
4507 like this:
4508 </p>
4509 <pre class="verbatim"> -repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet
4510 </pre>
4511 <p>Of course a real hostname and its particular top-level CTAN directory
4512 have to be specified. The list of CTAN mirrors is available at
4513 <a class="url" href="https://ctan.org/mirrors/mirmon">https://ctan.org/mirrors/mirmon</a>.
4514 </p>
4515 <p>Here&rsquo;s an example of using a local directory:
4516 </p>
4517 <pre class="verbatim"> -repository /local/TL/repository
4518 </pre>
4519 <p>For backward compatibility and convenience, <code class="code">--location</code> and <code class="code">--repo</code>
4520 are accepted as aliases for this option.
4521 </p>
4522 <p>Locations can be specified as any of the following:
4523 </p>
4524 <dl class="table">
4525 <dt><code class="code">/some/local/dir</code></dt>
4526 <dd><a class="anchor" id="tlmgr-_002fsome_002flocal_002fdir"></a>
4527 </dd>
4528 <dt><code class="code">file:/some/local/dir</code></dt>
4529 <dd><a class="anchor" id="tlmgr-file_003a_002fsome_002flocal_002fdir"></a>
4530 <p>Equivalent ways of specifying a local directory.
4531 </p>
4532 </dd>
4533 <dt><code class="code">ctan</code></dt>
4534 <dd><a class="anchor" id="tlmgr-ctan"></a>
4535 </dd>
4536 <dt><code class="code">https://mirror.ctan.org/systems/texlive/tlnet</code></dt>
4537 <dd><a class="anchor" id="tlmgr-https_003a_002f_002fmirror_002ectan_002eorg_002fsystems_002ftexlive_002ftlnet"></a>
4538 <p>Pick a CTAN mirror automatically, trying for one that is both nearby and
4539 up-to-date. The chosen mirror is used for the entire download. The bare
4540 <code class="code">ctan</code> is merely an alias for the full url. (See <a class="url" href="https://ctan.org">https://ctan.org</a> for
4541 more about CTAN and its mirrors.)
4542 </p>
4543 </dd>
4544 <dt><code class="code">http://server/path/to/tlnet</code></dt>
4545 <dd><a class="anchor" id="tlmgr-http_003a_002f_002fserver_002fpath_002fto_002ftlnet"></a>
4546 <p>Standard HTTP. If the (default) LWP method is used, persistent
4547 connections are supported. TL can also use <code class="code">curl</code> or <code class="code">wget</code> to do the
4548 downloads, or an arbitrary user-specified program, as described in the
4549 <code class="code">tlmgr</code> documentation
4550 (<a class="url" href="https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES">https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES</a>).
4551 </p>
4552 </dd>
4553 <dt><code class="code">https://server/path/to/tlnet</code></dt>
4554 <dd><a class="anchor" id="tlmgr-https_003a_002f_002fserver_002fpath_002fto_002ftlnet"></a>
4555 <p>Again, if the (default) LWP method is used, this supports persistent
4556 connections. Unfortunately, some versions of <code class="code">wget</code> and <code class="code">curl</code> do not
4557 support https, and even when <code class="code">wget</code> supports https, certificates may be
4558 rejected even when the certificate is fine, due to a lack of local
4559 certificate roots. The simplest workaround for this problem is to use
4560 http or ftp.
4561 </p>
4562 </dd>
4563 <dt><code class="code">ftp://server/path/to/tlnet</code></dt>
4564 <dd><a class="anchor" id="tlmgr-ftp_003a_002f_002fserver_002fpath_002fto_002ftlnet"></a>
4565 <p>If the (default) LWP method is used, persistent connections are
4566 supported.
4567 </p>
4568 </dd>
4569 <dt><code class="code">user@machine:/path/to/tlnet</code></dt>
4570 <dd><a class="anchor" id="tlmgr-user_0040machine_003a_002fpath_002fto_002ftlnet"></a>
4571 </dd>
4572 <dt><code class="code">scp://user@machine/path/to/tlnet</code></dt>
4573 <dd><a class="anchor" id="tlmgr-scp_003a_002f_002fuser_0040machine_002fpath_002fto_002ftlnet"></a>
4574 </dd>
4575 <dt><code class="code">ssh://user@machine/path/to/tlnet</code></dt>
4576 <dd><a class="anchor" id="tlmgr-ssh_003a_002f_002fuser_0040machine_002fpath_002fto_002ftlnet"></a>
4577 <p>These forms are equivalent; they all use <code class="code">scp</code> to transfer files. Using
4578 <code class="code">ssh-agent</code> is recommended. (Info:
4579 <a class="url" href="https://en.wikipedia.org/wiki/OpenSSH">https://en.wikipedia.org/wiki/OpenSSH</a>,
4580 <a class="url" href="https://en.wikipedia.org/wiki/Ssh-agent">https://en.wikipedia.org/wiki/Ssh-agent</a>.)
4581 </p>
4582 </dd>
4583 </dl>
4584
4585 <p>If the repository is on the network, trailing <code class="code">/</code> characters and/or
4586 trailing <code class="code">/tlpkg</code> and/or <code class="code">/archive</code> components are ignored.
4587 </p>
4588 </dd>
4589 <dt><strong class="strong">--gui</strong> [<em class="emph">action</em>]</dt>
4590 <dd><a class="anchor" id="tlmgr-_002d_002dgui-_005baction_005d"></a>
4591 <p>Two notable GUI front-ends for <code class="code">tlmgr</code>, <code class="code">tlshell</code> and <code class="code">tlcockpit</code>,
4592 are started up as separate programs; see their own documentation.
4593 </p>
4594 <p><code class="code">tlmgr</code> itself has a graphical interface as well as the command line
4595 interface. You can give the option to invoke it, <code class="code">--gui</code>, together with
4596 an action to be brought directly into the respective screen of the GUI.
4597 For example, running
4598 </p>
4599 <pre class="verbatim"> tlmgr --gui update
4600 </pre>
4601 <p>starts you directly at the update screen. If no action is given, the
4602 GUI will be started at the main screen. See <a class="ref" href="#tlmgr-GUI-FOR-TLMGR">GUI FOR TLMGR</a>.
4603 </p>
4604 <p>However, the native GUI requires Perl/TK, which is no longer included in
4605 TeX Live&rsquo;s Perl distribution for Windows. You may find <code class="code">tlshell</code> or
4606 <code class="code">tlcockpit</code> easier to work with.
4607 </p>
4608 </dd>
4609 <dt><strong class="strong">--gui-lang</strong> <em class="emph">llcode</em></dt>
4610 <dd><a class="anchor" id="tlmgr-_002d_002dgui_002dlang-llcode"></a>
4611 <p>By default, the GUI tries to deduce your language from the environment
4612 (on Windows via the registry, on Unix via <code class="code">LC_MESSAGES</code>). If that fails
4613 you can select a different language by giving this option with a
4614 language code (based on ISO 639-1). Currently supported (but not
4615 necessarily completely translated) are: English&nbsp;(en,&nbsp;default)<!-- /@w -->,
4616 Czech&nbsp;(cs)<!-- /@w -->, German&nbsp;(de)<!-- /@w -->, French&nbsp;(fr)<!-- /@w -->, Italian&nbsp;(it)<!-- /@w -->,
4617 Japanese&nbsp;(ja)<!-- /@w -->, Dutch&nbsp;(nl)<!-- /@w -->, Polish&nbsp;(pl)<!-- /@w -->, Brazilian&nbsp;Portuguese&nbsp;(pt_BR)<!-- /@w -->, Russian&nbsp;(ru)<!-- /@w -->, Slovak&nbsp;(sk)<!-- /@w -->, Slovenian&nbsp;(sl)<!-- /@w -->, Serbian&nbsp;(sr)<!-- /@w -->, Ukrainian&nbsp;(uk)<!-- /@w -->, Vietnamese&nbsp;(vi)<!-- /@w -->, simplified&nbsp;Chinese&nbsp;(zh_CN)<!-- /@w -->, and traditional&nbsp;Chinese&nbsp;(zh_TW)<!-- /@w -->.
4618 </p>
4619 <p>tlshell shares its message catalog with tlmgr.
4620 </p>
4621 </dd>
4622 <dt><strong class="strong">--command-logfile</strong> <em class="emph">file</em></dt>
4623 <dd><a class="anchor" id="tlmgr-_002d_002dcommand_002dlogfile-file"></a>
4624 <p><code class="code">tlmgr</code> logs the output of all programs invoked (mktexlr, mtxrun, fmtutil,
4625 updmap) to a separate log file, by default
4626 <code class="code">TEXMFSYSVAR/web2c/tlmgr-commands.log</code>. This option allows you to specify a
4627 different file for the log.
4628 </p>
4629 </dd>
4630 <dt><strong class="strong">--debug-translation</strong></dt>
4631 <dd><a class="anchor" id="tlmgr-_002d_002ddebug_002dtranslation"></a>
4632 <p>In GUI mode, this switch tells <code class="code">tlmgr</code> to report any untranslated (or
4633 missing) messages to standard error. This can help translators to see
4634 what remains to be done.
4635 </p>
4636 </dd>
4637 <dt><strong class="strong">--machine-readable</strong></dt>
4638 <dd><a class="anchor" id="tlmgr-_002d_002dmachine_002dreadable"></a>
4639 <p>Instead of the normal output intended for human consumption, write (to
4640 standard output) a fixed format more suitable for machine parsing. See
4641 the <a class="ref" href="#tlmgr-MACHINE_002dREADABLE-OUTPUT">MACHINE-READABLE OUTPUT</a> section below.
4642 </p>
4643 </dd>
4644 <dt><strong class="strong">--no-execute-actions</strong></dt>
4645 <dd><a class="anchor" id="tlmgr-_002d_002dno_002dexecute_002dactions"></a>
4646 <p>Suppress the execution of the execute actions as defined in the tlpsrc
4647 files. Unless you are going to do the postprocessing yourself (as, for
4648 example, <code class="code">install-tl</code> does), this shouldn&rsquo;t be specified. Otherwise,
4649 format files and the filename database will become stale, among other
4650 problems.
4651 </p>
4652 </dd>
4653 <dt><strong class="strong">--package-logfile</strong> <em class="emph">file</em></dt>
4654 <dd><a class="anchor" id="tlmgr-_002d_002dpackage_002dlogfile-file"></a>
4655 <p><code class="code">tlmgr</code> logs all package actions (install, remove, update, failed
4656 updates, failed restores) to a separate log file, by default
4657 <code class="code">TEXMFSYSVAR/web2c/tlmgr.log</code>. This option allows you to specify a
4658 different file for the log.
4659 </p>
4660 </dd>
4661 <dt><strong class="strong">--pause</strong></dt>
4662 <dd><a class="anchor" id="tlmgr-_002d_002dpause"></a>
4663 <p>This option makes <code class="code">tlmgr</code> wait for user input before exiting. Useful on
4664 Windows to avoid disappearing command windows.
4665 </p>
4666 </dd>
4667 <dt><strong class="strong">--persistent-downloads</strong></dt>
4668 <dd><a class="anchor" id="tlmgr-_002d_002dpersistent_002ddownloads"></a>
4669 </dd>
4670 <dt><strong class="strong">--no-persistent-downloads</strong></dt>
4671 <dd><a class="anchor" id="tlmgr-_002d_002dno_002dpersistent_002ddownloads"></a>
4672 <p>For network-based installations, this option (on by default) makes
4673 <code class="code">tlmgr</code> try to set up a persistent connection (using the <code class="code">LWP</code> Perl
4674 module). The idea is to open and reuse only one connection per session
4675 between your computer and the server, instead of initiating a new
4676 download for each package.
4677 </p>
4678 <p>If this is not possible, <code class="code">tlmgr</code> will fall back to using <code class="code">wget</code>. To
4679 disable these persistent connections, use <code class="code">--no-persistent-downloads</code>.
4680 </p>
4681 </dd>
4682 <dt><strong class="strong">--pin-file</strong></dt>
4683 <dd><a class="anchor" id="tlmgr-_002d_002dpin_002dfile"></a>
4684 <p>Change the pinning file location from <code class="code">TEXMFLOCAL/tlpkg/pinning.txt</code>
4685 (see <a class="ref" href="#tlmgr-Pinning">Pinning</a> below). Documented only for completeness, as this is
4686 only useful in debugging.
4687 </p>
4688 </dd>
4689 <dt><strong class="strong">--usermode</strong></dt>
4690 <dd><a class="anchor" id="tlmgr-_002d_002dusermode"></a>
4691 <p>Activates user mode for this run of <code class="code">tlmgr</code>; see <a class="ref" href="#tlmgr-USER-MODE">USER MODE</a> below.
4692 </p>
4693 </dd>
4694 <dt><strong class="strong">--usertree</strong> <em class="emph">dir</em></dt>
4695 <dd><a class="anchor" id="tlmgr-_002d_002dusertree-dir"></a>
4696 <p>Uses <em class="emph">dir</em> for the tree in user mode; see <a class="ref" href="#tlmgr-USER-MODE">USER MODE</a> below.
4697 </p>
4698 </dd>
4699 <dt><strong class="strong">--verify-repo=[none|main|all]</strong></dt>
4700 <dd><a class="anchor" id="tlmgr-_002d_002dverify_002drepo_003d_005bnone_007cmain_007call_005d"></a>
4701 <p>Defines the level of verification done: If <code class="code">none</code> is specified, no
4702 verification whatsoever is done. If <code class="code">main</code> is given and a working GnuPG
4703 (<code class="code">gpg</code>) binary is available, all repositories are checked, but only the
4704 main repository is required to be signed. If <code class="code">all</code> is given, then all
4705 repositories need to be signed. See <a class="ref" href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION">CRYPTOGRAPHIC VERIFICATION</a> below
4706 for details.
4707 </p>
4708 </dd>
4709 </dl>
4710
4711 <p>The standard options for TeX Live programs are also accepted:
4712 <code class="code">--help/-h/-?</code>, <code class="code">--version</code>, <code class="code">-q</code> (no informational messages), <code class="code">-v</code>
4713 (debugging messages, can be repeated). For the details about these, see
4714 the <code class="code">TeXLive::TLUtils</code> documentation.
4715 </p>
4716 <p>The <code class="code">--version</code> option shows version information about the TeX Live
4717 release and about the <code class="code">tlmgr</code> script itself. If <code class="code">-v</code> is also given,
4718 revision number for the loaded TeX Live Perl modules are shown, too.
4719 </p>
4720 <hr>
4721 </div>
4722 <div class="appendixsec-level-extent" id="tlmgr-ACTIONS">
4723 <div class="nav-panel">
4724 <p>
4725 Next: <a href="#tlmgr-CONFIGURATION-FILE-FOR-TLMGR" accesskey="n" rel="next">CONFIGURATION FILE FOR TLMGR</a>, Previous: <a href="#tlmgr-OPTIONS" accesskey="p" rel="prev">tlmgr OPTIONS</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4726 </div>
4727 <h3 class="appendixsec" id="ACTIONS"><span>B.6 ACTIONS<a class="copiable-link" href="#ACTIONS"> &para;</a></span></h3>
4728
4729 <ul class="mini-toc">
4730 <li><a href="#tlmgr-help" accesskey="1">help</a></li>
4731 <li><a href="#tlmgr-version" accesskey="2">version</a></li>
4732 <li><a href="#tlmgr-backup" accesskey="3">backup</a></li>
4733 <li><a href="#tlmgr-bug-_005bsearch_002dstring_005d" accesskey="4">bug [<em class="emph">search-string</em>]</a></li>
4734 <li><a href="#tlmgr-candidates-pkg" accesskey="5">candidates <em class="emph">pkg</em></a></li>
4735 <li><a href="#tlmgr-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d" accesskey="6">check [<em class="emph">option</em>...] [depends|executes|files|runfiles|texmfdbs|all]</a></li>
4736 <li><a href="#tlmgr-conf" accesskey="7">conf</a></li>
4737 <li><a href="#tlmgr-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d" accesskey="8">dump-tlpdb [<em class="emph">option</em>...] [--json]</a></li>
4738 <li><a href="#tlmgr-generate" accesskey="9">generate</a></li>
4739 <li><a href="#tlmgr-gui">gui</a></li>
4740 <li><a href="#tlmgr-info">info</a></li>
4741 <li><a href="#tlmgr-init_002dusertree">init-usertree</a></li>
4742 <li><a href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">install [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a></li>
4743 <li><a href="#tlmgr-key">key</a></li>
4744 <li><a href="#tlmgr-list">list</a></li>
4745 <li><a href="#tlmgr-option">option</a></li>
4746 <li><a href="#tlmgr-paper">paper</a></li>
4747 <li><a href="#tlmgr-path">path</a></li>
4748 <li><a href="#tlmgr-pinning">pinning</a></li>
4749 <li><a href="#tlmgr-platform">platform</a></li>
4750 <li><a href="#tlmgr-postaction">postaction</a></li>
4751 <li><a href="#tlmgr-print_002dplatform">print-platform</a></li>
4752 <li><a href="#tlmgr-print_002dplatform_002dinfo">print-platform-info</a></li>
4753 <li><a href="#tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">remove [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a></li>
4754 <li><a href="#tlmgr-repository">repository</a></li>
4755 <li><a href="#tlmgr-restore">restore</a></li>
4756 <li><a href="#tlmgr-search">search</a></li>
4757 <li><a href="#tlmgr-shell">shell</a></li>
4758 <li><a href="#tlmgr-show">show</a></li>
4759 <li><a href="#tlmgr-uninstall">uninstall</a></li>
4760 <li><a href="#tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d">update [<em class="emph">option</em>...] [<em class="emph">pkg</em>...]</a></li>
4761 </ul>
4762 <hr>
4763 <div class="appendixsubsec-level-extent" id="tlmgr-help">
4764 <div class="nav-panel">
4765 <p>
4766 Next: <a href="#tlmgr-version" accesskey="n" rel="next">version</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4767 </div>
4768 <h4 class="appendixsubsec" id="help"><span>B.6.1 help<a class="copiable-link" href="#help"> &para;</a></span></h4>
4769
4770 <p>Display this help information and exit (same as <code class="code">--help</code>, and on the
4771 web at <a class="url" href="https://tug.org/texlive/doc/tlmgr.html">https://tug.org/texlive/doc/tlmgr.html</a>). Sometimes the
4772 <code class="code">perldoc</code> and/or <code class="code">PAGER</code> programs on the system have problems,
4773 resulting in control characters being literally output. This can&rsquo;t
4774 always be detected, but you can set the <code class="code">NOPERLDOC</code> environment
4775 variable and <code class="code">perldoc</code> will not be used.
4776 </p>
4777 <hr>
4778 </div>
4779 <div class="appendixsubsec-level-extent" id="tlmgr-version">
4780 <div class="nav-panel">
4781 <p>
4782 Next: <a href="#tlmgr-backup" accesskey="n" rel="next">backup</a>, Previous: <a href="#tlmgr-help" accesskey="p" rel="prev">help</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4783 </div>
4784 <h4 class="appendixsubsec" id="version"><span>B.6.2 version<a class="copiable-link" href="#version"> &para;</a></span></h4>
4785
4786 <p>Gives version information (same as <code class="code">--version</code>).
4787 </p>
4788 <p>If <code class="code">-v</code> has been given the revisions of the used modules are reported, too.
4789 </p>
4790 <hr>
4791 </div>
4792 <div class="appendixsubsec-level-extent" id="tlmgr-backup">
4793 <div class="nav-panel">
4794 <p>
4795 Next: <a href="#tlmgr-bug-_005bsearch_002dstring_005d" accesskey="n" rel="next">bug [<em class="emph">search-string</em>]</a>, Previous: <a href="#tlmgr-version" accesskey="p" rel="prev">version</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4796 </div>
4797 <h4 class="appendixsubsec" id="backup"><span>B.6.3 backup<a class="copiable-link" href="#backup"> &para;</a></span></h4>
4798
4799 <dl class="table">
4800 <dt><strong class="strong">backup [<em class="emph">option</em>...] --all</strong></dt>
4801 <dd><a class="anchor" id="tlmgr-backup-_005boption_002e_002e_002e_005d-_002d_002dall"></a>
4802 </dd>
4803 <dt><strong class="strong">backup [<em class="emph">option</em>...] <em class="emph">pkg</em>...</strong></dt>
4804 <dd><a class="anchor" id="tlmgr-backup-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"></a>
4805 <p>If the <code class="code">--clean</code> option is not specified, this action makes a backup of
4806 the given packages, or all packages given <code class="code">--all</code>. These backups are
4807 saved to the value of the <code class="code">--backupdir</code> option, if that is an existing
4808 and writable directory. If <code class="code">--backupdir</code> is not given, the <code class="code">backupdir</code>
4809 option setting in the TLPDB is used, if present. If both are missing, no
4810 backups are made. (The installer sets <code class="code">backupdir</code> to
4811 <code class="code">.../tlpkg/backups</code>, under the TL root installation directory, so it is
4812 usually defined; see the <a class="ref" href="#tlmgr-option">option</a> description for more information.)
4813 </p>
4814 <p>If the <code class="code">--clean</code> option is specified, backups are pruned (removed)
4815 instead of saved. The optional integer value <em class="emph">N</em> may be specified to
4816 set the number of backups that will be retained when cleaning. If <code class="code">N</code>
4817 is not given, the value of the <code class="code">autobackup</code> option is used. If both are
4818 missing, an error is issued. For more details of backup pruning, see
4819 the <code class="code">option</code> action.
4820 </p>
4821 <p>Options:
4822 </p>
4823 <dl class="table">
4824 <dt><strong class="strong">--backupdir</strong> <em class="emph">directory</em></dt>
4825 <dd><a class="anchor" id="tlmgr-_002d_002dbackupdir-directory"></a>
4826 <p>Overrides the <code class="code">backupdir</code> option setting in the TLPDB.
4827 The <em class="emph">directory</em> argument is required and must specify an existing,
4828 writable directory where backups are to be placed.
4829 </p>
4830 </dd>
4831 <dt><strong class="strong">--all</strong></dt>
4832 <dd><a class="anchor" id="tlmgr-_002d_002dall"></a>
4833 <p>If <code class="code">--clean</code> is not specified, make a backup of all packages in the TeX
4834 Live installation; this will take quite a lot of space and time. If
4835 <code class="code">--clean</code> is specified, all packages are pruned.
4836 </p>
4837 </dd>
4838 <dt><strong class="strong">--clean</strong>[=<em class="emph">N</em>]</dt>
4839 <dd><a class="anchor" id="tlmgr-_002d_002dclean_005b_003dN_005d"></a>
4840 <p>Instead of making backups, prune the backup directory of old backups, as
4841 explained above. The optional integer argument <em class="emph">N</em> overrides the
4842 <code class="code">autobackup</code> option set in the TLPDB. You must use <code class="code">--all</code> or a list
4843 of packages together with this option, as desired.
4844 </p>
4845 </dd>
4846 <dt><strong class="strong">--dry-run</strong></dt>
4847 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun"></a>
4848 <p>Nothing is actually backed up or removed; instead, the actions to be
4849 performed are written to the terminal.
4850 </p>
4851 </dd>
4852 </dl>
4853
4854 </dd>
4855 </dl>
4856
4857 <hr>
4858 </div>
4859 <div class="appendixsubsec-level-extent" id="tlmgr-bug-_005bsearch_002dstring_005d">
4860 <div class="nav-panel">
4861 <p>
4862 Next: <a href="#tlmgr-candidates-pkg" accesskey="n" rel="next">candidates <em class="emph">pkg</em></a>, Previous: <a href="#tlmgr-backup" accesskey="p" rel="prev">backup</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4863 </div>
4864 <h4 class="appendixsubsec" id="bug-_005bsearch_002dstring_005d"><span>B.6.4 bug [<em class="emph">search-string</em>]<a class="copiable-link" href="#bug-_005bsearch_002dstring_005d"> &para;</a></span></h4>
4865
4866 <p>Searches for <em class="emph">search-string</em> (prompted for, if not given) as a package
4867 name and in package descriptions, as complete words, and in filenames,
4868 as any substring, and outputs bug-reporting and other information for
4869 the package selected from the results.
4870 </p>
4871 <p>The search is equivalent to <code class="code">tlmgr search --word --file</code> <em class="emph">search-string</em>.
4872 Thus, <em class="emph">search-string</em> is interpreted as a (Perl) regular expression.
4873 </p>
4874 <hr>
4875 </div>
4876 <div class="appendixsubsec-level-extent" id="tlmgr-candidates-pkg">
4877 <div class="nav-panel">
4878 <p>
4879 Next: <a href="#tlmgr-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d" accesskey="n" rel="next">check [<em class="emph">option</em>...] [depends|executes|files|runfiles|texmfdbs|all]</a>, Previous: <a href="#tlmgr-bug-_005bsearch_002dstring_005d" accesskey="p" rel="prev">bug [<em class="emph">search-string</em>]</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4880 </div>
4881 <h4 class="appendixsubsec" id="candidates-pkg"><span>B.6.5 candidates <em class="emph">pkg</em><a class="copiable-link" href="#candidates-pkg"> &para;</a></span></h4>
4882
4883 <p>Shows the available candidate repositories for package <em class="emph">pkg</em>.
4884 See <a class="ref" href="#tlmgr-MULTIPLE-REPOSITORIES">MULTIPLE REPOSITORIES</a> below.
4885 </p>
4886 <hr>
4887 </div>
4888 <div class="appendixsubsec-level-extent" id="tlmgr-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d">
4889 <div class="nav-panel">
4890 <p>
4891 Next: <a href="#tlmgr-conf" accesskey="n" rel="next">conf</a>, Previous: <a href="#tlmgr-candidates-pkg" accesskey="p" rel="prev">candidates <em class="emph">pkg</em></a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4892 </div>
4893 <h4 class="appendixsubsec" id="check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d"><span>B.6.6 check [<em class="emph">option</em>...] [depends|executes|files|runfiles|texmfdbs|all]<a class="copiable-link" href="#check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d"> &para;</a></span></h4>
4894
4895 <p>Execute one (or all) check(s) of the consistency of the installation.
4896 If no problems are found, there will be no output. (To get a view of
4897 what is being done, run <code class="code">tlmgr -v check</code>.)
4898 </p>
4899 <dl class="table">
4900 <dt><strong class="strong">depends</strong></dt>
4901 <dd><a class="anchor" id="tlmgr-depends"></a>
4902 <p>Lists those packages which occur as dependencies in an installed collection,
4903 but are themselves not installed, and those packages which are not
4904 contained in any collection.
4905 </p>
4906 <p>If you call <code class="code">tlmgr check collections</code> this test will be carried out
4907 instead since former versions for <code class="code">tlmgr</code> called it that way.
4908 </p>
4909 </dd>
4910 <dt><strong class="strong">executes</strong></dt>
4911 <dd><a class="anchor" id="tlmgr-executes"></a>
4912 <p>Check that the files referred to by <code class="code">execute</code> directives in the TeX
4913 Live Database are present.
4914 </p>
4915 </dd>
4916 <dt><strong class="strong">files</strong></dt>
4917 <dd><a class="anchor" id="tlmgr-files"></a>
4918 <p>Checks that all files listed in the local TLPDB (<code class="code">texlive.tlpdb</code>) are
4919 actually present, and lists those missing.
4920 </p>
4921 </dd>
4922 <dt><strong class="strong">runfiles</strong></dt>
4923 <dd><a class="anchor" id="tlmgr-runfiles"></a>
4924 <p>List those filenames that are occurring more than one time in the
4925 runfiles sections, except for known duplicates.
4926 </p>
4927 </dd>
4928 <dt><strong class="strong">texmfdbs</strong></dt>
4929 <dd><a class="anchor" id="tlmgr-texmfdbs"></a>
4930 <p>Checks related to the <code class="code">ls-R</code> files. If you have defined new trees, or
4931 changed the <code class="code">TEXMF</code> or <code class="code">TEXMFDBS</code> variables, it can&rsquo;t hurt to run
4932 this. It checks that:
4933 </p>
4934 <dl class="table">
4935 <dt>- all items in <code class="code">TEXMFDBS</code> have the <code class="code">!!</code> prefix.</dt>
4936 <dd><a class="anchor" id="tlmgr-_002d-all-items-in-TEXMFDBS-have-the-_0021_0021-prefix_002e"></a>
4937 </dd>
4938 <dt>- all items in <code class="code">TEXMFBDS</code> have an <code class="code">ls-R</code> file (if they exist at all).</dt>
4939 <dd><a class="anchor" id="tlmgr-_002d-all-items-in-TEXMFBDS-have-an-ls_002dR-file-_0028if-they-exist-at-all_0029_002e"></a>
4940 </dd>
4941 <dt>- all items in <code class="code">TEXMF</code> with <code class="code">!!</code> are listed in <code class="code">TEXMFDBS</code>.</dt>
4942 <dd><a class="anchor" id="tlmgr-_002d-all-items-in-TEXMF-with-_0021_0021-are-listed-in-TEXMFDBS_002e"></a>
4943 </dd>
4944 <dt>- all items in <code class="code">TEXMF</code> with an <code class="code">ls-R</code> file are listed in <code class="code">TEXMFDBS</code>.</dt>
4945 <dd><a class="anchor" id="tlmgr-_002d-all-items-in-TEXMF-with-an-ls_002dR-file-are-listed-in-TEXMFDBS_002e"></a>
4946 </dd>
4947 </dl>
4948
4949 </dd>
4950 </dl>
4951
4952 <p>Options:
4953 </p>
4954 <dl class="table">
4955 <dt><strong class="strong">--use-svn</strong></dt>
4956 <dd><a class="anchor" id="tlmgr-_002d_002duse_002dsvn"></a>
4957 <p>Use the output of <code class="code">svn status</code> instead of listing the files; for
4958 checking the TL development repository. (This is run nightly.)
4959 </p>
4960 </dd>
4961 </dl>
4962
4963 <hr>
4964 </div>
4965 <div class="appendixsubsec-level-extent" id="tlmgr-conf">
4966 <div class="nav-panel">
4967 <p>
4968 Next: <a href="#tlmgr-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d" accesskey="n" rel="next">dump-tlpdb [<em class="emph">option</em>...] [--json]</a>, Previous: <a href="#tlmgr-check-_005boption_002e_002e_002e_005d-_005bdepends_007cexecutes_007cfiles_007crunfiles_007ctexmfdbs_007call_005d" accesskey="p" rel="prev">check [<em class="emph">option</em>...] [depends|executes|files|runfiles|texmfdbs|all]</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
4969 </div>
4970 <h4 class="appendixsubsec" id="conf"><span>B.6.7 conf<a class="copiable-link" href="#conf"> &para;</a></span></h4>
4971
4972 <dl class="table">
4973 <dt><strong class="strong">conf [texmf|tlmgr|updmap [--conffile <em class="emph">file</em>] [--delete] [<em class="emph">key</em> [<em class="emph">value</em>]]]</strong></dt>
4974 <dd><a class="anchor" id="tlmgr-conf-_005btexmf_007ctlmgr_007cupdmap-_005b_002d_002dconffile-file_005d-_005b_002d_002ddelete_005d-_005bkey-_005bvalue_005d_005d_005d"></a>
4975 </dd>
4976 <dt><strong class="strong">conf auxtrees [--conffile <em class="emph">file</em>] [show|add|remove] [<em class="emph">value</em>]</strong></dt>
4977 <dd><a class="anchor" id="tlmgr-conf-auxtrees-_005b_002d_002dconffile-file_005d-_005bshow_007cadd_007cremove_005d-_005bvalue_005d"></a>
4978 <p>With only <code class="code">conf</code>, show general configuration information for TeX Live,
4979 including active configuration files, path settings, and more. This is
4980 like running <code class="code">texconfig conf</code>, but works on all supported platforms.
4981 </p>
4982 <p>With one of <code class="code">conf texmf</code>, <code class="code">conf tlmgr</code>, or <code class="code">conf updmap</code>, shows all
4983 key/value pairs (i.e., all settings) as saved in <code class="code">ROOT/texmf.cnf</code>, the
4984 user-specific <code class="code">tlmgr</code> configuration file (see below), or the first
4985 found (via <code class="code">kpsewhich</code>) <code class="code">updmap.cfg</code> file, respectively.
4986 </p>
4987 <p>If <em class="emph">key</em> is given in addition, shows the value of only that <em class="emph">key</em> in
4988 the respective file. If option <em class="emph">--delete</em> is also given, the value in
4989 the given configuration file is entirely removed (not just commented
4990 out).
4991 </p>
4992 <p>If <em class="emph">value</em> is given in addition, <em class="emph">key</em> is set to <em class="emph">value</em> in the
4993 respective file. <em class="emph">No error checking is done!</em>
4994 </p>
4995 <p>The <code class="code">PATH</code> value shown by <code class="code">conf</code> is as used by <code class="code">tlmgr</code>. The
4996 directory in which the <code class="code">tlmgr</code> executable is found is automatically
4997 prepended to the PATH value inherited from the environment.
4998 </p>
4999 <p>Here is a practical example of changing configuration values. If the
5000 execution of (some or all) system commands via <code class="code">\write18</code> was left
5001 enabled during installation, you can disable it afterwards:
5002 </p>
5003 <pre class="verbatim"> tlmgr conf texmf shell_escape 0
5004 </pre>
5005 <p>The subcommand <code class="code">auxtrees</code> allows adding and removing arbitrary
5006 additional texmf trees, completely under user control. <code class="code">auxtrees show</code>
5007 shows the list of additional trees, <code class="code">auxtrees add</code> <em class="emph">tree</em> adds a tree
5008 to the list, and <code class="code">auxtrees remove</code> <em class="emph">tree</em> removes a tree from the list
5009 (if present). The trees should not contain an <code class="code">ls-R</code> file (or files
5010 will not be found if the <code class="code">ls-R</code> becomes stale). This works by
5011 manipulating the Kpathsea variable <code class="code">TEXMFAUXTREES</code>, in (by default)
5012 <code class="code">ROOT/texmf.cnf</code>. Example:
5013 </p>
5014 <pre class="verbatim"> tlmgr conf auxtrees add /quick/test/tree
5015 tlmgr conf auxtrees remove /quick/test/tree
5016 </pre>
5017 <p>In all cases the configuration file can be explicitly specified via the
5018 option <code class="code">--conffile</code> <em class="emph">file</em>, e.g., if you don&rsquo;t want to change the
5019 system-wide configuration.
5020 </p>
5021 <p>Warning: The general facility for changing configuration values is here,
5022 but tinkering with settings in this way is strongly discouraged. Again,
5023 no error checking on either keys or values is done, so any sort of
5024 breakage is possible.
5025 </p>
5026 </dd>
5027 </dl>
5028
5029 <hr>
5030 </div>
5031 <div class="appendixsubsec-level-extent" id="tlmgr-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d">
5032 <div class="nav-panel">
5033 <p>
5034 Next: <a href="#tlmgr-generate" accesskey="n" rel="next">generate</a>, Previous: <a href="#tlmgr-conf" accesskey="p" rel="prev">conf</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5035 </div>
5036 <h4 class="appendixsubsec" id="dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d"><span>B.6.8 dump-tlpdb [<em class="emph">option</em>...] [--json]<a class="copiable-link" href="#dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d"> &para;</a></span></h4>
5037
5038 <p>Dump complete local or remote TLPDB to standard output, as-is. The
5039 output is analogous to the <code class="code">--machine-readable</code> output; see
5040 <a class="ref" href="#tlmgr-MACHINE_002dREADABLE-OUTPUT">MACHINE-READABLE OUTPUT</a> section.
5041 </p>
5042 <p>Options:
5043 </p>
5044 <dl class="table">
5045 <dt><strong class="strong">--local</strong></dt>
5046 <dd><a class="anchor" id="tlmgr-_002d_002dlocal"></a>
5047 <p>Dump the local TLPDB.
5048 </p>
5049 </dd>
5050 <dt><strong class="strong">--remote</strong></dt>
5051 <dd><a class="anchor" id="tlmgr-_002d_002dremote"></a>
5052 <p>Dump the remote TLPDB.
5053 </p>
5054 </dd>
5055 <dt><strong class="strong">--json</strong></dt>
5056 <dd><a class="anchor" id="tlmgr-_002d_002djson"></a>
5057 <p>Instead of dumping the actual content, the database is dumped as
5058 JSON. For the format of JSON output see <code class="code">tlpkg/doc/json-formats.txt</code>,
5059 format definition <code class="code">TLPDB</code>.
5060 </p>
5061 </dd>
5062 </dl>
5063
5064 <p>Exactly one of <code class="code">--local</code> and <code class="code">--remote</code> must be given.
5065 </p>
5066 <p>In either case, the first line of the output specifies the repository
5067 location, in this format:
5068 </p>
5069 <pre class="verbatim"> &quot;location-url&quot; &quot;\t&quot; location
5070 </pre>
5071 <p>where <code class="code">location-url</code> is the literal field name, followed by a tab, and
5072 <em class="emph">location</em> is the file or url to the repository.
5073 </p>
5074 <p>Line endings may be either LF or CRLF depending on the current platform.
5075 </p>
5076 <hr>
5077 </div>
5078 <div class="appendixsubsec-level-extent" id="tlmgr-generate">
5079 <div class="nav-panel">
5080 <p>
5081 Next: <a href="#tlmgr-gui" accesskey="n" rel="next">gui</a>, Previous: <a href="#tlmgr-dump_002dtlpdb-_005boption_002e_002e_002e_005d-_005b_002d_002djson_005d" accesskey="p" rel="prev">dump-tlpdb [<em class="emph">option</em>...] [--json]</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5082 </div>
5083 <h4 class="appendixsubsec" id="generate"><span>B.6.9 generate<a class="copiable-link" href="#generate"> &para;</a></span></h4>
5084
5085 <dl class="table">
5086 <dt><strong class="strong">generate [<em class="emph">option</em>...] language</strong></dt>
5087 <dd><a class="anchor" id="tlmgr-generate-_005boption_002e_002e_002e_005d-language"></a>
5088 </dd>
5089 <dt><strong class="strong">generate [<em class="emph">option</em>...] language.dat</strong></dt>
5090 <dd><a class="anchor" id="tlmgr-generate-_005boption_002e_002e_002e_005d-language_002edat"></a>
5091 </dd>
5092 <dt><strong class="strong">generate [<em class="emph">option</em>...] language.def</strong></dt>
5093 <dd><a class="anchor" id="tlmgr-generate-_005boption_002e_002e_002e_005d-language_002edef"></a>
5094 </dd>
5095 <dt><strong class="strong">generate [<em class="emph">option</em>...] language.dat.lua</strong></dt>
5096 <dd><a class="anchor" id="tlmgr-generate-_005boption_002e_002e_002e_005d-language_002edat_002elua"></a>
5097 </dd>
5098 </dl>
5099
5100 <p>The <code class="code">generate</code> action overwrites any manual changes made in the
5101 respective files: it recreates them from scratch based on the
5102 information of the installed packages, plus local adaptations.
5103 The TeX Live installer and <code class="code">tlmgr</code> routinely call <code class="code">generate</code> for
5104 all of these files.
5105 </p>
5106 <p>For managing your own fonts, please read the <code class="code">updmap --help</code>
5107 information and/or <a class="url" href="https://tug.org/fonts/fontinstall.html">https://tug.org/fonts/fontinstall.html</a>.
5108 </p>
5109 <p>For managing your own formats, please read the <code class="code">fmtutil --help</code>
5110 information.
5111 </p>
5112 <p>In more detail: <code class="code">generate</code> remakes any of the configuration files
5113 <code class="code">language.dat</code>, <code class="code">language.def</code>, and <code class="code">language.dat.lua</code>
5114 from the information present in the local TLPDB, plus
5115 locally-maintained files.
5116 </p>
5117 <p>The locally-maintained files are <code class="code">language-local.dat</code>,
5118 <code class="code">language-local.def</code>, or <code class="code">language-local.dat.lua</code>,
5119 searched for in <code class="code">TEXMFLOCAL</code> in the respective
5120 directories. If local additions are present, the final file is made by
5121 starting with the main file, omitting any entries that the local file
5122 specifies to be disabled, and finally appending the local file.
5123 </p>
5124 <p>(Historical note: The formerly supported <code class="code">updmap-local.cfg</code> and
5125 <code class="code">fmtutil-local.cnf</code> are no longer read, since <code class="code">updmap</code> and <code class="code">fmtutil</code>
5126 now reads and supports multiple configuration files. Thus,
5127 local additions can and should be put into an <code class="code">updmap.cfg</code> of <code class="code">fmtutil.cnf</code>
5128 file in <code class="code">TEXMFLOCAL</code>. The <code class="code">generate updmap</code> and <code class="code">generate fmtutil</code> actions
5129 no longer exist.)
5130 </p>
5131 <p>Local files specify entries to be disabled with a comment line, namely
5132 one of these:
5133 </p>
5134 <pre class="verbatim"> %!NAME
5135 --!NAME
5136 </pre>
5137 <p>where <code class="code">language.dat</code> and <code class="code">language.def</code> use <code class="code">%</code>,
5138 and <code class="code">language.dat.lua</code> use <code class="code">--</code>. In all cases, the <em class="emph">name</em> is
5139 the respective format name or hyphenation pattern identifier.
5140 Examples:
5141 </p>
5142 <pre class="verbatim"> %!german
5143 --!usenglishmax
5144 </pre>
5145 <p>(Of course, you&rsquo;re not likely to actually want to disable those
5146 particular items. They&rsquo;re just examples.)
5147 </p>
5148 <p>After such a disabling line, the local file can include another entry
5149 for the same item, if a different definition is desired. In general,
5150 except for the special disabling lines, the local files follow the same
5151 syntax as the master files.
5152 </p>
5153 <p>The form <code class="code">generate language</code> recreates all three files <code class="code">language.dat</code>,
5154 <code class="code">language.def</code>, and <code class="code">language.dat.lua</code>, while the forms with an
5155 extension recreates only that given language file.
5156 </p>
5157 <p>Options:
5158 </p>
5159 <dl class="table">
5160 <dt><strong class="strong">--dest</strong> <em class="emph">output_file</em></dt>
5161 <dd><a class="anchor" id="tlmgr-_002d_002ddest-output_005ffile"></a>
5162 <p>specifies the output file (defaults to the respective location in
5163 <code class="code">TEXMFSYSVAR</code>). If <code class="code">--dest</code> is given to <code class="code">generate language</code>, it
5164 serves as a basename onto which <code class="code">.dat</code> will be appended for the name of
5165 the <code class="code">language.dat</code> output file, <code class="code">.def</code> will be appended to the value
5166 for the name of the <code class="code">language.def</code> output file, and <code class="code">.dat.lua</code> to the
5167 name of the <code class="code">language.dat.lua</code> file. (This is just to avoid
5168 overwriting; if you want a specific name for each output file, we
5169 recommend invoking <code class="code">tlmgr</code> twice.)
5170 </p>
5171 </dd>
5172 <dt><strong class="strong">--localcfg</strong> <em class="emph">local_conf_file</em></dt>
5173 <dd><a class="anchor" id="tlmgr-_002d_002dlocalcfg-local_005fconf_005ffile"></a>
5174 <p>specifies the (optional) local additions (defaults to the respective
5175 location in <code class="code">TEXMFLOCAL</code>).
5176 </p>
5177 </dd>
5178 <dt><strong class="strong">--rebuild-sys</strong></dt>
5179 <dd><a class="anchor" id="tlmgr-_002d_002drebuild_002dsys"></a>
5180 <p>tells <code class="code">tlmgr</code> to run necessary programs after config files have been
5181 regenerated. These are:
5182 <code class="code">fmtutil-sys --all</code> after <code class="code">generate fmtutil</code>,
5183 <code class="code">fmtutil-sys --byhyphen .../language.dat</code> after <code class="code">generate language.dat</code>,
5184 and
5185 <code class="code">fmtutil-sys --byhyphen .../language.def</code> after <code class="code">generate language.def</code>.
5186 </p>
5187 <p>These subsequent calls cause the newly-generated files to actually take
5188 effect. This is not done by default since those calls are lengthy
5189 processes and one might want to made several related changes in
5190 succession before invoking these programs.
5191 </p>
5192 </dd>
5193 </dl>
5194
5195 <p>The respective locations are as follows:
5196 </p>
5197 <pre class="verbatim"> tex/generic/config/language.dat (and language-local.dat)
5198 tex/generic/config/language.def (and language-local.def)
5199 tex/generic/config/language.dat.lua (and language-local.dat.lua)
5200 </pre>
5201 <hr>
5202 </div>
5203 <div class="appendixsubsec-level-extent" id="tlmgr-gui">
5204 <div class="nav-panel">
5205 <p>
5206 Next: <a href="#tlmgr-info" accesskey="n" rel="next">info</a>, Previous: <a href="#tlmgr-generate" accesskey="p" rel="prev">generate</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5207 </div>
5208 <h4 class="appendixsubsec" id="gui"><span>B.6.10 gui<a class="copiable-link" href="#gui"> &para;</a></span></h4>
5209
5210 <p>Start the graphical user interface. See <strong class="strong">GUI</strong> below.
5211 </p>
5212 <hr>
5213 </div>
5214 <div class="appendixsubsec-level-extent" id="tlmgr-info">
5215 <div class="nav-panel">
5216 <p>
5217 Next: <a href="#tlmgr-init_002dusertree" accesskey="n" rel="next">init-usertree</a>, Previous: <a href="#tlmgr-gui" accesskey="p" rel="prev">gui</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5218 </div>
5219 <h4 class="appendixsubsec" id="info"><span>B.6.11 info<a class="copiable-link" href="#info"> &para;</a></span></h4>
5220
5221 <dl class="table">
5222 <dt><strong class="strong">info [<em class="emph">option</em>...] <em class="emph">pkg</em>...</strong></dt>
5223 <dd><a class="anchor" id="tlmgr-info-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"></a>
5224 </dd>
5225 <dt><strong class="strong">info [<em class="emph">option</em>...] collections</strong></dt>
5226 <dd><a class="anchor" id="tlmgr-info-_005boption_002e_002e_002e_005d-collections"></a>
5227 </dd>
5228 <dt><strong class="strong">info [<em class="emph">option</em>...] schemes</strong></dt>
5229 <dd><a class="anchor" id="tlmgr-info-_005boption_002e_002e_002e_005d-schemes"></a>
5230 <p>With no argument, lists all packages available at the package
5231 repository, prefixing those already installed with <code class="code">i</code>.
5232 </p>
5233 <p>With the single word <code class="code">collections</code> or <code class="code">schemes</code> as the argument, lists
5234 the request type instead of all packages.
5235 </p>
5236 <p>With any other arguments, display information about <em class="emph">pkg</em>: the name,
5237 category, short and long description, sizes, installation status, and TeX Live
5238 revision number. If <em class="emph">pkg</em> is not locally installed, searches in the
5239 remote installation source.
5240 </p>
5241 <p>For normal packages (not collections or schemes), the sizes of the four
5242 groups of files (run/src/doc/bin files) are shown separately. For
5243 collections, the cumulative size is shown, including all
5244 directly-dependent packages (but not dependent collections). For
5245 schemes, the cumulative size is also shown, including all
5246 directly-dependent collections and packages.
5247 </p>
5248 <p>If <em class="emph">pkg</em> is not found locally or remotely, the search action is used
5249 and lists matching packages and files.
5250 </p>
5251 <p>It also displays information taken from the TeX Catalogue, namely the
5252 package version, date, and license. Consider these, especially the
5253 package version, as approximations only, due to timing skew of the
5254 updates of the different pieces. By contrast, the <code class="code">revision</code> value
5255 comes directly from TL and is reliable.
5256 </p>
5257 <p>The former actions <code class="code">show</code> and <code class="code">list</code> are merged into this action,
5258 but are still supported for backward compatibility.
5259 </p>
5260 <p>Options:
5261 </p>
5262 <dl class="table">
5263 <dt><strong class="strong">--list</strong></dt>
5264 <dd><a class="anchor" id="tlmgr-_002d_002dlist"></a>
5265 <p>If the option <code class="code">--list</code> is given with a package, the list of contained
5266 files is also shown, including those for platform-specific dependencies.
5267 When given with schemes and collections, <code class="code">--list</code> outputs their
5268 dependencies in a similar way.
5269 </p>
5270 </dd>
5271 <dt><strong class="strong">--only-files</strong></dt>
5272 <dd><a class="anchor" id="tlmgr-_002d_002donly_002dfiles"></a>
5273 <p>If this option is given, only the files for a given package are listed,
5274 no further information. If more than one package name is given, each
5275 file list is preceded by the package name.
5276 </p>
5277 </dd>
5278 <dt><strong class="strong">--only-installed</strong></dt>
5279 <dd><a class="anchor" id="tlmgr-_002d_002donly_002dinstalled"></a>
5280 <p>If this option is given, the installation source will not be used; only
5281 locally installed packages, collections, or schemes are listed.
5282 </p>
5283 </dd>
5284 <dt><strong class="strong">--only-remote</strong></dt>
5285 <dd><a class="anchor" id="tlmgr-_002d_002donly_002dremote"></a>
5286 <p>Only list packages from the remote repository. Useful when checking what
5287 is available in a remote repository using
5288 <code class="code">tlmgr --repo ... --only-remote info</code>. Note that
5289 <code class="code">--only-installed</code> and <code class="code">--only-remote</code> cannot both be specified.
5290 </p>
5291 </dd>
5292 <dt><strong class="strong">--data <code class="code">item1,item2,...</code></strong></dt>
5293 <dd><a class="anchor" id="tlmgr-_002d_002ddata-item1_002citem2_002c_002e_002e_002e"></a>
5294 <p>If the option <code class="code">--data</code> is given, its argument must be a comma or colon
5295 separated list of field names from: <code class="code">name</code>, <code class="code">category</code>, <code class="code">localrev</code>,
5296 <code class="code">remoterev</code>, <code class="code">shortdesc</code>, <code class="code">longdesc</code>, <code class="code">installed</code>, <code class="code">size</code>,
5297 <code class="code">relocatable</code>, <code class="code">depends</code>, <code class="code">cat-version</code>, <code class="code">cat-date</code>, <code class="code">cat-license</code>,
5298 plus various <code class="code">cat-contact-*</code> fields (see below).
5299 </p>
5300 <p>The <code class="code">cat-*</code> fields all come from the TeX Catalogue
5301 (<a class="url" href="https://ctan.org/pkg/catalogue">https://ctan.org/pkg/catalogue</a>). For each, there are two more
5302 variants with prefix <code class="code">l</code> and <code class="code">r</code>, e.g., <code class="code">lcat-version</code> and
5303 <code class="code">rcat-version</code>, which indicate the local and remote information,
5304 respectively. The variants without <code class="code">l</code> and <code class="code">r</code> show the most current
5305 one, which is normally the remote value.
5306 </p>
5307 <p>The requested packages&rsquo; information is listed in CSV format, one package
5308 per line, and the column information is given by the <code class="code">itemN</code>. The
5309 <code class="code">depends</code> column contains the names of all the dependencies separated
5310 by <code class="code">:</code> characters.
5311 </p>
5312 <p>At this writing, the <code class="code">cat-contact-*</code> fields include: <code class="code">home</code>,
5313 <code class="code">repository</code>, <code class="code">support</code>, <code class="code">bugs</code>, <code class="code">announce</code>, <code class="code">development</code>. Each
5314 may be empty or a url value. A brief description is on the CTAN upload
5315 page for new packages: <a class="url" href="https://ctan.org/upload">https://ctan.org/upload</a>.
5316 </p>
5317 </dd>
5318 <dt><strong class="strong">--json</strong></dt>
5319 <dd><a class="anchor" id="tlmgr-_002d_002djson-1"></a>
5320 <p>If <code class="code">--json</code> is specified, the output is a JSON encoded array where each
5321 array element is the JSON representation of a single <code class="code">TLPOBJ</code> but with
5322 additional information. For details see <code class="code">tlpkg/doc/json-formats.txt</code>,
5323 format definition: <code class="code">TLPOBJINFO</code>. If both <code class="code">--json</code> and <code class="code">--data</code> are
5324 given, <code class="code">--json</code> takes precedence.
5325 </p>
5326 </dd>
5327 </dl>
5328
5329 </dd>
5330 </dl>
5331
5332 <hr>
5333 </div>
5334 <div class="appendixsubsec-level-extent" id="tlmgr-init_002dusertree">
5335 <div class="nav-panel">
5336 <p>
5337 Next: <a href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" accesskey="n" rel="next">install [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a>, Previous: <a href="#tlmgr-info" accesskey="p" rel="prev">info</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5338 </div>
5339 <h4 class="appendixsubsec" id="init_002dusertree"><span>B.6.12 init-usertree<a class="copiable-link" href="#init_002dusertree"> &para;</a></span></h4>
5340
5341 <p>Sets up a texmf tree for so-called user mode management, either the
5342 default user tree (<code class="code">TEXMFHOME</code>), or one specified on the command line
5343 with <code class="code">--usertree</code>. See <a class="ref" href="#tlmgr-USER-MODE">USER MODE</a> below.
5344 </p>
5345 <hr>
5346 </div>
5347 <div class="appendixsubsec-level-extent" id="tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">
5348 <div class="nav-panel">
5349 <p>
5350 Next: <a href="#tlmgr-key" accesskey="n" rel="next">key</a>, Previous: <a href="#tlmgr-init_002dusertree" accesskey="p" rel="prev">init-usertree</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5351 </div>
5352 <h4 class="appendixsubsec" id="install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"><span>B.6.13 install [<em class="emph">option</em>...] <em class="emph">pkg</em>...<a class="copiable-link" href="#install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"> &para;</a></span></h4>
5353
5354 <p>Install each <em class="emph">pkg</em> given on the command line, if it is not already
5355 installed. It does not touch existing packages; see the <code class="code">update</code>
5356 action for how to get the latest version of a package.
5357 </p>
5358 <p>By default this also installs all packages on which the given <em class="emph">pkg</em>s are
5359 dependent. Options:
5360 </p>
5361 <dl class="table">
5362 <dt><strong class="strong">--dry-run</strong></dt>
5363 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun-1"></a>
5364 <p>Nothing is actually installed; instead, the actions to be performed are
5365 written to the terminal.
5366 </p>
5367 </dd>
5368 <dt><strong class="strong">--file</strong></dt>
5369 <dd><a class="anchor" id="tlmgr-_002d_002dfile"></a>
5370 <p>Instead of fetching a package from the installation repository, use
5371 the package files given on the command line. These files must
5372 be standard TeX Live package files (with contained tlpobj file).
5373 </p>
5374 </dd>
5375 <dt><strong class="strong">--force</strong></dt>
5376 <dd><a class="anchor" id="tlmgr-_002d_002dforce"></a>
5377 <p>If updates to <code class="code">tlmgr</code> itself (or other parts of the basic
5378 infrastructure) are present, <code class="code">tlmgr</code> will bail out and not perform the
5379 installation unless this option is given. Not recommended.
5380 </p>
5381 </dd>
5382 <dt><strong class="strong">--no-depends</strong></dt>
5383 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends"></a>
5384 <p>Do not install dependencies. (By default, installing a package ensures
5385 that all dependencies of this package are fulfilled.)
5386 </p>
5387 </dd>
5388 <dt><strong class="strong">--no-depends-at-all</strong></dt>
5389 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends_002dat_002dall"></a>
5390 <p>Normally, when you install a package which ships binary files the
5391 respective binary package will also be installed. That is, for a
5392 package <code class="code">foo</code>, the package <code class="code">foo.i386-linux</code> will also be installed on
5393 an <code class="code">i386-linux</code> system. This option suppresses this behavior, and also
5394 implies <code class="code">--no-depends</code>. Don&rsquo;t use it unless you are sure of what you
5395 are doing.
5396 </p>
5397 </dd>
5398 <dt><strong class="strong">--reinstall</strong></dt>
5399 <dd><a class="anchor" id="tlmgr-_002d_002dreinstall"></a>
5400 <p>Reinstall a package (including dependencies for collections) even if it
5401 already seems to be installed (i.e, is present in the TLPDB). This is
5402 useful to recover from accidental removal of files in the hierarchy.
5403 </p>
5404 <p>When re-installing, only dependencies on normal packages are followed
5405 (i.e., not those of category Scheme or Collection).
5406 </p>
5407 </dd>
5408 <dt><strong class="strong">--with-doc</strong></dt>
5409 <dd><a class="anchor" id="tlmgr-_002d_002dwith_002ddoc"></a>
5410 </dd>
5411 <dt><strong class="strong">--with-src</strong></dt>
5412 <dd><a class="anchor" id="tlmgr-_002d_002dwith_002dsrc"></a>
5413 <p>While not recommended, the <code class="code">install-tl</code> program provides an option to
5414 omit installation of all documentation and/or source files. (By
5415 default, everything is installed.) After such an installation, you may
5416 find that you want the documentation or source files for a given package
5417 after all. You can get them by using these options in conjunction with
5418 <code class="code">--reinstall</code>, as in (using the <code class="code">fontspec</code> package as the example):
5419 </p>
5420 <pre class="verbatim"> tlmgr install --reinstall --with-doc --with-src fontspec
5421 </pre>
5422 </dd>
5423 </dl>
5424
5425 <p>This action does not automatically add new symlinks in system
5426 directories; you need to run <code class="code">tlmgr path add</code> (<a class="ref" href="#tlmgr-path">path</a>) yourself if
5427 you are using this feature and want new symlinks added.
5428 </p>
5429 <hr>
5430 </div>
5431 <div class="appendixsubsec-level-extent" id="tlmgr-key">
5432 <div class="nav-panel">
5433 <p>
5434 Next: <a href="#tlmgr-list" accesskey="n" rel="next">list</a>, Previous: <a href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" accesskey="p" rel="prev">install [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5435 </div>
5436 <h4 class="appendixsubsec" id="key"><span>B.6.14 key<a class="copiable-link" href="#key"> &para;</a></span></h4>
5437
5438 <dl class="table">
5439 <dt><strong class="strong">key list</strong></dt>
5440 <dd><a class="anchor" id="tlmgr-key-list"></a>
5441 </dd>
5442 <dt><strong class="strong">key add <em class="emph">file</em></strong></dt>
5443 <dd><a class="anchor" id="tlmgr-key-add-file"></a>
5444 </dd>
5445 <dt><strong class="strong">key remove <em class="emph">keyid</em></strong></dt>
5446 <dd><a class="anchor" id="tlmgr-key-remove-keyid"></a>
5447 <p>The action <code class="code">key</code> allows listing, adding and removing additional GPG
5448 keys to the set of trusted keys, that is, those that are used to verify
5449 the TeX Live databases.
5450 </p>
5451 <p>With the <code class="code">list</code> argument, <code class="code">key</code> lists all keys.
5452 </p>
5453 <p>The <code class="code">add</code> argument requires another argument, either a filename or
5454 <code class="code">-</code> for stdin, from which the key is added. The key is added to the
5455 local keyring <code class="code">GNUPGHOME/repository-keys.gpg</code>, which is normally
5456 <code class="code">tlpkg/gpg/repository-keys.gpg</code>.
5457 </p>
5458 <p>The <code class="code">remove</code> argument requires a key id and removes the requested id
5459 from the local keyring.
5460 </p>
5461 </dd>
5462 </dl>
5463
5464 <hr>
5465 </div>
5466 <div class="appendixsubsec-level-extent" id="tlmgr-list">
5467 <div class="nav-panel">
5468 <p>
5469 Next: <a href="#tlmgr-option" accesskey="n" rel="next">option</a>, Previous: <a href="#tlmgr-key" accesskey="p" rel="prev">key</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5470 </div>
5471 <h4 class="appendixsubsec" id="list"><span>B.6.15 list<a class="copiable-link" href="#list"> &para;</a></span></h4>
5472
5473 <p>Synonym for <a class="ref" href="#tlmgr-info">info</a>.
5474 </p>
5475 <hr>
5476 </div>
5477 <div class="appendixsubsec-level-extent" id="tlmgr-option">
5478 <div class="nav-panel">
5479 <p>
5480 Next: <a href="#tlmgr-paper" accesskey="n" rel="next">paper</a>, Previous: <a href="#tlmgr-list" accesskey="p" rel="prev">list</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5481 </div>
5482 <h4 class="appendixsubsec" id="option"><span>B.6.16 option<a class="copiable-link" href="#option"> &para;</a></span></h4>
5483
5484 <dl class="table">
5485 <dt><strong class="strong">option [--json] [show]</strong></dt>
5486 <dd><a class="anchor" id="tlmgr-option-_005b_002d_002djson_005d-_005bshow_005d"></a>
5487 </dd>
5488 <dt><strong class="strong">option [--json] showall|help</strong></dt>
5489 <dd><a class="anchor" id="tlmgr-option-_005b_002d_002djson_005d-showall_007chelp"></a>
5490 </dd>
5491 <dt><strong class="strong">option <em class="emph">key</em> [<em class="emph">value</em>]</strong></dt>
5492 <dd><a class="anchor" id="tlmgr-option-key-_005bvalue_005d"></a>
5493 </dd>
5494 </dl>
5495
5496 <p>The first form, <code class="code">show</code>, shows the global TeX Live settings currently
5497 saved in the TLPDB with a short description and the <code class="code">key</code> used for
5498 changing it in parentheses.
5499 </p>
5500 <p>The second form, <code class="code">showall</code>, is similar, but also shows options which
5501 can be defined but are not currently set to any value (<code class="code">help</code> is a
5502 synonym).
5503 </p>
5504 <p>Both <code class="code">show...</code> forms take an option <code class="code">--json</code>, which dumps the option
5505 information in JSON format. In this case, both forms dump the same
5506 data. For the format of the JSON output see
5507 <code class="code">tlpkg/doc/json-formats.txt</code>, format definition <code class="code">TLOPTION</code>.
5508 </p>
5509 <p>In the third form, with <em class="emph">key</em>, if <em class="emph">value</em> is not given, the setting
5510 for <em class="emph">key</em> is displayed. If <em class="emph">value</em> is present, <em class="emph">key</em> is set to
5511 <em class="emph">value</em>.
5512 </p>
5513 <p>Possible values for <em class="emph">key</em> are (run <code class="code">tlmgr option showall</code> for
5514 the definitive list):
5515 </p>
5516 <pre class="verbatim"> repository (default package repository),
5517 formats (generate formats at installation or update time),
5518 postcode (run postinst code blobs)
5519 docfiles (install documentation files),
5520 srcfiles (install source files),
5521 backupdir (default directory for backups),
5522 autobackup (number of backups to keep).
5523 sys_bin (directory to which executables are linked by the path action)
5524 sys_man (directory to which man pages are linked by the path action)
5525 sys_info (directory to which Info files are linked by the path action)
5526 desktop_integration (Windows-only: create Start menu shortcuts)
5527 fileassocs (Windows-only: change file associations)
5528 multiuser (Windows-only: install for all users)
5529 </pre>
5530 <p>One common use of <code class="code">option</code> is to permanently change the installation to
5531 get further updates from the Internet, after originally installing from
5532 DVD. To do this, you can run
5533 </p>
5534 <pre class="verbatim"> tlmgr option repository https://mirror.ctan.org/systems/texlive/tlnet
5535 </pre>
5536 <p>The <code class="code">install-tl</code> documentation has more information about the possible
5537 values for <code class="code">repository</code>. (For backward compatibility, <code class="code">location</code> can
5538 be used as a synonym for <code class="code">repository</code>.)
5539 </p>
5540 <p>If <code class="code">formats</code> is set (this is the default), then formats are regenerated
5541 when either the engine or the format files have changed. Disable this
5542 only when you know how and want to regenerate formats yourself whenever
5543 needed (which is often, in practice).
5544 </p>
5545 <p>The <code class="code">postcode</code> option controls execution of per-package
5546 postinstallation action code. It is set by default, and again disabling
5547 is not likely to be of interest except to developers doing debugging.
5548 </p>
5549 <p>The <code class="code">docfiles</code> and <code class="code">srcfiles</code> options control the installation of
5550 their respective file groups (documentation, sources; grouping is
5551 approximate) per package. By default both are enabled (1). Either or
5552 both can be disabled (set to 0) if disk space is limited or for minimal
5553 testing installations, etc. When disabled, the respective files are not
5554 downloaded at all.
5555 </p>
5556 <p>The options <code class="code">autobackup</code> and <code class="code">backupdir</code> determine the defaults for
5557 the actions <code class="code">update</code>, <code class="code">backup</code> and <code class="code">restore</code>. These three actions
5558 need a directory in which to read or write the backups. If
5559 <code class="code">--backupdir</code> is not specified on the command line, the <code class="code">backupdir</code>
5560 option value is used (if set). The TL installer sets <code class="code">backupdir</code> to
5561 <code class="code">.../tlpkg/backups</code>, under the TL root installation directory.
5562 </p>
5563 <p>The <code class="code">autobackup</code> option (de)activates automatic generation of backups.
5564 Its value is an integer. If the <code class="code">autobackup</code> value is <code class="code">-1</code>, no
5565 backups are removed. If <code class="code">autobackup</code> is 0 or more, it specifies the
5566 number of backups to keep. Thus, backups are disabled if the value is
5567 0. In the <code class="code">--clean</code> mode of the <code class="code">backup</code> action this option also
5568 specifies the number to be kept. The default value is 1, so that
5569 backups are made, but only one backup is kept.
5570 </p>
5571 <p>To setup <code class="code">autobackup</code> to <code class="code">-1</code> on the command line, use:
5572 </p>
5573 <pre class="verbatim"> tlmgr option -- autobackup -1
5574 </pre>
5575 <p>The <code class="code">--</code> avoids having the <code class="code">-1</code> treated as an option. (The <code class="code">--</code>
5576 stops parsing for options at the point where it appears; this is a
5577 general feature across most Unix programs.)
5578 </p>
5579 <p>The <code class="code">sys_bin</code>, <code class="code">sys_man</code>, and <code class="code">sys_info</code> options are used on Unix
5580 systems to control the generation of links for executables, Info files
5581 and man pages. See the <code class="code">path</code> action for details.
5582 </p>
5583 <p>The last three options affect behavior on Windows installations. If
5584 <code class="code">desktop_integration</code> is set, then some packages will install items in
5585 a sub-folder of the Start menu for <code class="code">tlmgr gui</code>, documentation, etc. If
5586 <code class="code">fileassocs</code> is set, Windows file associations are made (see also the
5587 <code class="code">postaction</code> action). Finally, if <code class="code">multiuser</code> is set, then changes
5588 to the registry and the menus are done for all users on the system
5589 instead of only the current user. All three options are on by default.
5590 </p>
5591 <hr>
5592 </div>
5593 <div class="appendixsubsec-level-extent" id="tlmgr-paper">
5594 <div class="nav-panel">
5595 <p>
5596 Next: <a href="#tlmgr-path" accesskey="n" rel="next">path</a>, Previous: <a href="#tlmgr-option" accesskey="p" rel="prev">option</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5597 </div>
5598 <h4 class="appendixsubsec" id="paper"><span>B.6.17 paper<a class="copiable-link" href="#paper"> &para;</a></span></h4>
5599
5600 <dl class="table">
5601 <dt><strong class="strong">paper [a4|letter]</strong></dt>
5602 <dd><a class="anchor" id="tlmgr-paper-_005ba4_007cletter_005d"></a>
5603 </dd>
5604 <dt><strong class="strong">&lt;[xdvi|pdftex|dvips|dvipdfmx|context|psutils] paper [<em class="emph">papersize</em>|--list]</strong>&gt;</dt>
5605 <dd><a class="anchor" id="tlmgr-_003c_005bxdvi_007cpdftex_007cdvips_007cdvipdfmx_007ccontext_007cpsutils_005d-paper-_005bpapersize_007c_002d_002dlist_005d_003e"></a>
5606 </dd>
5607 <dt><strong class="strong">paper --json</strong></dt>
5608 <dd><a class="anchor" id="tlmgr-paper-_002d_002djson"></a>
5609 </dd>
5610 </dl>
5611
5612 <p>With no arguments (<code class="code">tlmgr paper</code>), shows the default paper size setting
5613 for all known programs.
5614 </p>
5615 <p>With one argument (e.g., <code class="code">tlmgr paper a4</code>), sets the default for all
5616 known programs to that paper size.
5617 </p>
5618 <p>With a program given as the first argument and no paper size specified
5619 (e.g., <code class="code">tlmgr dvips paper</code>), shows the default paper size for that
5620 program.
5621 </p>
5622 <p>With a program given as the first argument and a paper size as the last
5623 argument (e.g., <code class="code">tlmgr dvips paper a4</code>), set the default for that
5624 program to that paper size.
5625 </p>
5626 <p>If either <code class="code">pdftex</code> or <code class="code">context</code> is one of the arguments, whether
5627 implicitly or explicitly, existing formats are rebuilt (i.e., <code class="code">fmtutil
5628 --refresh</code> is called), unless <code class="code">--no-execute-actions</code> is specified.
5629 </p>
5630 <p>With a program given as the first argument and <code class="code">--list</code> given as the
5631 last argument (e.g., <code class="code">tlmgr dvips paper --list</code>), shows all valid paper
5632 sizes for that program. The first size shown is the default.
5633 </p>
5634 <p>If <code class="code">--json</code> is specified without other options, the paper setup is
5635 dumped in JSON format. For the format of JSON output see
5636 <code class="code">tlpkg/doc/json-formats.txt</code>, format definition <code class="code">TLPAPER</code>.
5637 </p>
5638 <p>Incidentally, this syntax of having a specific program name before the
5639 <code class="code">paper</code> keyword is unusual. It is inherited from the longstanding
5640 <code class="code">texconfig</code> script, which supports other configuration settings for
5641 some programs, notably <code class="code">dvips</code>. <code class="code">tlmgr</code> does not support those extra
5642 settings.
5643 </p>
5644 <hr>
5645 </div>
5646 <div class="appendixsubsec-level-extent" id="tlmgr-path">
5647 <div class="nav-panel">
5648 <p>
5649 Next: <a href="#tlmgr-pinning" accesskey="n" rel="next">pinning</a>, Previous: <a href="#tlmgr-paper" accesskey="p" rel="prev">paper</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5650 </div>
5651 <h4 class="appendixsubsec" id="path"><span>B.6.18 path<a class="copiable-link" href="#path"> &para;</a></span></h4>
5652
5653 <dl class="table">
5654 <dt><strong class="strong">path [--windowsmode=user|admin] add</strong></dt>
5655 <dd><a class="anchor" id="tlmgr-path-_005b_002d_002dwindowsmode_003duser_007cadmin_005d-add"></a>
5656 </dd>
5657 <dt><strong class="strong">path [--windowsmode=user|admin] remove</strong></dt>
5658 <dd><a class="anchor" id="tlmgr-path-_005b_002d_002dwindowsmode_003duser_007cadmin_005d-remove"></a>
5659 <p>On Unix, adds or removes symlinks for executables, man pages, and info
5660 pages in the system directories specified by the respective options (see
5661 the <a class="ref" href="#tlmgr-option">option</a> description above). Does not change any initialization
5662 files, either system or personal. Furthermore, any executables added or
5663 removed by future updates are not taken care of automatically; this
5664 command must be rerun as needed.
5665 </p>
5666 <p>On Windows, the registry part where the binary directory is added or
5667 removed is determined in the following way:
5668 </p>
5669 <p>If the user has admin rights, and the option <code class="code">--windowsmode</code> is not given,
5670 the setting <em class="emph">w32_multi_user</em> determines the location (i.e., if it is
5671 on then the system path, otherwise the user path is changed).
5672 </p>
5673 <p>If the user has admin rights, and the option <code class="code">--windowsmode</code> is given, this
5674 option determines the path to be adjusted.
5675 </p>
5676 <p>If the user does not have admin rights, and the option <code class="code">--windowsmode</code>
5677 is not given, and the setting <em class="emph">w32_multi_user</em> is off, the user path
5678 is changed, while if the setting <em class="emph">w32_multi_user</em> is on, a warning is
5679 issued that the caller does not have enough privileges.
5680 </p>
5681 <p>If the user does not have admin rights, and the option <code class="code">--windowsmode</code>
5682 is given, it must be <code class="code">user</code> and the user path will be adjusted. If a
5683 user without admin rights uses the option <code class="code">--windowsmode admin</code> a warning
5684 is issued that the caller does not have enough privileges.
5685 </p>
5686 </dd>
5687 </dl>
5688
5689 <hr>
5690 </div>
5691 <div class="appendixsubsec-level-extent" id="tlmgr-pinning">
5692 <div class="nav-panel">
5693 <p>
5694 Next: <a href="#tlmgr-platform" accesskey="n" rel="next">platform</a>, Previous: <a href="#tlmgr-path" accesskey="p" rel="prev">path</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5695 </div>
5696 <h4 class="appendixsubsec" id="pinning"><span>B.6.19 pinning<a class="copiable-link" href="#pinning"> &para;</a></span></h4>
5697
5698 <p>The <code class="code">pinning</code> action manages the pinning file, see <a class="ref" href="#tlmgr-Pinning">Pinning</a> below.
5699 </p>
5700 <dl class="table">
5701 <dt><code class="code">pinning show</code></dt>
5702 <dd><a class="anchor" id="tlmgr-pinning-show"></a>
5703 <p>Shows the current pinning data.
5704 </p>
5705 </dd>
5706 <dt><code class="code">pinning add</code> <em class="emph">repo</em> <em class="emph">pkgglob</em>...</dt>
5707 <dd><a class="anchor" id="tlmgr-pinning-add-repo-pkgglob_002e_002e_002e"></a>
5708 <p>Pins the packages matching the <em class="emph">pkgglob</em>(s) to the repository
5709 <em class="emph">repo</em>.
5710 </p>
5711 </dd>
5712 <dt><code class="code">pinning remove</code> <em class="emph">repo</em> <em class="emph">pkgglob</em>...</dt>
5713 <dd><a class="anchor" id="tlmgr-pinning-remove-repo-pkgglob_002e_002e_002e"></a>
5714 <p>Any packages recorded in the pinning file matching the &lt;pkgglob&gt;s for
5715 the given repository <em class="emph">repo</em> are removed.
5716 </p>
5717 </dd>
5718 <dt><code class="code">pinning remove <em class="emph">repo</em> --all</code></dt>
5719 <dd><a class="anchor" id="tlmgr-pinning-remove-repo-_002d_002dall"></a>
5720 <p>Remove all pinning data for repository <em class="emph">repo</em>.
5721 </p>
5722 </dd>
5723 </dl>
5724
5725 <hr>
5726 </div>
5727 <div class="appendixsubsec-level-extent" id="tlmgr-platform">
5728 <div class="nav-panel">
5729 <p>
5730 Next: <a href="#tlmgr-postaction" accesskey="n" rel="next">postaction</a>, Previous: <a href="#tlmgr-pinning" accesskey="p" rel="prev">pinning</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5731 </div>
5732 <h4 class="appendixsubsec" id="platform"><span>B.6.20 platform<a class="copiable-link" href="#platform"> &para;</a></span></h4>
5733
5734 <dl class="table">
5735 <dt><strong class="strong">platform list|add|remove <em class="emph">platform</em>...</strong></dt>
5736 <dd><a class="anchor" id="tlmgr-platform-list_007cadd_007cremove-platform_002e_002e_002e"></a>
5737 </dd>
5738 <dt><strong class="strong">platform set <em class="emph">platform</em></strong></dt>
5739 <dd><a class="anchor" id="tlmgr-platform-set-platform"></a>
5740 </dd>
5741 <dt><strong class="strong">platform set auto</strong></dt>
5742 <dd><a class="anchor" id="tlmgr-platform-set-auto"></a>
5743 <p><code class="code">platform list</code> lists the TeX Live names of all the platforms
5744 (a.k.a. architectures), (<code class="code">i386-linux</code>, ...) available at the package
5745 repository.
5746 </p>
5747 <p><code class="code">platform add</code> <em class="emph">platform</em>... adds the executables for each given platform
5748 <em class="emph">platform</em> to the installation from the repository.
5749 </p>
5750 <p><code class="code">platform remove</code> <em class="emph">platform</em>... removes the executables for each given
5751 platform <em class="emph">platform</em> from the installation, but keeps the currently
5752 running platform in any case.
5753 </p>
5754 <p><code class="code">platform set</code> <em class="emph">platform</em> switches TeX Live to always use the given
5755 platform instead of auto detection.
5756 </p>
5757 <p><code class="code">platform set auto</code> switches TeX Live to auto detection mode for platform.
5758 </p>
5759 <p>Platform detection is needed to select the proper <code class="code">xz</code> and
5760 <code class="code">wget</code> binaries that are shipped with TeX Live.
5761 </p>
5762 <p><code class="code">arch</code> is a synonym for <code class="code">platform</code>.
5763 </p>
5764 <p>Options:
5765 </p>
5766 <dl class="table">
5767 <dt><strong class="strong">--dry-run</strong></dt>
5768 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun-2"></a>
5769 <p>Nothing is actually installed; instead, the actions to be performed are
5770 written to the terminal.
5771 </p>
5772 </dd>
5773 </dl>
5774
5775 </dd>
5776 </dl>
5777
5778 <hr>
5779 </div>
5780 <div class="appendixsubsec-level-extent" id="tlmgr-postaction">
5781 <div class="nav-panel">
5782 <p>
5783 Next: <a href="#tlmgr-print_002dplatform" accesskey="n" rel="next">print-platform</a>, Previous: <a href="#tlmgr-platform" accesskey="p" rel="prev">platform</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5784 </div>
5785 <h4 class="appendixsubsec" id="postaction"><span>B.6.21 postaction<a class="copiable-link" href="#postaction"> &para;</a></span></h4>
5786
5787 <dl class="table">
5788 <dt><strong class="strong">postaction [<em class="emph">option</em>...] install [shortcut|fileassoc|script] [<em class="emph">pkg</em>...]</strong></dt>
5789 <dd><a class="anchor" id="tlmgr-postaction-_005boption_002e_002e_002e_005d-install-_005bshortcut_007cfileassoc_007cscript_005d-_005bpkg_002e_002e_002e_005d"></a>
5790 </dd>
5791 <dt><strong class="strong">postaction [<em class="emph">option</em>...] remove [shortcut|fileassoc|script] [<em class="emph">pkg</em>...]</strong></dt>
5792 <dd><a class="anchor" id="tlmgr-postaction-_005boption_002e_002e_002e_005d-remove-_005bshortcut_007cfileassoc_007cscript_005d-_005bpkg_002e_002e_002e_005d"></a>
5793 <p>Carry out the postaction <code class="code">shortcut</code>, <code class="code">fileassoc</code>, or <code class="code">script</code> given
5794 as the second required argument in install or remove mode (which is the
5795 first required argument), for either the packages given on the command
5796 line, or for all if <code class="code">--all</code> is given.
5797 </p>
5798 <p>Options:
5799 </p>
5800 <dl class="table">
5801 <dt><strong class="strong">--windowsmode=[user|admin]</strong></dt>
5802 <dd><a class="anchor" id="tlmgr-_002d_002dwindowsmode_003d_005buser_007cadmin_005d"></a>
5803 <p>If the option <code class="code">--windowsmode</code> is given the value <code class="code">user</code>, all actions will
5804 only be carried out in the user-accessible parts of the
5805 registry/filesystem, while the value <code class="code">admin</code> selects the system-wide
5806 parts of the registry for the file associations. If you do not have
5807 enough permissions, using <code class="code">--windowsmode=admin</code> will not succeed.
5808 </p>
5809 </dd>
5810 <dt><strong class="strong">--fileassocmode=[1|2]</strong></dt>
5811 <dd><a class="anchor" id="tlmgr-_002d_002dfileassocmode_003d_005b1_007c2_005d"></a>
5812 <p><code class="code">--fileassocmode</code> specifies the action for file associations. If it is
5813 set to 1 (the default), only new associations are added; if it is set to
5814 2, all associations are set to the TeX Live programs. (See also
5815 <code class="code">option fileassocs</code>.)
5816 </p>
5817 </dd>
5818 <dt><strong class="strong">--all</strong></dt>
5819 <dd><a class="anchor" id="tlmgr-_002d_002dall-1"></a>
5820 <p>Carry out the postactions for all packages
5821 </p>
5822 </dd>
5823 </dl>
5824
5825 </dd>
5826 </dl>
5827
5828 <hr>
5829 </div>
5830 <div class="appendixsubsec-level-extent" id="tlmgr-print_002dplatform">
5831 <div class="nav-panel">
5832 <p>
5833 Next: <a href="#tlmgr-print_002dplatform_002dinfo" accesskey="n" rel="next">print-platform-info</a>, Previous: <a href="#tlmgr-postaction" accesskey="p" rel="prev">postaction</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5834 </div>
5835 <h4 class="appendixsubsec" id="print_002dplatform"><span>B.6.22 print-platform<a class="copiable-link" href="#print_002dplatform"> &para;</a></span></h4>
5836
5837 <p>Print the TeX Live identifier for the detected platform
5838 (hardware/operating system) combination to standard output, and exit.
5839 <code class="code">--print-arch</code> is a synonym.
5840 </p>
5841 <hr>
5842 </div>
5843 <div class="appendixsubsec-level-extent" id="tlmgr-print_002dplatform_002dinfo">
5844 <div class="nav-panel">
5845 <p>
5846 Next: <a href="#tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" accesskey="n" rel="next">remove [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a>, Previous: <a href="#tlmgr-print_002dplatform" accesskey="p" rel="prev">print-platform</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5847 </div>
5848 <h4 class="appendixsubsec" id="print_002dplatform_002dinfo"><span>B.6.23 print-platform-info<a class="copiable-link" href="#print_002dplatform_002dinfo"> &para;</a></span></h4>
5849
5850 <p>Print the TeX Live platform identifier, TL platform long name, and
5851 original output from guess.
5852 </p>
5853 <hr>
5854 </div>
5855 <div class="appendixsubsec-level-extent" id="tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">
5856 <div class="nav-panel">
5857 <p>
5858 Next: <a href="#tlmgr-repository" accesskey="n" rel="next">repository</a>, Previous: <a href="#tlmgr-print_002dplatform_002dinfo" accesskey="p" rel="prev">print-platform-info</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5859 </div>
5860 <h4 class="appendixsubsec" id="remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"><span>B.6.24 remove [<em class="emph">option</em>...] <em class="emph">pkg</em>...<a class="copiable-link" href="#remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e"> &para;</a></span></h4>
5861
5862 <p>Remove each <em class="emph">pkg</em> specified. Removing a collection removes all package
5863 dependencies (unless <code class="code">--no-depends</code> is specified), but not any
5864 collection dependencies of that collection. However, when removing a
5865 package, dependencies are never removed. Options:
5866 </p>
5867 <dl class="table">
5868 <dt><strong class="strong">--all</strong></dt>
5869 <dd><a class="anchor" id="tlmgr-_002d_002dall-2"></a>
5870 <p>Uninstalls all of TeX Live, asking for confirmation unless <code class="code">--force</code> is
5871 also specified.
5872 </p>
5873 </dd>
5874 <dt><strong class="strong">--backup</strong></dt>
5875 <dd><a class="anchor" id="tlmgr-_002d_002dbackup"></a>
5876 </dd>
5877 <dt><strong class="strong">--backupdir</strong> <em class="emph">directory</em></dt>
5878 <dd><a class="anchor" id="tlmgr-_002d_002dbackupdir-directory-1"></a>
5879 <p>These options behave just as with the <a class="ref" href="#tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d">update</a> action (q.v.), except they apply to making
5880 backups of packages before they are removed. The default is to make
5881 such a backup, that is, to save a copy of packages before removal.
5882 </p>
5883 <p>The <a class="ref" href="#tlmgr-restore">restore</a> action explains how to restore from a backup.
5884 </p>
5885 </dd>
5886 <dt><strong class="strong">--no-depends</strong></dt>
5887 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends-1"></a>
5888 <p>Do not remove dependent packages.
5889 </p>
5890 </dd>
5891 <dt><strong class="strong">--no-depends-at-all</strong></dt>
5892 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends_002dat_002dall-1"></a>
5893 <p>See above under <a class="ref" href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">install</a> (and beware).
5894 </p>
5895 </dd>
5896 <dt><strong class="strong">--force</strong></dt>
5897 <dd><a class="anchor" id="tlmgr-_002d_002dforce-1"></a>
5898 <p>By default, removal of a package or collection that is a dependency of
5899 another collection or scheme is not allowed. With this option, the
5900 package will be removed unconditionally. Use with care.
5901 </p>
5902 <p>A package that has been removed using the <code class="code">--force</code> option because it
5903 is still listed in an installed collection or scheme will not be
5904 updated, and will be mentioned as <code class="code">forcibly removed</code> in the output of
5905 <code class="code">tlmgr update --list</code>.
5906 </p>
5907 </dd>
5908 <dt><strong class="strong">--dry-run</strong></dt>
5909 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun-3"></a>
5910 <p>Nothing is actually removed; instead, the actions to be performed are
5911 written to the terminal.
5912 </p>
5913 </dd>
5914 </dl>
5915
5916 <p>Except with <code class="code">--all</code>, this <code class="code">remove</code> action does not automatically
5917 remove symlinks to executables from system directories; you need to run
5918 <code class="code">tlmgr path remove</code> (<a class="ref" href="#tlmgr-path">path</a>) yourself if you remove an individual
5919 package with a symlink in a system directory.
5920 </p>
5921 <hr>
5922 </div>
5923 <div class="appendixsubsec-level-extent" id="tlmgr-repository">
5924 <div class="nav-panel">
5925 <p>
5926 Next: <a href="#tlmgr-restore" accesskey="n" rel="next">restore</a>, Previous: <a href="#tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e" accesskey="p" rel="prev">remove [<em class="emph">option</em>...] <em class="emph">pkg</em>...</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5927 </div>
5928 <h4 class="appendixsubsec" id="repository"><span>B.6.25 repository<a class="copiable-link" href="#repository"> &para;</a></span></h4>
5929
5930 <dl class="table">
5931 <dt><strong class="strong">repository list</strong></dt>
5932 <dd><a class="anchor" id="tlmgr-repository-list"></a>
5933 </dd>
5934 <dt><strong class="strong">repository list <em class="emph">path|url|tag</em></strong></dt>
5935 <dd><a class="anchor" id="tlmgr-repository-list-path_007curl_007ctag"></a>
5936 </dd>
5937 <dt><strong class="strong">repository add <em class="emph">path</em> [<em class="emph">tag</em>]</strong></dt>
5938 <dd><a class="anchor" id="tlmgr-repository-add-path-_005btag_005d"></a>
5939 </dd>
5940 <dt><strong class="strong">repository remove <em class="emph">path|tag</em></strong></dt>
5941 <dd><a class="anchor" id="tlmgr-repository-remove-path_007ctag"></a>
5942 </dd>
5943 <dt><strong class="strong">repository set <em class="emph">path</em>[#<em class="emph">tag</em>] [<em class="emph">path</em>[#<em class="emph">tag</em>] ...]</strong></dt>
5944 <dd><a class="anchor" id="tlmgr-repository-set-path_005b_0023tag_005d-_005bpath_005b_0023tag_005d-_002e_002e_002e_005d"></a>
5945 </dd>
5946 <dt><strong class="strong">repository status</strong></dt>
5947 <dd><a class="anchor" id="tlmgr-repository-status"></a>
5948 <p>This action manages the list of repositories. See <a class="url" href="https://metacpan.org/pod/MULTIPLE%20REPOSITORIES">MULTIPLE
5949 REPOSITORIES</a> below for detailed explanations.
5950 </p>
5951 <p>The first form, <code class="code">repository list</code>, lists all configured repositories
5952 and the respective tags if set. If a path, url, or tag is given after
5953 the <code class="code">list</code> keyword, it is interpreted as the source from which to
5954 initialize a TL database and lists the contained packages. This can also
5955 be an otherwise-unused repository, either local or remote. If the option
5956 <code class="code">--with-platforms</code> is specified in addition, for each package the
5957 available platforms (if any) are also listed.
5958 </p>
5959 <p>The form <code class="code">repository add</code> adds a repository (optionally attaching a
5960 tag) to the list of repositories, while <code class="code">repository remove</code> removes a
5961 repository, either by full path/url, or by tag.
5962 </p>
5963 <p>The form <code class="code">repository set</code> sets the list of available repositories to
5964 the items given on the command line, overwriting previous settings.
5965 </p>
5966 <p>The form <code class="code">repository status</code> reports the verification status of the
5967 loaded repositories with the format of one repository per line
5968 with fields separated by a single space:
5969 </p>
5970 <dl class="table">
5971 <dt>The tag (which can be the same as the url);</dt>
5972 <dd><a class="anchor" id="tlmgr-The-tag-_0028which-can-be-the-same-as-the-url_0029_003b"></a>
5973 <p>= the url;
5974 </p>
5975 <p>= iff machine-readable output is specified, the verification code (a
5976 number);
5977 </p>
5978 <p>= a textual description of the verification status, as the last field
5979 extending to the end of line.
5980 </p>
5981 </dd>
5982 </dl>
5983
5984 <p>That is, in normal (not machine-readable) output, the third field
5985 (numeric verification status) is not present.
5986 </p>
5987 <p>In all cases, one of the repositories must be tagged as <code class="code">main</code>;
5988 otherwise, all operations will fail!
5989 </p>
5990 </dd>
5991 </dl>
5992
5993 <hr>
5994 </div>
5995 <div class="appendixsubsec-level-extent" id="tlmgr-restore">
5996 <div class="nav-panel">
5997 <p>
5998 Next: <a href="#tlmgr-search" accesskey="n" rel="next">search</a>, Previous: <a href="#tlmgr-repository" accesskey="p" rel="prev">repository</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
5999 </div>
6000 <h4 class="appendixsubsec" id="restore"><span>B.6.26 restore<a class="copiable-link" href="#restore"> &para;</a></span></h4>
6001
6002 <dl class="table">
6003 <dt><strong class="strong">restore [<em class="emph">option</em>...] <em class="emph">pkg</em> [<em class="emph">rev</em>]</strong></dt>
6004 <dd><a class="anchor" id="tlmgr-restore-_005boption_002e_002e_002e_005d-pkg-_005brev_005d"></a>
6005 </dd>
6006 <dt><strong class="strong">restore [<em class="emph">option</em>...] --all</strong></dt>
6007 <dd><a class="anchor" id="tlmgr-restore-_005boption_002e_002e_002e_005d-_002d_002dall"></a>
6008 <p>Restore a package from a previously-made backup.
6009 </p>
6010 <p>If <code class="code">--all</code> is given, try to restore the latest revision of all
6011 package backups found in the backup directory.
6012 </p>
6013 <p>Otherwise, if neither <em class="emph">pkg</em> nor <em class="emph">rev</em> are given, list the available
6014 backup revisions for all packages. With <em class="emph">pkg</em> given but no <em class="emph">rev</em>,
6015 list all available backup revisions of <em class="emph">pkg</em>.
6016 </p>
6017 <p>When listing available packages, <code class="code">tlmgr</code> shows the revision, and in
6018 parenthesis the creation time if available (in format yyyy-mm-dd hh:mm).
6019 </p>
6020 <p>If (and only if) both <em class="emph">pkg</em> and a valid revision number <em class="emph">rev</em> are
6021 specified, try to restore the package from the specified backup.
6022 </p>
6023 <p>Options:
6024 </p>
6025 <dl class="table">
6026 <dt><strong class="strong">--all</strong></dt>
6027 <dd><a class="anchor" id="tlmgr-_002d_002dall-3"></a>
6028 <p>Try to restore the latest revision of all package backups found in the
6029 backup directory. Additional non-option arguments (like <em class="emph">pkg</em>) are not
6030 allowed.
6031 </p>
6032 </dd>
6033 <dt><strong class="strong">--backupdir</strong> <em class="emph">directory</em></dt>
6034 <dd><a class="anchor" id="tlmgr-_002d_002dbackupdir-directory-2"></a>
6035 <p>Specify the directory where the backups are to be found. If not given it
6036 will be taken from the configuration setting in the TLPDB.
6037 </p>
6038 </dd>
6039 <dt><strong class="strong">--dry-run</strong></dt>
6040 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun-4"></a>
6041 <p>Nothing is actually restored; instead, the actions to be performed are
6042 written to the terminal.
6043 </p>
6044 </dd>
6045 <dt><strong class="strong">--force</strong></dt>
6046 <dd><a class="anchor" id="tlmgr-_002d_002dforce-2"></a>
6047 <p>Don&rsquo;t ask questions.
6048 </p>
6049 </dd>
6050 <dt><strong class="strong">--json</strong></dt>
6051 <dd><a class="anchor" id="tlmgr-_002d_002djson-2"></a>
6052 <p>When listing backups, the option <code class="code">--json</code> writes JSON output. The
6053 format is an array of JSON objects (<code class="code">name</code>, <code class="code">rev</code>, <code class="code">date</code>). For
6054 details see <code class="code">tlpkg/doc/json-formats.txt</code>, format definition:
6055 <code class="code">TLBACKUPS</code>. If both <code class="code">--json</code> and <code class="code">--data</code> are given, <code class="code">--json</code> takes
6056 precedence.
6057 </p>
6058 </dd>
6059 </dl>
6060
6061 </dd>
6062 </dl>
6063
6064 <hr>
6065 </div>
6066 <div class="appendixsubsec-level-extent" id="tlmgr-search">
6067 <div class="nav-panel">
6068 <p>
6069 Next: <a href="#tlmgr-shell" accesskey="n" rel="next">shell</a>, Previous: <a href="#tlmgr-restore" accesskey="p" rel="prev">restore</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6070 </div>
6071 <h4 class="appendixsubsec" id="search"><span>B.6.27 search<a class="copiable-link" href="#search"> &para;</a></span></h4>
6072
6073 <dl class="table">
6074 <dt><strong class="strong">search [<em class="emph">option</em>...] <em class="emph">what</em></strong></dt>
6075 <dd><a class="anchor" id="tlmgr-search-_005boption_002e_002e_002e_005d-what"></a>
6076 </dd>
6077 <dt><strong class="strong">search [<em class="emph">option</em>...] --file <em class="emph">what</em></strong></dt>
6078 <dd><a class="anchor" id="tlmgr-search-_005boption_002e_002e_002e_005d-_002d_002dfile-what"></a>
6079 </dd>
6080 <dt><strong class="strong">search [<em class="emph">option</em>...] --all <em class="emph">what</em></strong></dt>
6081 <dd><a class="anchor" id="tlmgr-search-_005boption_002e_002e_002e_005d-_002d_002dall-what"></a>
6082 <p>By default, search the names, short descriptions, and long descriptions
6083 of all locally installed packages for the argument <em class="emph">what</em>, interpreted
6084 as a (Perl) regular expression.
6085 </p>
6086 <p>Options:
6087 </p>
6088 <dl class="table">
6089 <dt><strong class="strong">--file</strong></dt>
6090 <dd><a class="anchor" id="tlmgr-_002d_002dfile-1"></a>
6091 <p>List all filenames containing <em class="emph">what</em>.
6092 </p>
6093 </dd>
6094 <dt><strong class="strong">--all</strong></dt>
6095 <dd><a class="anchor" id="tlmgr-_002d_002dall-4"></a>
6096 <p>Search everything: package names, descriptions and filenames.
6097 </p>
6098 </dd>
6099 <dt><strong class="strong">--global</strong></dt>
6100 <dd><a class="anchor" id="tlmgr-_002d_002dglobal"></a>
6101 <p>Search the TeX Live Database of the installation medium, instead of the
6102 local installation.
6103 </p>
6104 </dd>
6105 <dt><strong class="strong">--word</strong></dt>
6106 <dd><a class="anchor" id="tlmgr-_002d_002dword"></a>
6107 <p>Restrict the search of package names and descriptions (but not
6108 filenames) to match only full words. For example, searching for
6109 <code class="code">table</code> with this option will not output packages containing the word
6110 <code class="code">tables</code> (unless they also contain the word <code class="code">table</code> on its own).
6111 </p>
6112 </dd>
6113 <dt><strong class="strong">--json</strong></dt>
6114 <dd><a class="anchor" id="tlmgr-_002d_002djson-3"></a>
6115 <p>Output search results as a JSON hash with two keys: <strong class="strong">files</strong> and
6116 <strong class="strong">packages</strong>. For the format of the JSON output see
6117 <code class="code">tlpkg/doc/json-formats.txt</code>, format definition <code class="code">TLSEARCH</code>.
6118 </p>
6119 </dd>
6120 </dl>
6121
6122 </dd>
6123 </dl>
6124
6125 <hr>
6126 </div>
6127 <div class="appendixsubsec-level-extent" id="tlmgr-shell">
6128 <div class="nav-panel">
6129 <p>
6130 Next: <a href="#tlmgr-show" accesskey="n" rel="next">show</a>, Previous: <a href="#tlmgr-search" accesskey="p" rel="prev">search</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6131 </div>
6132 <h4 class="appendixsubsec" id="shell"><span>B.6.28 shell<a class="copiable-link" href="#shell"> &para;</a></span></h4>
6133
6134 <p>Starts an interactive mode, where tlmgr prompts for commands. This can
6135 be used directly, or for scripting. The first line of output is
6136 <code class="code">protocol</code> <em class="emph">n</em>, where <em class="emph">n</em> is an unsigned number identifying the
6137 protocol version (currently 1).
6138 </p>
6139 <p>In general, tlmgr actions that can be given on the command line
6140 translate to commands in this shell mode. For example, you can say
6141 <code class="code">update --list</code> to see what would be updated. The TLPDB is loaded the
6142 first time it is needed (not at the beginning), and used for the rest of
6143 the session.
6144 </p>
6145 <p>Besides these actions, a few commands are specific to shell mode:
6146 </p>
6147 <dl class="table">
6148 <dt>protocol</dt>
6149 <dd><a class="anchor" id="tlmgr-protocol"></a>
6150 <p>Print <code class="code">protocol <em class="emph">n</em></code>, the current protocol version.
6151 </p>
6152 </dd>
6153 <dt>help</dt>
6154 <dd><a class="anchor" id="tlmgr-help-1"></a>
6155 <p>Print pointers to this documentation.
6156 </p>
6157 </dd>
6158 <dt>version</dt>
6159 <dd><a class="anchor" id="tlmgr-version-1"></a>
6160 <p>Print tlmgr version information.
6161 </p>
6162 </dd>
6163 <dt>quit, end, bye, byebye, EOF</dt>
6164 <dd><a class="anchor" id="tlmgr-quit_002c-end_002c-bye_002c-byebye_002c-EOF"></a>
6165 <p>Exit.
6166 </p>
6167 </dd>
6168 <dt>restart</dt>
6169 <dd><a class="anchor" id="tlmgr-restart"></a>
6170 <p>Restart <code class="code">tlmgr shell</code> with the original command line; most useful when
6171 developing <code class="code">tlmgr</code>.
6172 </p>
6173 </dd>
6174 <dt>load [local|remote]</dt>
6175 <dd><a class="anchor" id="tlmgr-load-_005blocal_007cremote_005d"></a>
6176 <p>Explicitly load the local or remote, respectively, TLPDB.
6177 </p>
6178 </dd>
6179 <dt>save</dt>
6180 <dd><a class="anchor" id="tlmgr-save"></a>
6181 <p>Save the local TLPDB, presumably after other operations have changed it.
6182 </p>
6183 </dd>
6184 <dt>get [<em class="emph">var</em>] =item set [<em class="emph">var</em> [<em class="emph">val</em>]]</dt>
6185 <dd><a class="anchor" id="tlmgr-get-_005bvar_005d-_003ditem-set-_005bvar-_005bval_005d_005d"></a>
6186 <p>Get the value of <em class="emph">var</em>, or set it to <em class="emph">val</em>. Possible <em class="emph">var</em> names:
6187 <code class="code">debug-translation</code>, <code class="code">machine-readable</code>, <code class="code">no-execute-actions</code>,
6188 <code class="code">require-verification</code>, <code class="code">verify-downloads</code>, <code class="code">repository</code>, and
6189 <code class="code">prompt</code>. All except <code class="code">repository</code> and <code class="code">prompt</code> are booleans, taking
6190 values 0 and 1, and behave like the corresponding command line option.
6191 The <code class="code">repository</code> variable takes a string, and sets the remote
6192 repository location. The <code class="code">prompt</code> variable takes a string, and sets the
6193 current default prompt.
6194 </p>
6195 <p>If <em class="emph">var</em> or then <em class="emph">val</em> is not specified, it is prompted for.
6196 </p>
6197 </dd>
6198 </dl>
6199
6200 <hr>
6201 </div>
6202 <div class="appendixsubsec-level-extent" id="tlmgr-show">
6203 <div class="nav-panel">
6204 <p>
6205 Next: <a href="#tlmgr-uninstall" accesskey="n" rel="next">uninstall</a>, Previous: <a href="#tlmgr-shell" accesskey="p" rel="prev">shell</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6206 </div>
6207 <h4 class="appendixsubsec" id="show"><span>B.6.29 show<a class="copiable-link" href="#show"> &para;</a></span></h4>
6208
6209 <p>Synonym for <a class="ref" href="#tlmgr-info">info</a>.
6210 </p>
6211 <hr>
6212 </div>
6213 <div class="appendixsubsec-level-extent" id="tlmgr-uninstall">
6214 <div class="nav-panel">
6215 <p>
6216 Next: <a href="#tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d" accesskey="n" rel="next">update [<em class="emph">option</em>...] [<em class="emph">pkg</em>...]</a>, Previous: <a href="#tlmgr-show" accesskey="p" rel="prev">show</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6217 </div>
6218 <h4 class="appendixsubsec" id="uninstall"><span>B.6.30 uninstall<a class="copiable-link" href="#uninstall"> &para;</a></span></h4>
6219
6220 <p>Synonym for <a class="ref" href="#tlmgr-remove-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">remove</a>.
6221 </p>
6222 <hr>
6223 </div>
6224 <div class="appendixsubsec-level-extent" id="tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d">
6225 <div class="nav-panel">
6226 <p>
6227 Previous: <a href="#tlmgr-uninstall" accesskey="p" rel="prev">uninstall</a>, Up: <a href="#tlmgr-ACTIONS" accesskey="u" rel="up">ACTIONS</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6228 </div>
6229 <h4 class="appendixsubsec" id="update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d"><span>B.6.31 update [<em class="emph">option</em>...] [<em class="emph">pkg</em>...]<a class="copiable-link" href="#update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d"> &para;</a></span></h4>
6230
6231 <p>Updates the packages given as arguments to the latest version available
6232 at the installation source. Either <code class="code">--all</code> or at least one <em class="emph">pkg</em> name
6233 must be specified. Options:
6234 </p>
6235 <dl class="table">
6236 <dt><strong class="strong">--all</strong></dt>
6237 <dd><a class="anchor" id="tlmgr-_002d_002dall-5"></a>
6238 <p>Update all installed packages except for <code class="code">tlmgr</code> itself. If updates to
6239 <code class="code">tlmgr</code> itself are present, this gives an error, unless also the option
6240 <code class="code">--force</code> or <code class="code">--self</code> is given. (See below.)
6241 </p>
6242 <p>In addition to updating the installed packages, during the update of a
6243 collection the local installation is (by default) synchronized to the
6244 status of the collection on the server, for both additions and removals.
6245 </p>
6246 <p>This means that if a package has been removed on the server (and thus
6247 has also been removed from the respective collection), <code class="code">tlmgr</code> will
6248 remove the package in the local installation. This is called
6249 &ldquo;auto-remove&rdquo; and is announced as such when using the option
6250 <code class="code">--list</code>. This auto-removal can be suppressed using the option
6251 <code class="code">--no-auto-remove</code> (not recommended, see option description).
6252 </p>
6253 <p>Analogously, if a package has been added to a collection on the server
6254 that is also installed locally, it will be added to the local
6255 installation. This is called &ldquo;auto-install&rdquo; and is announced as such
6256 when using the option <code class="code">--list</code>. This auto-installation can be
6257 suppressed using the option <code class="code">--no-auto-install</code> (also not recommended).
6258 </p>
6259 <p>An exception to the collection dependency checks (including the
6260 auto-installation of packages just mentioned) are those that have been
6261 &ldquo;forcibly removed&rdquo; by you, that is, you called <code class="code">tlmgr remove --force</code>
6262 on them. (See the <code class="code">remove</code> action documentation.) To reinstall any
6263 such forcibly removed packages use <code class="code">--reinstall-forcibly-removed</code>.
6264 </p>
6265 <p>To reiterate: automatic removals and additions are entirely determined
6266 by comparison of collections. Thus, if you manually install an
6267 individual package <code class="code">foo</code> which is later removed from the server,
6268 <code class="code">tlmgr</code> will not notice and will not remove it locally. (It has to be
6269 this way, without major rearchitecture work, because the tlpdb does not
6270 record the repository from which packages come from.)
6271 </p>
6272 <p>If you want to exclude some packages from the current update run (e.g.,
6273 due to a slow link), see the <code class="code">--exclude</code> option below.
6274 </p>
6275 </dd>
6276 <dt><strong class="strong">--self</strong></dt>
6277 <dd><a class="anchor" id="tlmgr-_002d_002dself"></a>
6278 <p>Update <code class="code">tlmgr</code> itself (that is, the infrastructure packages) if updates
6279 to it are present. On Windows this includes updates to the private Perl
6280 interpreter shipped inside TeX Live.
6281 </p>
6282 <p>If this option is given together with either <code class="code">--all</code> or a list of
6283 packages, then <code class="code">tlmgr</code> will be updated first and, if this update
6284 succeeds, the new version will be restarted to complete the rest of the
6285 updates.
6286 </p>
6287 <p>In short:
6288 </p>
6289 <pre class="verbatim"> tlmgr update --self # update infrastructure only
6290 tlmgr update --self --all # update infrastructure and all packages
6291 tlmgr update --force --all # update all packages but *not* infrastructure
6292 # ... this last at your own risk, not recommended!
6293 </pre>
6294 </dd>
6295 <dt><strong class="strong">--dry-run</strong></dt>
6296 <dd><a class="anchor" id="tlmgr-_002d_002ddry_002drun-5"></a>
6297 <p>Nothing is actually installed; instead, the actions to be performed are
6298 written to the terminal. This is a more detailed report than <code class="code">--list</code>.
6299 </p>
6300 </dd>
6301 <dt><strong class="strong">--list</strong> [<em class="emph">pkg</em>]</dt>
6302 <dd><a class="anchor" id="tlmgr-_002d_002dlist-_005bpkg_005d"></a>
6303 <p>Concisely list the packages which would be updated, newly installed, or
6304 removed, without actually changing anything.
6305 If <code class="code">--all</code> is also given, all available updates are listed.
6306 If <code class="code">--self</code> is given, but not <code class="code">--all</code>, only updates to the
6307 critical packages (tlmgr, texlive infrastructure, perl on Windows, etc.)
6308 are listed.
6309 If neither <code class="code">--all</code> nor <code class="code">--self</code> is given, and in addition no <em class="emph">pkg</em> is
6310 given, then <code class="code">--all</code> is assumed (thus, <code class="code">tlmgr update --list</code> is the
6311 same as <code class="code">tlmgr update --list --all</code>).
6312 If neither <code class="code">--all</code> nor <code class="code">--self</code> is given, but specific package names are
6313 given, those packages are checked for updates.
6314 </p>
6315 </dd>
6316 <dt><strong class="strong">--exclude</strong> <em class="emph">pkg</em></dt>
6317 <dd><a class="anchor" id="tlmgr-_002d_002dexclude-pkg"></a>
6318 <p>Exclude <em class="emph">pkg</em> from the update process. If this option is given more
6319 than once, its arguments accumulate.
6320 </p>
6321 <p>An argument <em class="emph">pkg</em> excludes both the package <em class="emph">pkg</em> itself and all
6322 its related platform-specific packages <em class="emph">pkg.ARCH</em>. For example,
6323 </p>
6324 <pre class="verbatim"> tlmgr update --all --exclude a2ping
6325 </pre>
6326 <p>will not update <code class="code">a2ping</code>, <code class="code">a2ping.i386-linux</code>, or
6327 any other <code class="code">a2ping.</code><em class="emph">ARCH</em> package.
6328 </p>
6329 <p>If this option specifies a package that would otherwise be a candidate
6330 for auto-installation, auto-removal, or reinstallation of a forcibly
6331 removed package, <code class="code">tlmgr</code> quits with an error message. Excludes are not
6332 supported in these circumstances.
6333 </p>
6334 <p>This option can also be set permanently in the tlmgr config file with
6335 the key <code class="code">update-exclude</code>.
6336 </p>
6337 </dd>
6338 <dt><strong class="strong">--no-auto-remove</strong> [<em class="emph">pkg</em>...]</dt>
6339 <dd><a class="anchor" id="tlmgr-_002d_002dno_002dauto_002dremove-_005bpkg_002e_002e_002e_005d"></a>
6340 <p>By default, <code class="code">tlmgr</code> tries to remove packages in an existing collection
6341 which have disappeared on the server, as described above under <code class="code">--all</code>.
6342 This option prevents such removals, either for all packages (with
6343 <code class="code">--all</code>), or for just the given <em class="emph">pkg</em> names. This can lead to an
6344 inconsistent TeX installation, since packages are not infrequently
6345 renamed or replaced by their authors. Therefore this is not recommended.
6346 </p>
6347 </dd>
6348 <dt><strong class="strong">--no-auto-install</strong> [<em class="emph">pkg</em>...]</dt>
6349 <dd><a class="anchor" id="tlmgr-_002d_002dno_002dauto_002dinstall-_005bpkg_002e_002e_002e_005d"></a>
6350 <p>Under normal circumstances <code class="code">tlmgr</code> will install packages which are new
6351 on the server, as described above under <code class="code">--all</code>. This option prevents
6352 any such automatic installation, either for all packages (with
6353 <code class="code">--all</code>), or the given <em class="emph">pkg</em> names.
6354 </p>
6355 <p>Furthermore, after the <code class="code">tlmgr</code> run using this has finished, the
6356 packages that would have been auto-installed <em class="emph">will be considered as
6357 forcibly removed</em>. So, if <code class="code">foobar</code> is the only new package on the
6358 server, then
6359 </p>
6360 <pre class="verbatim"> tlmgr update --all --no-auto-install
6361 </pre>
6362 <p>is equivalent to
6363 </p>
6364 <pre class="verbatim"> tlmgr update --all
6365 tlmgr remove --force foobar
6366 </pre>
6367 <p>Again, since packages are sometimes renamed or replaced, using this
6368 option is not recommended.
6369 </p>
6370 </dd>
6371 <dt><strong class="strong">--reinstall-forcibly-removed</strong></dt>
6372 <dd><a class="anchor" id="tlmgr-_002d_002dreinstall_002dforcibly_002dremoved"></a>
6373 <p>Under normal circumstances <code class="code">tlmgr</code> will not install packages that have
6374 been forcibly removed by the user; that is, removed with <code class="code">remove
6375 --force</code>, or whose installation was prohibited by <code class="code">--no-auto-install</code>
6376 during an earlier update.
6377 </p>
6378 <p>This option makes <code class="code">tlmgr</code> ignore the forcible removals and re-install
6379 all such packages. This can be used to completely synchronize an
6380 installation with the server&rsquo;s idea of what is available:
6381 </p>
6382 <pre class="verbatim"> tlmgr update --reinstall-forcibly-removed --all
6383 </pre>
6384 </dd>
6385 <dt><strong class="strong">--backup</strong></dt>
6386 <dd><a class="anchor" id="tlmgr-_002d_002dbackup-1"></a>
6387 </dd>
6388 <dt><strong class="strong">--backupdir</strong> <em class="emph">directory</em></dt>
6389 <dd><a class="anchor" id="tlmgr-_002d_002dbackupdir-directory-3"></a>
6390 <p>These two options control the creation of backups of packages <em class="emph">before</em>
6391 updating; that is, backing up packages as currently installed. If
6392 neither option is given, no backup will made. If <code class="code">--backupdir</code> is
6393 given and specifies a writable directory then a backup will be made in
6394 that location. If only <code class="code">--backup</code> is given, then a backup will be made
6395 to the directory previously set via the <a class="ref" href="#tlmgr-option">option</a> action (see
6396 below). If both are given then a backup will be made to the specified
6397 <em class="emph">directory</em>.
6398 </p>
6399 <p>You can also set options via the <a class="ref" href="#tlmgr-option">option</a> action to automatically make
6400 backups for all packages, and/or keep only a certain number of backups.
6401 </p>
6402 <p><code class="code">tlmgr</code> always makes a temporary backup when updating packages, in case
6403 of download or other failure during an update. In contrast, the purpose
6404 of this <code class="code">--backup</code> option is to save a persistent backup in case the
6405 actual <em class="emph">content</em> of the update causes problems, e.g., introduces an TeX
6406 incompatibility.
6407 </p>
6408 <p>The <a class="ref" href="#tlmgr-restore">restore</a> action explains how to restore from a backup.
6409 </p>
6410 </dd>
6411 <dt><strong class="strong">--no-depends</strong></dt>
6412 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends-2"></a>
6413 <p>If you call for updating a package normally all depending packages
6414 will also be checked for updates and updated if necessary. This switch
6415 suppresses this behavior.
6416 </p>
6417 </dd>
6418 <dt><strong class="strong">--no-depends-at-all</strong></dt>
6419 <dd><a class="anchor" id="tlmgr-_002d_002dno_002ddepends_002dat_002dall-2"></a>
6420 <p>See above under <a class="ref" href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">install</a> (and beware).
6421 </p>
6422 </dd>
6423 <dt><strong class="strong">--force</strong></dt>
6424 <dd><a class="anchor" id="tlmgr-_002d_002dforce-3"></a>
6425 <p>Force update of normal packages, without updating <code class="code">tlmgr</code> itself
6426 (unless the <code class="code">--self</code> option is also given). Not recommended.
6427 </p>
6428 <p>Also, <code class="code">update --list</code> is still performed regardless of this option.
6429 </p>
6430 </dd>
6431 </dl>
6432
6433 <p>If the package on the server is older than the package already installed
6434 (e.g., if the selected mirror is out of date), <code class="code">tlmgr</code> does not
6435 downgrade. Also, packages for uninstalled platforms are not installed.
6436 </p>
6437 <p><code class="code">tlmgr</code> saves one copy of the main <code class="code">texlive.tlpdb</code> file used for an
6438 update with a suffix representing the repository url, as in
6439 <code class="code">tlpkg/texlive.tlpdb.main.</code><em class="emph">long-hash-string</em>. Thus, even when many
6440 mirrors are used, only one main <code class="code">tlpdb</code> backup is kept. For non-main
6441 repositories, which do not generally have (m)any mirrors, no pruning of
6442 backups is done.
6443 </p>
6444 <p>This action does not automatically add or remove new symlinks in system
6445 directories; you need to run <code class="code">tlmgr</code> <a class="ref" href="#tlmgr-path">path</a> yourself if you are using
6446 this feature and want new symlinks added.
6447 </p>
6448 <hr>
6449 </div>
6450 </div>
6451 <div class="appendixsec-level-extent" id="tlmgr-CONFIGURATION-FILE-FOR-TLMGR">
6452 <div class="nav-panel">
6453 <p>
6454 Next: <a href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION" accesskey="n" rel="next">CRYPTOGRAPHIC VERIFICATION</a>, Previous: <a href="#tlmgr-ACTIONS" accesskey="p" rel="prev">ACTIONS</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6455 </div>
6456 <h3 class="appendixsec" id="CONFIGURATION-FILE-FOR-TLMGR"><span>B.7 CONFIGURATION FILE FOR TLMGR<a class="copiable-link" href="#CONFIGURATION-FILE-FOR-TLMGR"> &para;</a></span></h3>
6457
6458 <p><code class="code">tlmgr</code> reads two configuration files: one is system-wide, in
6459 <code class="code">TEXMFSYSCONFIG/tlmgr/config</code>, and the other is user-specific, in
6460 <code class="code">TEXMFCONFIG/tlmgr/config</code>. The user-specific one is the default for
6461 the <code class="code">conf tlmgr</code> action. (Run <code class="code">kpsewhich
6462 -var-value=TEXMFSYSCONFIG</code> or <code class="code">... TEXMFCONFIG ...</code> to see the actual
6463 directory names.)
6464 </p>
6465 <p>A few defaults corresponding to command-line options can be set in these
6466 configuration files. In addition, the system-wide file can contain a
6467 directive to restrict the allowed actions.
6468 </p>
6469 <p>In these config files, empty lines and lines starting with # are
6470 ignored. All other lines must look like:
6471 </p>
6472 <pre class="verbatim"> key = value
6473 </pre>
6474 <p>where the spaces are optional but the <code class="code">=</code> is required.
6475 </p>
6476 <p>The allowed keys are:
6477 </p>
6478 <dl class="table">
6479 <dt><code class="code">auto-remove =</code> 0 or 1 (default 1), same as command-line option.</dt>
6480 <dd><a class="anchor" id="tlmgr-auto_002dremove-_003d-0-or-1-_0028default-1_0029_002c-same-as-command_002dline-option_002e"></a>
6481 </dd>
6482 <dt><code class="code">gui-expertmode =</code> 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.</dt>
6483 <dd><a class="anchor" id="tlmgr-gui_002dexpertmode-_003d-0-or-1-_0028default-1_0029_002e-This-switches-between-the-full-GUI-and-a-simplified-GUI-with-only-the-most-common-settings_002e"></a>
6484 </dd>
6485 <dt><code class="code">gui-lang =</code> <em class="emph">llcode</em>, with a language code value as with the command-line option.</dt>
6486 <dd><a class="anchor" id="tlmgr-gui_002dlang-_003d-llcode_002c-with-a-language-code-value-as-with-the-command_002dline-option_002e"></a>
6487 </dd>
6488 <dt><code class="code">no-checksums =</code> 0 or 1 (default 0, see below).</dt>
6489 <dd><a class="anchor" id="tlmgr-no_002dchecksums-_003d-0-or-1-_0028default-0_002c-see-below_0029_002e"></a>
6490 </dd>
6491 <dt><code class="code">persistent-downloads =</code> 0 or 1 (default 1), same as command-line option.</dt>
6492 <dd><a class="anchor" id="tlmgr-persistent_002ddownloads-_003d-0-or-1-_0028default-1_0029_002c-same-as-command_002dline-option_002e"></a>
6493 </dd>
6494 <dt><code class="code">require-verification =</code> 0 or 1 (default 0), same as command-line option.</dt>
6495 <dd><a class="anchor" id="tlmgr-require_002dverification-_003d-0-or-1-_0028default-0_0029_002c-same-as-command_002dline-option_002e"></a>
6496 </dd>
6497 <dt><code class="code">tkfontscale =</code> <em class="emph">floating-point number</em> (default 1.0); scaling factor for fonts in the Tk-based frontends.</dt>
6498 <dd><a class="anchor" id="tlmgr-tkfontscale-_003d-floating_002dpoint-number-_0028default-1_002e0_0029_003b-scaling-factor-for-fonts-in-the-Tk_002dbased-frontends_002e"></a>
6499 </dd>
6500 <dt><code class="code">update-exclude =</code> <em class="emph">comma-separated list of packages</em> (no spaces allowed). Same as the command line option <code class="code">--exclude</code> for the <code class="code">update</code> action.</dt>
6501 <dd><a class="anchor" id="tlmgr-update_002dexclude-_003d-comma_002dseparated-list-of-packages-_0028no-spaces-allowed_0029_002e-Same-as-the-command-line-option-_002d_002dexclude-for-the-update-action_002e"></a>
6502 </dd>
6503 <dt><code class="code">verify-downloads =</code> 0 or 1 (default 1), same as command-line option.</dt>
6504 <dd><a class="anchor" id="tlmgr-verify_002ddownloads-_003d-0-or-1-_0028default-1_0029_002c-same-as-command_002dline-option_002e"></a>
6505 </dd>
6506 </dl>
6507
6508 <p>The system-wide config file can contain one additional key:
6509 </p>
6510 <dl class="table">
6511 <dt><code class="code">allowed-actions =</code> <em class="emph">action1</em>[,<em class="emph">action2</em>,...] The value is a comma-separated list (no spaces) of <code class="code">tlmgr</code> actions which are allowed to be executed when <code class="code">tlmgr</code> is invoked in system mode (that is, without <code class="code">--usermode</code>). This allows distributors to include <code class="code">tlmgr</code> 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&rsquo;t make sense to set this.</dt>
6512 <dd><a class="anchor" id="tlmgr-allowed_002dactions-_003d-action1_005b_002caction2_002c_002e_002e_002e_005d-The-value-is-a-comma_002dseparated-list-_0028no-spaces_0029-of-tlmgr-actions-which-are-allowed-to-be-executed-when-tlmgr-is-invoked-in-system-mode-_0028that-is_002c-without-_002d_002dusermode_0029_002e-This-allows-distributors-to-include-tlmgr-in-their-packaging_002c-but-allow-only-a-restricted-set-of-actions-that-do-not-interfere-with-their-distro-package-manager_002e-For-native-TeX-Live-installations_002c-it-doesn_0027t-make-sense-to-set-this_002e"></a>
6513 </dd>
6514 </dl>
6515
6516 <p>Finally, the <code class="code">no-checksums</code> key needs more explanation. By default,
6517 package checksums computed and stored on the server (in the TLPDB) are
6518 compared to checksums computed locally after downloading.
6519 <code class="code">no-checksums</code> disables this process. The checksum algorithm is
6520 SHA-512. Your system must have one of (looked for in this order) the
6521 Perl <code class="code">Digest::SHA</code> module, the <code class="code">openssl</code> program
6522 (<a class="url" href="https://openssl.org">https://openssl.org</a>), the <code class="code">sha512sum</code> program (from GNU Coreutils,
6523 <a class="url" href="https://www.gnu.org/software/coreutils">https://www.gnu.org/software/coreutils</a>), or finally the <code class="code">shasum</code>
6524 program (just to support old Macs). If none of these are available, a
6525 warning is issued and <code class="code">tlmgr</code> proceeds without checking checksums.
6526 <code class="code">no-checksums</code> avoids the warning. (Incidentally, other SHA
6527 implementations, such as the pure Perl and pure Lua modules, are much
6528 too slow to be usable in our context.)
6529 </p>
6530 <hr>
6531 </div>
6532 <div class="appendixsec-level-extent" id="tlmgr-CRYPTOGRAPHIC-VERIFICATION">
6533 <div class="nav-panel">
6534 <p>
6535 Next: <a href="#tlmgr-USER-MODE" accesskey="n" rel="next">USER MODE</a>, Previous: <a href="#tlmgr-CONFIGURATION-FILE-FOR-TLMGR" accesskey="p" rel="prev">CONFIGURATION FILE FOR TLMGR</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6536 </div>
6537 <h3 class="appendixsec" id="CRYPTOGRAPHIC-VERIFICATION"><span>B.8 CRYPTOGRAPHIC VERIFICATION<a class="copiable-link" href="#CRYPTOGRAPHIC-VERIFICATION"> &para;</a></span></h3>
6538
6539 <p><code class="code">tlmgr</code> and <code class="code">install-tl</code> perform cryptographic verification if
6540 possible. If verification is performed and successful, the programs
6541 report <code class="code">(verified)</code> after loading the TLPDB; otherwise, they report
6542 <code class="code">(not verified)</code>. But either way, by default the installation and/or
6543 updates proceed normally.
6544 </p>
6545 <p>If a program named <code class="code">gpg</code> is available (that is, found in <code class="code">PATH</code>), by
6546 default cryptographic signatures will be checked: we require the main
6547 repository be signed, but not any additional repositories. If <code class="code">gpg</code> is
6548 not available, by default signatures are not checked and no verification
6549 is carried out, but <code class="code">tlmgr</code> still proceeds normally.
6550 </p>
6551 <p>The behavior of the verification can be controlled by the command line
6552 and config file option <code class="code">verify-repo</code> which takes one of the following
6553 values: <code class="code">none</code>, <code class="code">main</code>, or <code class="code">all</code>. With <code class="code">none</code>, no verification
6554 whatsoever is attempted. With <code class="code">main</code> (the default) verification is
6555 required only for the main repository, and only if <code class="code">gpg</code> is available;
6556 though attempted for all, missing signatures of subsidiary repositories
6557 will not result in an error. Finally, in the case of <code class="code">all</code>, <code class="code">gpg</code>
6558 must be available and all repositories need to be signed.
6559 </p>
6560 <p>In all cases, if a signature is checked and fails to verify, an error
6561 is raised.
6562 </p>
6563 <p>Cryptographic verification requires checksum checking (described just
6564 above) to succeed, and a working GnuPG (<code class="code">gpg</code>) program (see below for
6565 search method). Then, unless cryptographic verification has been
6566 disabled, a signature file (<code class="code">texlive.tlpdb.*.asc</code>) of the checksum file
6567 is downloaded and the signature verified. The signature is created by
6568 the TeX Live Distribution GPG key 0x0D5E5D9106BAB6BC, which in turn is
6569 signed by Karl Berry&rsquo;s key 0x0716748A30D155AD and
6570 Norbert Preining&rsquo;s key 0x6CACA448860CDC13. All
6571 of these keys are obtainable from the standard key servers.
6572 </p>
6573 <p>Additional trusted keys can be added using the <code class="code">key</code> action.
6574 </p>
6575 <ul class="mini-toc">
6576 <li><a href="#tlmgr-Configuration-of-GnuPG-invocation" accesskey="1">Configuration of GnuPG invocation</a></li>
6577 </ul>
6578 <hr>
6579 <div class="appendixsubsec-level-extent" id="tlmgr-Configuration-of-GnuPG-invocation">
6580 <div class="nav-panel">
6581 <p>
6582 Up: <a href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION" accesskey="u" rel="up">CRYPTOGRAPHIC VERIFICATION</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6583 </div>
6584 <h4 class="appendixsubsec" id="Configuration-of-GnuPG-invocation"><span>B.8.1 Configuration of GnuPG invocation<a class="copiable-link" href="#Configuration-of-GnuPG-invocation"> &para;</a></span></h4>
6585
6586 <p>The executable used for GnuPG is searched as follows: If the environment
6587 variable <code class="code">TL_GNUPG</code> is set, it is tested and used; otherwise <code class="code">gpg</code> is
6588 checked; finally <code class="code">gpg2</code> is checked.
6589 </p>
6590 <p>Further adaptation of the <code class="code">gpg</code> invocation can be made using the two
6591 environment variables <code class="code">TL_GNUPGHOME</code>, which is passed to <code class="code">gpg</code> as the
6592 value for <code class="code">--homedir</code>, and <code class="code">TL_GNUPGARGS</code>, which replaces the default
6593 options <code class="code">--no-secmem-warning --no-permission-warning</code>.
6594 </p>
6595 <hr>
6596 </div>
6597 </div>
6598 <div class="appendixsec-level-extent" id="tlmgr-USER-MODE">
6599 <div class="nav-panel">
6600 <p>
6601 Next: <a href="#tlmgr-MULTIPLE-REPOSITORIES" accesskey="n" rel="next">MULTIPLE REPOSITORIES</a>, Previous: <a href="#tlmgr-CRYPTOGRAPHIC-VERIFICATION" accesskey="p" rel="prev">CRYPTOGRAPHIC VERIFICATION</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6602 </div>
6603 <h3 class="appendixsec" id="USER-MODE"><span>B.9 USER MODE<a class="copiable-link" href="#USER-MODE"> &para;</a></span></h3>
6604
6605 <p><code class="code">tlmgr</code> provides a restricted way, called &ldquo;user mode&rdquo;, to manage
6606 arbitrary texmf trees in the same way as the main installation. For
6607 example, this allows people without write permissions on the
6608 installation location to update/install packages into a tree of their
6609 own.
6610 </p>
6611 <p><code class="code">tlmgr</code> is switched into user mode with the command line option
6612 <code class="code">--usermode</code>. It does not switch automatically, nor is there any
6613 configuration file setting for it. Thus, this option has to be
6614 explicitly given every time user mode is to be activated.
6615 </p>
6616 <p>This mode of <code class="code">tlmgr</code> works on a user tree, by default the value of the
6617 <code class="code">TEXMFHOME</code> variable. This can be overridden with the command line
6618 option <code class="code">--usertree</code>. In the following when we speak of the user tree
6619 we mean either <code class="code">TEXMFHOME</code> or the one given on the command line.
6620 </p>
6621 <p>Not all actions are allowed in user mode; <code class="code">tlmgr</code> will warn you and not
6622 carry out any problematic actions. Currently not supported (and
6623 probably will never be) is the <code class="code">platform</code> action. The <code class="code">gui</code> action is
6624 currently not supported, but may be in a future release.
6625 </p>
6626 <p>Some <code class="code">tlmgr</code> actions don&rsquo;t need any write permissions and thus work the
6627 same in user mode and normal mode. Currently these are: <code class="code">check</code>,
6628 <code class="code">help</code>, <code class="code">list</code>, <code class="code">print-platform</code>, <code class="code">print-platform-info</code>, <code class="code">search</code>,
6629 <code class="code">show</code>, <code class="code">version</code>.
6630 </p>
6631 <p>On the other hand, most of the actions dealing with package management
6632 do need write permissions, and thus behave differently in user mode, as
6633 described below: <code class="code">install</code>, <code class="code">update</code>, <code class="code">remove</code>, <code class="code">option</code>, <code class="code">paper</code>,
6634 <code class="code">generate</code>, <code class="code">backup</code>, <code class="code">restore</code>, <code class="code">uninstall</code>, <code class="code">symlinks</code>.
6635 </p>
6636 <p>Before using <code class="code">tlmgr</code> in user mode, you have to set up the user tree
6637 with the <code class="code">init-usertree</code> action. This creates <em class="emph">usertree</em><code class="code">/web2c</code> and
6638 <em class="emph">usertree</em><code class="code">/tlpkg/tlpobj</code>, and a minimal
6639 <em class="emph">usertree</em><code class="code">/tlpkg/texlive.tlpdb</code>. At that point, you can tell
6640 <code class="code">tlmgr</code> to do the (supported) actions by adding the <code class="code">--usermode</code>
6641 command line option.
6642 </p>
6643 <p>In user mode the file <em class="emph">usertree</em><code class="code">/tlpkg/texlive.tlpdb</code> contains only
6644 the packages that have been installed into the user tree using <code class="code">tlmgr</code>,
6645 plus additional options from the &ldquo;virtual&rdquo; package
6646 <code class="code">00texlive.installation</code> (similar to the main installation&rsquo;s
6647 <code class="code">texlive.tlpdb</code>).
6648 </p>
6649 <p>All actions on packages in user mode can only be carried out on packages
6650 that are known as <code class="code">relocatable</code>. This excludes all packages containing
6651 executables and a few other core packages. Of the 2500 or so packages
6652 currently in TeX Live the vast majority are relocatable and can be
6653 installed into a user tree.
6654 </p>
6655 <p>Description of changes of actions in user mode:
6656 </p>
6657 <ul class="mini-toc">
6658 <li><a href="#tlmgr-User-mode-install" accesskey="1">User mode install</a></li>
6659 <li><a href="#tlmgr-User-mode-backup_002c-restore_002c-remove_002c-update" accesskey="2">User mode backup, restore, remove, update</a></li>
6660 <li><a href="#tlmgr-User-mode-generate_002c-option_002c-paper" accesskey="3">User mode generate, option, paper</a></li>
6661 <li><a href="#tlmgr-User-mode-logs" accesskey="4">User mode logs</a></li>
6662 </ul>
6663 <hr>
6664 <div class="appendixsubsec-level-extent" id="tlmgr-User-mode-install">
6665 <div class="nav-panel">
6666 <p>
6667 Next: <a href="#tlmgr-User-mode-backup_002c-restore_002c-remove_002c-update" accesskey="n" rel="next">User mode backup, restore, remove, update</a>, Up: <a href="#tlmgr-USER-MODE" accesskey="u" rel="up">USER MODE</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6668 </div>
6669 <h4 class="appendixsubsec" id="User-mode-install"><span>B.9.1 User mode install<a class="copiable-link" href="#User-mode-install"> &para;</a></span></h4>
6670
6671 <p>In user mode, the <code class="code">install</code> action checks that the package and all
6672 dependencies are all either relocated or already installed in the system
6673 installation. If this is the case, it unpacks all containers to be
6674 installed into the user tree (to repeat, that&rsquo;s either <code class="code">TEXMFHOME</code> or
6675 the value of <code class="code">--usertree</code>) and add the respective packages to the user
6676 tree&rsquo;s <code class="code">texlive.tlpdb</code> (creating it if need be).
6677 </p>
6678 <p>Currently installing a collection in user mode installs all dependent
6679 packages, but in contrast to normal mode, does <em class="emph">not</em> install dependent
6680 collections. For example, in normal mode <code class="code">tlmgr install
6681 collection-context</code> would install <code class="code">collection-basic</code> and other
6682 collections, while in user mode, <em class="emph">only</em> the packages mentioned in
6683 <code class="code">collection-context</code> are installed.
6684 </p>
6685 <p>If a package shipping map files is installed in user mode, a backup of
6686 the user&rsquo;s <code class="code">updmap.cfg</code> in <code class="code">USERTREE/web2c/</code> is made, and then this file
6687 regenerated from the list of installed packages.
6688 </p>
6689 <hr>
6690 </div>
6691 <div class="appendixsubsec-level-extent" id="tlmgr-User-mode-backup_002c-restore_002c-remove_002c-update">
6692 <div class="nav-panel">
6693 <p>
6694 Next: <a href="#tlmgr-User-mode-generate_002c-option_002c-paper" accesskey="n" rel="next">User mode generate, option, paper</a>, Previous: <a href="#tlmgr-User-mode-install" accesskey="p" rel="prev">User mode install</a>, Up: <a href="#tlmgr-USER-MODE" accesskey="u" rel="up">USER MODE</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6695 </div>
6696 <h4 class="appendixsubsec" id="User-mode-backup_002c-restore_002c-remove_002c-update"><span>B.9.2 User mode backup, restore, remove, update<a class="copiable-link" href="#User-mode-backup_002c-restore_002c-remove_002c-update"> &para;</a></span></h4>
6697
6698 <p>In user mode, these actions check that all packages to be acted on are
6699 installed in the user tree before proceeding; otherwise, they behave
6700 just as in normal mode.
6701 </p>
6702 <hr>
6703 </div>
6704 <div class="appendixsubsec-level-extent" id="tlmgr-User-mode-generate_002c-option_002c-paper">
6705 <div class="nav-panel">
6706 <p>
6707 Next: <a href="#tlmgr-User-mode-logs" accesskey="n" rel="next">User mode logs</a>, Previous: <a href="#tlmgr-User-mode-backup_002c-restore_002c-remove_002c-update" accesskey="p" rel="prev">User mode backup, restore, remove, update</a>, Up: <a href="#tlmgr-USER-MODE" accesskey="u" rel="up">USER MODE</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6708 </div>
6709 <h4 class="appendixsubsec" id="User-mode-generate_002c-option_002c-paper"><span>B.9.3 User mode generate, option, paper<a class="copiable-link" href="#User-mode-generate_002c-option_002c-paper"> &para;</a></span></h4>
6710
6711 <p>In user mode, these actions operate only on the user tree&rsquo;s
6712 configuration files and/or <code class="code">texlive.tlpdb</code>.
6713 </p>
6714 <hr>
6715 </div>
6716 <div class="appendixsubsec-level-extent" id="tlmgr-User-mode-logs">
6717 <div class="nav-panel">
6718 <p>
6719 Previous: <a href="#tlmgr-User-mode-generate_002c-option_002c-paper" accesskey="p" rel="prev">User mode generate, option, paper</a>, Up: <a href="#tlmgr-USER-MODE" accesskey="u" rel="up">USER MODE</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6720 </div>
6721 <h4 class="appendixsubsec" id="User-mode-logs"><span>B.9.4 User mode logs<a class="copiable-link" href="#User-mode-logs"> &para;</a></span></h4>
6722
6723 <p>In user mode, <code class="code">tlmgr.log</code> and &lt;tlmgr-commands.log&gt; are written in the
6724 <code class="code">TEXMFVAR/web2c/</code> directlry instead of <code class="code">TEXMFSYSVAR/web2c/</code>.
6725 </p>
6726 <hr>
6727 </div>
6728 </div>
6729 <div class="appendixsec-level-extent" id="tlmgr-MULTIPLE-REPOSITORIES">
6730 <div class="nav-panel">
6731 <p>
6732 Next: <a href="#tlmgr-GUI-FOR-TLMGR" accesskey="n" rel="next">GUI FOR TLMGR</a>, Previous: <a href="#tlmgr-USER-MODE" accesskey="p" rel="prev">USER MODE</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6733 </div>
6734 <h3 class="appendixsec" id="MULTIPLE-REPOSITORIES"><span>B.10 MULTIPLE REPOSITORIES<a class="copiable-link" href="#MULTIPLE-REPOSITORIES"> &para;</a></span></h3>
6735
6736 <p>The main TeX Live repository contains a vast array of packages.
6737 Nevertheless, additional local repositories can be useful to provide
6738 locally-installed resources, such as proprietary fonts and house styles.
6739 Also, alternative package repositories distribute packages that cannot
6740 or should not be included in TeX Live, for whatever reason.
6741 </p>
6742 <p>The simplest and most reliable method is to temporarily set the
6743 installation source to any repository (with the <code class="code">-repository</code> or
6744 <code class="code">option repository</code> command line options), and perform your operations.
6745 </p>
6746 <p>When you are using multiple repositories over a sustained length of
6747 time, however, explicitly switching between them becomes inconvenient.
6748 Thus, it&rsquo;s possible to tell <code class="code">tlmgr</code> about additional repositories you
6749 want to use. The basic command is <code class="code">tlmgr repository add</code>. The rest of
6750 this section explains further.
6751 </p>
6752 <p>When using multiple repositories, one of them has to be set as the main
6753 repository, which distributes most of the installed packages. When you
6754 switch from a single repository installation to a multiple repository
6755 installation, the previous sole repository will be set as the main
6756 repository.
6757 </p>
6758 <p>By default, even if multiple repositories are configured, packages are
6759 <em class="emph">still</em> <em class="emph">only</em> installed from the main repository. Thus, simply
6760 adding a second repository does not actually enable installation of
6761 anything from there. You also have to specify which packages should be
6762 taken from the new repository, by specifying so-called &ldquo;pinning&rdquo;
6763 rules, described next.
6764 </p>
6765 <ul class="mini-toc">
6766 <li><a href="#tlmgr-Pinning" accesskey="1">Pinning</a></li>
6767 </ul>
6768 <hr>
6769 <div class="appendixsubsec-level-extent" id="tlmgr-Pinning">
6770 <div class="nav-panel">
6771 <p>
6772 Up: <a href="#tlmgr-MULTIPLE-REPOSITORIES" accesskey="u" rel="up">MULTIPLE REPOSITORIES</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6773 </div>
6774 <h4 class="appendixsubsec" id="Pinning"><span>B.10.1 Pinning<a class="copiable-link" href="#Pinning"> &para;</a></span></h4>
6775
6776 <p>When a package <code class="code">foo</code> is pinned to a repository, a package <code class="code">foo</code> in any
6777 other repository, even if it has a higher revision number, will not be
6778 considered an installable candidate.
6779 </p>
6780 <p>As mentioned above, by default everything is pinned to the main
6781 repository. Let&rsquo;s now go through an example of setting up a second
6782 repository and enabling updates of a package from it.
6783 </p>
6784 <p>First, check that we have support for multiple repositories, and have
6785 only one enabled (as is the case by default):
6786 </p>
6787 <pre class="verbatim"> $ tlmgr repository list
6788 List of repositories (with tags if set):
6789 /var/www/norbert/tlnet
6790 </pre>
6791 <p>Ok. Let&rsquo;s add the <code class="code">tlcontrib</code> repository (this is a real
6792 repository hosted at <a class="url" href="http://contrib.texlive.info">http://contrib.texlive.info</a>) with the tag <code class="code">tlcontrib</code>:
6793 </p>
6794 <pre class="verbatim"> $ tlmgr repository add http://contrib.texlive.info/current tlcontrib
6795 </pre>
6796 <p>Check the repository list again:
6797 </p>
6798 <pre class="verbatim"> $ tlmgr repository list
6799 List of repositories (with tags if set):
6800 http://contrib.texlive.info/current (tlcontrib)
6801 /var/www/norbert/tlnet (main)
6802 </pre>
6803 <p>Now we specify a pinning entry to get the package <code class="code">classico</code> from
6804 <code class="code">tlcontrib</code>:
6805 </p>
6806 <pre class="verbatim"> $ tlmgr pinning add tlcontrib classico
6807 </pre>
6808 <p>Check that we can find <code class="code">classico</code>:
6809 </p>
6810 <pre class="verbatim"> $ tlmgr show classico
6811 package: classico
6812 ...
6813 shortdesc: URW Classico fonts
6814 ...
6815 </pre>
6816 <p>- install <code class="code">classico</code>:
6817 </p>
6818 <pre class="verbatim"> $ tlmgr install classico
6819 tlmgr: package repositories:
6820 ...
6821 [1/1, ??:??/??:??] install: classico @tlcontrib [737k]
6822 </pre>
6823 <p>In the output here you can see that the <code class="code">classico</code> package has been
6824 installed from the <code class="code">tlcontrib</code> repository (<code class="code">@tlcontrib</code>).
6825 </p>
6826 <p>Finally, <code class="code">tlmgr pinning</code> also supports removing certain or all packages
6827 from a given repository:
6828 </p>
6829 <pre class="verbatim"> $ tlmgr pinning remove tlcontrib classico # remove just classico
6830 $ tlmgr pinning remove tlcontrib --all # take nothing from tlcontrib
6831 </pre>
6832 <p>A summary of <code class="code">tlmgr pinning</code> actions is given above.
6833 </p>
6834 <hr>
6835 </div>
6836 </div>
6837 <div class="appendixsec-level-extent" id="tlmgr-GUI-FOR-TLMGR">
6838 <div class="nav-panel">
6839 <p>
6840 Next: <a href="#tlmgr-MACHINE_002dREADABLE-OUTPUT" accesskey="n" rel="next">MACHINE-READABLE OUTPUT</a>, Previous: <a href="#tlmgr-MULTIPLE-REPOSITORIES" accesskey="p" rel="prev">MULTIPLE REPOSITORIES</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6841 </div>
6842 <h3 class="appendixsec" id="GUI-FOR-TLMGR"><span>B.11 GUI FOR TLMGR<a class="copiable-link" href="#GUI-FOR-TLMGR"> &para;</a></span></h3>
6843
6844 <p>The graphical user interface for <code class="code">tlmgr</code> requires Perl/Tk
6845 <a class="url" href="https://search.cpan.org/search?query=perl%2Ftk">https://search.cpan.org/search?query=perl%2Ftk</a>. For Unix-based
6846 systems Perl/Tk (as well as Perl of course) has to be installed
6847 outside of TL. <a class="url" href="https://tug.org/texlive/distro.html#perltk">https://tug.org/texlive/distro.html#perltk</a> has a
6848 list of invocations for some distros. For Windows the necessary
6849 modules are no longer shipped within TeX Live, so you&rsquo;ll have to have an
6850 external Perl available that includes them.
6851 </p>
6852 <p>We are talking here about the GUI built into tlmgr itself, not about the
6853 other tlmgr GUIs, which are: tlshell (Tcl/Tk-based), tlcockpit
6854 (Java-based) and, only on Macs, TeX Live Utility. These are invoked as
6855 separate programs.
6856 </p>
6857 <p>The GUI mode of tlmgr is started with the invocation <code class="code">tlmgr gui</code>;
6858 assuming Tk is loadable, the graphical user interface will be shown.
6859 The main window contains a menu bar, the main display, and a status
6860 area where messages normally shown on the console are displayed.
6861 </p>
6862 <p>Within the main display there are three main parts: the <code class="code">Display
6863 configuration</code> area, the list of packages, and the action buttons.
6864 </p>
6865 <p>Also, at the top right the currently loaded repository is shown; this
6866 also acts as a button and when clicked will try to load the default
6867 repository. To load a different repository, see the <code class="code">tlmgr</code> menu item.
6868 </p>
6869 <p>Finally, the status area at the bottom of the window gives additional
6870 information about what is going on.
6871 </p>
6872 <ul class="mini-toc">
6873 <li><a href="#tlmgr-Main-display" accesskey="1">Main display</a></li>
6874 <li><a href="#tlmgr-Menu-bar" accesskey="2">Menu bar</a></li>
6875 <li><a href="#tlmgr-GUI-options" accesskey="3">GUI options</a></li>
6876 </ul>
6877 <hr>
6878 <div class="appendixsubsec-level-extent" id="tlmgr-Main-display">
6879 <div class="nav-panel">
6880 <p>
6881 Next: <a href="#tlmgr-Menu-bar" accesskey="n" rel="next">Menu bar</a>, Up: <a href="#tlmgr-GUI-FOR-TLMGR" accesskey="u" rel="up">GUI FOR TLMGR</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6882 </div>
6883 <h4 class="appendixsubsec" id="Main-display"><span>B.11.1 Main display<a class="copiable-link" href="#Main-display"> &para;</a></span></h4>
6884
6885 <ul class="mini-toc">
6886 <li><a href="#tlmgr-Display-configuration-area" accesskey="1">Display configuration area</a></li>
6887 <li><a href="#tlmgr-Package-list-area" accesskey="2">Package list area</a></li>
6888 <li><a href="#tlmgr-Main-display-action-buttons" accesskey="3">Main display action buttons</a></li>
6889 </ul>
6890 <hr>
6891 <div class="appendixsubsubsec-level-extent" id="tlmgr-Display-configuration-area">
6892 <div class="nav-panel">
6893 <p>
6894 Next: <a href="#tlmgr-Package-list-area" accesskey="n" rel="next">Package list area</a>, Up: <a href="#tlmgr-Main-display" accesskey="u" rel="up">Main display</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6895 </div>
6896 <h4 class="appendixsubsubsec" id="Display-configuration-area"><span>B.11.1.1 Display configuration area<a class="copiable-link" href="#Display-configuration-area"> &para;</a></span></h4>
6897
6898 <p>The first part of the main display allows you to specify (filter) which
6899 packages are shown. By default, all are shown. Changes here are
6900 reflected right away.
6901 </p>
6902 <dl class="table">
6903 <dt>Status</dt>
6904 <dd><a class="anchor" id="tlmgr-Status"></a>
6905 <p>Select whether to show all packages (the default), only those installed,
6906 only those <em class="emph">not</em> installed, or only those with update available.
6907 </p>
6908 </dd>
6909 <dt>Category</dt>
6910 <dd><a class="anchor" id="tlmgr-Category"></a>
6911 <p>Select which categories are shown: packages, collections, and/or
6912 schemes. These are briefly explained in the <a class="ref" href="#tlmgr-DESCRIPTION">DESCRIPTION</a> section
6913 above.
6914 </p>
6915 </dd>
6916 <dt>Match</dt>
6917 <dd><a class="anchor" id="tlmgr-Match"></a>
6918 <p>Select packages matching for a specific pattern. By default, this
6919 searches both descriptions and filenames. You can also select a subset
6920 for searching.
6921 </p>
6922 </dd>
6923 <dt>Selection</dt>
6924 <dd><a class="anchor" id="tlmgr-Selection"></a>
6925 <p>Select packages to those selected, those not selected, or all. Here,
6926 &ldquo;selected&rdquo; means that the checkbox in the beginning of the line of a
6927 package is ticked.
6928 </p>
6929 </dd>
6930 <dt>Display configuration buttons</dt>
6931 <dd><a class="anchor" id="tlmgr-Display-configuration-buttons"></a>
6932 <p>To the right there are three buttons: select all packages, select none
6933 (a.k.a. deselect all), and reset all these filters to the defaults,
6934 i.e., show all available.
6935 </p>
6936 </dd>
6937 </dl>
6938
6939 <hr>
6940 </div>
6941 <div class="appendixsubsubsec-level-extent" id="tlmgr-Package-list-area">
6942 <div class="nav-panel">
6943 <p>
6944 Next: <a href="#tlmgr-Main-display-action-buttons" accesskey="n" rel="next">Main display action buttons</a>, Previous: <a href="#tlmgr-Display-configuration-area" accesskey="p" rel="prev">Display configuration area</a>, Up: <a href="#tlmgr-Main-display" accesskey="u" rel="up">Main display</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6945 </div>
6946 <h4 class="appendixsubsubsec" id="Package-list-area"><span>B.11.1.2 Package list area<a class="copiable-link" href="#Package-list-area"> &para;</a></span></h4>
6947
6948 <p>The second are of the main display lists all installed packages. If a
6949 repository is loaded, those that are available but not installed are
6950 also listed.
6951 </p>
6952 <p>Double clicking on a package line pops up an informational window with
6953 further details: the long description, included files, etc.
6954 </p>
6955 <p>Each line of the package list consists of the following items:
6956 </p>
6957 <dl class="table">
6958 <dt>a checkbox</dt>
6959 <dd><a class="anchor" id="tlmgr-a-checkbox"></a>
6960 <p>Used to select particular packages; some of the action buttons (see
6961 below) work only on the selected packages.
6962 </p>
6963 </dd>
6964 <dt>package name</dt>
6965 <dd><a class="anchor" id="tlmgr-package-name"></a>
6966 <p>The name (identifier) of the package as given in the database.
6967 </p>
6968 </dd>
6969 <dt>local revision (and version)</dt>
6970 <dd><a class="anchor" id="tlmgr-local-revision-_0028and-version_0029"></a>
6971 <p>If the package is installed the TeX Live revision number for the
6972 installed package will be shown. If there is a catalogue version given
6973 in the database for this package, it will be shown in parentheses.
6974 However, the catalogue version, unlike the TL revision, is not
6975 guaranteed to reflect what is actually installed.
6976 </p>
6977 </dd>
6978 <dt>remote revision (and version)</dt>
6979 <dd><a class="anchor" id="tlmgr-remote-revision-_0028and-version_0029"></a>
6980 <p>If a repository has been loaded the revision of the package in the
6981 repository (if present) is shown. As with the local column, if a
6982 catalogue version is provided it will be displayed. And also as with
6983 the local column, the catalogue version may be stale.
6984 </p>
6985 </dd>
6986 <dt>short description</dt>
6987 <dd><a class="anchor" id="tlmgr-short-description"></a>
6988 <p>The short description of the package.
6989 </p>
6990 </dd>
6991 </dl>
6992
6993 <hr>
6994 </div>
6995 <div class="appendixsubsubsec-level-extent" id="tlmgr-Main-display-action-buttons">
6996 <div class="nav-panel">
6997 <p>
6998 Previous: <a href="#tlmgr-Package-list-area" accesskey="p" rel="prev">Package list area</a>, Up: <a href="#tlmgr-Main-display" accesskey="u" rel="up">Main display</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
6999 </div>
7000 <h4 class="appendixsubsubsec" id="Main-display-action-buttons"><span>B.11.1.3 Main display action buttons<a class="copiable-link" href="#Main-display-action-buttons"> &para;</a></span></h4>
7001
7002 <p>Below the list of packages are several buttons:
7003 </p>
7004 <dl class="table">
7005 <dt>Update all installed</dt>
7006 <dd><a class="anchor" id="tlmgr-Update-all-installed"></a>
7007 <p>This calls <code class="code">tlmgr update --all</code>, i.e., tries to update all available
7008 packages. Below this button is a toggle to allow reinstallation of
7009 previously removed packages as part of this action.
7010 </p>
7011 <p>The other four buttons only work on the selected packages, i.e., those
7012 where the checkbox at the beginning of the package line is ticked.
7013 </p>
7014 </dd>
7015 <dt>Update</dt>
7016 <dd><a class="anchor" id="tlmgr-Update"></a>
7017 <p>Update only the selected packages.
7018 </p>
7019 </dd>
7020 <dt>Install</dt>
7021 <dd><a class="anchor" id="tlmgr-Install"></a>
7022 <p>Install the selected packages; acts like <code class="code">tlmgr install</code>, i.e., also
7023 installs dependencies. Thus, installing a collection installs all its
7024 constituent packages.
7025 </p>
7026 </dd>
7027 <dt>Remove</dt>
7028 <dd><a class="anchor" id="tlmgr-Remove"></a>
7029 <p>Removes the selected packages; acts like <code class="code">tlmgr remove</code>, i.e., it will
7030 also remove dependencies of collections (but not dependencies of normal
7031 packages).
7032 </p>
7033 </dd>
7034 <dt>Backup</dt>
7035 <dd><a class="anchor" id="tlmgr-Backup"></a>
7036 <p>Makes a backup of the selected packages; acts like <code class="code">tlmgr backup</code>. This
7037 action needs the option <code class="code">backupdir</code> set (see <code class="code">Options -</code> General&gt;).
7038 </p>
7039 </dd>
7040 </dl>
7041
7042 <hr>
7043 </div>
7044 </div>
7045 <div class="appendixsubsec-level-extent" id="tlmgr-Menu-bar">
7046 <div class="nav-panel">
7047 <p>
7048 Next: <a href="#tlmgr-GUI-options" accesskey="n" rel="next">GUI options</a>, Previous: <a href="#tlmgr-Main-display" accesskey="p" rel="prev">Main display</a>, Up: <a href="#tlmgr-GUI-FOR-TLMGR" accesskey="u" rel="up">GUI FOR TLMGR</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7049 </div>
7050 <h4 class="appendixsubsec" id="Menu-bar"><span>B.11.2 Menu bar<a class="copiable-link" href="#Menu-bar"> &para;</a></span></h4>
7051
7052 <p>The following entries can be found in the menu bar:
7053 </p>
7054 <dl class="table">
7055 <dt><code class="code">tlmgr</code> menu</dt>
7056 <dd><a class="anchor" id="tlmgr-tlmgr-menu"></a>
7057 <p>The items here load various repositories: the default as specified in
7058 the TeX Live database, the default network repository, the repository
7059 specified on the command line (if any), and an arbitrarily
7060 manually-entered one. Also has the so-necessary <code class="code">quit</code> operation.
7061 </p>
7062 </dd>
7063 <dt><code class="code">Options menu</code></dt>
7064 <dd><a class="anchor" id="tlmgr-Options-menu"></a>
7065 <p>Provides access to several groups of options: <code class="code">Paper</code> (configuration of
7066 default paper sizes), <code class="code">Platforms</code> (only on Unix, configuration of the
7067 supported/installed platforms), <code class="code">GUI Language</code> (select language used in
7068 the GUI interface), and <code class="code">General</code> (everything else).
7069 </p>
7070 <p>Several toggles are also here. The first is <code class="code">Expert options</code>, which is
7071 set by default. If you turn this off, the next time you start the GUI a
7072 simplified screen will be shown that display only the most important
7073 functionality. This setting is saved in the configuration file of
7074 <code class="code">tlmgr</code>; see <a class="ref" href="#tlmgr-CONFIGURATION-FILE-FOR-TLMGR">CONFIGURATION FILE FOR TLMGR</a> for details.
7075 </p>
7076 <p>The other toggles are all off by default: for debugging output, to
7077 disable the automatic installation of new packages, and to disable the
7078 automatic removal of packages deleted from the server. Playing with the
7079 choices of what is or isn&rsquo;t installed may lead to an inconsistent TeX Live
7080 installation; e.g., when a package is renamed.
7081 </p>
7082 </dd>
7083 <dt><code class="code">Actions menu</code></dt>
7084 <dd><a class="anchor" id="tlmgr-Actions-menu"></a>
7085 <p>Provides access to several actions: update the filename database (aka
7086 <code class="code">ls-R</code>, <code class="code">mktexlsr</code>, <code class="code">texhash</code>), rebuild all formats (<code class="code">fmtutil-sys
7087 --all</code>), update the font map database (<code class="code">updmap-sys</code>), restore from a backup
7088 of a package, and use of symbolic links in system directories (not on
7089 Windows).
7090 </p>
7091 <p>The final action is to remove the entire TeX Live installation (also not
7092 on Windows).
7093 </p>
7094 </dd>
7095 <dt><code class="code">Help menu</code></dt>
7096 <dd><a class="anchor" id="tlmgr-Help-menu"></a>
7097 <p>Provides access to the TeX Live manual (also on the web at
7098 <a class="url" href="https://tug.org/texlive/doc.html">https://tug.org/texlive/doc.html</a>) and the usual &ldquo;About&rdquo; box.
7099 </p>
7100 </dd>
7101 </dl>
7102
7103 <hr>
7104 </div>
7105 <div class="appendixsubsec-level-extent" id="tlmgr-GUI-options">
7106 <div class="nav-panel">
7107 <p>
7108 Previous: <a href="#tlmgr-Menu-bar" accesskey="p" rel="prev">Menu bar</a>, Up: <a href="#tlmgr-GUI-FOR-TLMGR" accesskey="u" rel="up">GUI FOR TLMGR</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7109 </div>
7110 <h4 class="appendixsubsec" id="GUI-options"><span>B.11.3 GUI options<a class="copiable-link" href="#GUI-options"> &para;</a></span></h4>
7111
7112 <p>Some generic Perl/Tk options can be specified with <code class="code">tlmgr gui</code> to
7113 control the display:
7114 </p>
7115 <dl class="table">
7116 <dt><code class="code">-background</code> <em class="emph">color</em></dt>
7117 <dd><a class="anchor" id="tlmgr-_002dbackground-color"></a>
7118 <p>Set background color.
7119 </p>
7120 </dd>
7121 <dt><code class="code">-font &quot;</code> <em class="emph">fontname</em> <em class="emph">fontsize</em> <code class="code">&quot;</code></dt>
7122 <dd><a class="anchor" id="tlmgr-_002dfont-_0022-fontname-fontsize-_0022"></a>
7123 <p>Set font, e.g., <code class="code">tlmgr gui -font &quot;helvetica 18&quot;</code>. The argument to
7124 <code class="code">-font</code> must be quoted, i.e., passed as a single string.
7125 </p>
7126 </dd>
7127 <dt><code class="code">-foreground</code> <em class="emph">color</em></dt>
7128 <dd><a class="anchor" id="tlmgr-_002dforeground-color"></a>
7129 <p>Set foreground color.
7130 </p>
7131 </dd>
7132 <dt><code class="code">-geometry</code> <em class="emph">geomspec</em></dt>
7133 <dd><a class="anchor" id="tlmgr-_002dgeometry-geomspec"></a>
7134 <p>Set the X geometry, e.g., <code class="code">tlmgr gui -geometry 1024x512-0+0</code> creates
7135 the window of (approximately) the given size in the upper-right corner
7136 of the display.
7137 </p>
7138 </dd>
7139 <dt><code class="code">-xrm</code> <em class="emph">xresource</em></dt>
7140 <dd><a class="anchor" id="tlmgr-_002dxrm-xresource"></a>
7141 <p>Pass the arbitrary X resource string <em class="emph">xresource</em>.
7142 </p>
7143 </dd>
7144 </dl>
7145
7146 <p>A few other obscure options are recognized but not mentioned here. See
7147 the Perl/Tk documentation (<a class="url" href="https://search.cpan.org/perldoc?Tk">https://search.cpan.org/perldoc?Tk</a>) for the
7148 complete list, and any X documentation for general information.
7149 </p>
7150 <hr>
7151 </div>
7152 </div>
7153 <div class="appendixsec-level-extent" id="tlmgr-MACHINE_002dREADABLE-OUTPUT">
7154 <div class="nav-panel">
7155 <p>
7156 Next: <a href="#tlmgr-ENVIRONMENT-VARIABLES" accesskey="n" rel="next">ENVIRONMENT VARIABLES</a>, Previous: <a href="#tlmgr-GUI-FOR-TLMGR" accesskey="p" rel="prev">GUI FOR TLMGR</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7157 </div>
7158 <h3 class="appendixsec" id="MACHINE_002dREADABLE-OUTPUT"><span>B.12 MACHINE-READABLE OUTPUT<a class="copiable-link" href="#MACHINE_002dREADABLE-OUTPUT"> &para;</a></span></h3>
7159
7160 <p>With the <code class="code">--machine-readable</code> option, <code class="code">tlmgr</code> writes to stdout in the
7161 fixed line-oriented format described here, and the usual informational
7162 messages for human consumption are written to stderr (normally they are
7163 written to stdout). The idea is that a program can get all the
7164 information it needs by reading stdout.
7165 </p>
7166 <p>Currently this option only applies to the
7167 <a class="ref" href="#tlmgr-update-_005boption_002e_002e_002e_005d-_005bpkg_002e_002e_002e_005d">update</a>,
7168 <a class="ref" href="#tlmgr-install-_005boption_002e_002e_002e_005d-pkg_002e_002e_002e">install</a>, and
7169 <a class="ref" href="#tlmgr-option">option</a> actions.
7170 </p>
7171 <ul class="mini-toc">
7172 <li><a href="#tlmgr-Machine_002dreadable-update-and-install-output" accesskey="1">Machine-readable <code class="code">update</code> and <code class="code">install</code> output</a></li>
7173 <li><a href="#tlmgr-Machine_002dreadable-option-output" accesskey="2">Machine-readable <code class="code">option</code> output</a></li>
7174 </ul>
7175 <hr>
7176 <div class="appendixsubsec-level-extent" id="tlmgr-Machine_002dreadable-update-and-install-output">
7177 <div class="nav-panel">
7178 <p>
7179 Next: <a href="#tlmgr-Machine_002dreadable-option-output" accesskey="n" rel="next">Machine-readable <code class="code">option</code> output</a>, Up: <a href="#tlmgr-MACHINE_002dREADABLE-OUTPUT" accesskey="u" rel="up">MACHINE-READABLE OUTPUT</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7180 </div>
7181 <h4 class="appendixsubsec" id="Machine_002dreadable-update-and-install-output"><span>B.12.1 Machine-readable <code class="code">update</code> and <code class="code">install</code> output<a class="copiable-link" href="#Machine_002dreadable-update-and-install-output"> &para;</a></span></h4>
7182
7183 <p>The output format is as follows:
7184 </p>
7185 <pre class="verbatim"> fieldname &quot;\t&quot; value
7186 ...
7187 &quot;end-of-header&quot;
7188 pkgname status localrev serverrev size runtime esttot
7189 ...
7190 &quot;end-of-updates&quot;
7191 other output from post actions, not in machine readable form
7192 </pre>
7193 <p>The header section currently has two fields: <code class="code">location-url</code> (the
7194 repository source from which updates are being drawn), and
7195 <code class="code">total-bytes</code> (the total number of bytes to be downloaded).
7196 </p>
7197 <p>The <em class="emph">localrev</em> and <em class="emph">serverrev</em> fields for each package are the
7198 revision numbers in the local installation and server repository,
7199 respectively. The <em class="emph">size</em> field is the number of bytes to be
7200 downloaded, i.e., the size of the compressed tar file for a network
7201 installation, not the unpacked size. The runtime and esttot fields
7202 are only present for updated and auto-install packages, and contain
7203 the currently passed time since start of installation/updates
7204 and the estimated total time.
7205 </p>
7206 <p>Line endings may be either LF or CRLF depending on the current platform.
7207 </p>
7208 <dl class="table">
7209 <dt><code class="code">location-url</code> <em class="emph">location</em></dt>
7210 <dd><a class="anchor" id="tlmgr-location_002durl-location"></a>
7211 <p>The <em class="emph">location</em> may be a url (including <code class="code">file:///foo/bar/...</code>), or a
7212 directory name (<code class="code">/foo/bar</code>). It is the package repository from which
7213 the new package information was drawn.
7214 </p>
7215 </dd>
7216 <dt><code class="code">total-bytes</code> <em class="emph">count</em></dt>
7217 <dd><a class="anchor" id="tlmgr-total_002dbytes-count"></a>
7218 <p>The <em class="emph">count</em> is simply a decimal number, the sum of the sizes of all the
7219 packages that need updating or installing (which are listed subsequently).
7220 </p>
7221 </dd>
7222 </dl>
7223
7224 <p>Then comes a line with only the literal string <code class="code">end-of-header</code>.
7225 </p>
7226 <p>Each following line until a line with literal string <code class="code">end-of-updates</code>
7227 reports on one package. The fields on
7228 each line are separated by a tab. Here are the fields.
7229 </p>
7230 <dl class="table">
7231 <dt><em class="emph">pkgname</em></dt>
7232 <dd><a class="anchor" id="tlmgr-pkgname"></a>
7233 <p>The TeX Live package identifier, with a possible platform suffix for
7234 executables. For instance, <code class="code">pdftex</code> and <code class="code">pdftex.i386-linux</code> are given
7235 as two separate packages, one on each line.
7236 </p>
7237 </dd>
7238 <dt><em class="emph">status</em></dt>
7239 <dd><a class="anchor" id="tlmgr-status"></a>
7240 <p>The status of the package update. One character, as follows:
7241 </p>
7242 <dl class="table">
7243 <dt><code class="code">d</code></dt>
7244 <dd><a class="anchor" id="tlmgr-d"></a>
7245 <p>The package was removed on the server.
7246 </p>
7247 </dd>
7248 <dt><code class="code">f</code></dt>
7249 <dd><a class="anchor" id="tlmgr-f"></a>
7250 <p>The package was removed in the local installation, even though a
7251 collection depended on it. (E.g., the user ran <code class="code">tlmgr remove
7252 --force</code>.)
7253 </p>
7254 </dd>
7255 <dt><code class="code">u</code></dt>
7256 <dd><a class="anchor" id="tlmgr-u"></a>
7257 <p>Normal update is needed.
7258 </p>
7259 </dd>
7260 <dt><code class="code">r</code></dt>
7261 <dd><a class="anchor" id="tlmgr-r"></a>
7262 <p>Reversed non-update: the locally-installed version is newer than the
7263 version on the server.
7264 </p>
7265 </dd>
7266 <dt><code class="code">a</code></dt>
7267 <dd><a class="anchor" id="tlmgr-a"></a>
7268 <p>Automatically-determined need for installation, the package is new on
7269 the server and is (most probably) part of an installed collection.
7270 </p>
7271 </dd>
7272 <dt><code class="code">i</code></dt>
7273 <dd><a class="anchor" id="tlmgr-i"></a>
7274 <p>Package will be installed and isn&rsquo;t present in the local installation
7275 (action install).
7276 </p>
7277 </dd>
7278 <dt><code class="code">I</code></dt>
7279 <dd><a class="anchor" id="tlmgr-I"></a>
7280 <p>Package is already present but will be reinstalled (action install).
7281 </p>
7282 </dd>
7283 </dl>
7284
7285 </dd>
7286 <dt><em class="emph">localrev</em></dt>
7287 <dd><a class="anchor" id="tlmgr-localrev"></a>
7288 <p>The revision number of the installed package, or <code class="code">-</code> if it is not
7289 present locally.
7290 </p>
7291 </dd>
7292 <dt><em class="emph">serverrev</em></dt>
7293 <dd><a class="anchor" id="tlmgr-serverrev"></a>
7294 <p>The revision number of the package on the server, or <code class="code">-</code> if it is not
7295 present on the server.
7296 </p>
7297 </dd>
7298 <dt><em class="emph">size</em></dt>
7299 <dd><a class="anchor" id="tlmgr-size"></a>
7300 <p>The size in bytes of the package on the server. The sum of all the
7301 package sizes is given in the <code class="code">total-bytes</code> header field mentioned above.
7302 </p>
7303 </dd>
7304 <dt><em class="emph">runtime</em></dt>
7305 <dd><a class="anchor" id="tlmgr-runtime"></a>
7306 <p>The run time since start of installations or updates.
7307 </p>
7308 </dd>
7309 <dt><em class="emph">esttot</em></dt>
7310 <dd><a class="anchor" id="tlmgr-esttot"></a>
7311 <p>The estimated total time.
7312 </p>
7313 </dd>
7314 </dl>
7315
7316 <hr>
7317 </div>
7318 <div class="appendixsubsec-level-extent" id="tlmgr-Machine_002dreadable-option-output">
7319 <div class="nav-panel">
7320 <p>
7321 Previous: <a href="#tlmgr-Machine_002dreadable-update-and-install-output" accesskey="p" rel="prev">Machine-readable <code class="code">update</code> and <code class="code">install</code> output</a>, Up: <a href="#tlmgr-MACHINE_002dREADABLE-OUTPUT" accesskey="u" rel="up">MACHINE-READABLE OUTPUT</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7322 </div>
7323 <h4 class="appendixsubsec" id="Machine_002dreadable-option-output"><span>B.12.2 Machine-readable <code class="code">option</code> output<a class="copiable-link" href="#Machine_002dreadable-option-output"> &para;</a></span></h4>
7324
7325 <p>The output format is as follows:
7326 </p>
7327 <pre class="verbatim"> key &quot;\t&quot; value
7328 </pre>
7329 <p>If a value is not saved in the database the string <code class="code">(not set)</code> is shown.
7330 </p>
7331 <p>If you are developing a program that uses this output, and find that
7332 changes would be helpful, do not hesitate to write the mailing list.
7333 </p>
7334 <hr>
7335 </div>
7336 </div>
7337 <div class="appendixsec-level-extent" id="tlmgr-ENVIRONMENT-VARIABLES">
7338 <div class="nav-panel">
7339 <p>
7340 Next: <a href="#tlmgr-AUTHORS-AND-COPYRIGHT" accesskey="n" rel="next">AUTHORS AND COPYRIGHT</a>, Previous: <a href="#tlmgr-MACHINE_002dREADABLE-OUTPUT" accesskey="p" rel="prev">MACHINE-READABLE OUTPUT</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7341 </div>
7342 <h3 class="appendixsec" id="ENVIRONMENT-VARIABLES-1"><span>B.13 ENVIRONMENT VARIABLES<a class="copiable-link" href="#ENVIRONMENT-VARIABLES-1"> &para;</a></span></h3>
7343
7344 <p><code class="code">tlmgr</code> uses many of the standard TeX environment variables, as
7345 reported by, e.g., <code class="code">tlmgr conf</code> (<a class="ref" href="#tlmgr-conf">conf</a>).
7346 </p>
7347 <p>In addition, for ease in scripting and debugging, <code class="code">tlmgr</code> looks for the
7348 following environment variables. These are not of interest for normal
7349 user installations.
7350 </p>
7351 <dl class="table">
7352 <dt><code class="code">TEXLIVE_COMPRESSOR</code></dt>
7353 <dd><a class="anchor" id="tlmgr-TEXLIVE_005fCOMPRESSOR"></a>
7354 <p>This variable allows selecting a different compressor program for
7355 backups and intermediate rollback containers. The order of selection is:
7356 </p>
7357 <ol class="enumerate">
7358 <li> If the environment variable <code class="code">TEXLIVE_COMPRESSOR</code> is
7359 defined, use it; abort if it doesn&rsquo;t work. Possible values:
7360 <code class="code">lz4</code>, <code class="code">gzip</code>, <code class="code">xz</code>. The necessary options are added internally.
7361
7362 </li><li> If lz4 is available (either from the system or TL) and working, use that.
7363
7364 </li><li> If gzip is available (from the system) and working, use that.
7365
7366 </li><li> If xz is available (either from the system or TL) and working, use that.
7367
7368 </li></ol>
7369
7370 <p>lz4 and gzip are faster in creating tlmgr&rsquo;s local backups, hence they
7371 are preferred. The unconditional use of xz for the tlnet containers is
7372 unaffected, to minimize download sizes.
7373 </p>
7374 </dd>
7375 <dt><code class="code">TEXLIVE_DOWNLOADER</code></dt>
7376 <dd><a class="anchor" id="tlmgr-TEXLIVE_005fDOWNLOADER"></a>
7377 </dd>
7378 <dt><code class="code">TL_DOWNLOAD_PROGRAM</code></dt>
7379 <dd><a class="anchor" id="tlmgr-TL_005fDOWNLOAD_005fPROGRAM"></a>
7380 </dd>
7381 <dt><code class="code">TL_DOWNLOAD_ARGS</code></dt>
7382 <dd><a class="anchor" id="tlmgr-TL_005fDOWNLOAD_005fARGS"></a>
7383 <p>These options allow selecting different download programs then the ones
7384 automatically selected by the installer. The order of selection is:
7385 </p>
7386 <ol class="enumerate">
7387 <li> If the environment variable <code class="code">TEXLIVE_DOWNLOADER</code> is defined, use it;
7388 abort if the specified program doesn&rsquo;t work. Possible values: <code class="code">lwp</code>,
7389 <code class="code">curl</code>, <code class="code">wget</code>. The necessary options are added internally.
7390
7391 </li><li> If the environment variable <code class="code">TL_DOWNLOAD_PROGRAM</code> is
7392 defined (can be any value), use it together with
7393 <code class="code">TL_DOWNLOAD_ARGS</code>; abort if it doesn&rsquo;t work.
7394
7395 </li><li> If LWP is available and working, use that (by far the most
7396 efficient method, as it supports persistent downloads).
7397
7398 </li><li> If curl is available (from the system) and working, use that.
7399
7400 </li><li> If wget is available (either from the system or TL) and working, use that.
7401
7402 </li></ol>
7403
7404 <p>TL provides <code class="code">wget</code> binaries for platforms where necessary, so some
7405 download method should always be available.
7406 </p>
7407 </dd>
7408 <dt><code class="code">TEXLIVE_PREFER_OWN</code></dt>
7409 <dd><a class="anchor" id="tlmgr-TEXLIVE_005fPREFER_005fOWN"></a>
7410 <p>By default, compression and download programs provided by the system,
7411 i.e., found along <code class="code">PATH</code> are preferred over those shipped with TeX
7412 Live.
7413 </p>
7414 <p>This can create problems with systems that are too old, and so can be
7415 overridden by setting the environment variable <code class="code">TEXLIVE_PREFER_OWN</code> to
7416 1. In this case, executables shipped with TL will be preferred.
7417 </p>
7418 <p>Extra compression/download programs not provided by TL, such as gzip,
7419 lwp, and curl, are still checked for on the system and used if
7420 available, per the above. <code class="code">TEXLIVE_PREFER_OWN</code> only applies when the
7421 program being checked for is shipped with TL, namely the lz4 and
7422 xz compressors and wget downloader.
7423 </p>
7424 <p>Exception: on Windows, the <code class="code">tar.exe</code> shipped with TL is always used,
7425 regardless of any setting.
7426 </p>
7427 </dd>
7428 </dl>
7429
7430 <hr>
7431 </div>
7432 <div class="appendixsec-level-extent" id="tlmgr-AUTHORS-AND-COPYRIGHT">
7433 <div class="nav-panel">
7434 <p>
7435 Previous: <a href="#tlmgr-ENVIRONMENT-VARIABLES" accesskey="p" rel="prev">ENVIRONMENT VARIABLES</a>, Up: <a href="#tlmgr" accesskey="u" rel="up">tlmgr</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7436 </div>
7437 <h3 class="appendixsec" id="AUTHORS-AND-COPYRIGHT-1"><span>B.14 AUTHORS AND COPYRIGHT<a class="copiable-link" href="#AUTHORS-AND-COPYRIGHT-1"> &para;</a></span></h3>
7438
7439 <p>This script and its documentation were written for the TeX Live
7440 distribution (<a class="url" href="https://tug.org/texlive">https://tug.org/texlive</a>) and both are licensed under the
7441 GNU General Public License Version 2 or later.
7442 </p>
7443 <p>$Id: tlmgr.pl 77655 2026-02-07 15:38:21Z karl $
7444 </p>
7445
7446 <hr>
7447 </div>
7448 </div>
7449 <div class="unnumbered-level-extent" id="Index">
7450 <div class="nav-panel">
7451 <p>
7452 Previous: <a href="#tlmgr" accesskey="p" rel="prev">tlmgr</a>, Up: <a href="#Top" accesskey="u" rel="up">Building TeX Live (2026)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
7453 </div>
7454 <h2 class="unnumbered" id="Index-1"><span>Index<a class="copiable-link" href="#Index-1"> &para;</a></span></h2>
7455
7456 <div class="printindex cp-printindex">
7457 <table class="cp-letters-header-printindex"><tr><th>Jump to: &nbsp; </th><td><a class="summary-letter-printindex" href="#Index_cp_symbol-1"><b>-</b></a>
7458 &nbsp;
7459 <a class="summary-letter-printindex" href="#Index_cp_symbol-2"><b>$</b></a>
7460 &nbsp;
7461 <br>
7462 <a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a>
7463 &nbsp;
7464 <a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a>
7465 &nbsp;
7466 <a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
7467 &nbsp;
7468 <a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a>
7469 &nbsp;
7470 <a class="summary-letter-printindex" href="#Index_cp_letter-E"><b>E</b></a>
7471 &nbsp;
7472 <a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
7473 &nbsp;
7474 <a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a>
7475 &nbsp;
7476 <a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
7477 &nbsp;
7478 <a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
7479 &nbsp;
7480 <a class="summary-letter-printindex" href="#Index_cp_letter-K"><b>K</b></a>
7481 &nbsp;
7482 <a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a>
7483 &nbsp;
7484 <a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
7485 &nbsp;
7486 <a class="summary-letter-printindex" href="#Index_cp_letter-N"><b>N</b></a>
7487 &nbsp;
7488 <a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
7489 &nbsp;
7490 <a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
7491 &nbsp;
7492 <a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
7493 &nbsp;
7494 <a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
7495 &nbsp;
7496 <a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
7497 &nbsp;
7498 <a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
7499 &nbsp;
7500 <a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
7501 &nbsp;
7502 <a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a>
7503 &nbsp;
7504 <a class="summary-letter-printindex" href="#Index_cp_letter-X"><b>X</b></a>
7505 &nbsp;
7506 <a class="summary-letter-printindex" href="#Index_cp_letter-Z"><b>Z</b></a>
7507 &nbsp;
7508 </td></tr></table>
7509 <table class="cp-entries-printindex">
7510 <tr><td></td><th class="entries-header-printindex">Index Entry</th><th class="sections-header-printindex">Section</th></tr>
7511 <tr><td colspan="3"><hr></td></tr>
7512 <tr><th id="Index_cp_symbol-1">-</th></tr>
7513 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dbindir-configure-option"><code>--bindir configure <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026"><code class="code">--prefix</code> <code class="code">--bindir</code> &hellip;</a></td></tr>
7514 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dbindir-configure-option-1"><code>--bindir configure <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dmultiplatform"><code class="code">--enable-multiplatform</code></a></td></tr>
7515 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dbuild_003dhost"><code>--build=<var class="var">host</var></code></a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7516 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dall_002dpackages"><code>--disable-all-packages</code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7517 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dall_002dpkgs"><code>--disable-all-pkgs</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dall_002dpkgs"><code class="code">--disable-all-pkgs</code></a></td></tr>
7518 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dbibtex8"><code>--disable-bibtex8</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7519 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dbibtexu"><code>--disable-bibtexu</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7520 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002ddump_002dshare"><code>--disable-dump-share</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7521 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002ddvipdfmx"><code>--disable-dvipdfmx</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7522 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002detex_002dsynctex"><code>--disable-etex-synctex</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7523 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dipc"><code>--disable-ipc</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7524 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dlargefile"><code>--disable-largefile</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7525 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dlinked_002dscripts"><code>--disable-linked-scripts</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002ftexlive">Configure options for <samp class="file">texk/texlive</samp></a></td></tr>
7526 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dmf_002dnowin"><code>--disable-mf-nowin</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7527 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dmissing"><code>--disable-missing</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dmissing"><code class="code">--disable-missing</code></a></td></tr>
7528 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dnative_002dtexlive_002dbuild"><code>--disable-native-texlive-build</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild"><code class="code">--disable-native-texlive-build</code></a></td></tr>
7529 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dprog"><code>--disable-<var class="var">prog</var></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog"><code class="code">--enable-<var class="var">prog</var></code> <code class="code">--disable-<var class="var">prog</var></code></a></td></tr>
7530 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dsynctex"><code>--disable-synctex</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7531 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dtex"><code>--disable-tex</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7532 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dweb_002dprogs"><code>--disable-web-progs</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7533 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002ddisable_002dxdvipdfmx"><code>--disable-xdvipdfmx</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7534 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002d_002awin-for-Metafont-window-support"><code>--enable-*win <span class="r">for Metafont window support</span></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7535 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dauto_002dcore"><code>--enable-auto-core</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7536 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dcompiler_002dwarnings_003dlevel"><code>--enable-compiler-warnings=<var class="var">level</var></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dcompiler_002dwarnings_003dlevel"><code class="code">--enable-compiler-warnings=</code><var class="var">level</var></a></td></tr>
7537 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dcxx_002druntime_002dhack"><code>--enable-cxx-runtime-hack</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7538 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002detex"><code>--enable-etex</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7539 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dlibtool_002dhack"><code>--enable-libtool-hack</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7540 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dmaintainer_002dmode"><code>--enable-maintainer-mode</code></a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7541 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dmaintainer_002dmode-1"><code>--enable-maintainer-mode</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dmaintainer_002dmode"><code class="code">--enable-maintainer-mode</code></a></td></tr>
7542 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dmissing-to-ignore-dependencies"><code>--enable-missing <span class="r">to ignore dependencies</span></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7543 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dmktextfm_002ddefault"><code>--enable-mktextfm-default</code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7544 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dmultiplatform"><code>--enable-multiplatform</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dmultiplatform"><code class="code">--enable-multiplatform</code></a></td></tr>
7545 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dprog"><code>--enable-<var class="var">prog</var></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dprog-_002d_002ddisable_002dprog"><code class="code">--enable-<var class="var">prog</var></code> <code class="code">--disable-<var class="var">prog</var></code></a></td></tr>
7546 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dshared"><code>--enable-shared</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dshared"><code class="code">--enable-shared</code></a></td></tr>
7547 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dsilent_002drules"><code>--enable-silent-rules</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dsilent_002drules"><code class="code">--enable-silent-rules</code></a></td></tr>
7548 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dtex_002dsynctex"><code>--enable-tex-synctex</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7549 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dtexlive_002dbuild"><code>--enable-texlive-build</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dnative_002dtexlive_002dbuild"><code class="code">--disable-native-texlive-build</code></a></td></tr>
7550 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dxi2_002dscrolling"><code>--enable-xi2-scrolling</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7551 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dxindy_002ddocs"><code>--enable-xindy-docs</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7552 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002denable_002dxindy_002drules"><code>--enable-xindy-rules</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7553 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dhost_003dhost"><code>--host=<var class="var">host</var></code></a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7554 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dlibdir-configure-option"><code>--libdir configure <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dmultiplatform"><code class="code">--enable-multiplatform</code></a></td></tr>
7555 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dno_002dprint_002ddirectory-GNU-make-option"><code>--no-print-directory <span class="r">GNU make option</span></code></a></td><td class="printindex-index-section"><a href="#Build-one-engine">Build one engine</a></td></tr>
7556 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dprefix-configure-option"><code>--prefix configure <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026"><code class="code">--prefix</code> <code class="code">--bindir</code> &hellip;</a></td></tr>
7557 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dbanner_002dadd_003dstr"><code>--with-banner-add=<var class="var">str</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7558 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dclisp_002druntime_003dfilename"><code>--with-clisp-runtime=<var class="var">filename</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7559 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002deditor_003dcmd"><code>--with-editor=<var class="var">cmd</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7560 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dfontconfig_002dincludes_003ddir"><code>--with-fontconfig-includes=<var class="var">dir</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7561 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dfontconfig_002dlibdir_003ddir"><code>--with-fontconfig-libdir=<var class="var">dir</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7562 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dgs_003dfilename"><code>--with-gs=<var class="var">filename</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7563 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dlib_002dincludes_003ddir_002c-_002dlibdir"><code>--with-<var class="var">lib</var>-includes=<var class="var">dir</var><span class="r">,</span> -libdir</code></a></td><td class="printindex-index-section"><a href="#Library_002dspecific-configure-options">Library-specific configure options</a></td></tr>
7564 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dlibgs_002dincludes_002c-_002dlibdir"><code>--with-libgs-includes<span class="r">,</span> -libdir</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvisvgm">Configure options for <samp class="file">texk/dvisvgm</samp></a></td></tr>
7565 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dsystem_002dkpathsea"><code>--with-system-kpathsea</code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7566 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dsystem_002dlib"><code>--with-system-<var class="var">lib</var></code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7567 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dsystem_002dlib-1"><code>--with-system-<var class="var">lib</var></code></a></td><td class="printindex-index-section"><a href="#Library_002dspecific-configure-options">Library-specific configure options</a></td></tr>
7568 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dsystem_002dlibgs"><code>--with-system-libgs</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvisvgm">Configure options for <samp class="file">texk/dvisvgm</samp></a></td></tr>
7569 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dxdvi_002dx_002dtoolkit"><code>--with-xdvi-x-toolkit</code></a></td><td class="printindex-index-section"><a href="#xdvik-package"><code class="code">xdvik</code> package</a></td></tr>
7570 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwith_002dxdvi_002dx_002dtoolkit_003dkit"><code>--with-xdvi-x-toolkit=<var class="var">kit</var></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7571 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwithout_002dlibgs"><code>--without-libgs</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvisvgm">Configure options for <samp class="file">texk/dvisvgm</samp></a></td></tr>
7572 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwithout_002dln_002ds"><code>--without-ln-s</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002dwithout_002dln_002ds"><code class="code">--without-ln-s</code></a></td></tr>
7573 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002d_002dwithout_002dx"><code>--without-x</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002dwithout_002dx"><code class="code">--without-x</code></a></td></tr>
7574 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002dC-configure-option"><code>-C configure <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7575 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002dfvisibility_002dinlines_002dhidden"><code>-fvisibility-inlines-hidden</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7576 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002dfvisibility_003dhidden"><code>-fvisibility=hidden</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7577 <tr><td></td><td class="printindex-index-entry"><a href="#index-_002dj-make-option"><code>-j make <span class="r">option</span></code></a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7578 <tr><td colspan="3"><hr></td></tr>
7579 <tr><th id="Index_cp_symbol-2">$</th></tr>
7580 <tr><td></td><td class="printindex-index-entry"><a href="#index-_0024_0040-target-in-normal-make-rules"><code class="code">$@</code> target in normal <code class="code">make</code> rules</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7581 <tr><td colspan="3"><hr></td></tr>
7582 <tr><th id="Index_cp_letter-A">A</th></tr>
7583 <tr><td></td><td class="printindex-index-entry"><a href="#index-ac_002fwithenable_002eac"><code>ac/withenable.ac</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7584 <tr><td></td><td class="printindex-index-entry"><a href="#index-adapting-TeX-Live-for-distros">adapting TeX&nbsp;Live for distros</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7585 <tr><td></td><td class="printindex-index-entry"><a href="#index-adding-a-new-engine">adding a new engine</a></td><td class="printindex-index-section"><a href="#Adding-a-new-engine">Adding a new engine</a></td></tr>
7586 <tr><td></td><td class="printindex-index-entry"><a href="#index-adding-a-new-generic-library">adding a new generic library</a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7587 <tr><td></td><td class="printindex-index-entry"><a href="#index-adding-a-new-program">adding a new program</a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7588 <tr><td></td><td class="printindex-index-entry"><a href="#index-adding-a-new-TeX_002dspecific-library">adding a new TeX-specific library</a></td><td class="printindex-index-section"><a href="#Adding-a-new-TeX_002dspecific-library-module">Adding a new TeX-specific library module</a></td></tr>
7589 <tr><td></td><td class="printindex-index-entry"><a href="#index-adding-to-TeX-Live">adding to TeX&nbsp;Live</a></td><td class="printindex-index-section"><a href="#Extending-TeX-Live">Extending TeX&nbsp;Live</a></td></tr>
7590 <tr><td></td><td class="printindex-index-entry"><a href="#index-am_002f-top_002dlevel-directory"><samp class="file">am/</samp> top-level directory</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7591 <tr><td></td><td class="printindex-index-entry"><a href="#index-ANSI-C">ANSI C</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7592 <tr><td></td><td class="printindex-index-entry"><a href="#index-ApplicationServices-Mac-framework_002c-required-by-xetex"><code class="code">ApplicationServices</code> Mac framework, required by <code class="code">xetex</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7593 <tr><td></td><td class="printindex-index-entry"><a href="#index-asymptote"><code>asymptote</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7594 <tr><td></td><td class="printindex-index-entry"><a href="#index-asymptote-1"><code>asymptote</code></a></td><td class="printindex-index-section"><a href="#asymptote"><code class="code">asymptote</code></a></td></tr>
7595 <tr><td></td><td class="printindex-index-entry"><a href="#index-Autoconf">Autoconf</a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7596 <tr><td></td><td class="printindex-index-entry"><a href="#index-autoconf-macros">autoconf macros</a></td><td class="printindex-index-section"><a href="#Autoconf-macros">Autoconf macros</a></td></tr>
7597 <tr><td></td><td class="printindex-index-entry"><a href="#index-Autoconf_002c-new-package-using-only">Autoconf, new package using only</a></td><td class="printindex-index-section"><a href="#Extending-TeX-Live">Extending TeX&nbsp;Live</a></td></tr>
7598 <tr><td></td><td class="printindex-index-entry"><a href="#index-Automake">Automake</a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7599 <tr><td></td><td class="printindex-index-entry"><a href="#index-autoreconf_002c-for-new-program"><code>autoreconf<span class="r">, for new program</span></code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7600 <tr><td colspan="3"><hr></td></tr>
7601 <tr><th id="Index_cp_letter-B">B</th></tr>
7602 <tr><td></td><td class="printindex-index-entry"><a href="#index-biber"><code>biber</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7603 <tr><td></td><td class="printindex-index-entry"><a href="#index-bibtex_002dx"><code>bibtex-x</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7604 <tr><td></td><td class="printindex-index-entry"><a href="#index-bibtex8"><code>bibtex8</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7605 <tr><td></td><td class="printindex-index-entry"><a href="#index-bibtexu"><code>bibtexu</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7606 <tr><td></td><td class="printindex-index-entry"><a href="#index-BSD-distro">BSD distro</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7607 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-directory_002c-required">build directory, required</a></td><td class="printindex-index-section"><a href="#Building">Building</a></td></tr>
7608 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-iteration">build iteration</a></td><td class="printindex-index-section"><a href="#Build-iteration">Build iteration</a></td></tr>
7609 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-on-demand">build on demand</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7610 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-one-engine">build one engine</a></td><td class="printindex-index-section"><a href="#Build-one-engine">Build one engine</a></td></tr>
7611 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-one-package">build one package</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7612 <tr><td></td><td class="printindex-index-entry"><a href="#index-Build-script"><code>Build <span class="r">script</span></code></a></td><td class="printindex-index-section"><a href="#Building">Building</a></td></tr>
7613 <tr><td></td><td class="printindex-index-entry"><a href="#index-build-system_002c-design-of">build system, design of</a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7614 <tr><td></td><td class="printindex-index-entry"><a href="#index-build_002daux_002f-top_002dlevel-directory"><samp class="file">build-aux/</samp> top-level directory</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7615 <tr><td></td><td class="printindex-index-entry"><a href="#index-BUILDCC_002c-BUILDCFLAGS_002c-_002e_002e_002e"><code>BUILDCC<span class="r">,</span> BUILDCFLAGS<span class="r">, &hellip;</span></code></a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7616 <tr><td></td><td class="printindex-index-entry"><a href="#index-building">building</a></td><td class="printindex-index-section"><a href="#Building">Building</a></td></tr>
7617 <tr><td></td><td class="printindex-index-entry"><a href="#index-building-a-distribution">building a distribution</a></td><td class="printindex-index-section"><a href="#Build-distribution">Build distribution</a></td></tr>
7618 <tr><td></td><td class="printindex-index-entry"><a href="#index-building-in-parallel">building in parallel</a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7619 <tr><td colspan="3"><hr></td></tr>
7620 <tr><th id="Index_cp_letter-C">C</th></tr>
7621 <tr><td></td><td class="printindex-index-entry"><a href="#index-C_002c-ANSI_002c-required">C, ANSI, required</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7622 <tr><td></td><td class="printindex-index-entry"><a href="#index-C_002b_002b11_002c-removing-dependent-sources">C++11, removing dependent sources</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7623 <tr><td></td><td class="printindex-index-entry"><a href="#index-C_002b_002b11_002c-required">C++11, required</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7624 <tr><td></td><td class="printindex-index-entry"><a href="#index-C99_002c-avoided">C99, avoided</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7625 <tr><td></td><td class="printindex-index-entry"><a href="#index-cache-file_002c-for-configure">cache file, for <code class="code">configure</code></a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7626 <tr><td></td><td class="printindex-index-entry"><a href="#index-cache-for-configure">cache for <code class="code">configure</code></a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7627 <tr><td></td><td class="printindex-index-entry"><a href="#index-callexe_002ec"><code>callexe.c</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7628 <tr><td></td><td class="printindex-index-entry"><a href="#index-CC"><code>CC</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7629 <tr><td></td><td class="printindex-index-entry"><a href="#index-CC_005fBUILD"><code>CC_BUILD</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7630 <tr><td></td><td class="printindex-index-entry"><a href="#index-CC_003dc_002dcompiler"><code>CC=<var class="var">c-compiler</var></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7631 <tr><td></td><td class="printindex-index-entry"><a href="#index-ChangeLog"><code>ChangeLog</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7632 <tr><td></td><td class="printindex-index-entry"><a href="#index-chktex"><code>chktex</code></a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7633 <tr><td></td><td class="printindex-index-entry"><a href="#index-clisp"><code>clisp</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7634 <tr><td></td><td class="printindex-index-entry"><a href="#index-CLISP-1"><code>CLISP</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7635 <tr><td></td><td class="printindex-index-entry"><a href="#index-CLISP">CLISP</a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7636 <tr><td></td><td class="printindex-index-entry"><a href="#index-clisp_002c-required-by-xindy"><code class="code">clisp</code>, required by <code class="code">xindy</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7637 <tr><td></td><td class="printindex-index-entry"><a href="#index-Cocoa-Mac-framework_002c-required-by-xetex"><code class="code">Cocoa</code> Mac framework, required by <code class="code">xetex</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7638 <tr><td></td><td class="printindex-index-entry"><a href="#index-coding-conventions">coding conventions</a></td><td class="printindex-index-section"><a href="#Coding-conventions">Coding conventions</a></td></tr>
7639 <tr><td></td><td class="printindex-index-entry"><a href="#index-compilers_002c-C-and-C_002b_002b11">compilers, C and C++11</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7640 <tr><td></td><td class="printindex-index-entry"><a href="#index-config_002eguess_002c-config_002esub_002c-_002e_002e_002e"><code>config.guess<span class="r">,</span> config.sub, &hellip;</code></a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7641 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options"><code class="code">configure</code> options</a></td><td class="printindex-index-section"><a href="#Configure-options">Configure options</a></td></tr>
7642 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-bibtex_002dx"><code class="code">configure</code> options, for <code class="code">bibtex-x</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fbibtex_002dx">Configure options for <samp class="file">texk/bibtex-x</samp></a></td></tr>
7643 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-dvipdfm_002dx"><code class="code">configure</code> options, for <code class="code">dvipdfm-x</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7644 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-dvisvgm"><code class="code">configure</code> options, for <samp class="file">dvisvgm</samp></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvisvgm">Configure options for <samp class="file">texk/dvisvgm</samp></a></td></tr>
7645 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-kpathsea"><code class="code">configure</code> options, for <code class="code">kpathsea</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-kpathsea">Configure options for <code class="code">kpathsea</code></a></td></tr>
7646 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-texk_002ftexlive"><code class="code">configure</code> options, for <samp class="file">texk/texlive</samp></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002ftexlive">Configure options for <samp class="file">texk/texlive</samp></a></td></tr>
7647 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-web2c"><code class="code">configure</code> options, for <code class="code">web2c</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7648 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-xdvik"><code class="code">configure</code> options, for <samp class="file">xdvik</samp></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7649 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-for-xindy"><code class="code">configure</code> options, for <samp class="file">xindy</samp></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7650 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-global"><code class="code">configure</code> options, global</a></td><td class="printindex-index-section"><a href="#Global-configure-options">Global configure options</a></td></tr>
7651 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-library_002dspecific"><code class="code">configure</code> options, library-specific</a></td><td class="printindex-index-section"><a href="#Library_002dspecific-configure-options">Library-specific configure options</a></td></tr>
7652 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-options_002c-program_002dspecific"><code class="code">configure</code> options, program-specific</a></td><td class="printindex-index-section"><a href="#Program_002dspecific-configure-options">Program-specific configure options</a></td></tr>
7653 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-problems_002c-work-around-by-removing"><code class="code">configure</code> problems, work around by removing</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7654 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure-variables"><code class="code">configure</code> variables</a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7655 <tr><td></td><td class="printindex-index-entry"><a href="#index-configure_002eac"><code>configure.ac</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7656 <tr><td></td><td class="printindex-index-entry"><a href="#index-configuring_002c-for-cross-compilation">configuring, for cross compilation</a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7657 <tr><td></td><td class="printindex-index-entry"><a href="#index-const"><code class="code">const</code></a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7658 <tr><td></td><td class="printindex-index-entry"><a href="#index-continuous-integration">continuous integration</a></td><td class="printindex-index-section"><a href="#Continuous-integration">Continuous integration</a></td></tr>
7659 <tr><td></td><td class="printindex-index-entry"><a href="#index-conventions_002c-coding">conventions, coding</a></td><td class="printindex-index-section"><a href="#Coding-conventions">Coding conventions</a></td></tr>
7660 <tr><td></td><td class="printindex-index-entry"><a href="#index-CPPFLAGS"><code>CPPFLAGS</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7661 <tr><td></td><td class="printindex-index-entry"><a href="#index-cross-compilation">cross compilation</a></td><td class="printindex-index-section"><a href="#Cross-compilation">Cross compilation</a></td></tr>
7662 <tr><td></td><td class="printindex-index-entry"><a href="#index-cross-compilation-configuring">cross compilation configuring</a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7663 <tr><td></td><td class="printindex-index-entry"><a href="#index-cross-compilation-problems">cross compilation problems</a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7664 <tr><td></td><td class="printindex-index-entry"><a href="#index-cross-compilation_002c-with-host-binary">cross compilation, with host binary</a></td><td class="printindex-index-section"><a href="#xdvik-package"><code class="code">xdvik</code> package</a></td></tr>
7665 <tr><td></td><td class="printindex-index-entry"><a href="#index-ctangle"><code>ctangle</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7666 <tr><td></td><td class="printindex-index-entry"><a href="#index-CXX"><code>CXX</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7667 <tr><td></td><td class="printindex-index-entry"><a href="#index-CXX_003dc_002b_002b_002dcompiler"><code>CXX=<var class="var">c++-compiler</var></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7668 <tr><td colspan="3"><hr></td></tr>
7669 <tr><th id="Index_cp_letter-D">D</th></tr>
7670 <tr><td></td><td class="printindex-index-entry"><a href="#index-declarations-and-definitions_002c-in-source-code">declarations and definitions, in source code</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7671 <tr><td></td><td class="printindex-index-entry"><a href="#index-declarations-before-statements_002c-avoiding">declarations before statements, avoiding</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7672 <tr><td></td><td class="printindex-index-entry"><a href="#index-dependencies_002c-with-several-output-files">dependencies, with several output files</a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7673 <tr><td></td><td class="printindex-index-entry"><a href="#index-DESTDIR"><code>DESTDIR</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002dprefix-_002d_002dbindir-_2026"><code class="code">--prefix</code> <code class="code">--bindir</code> &hellip;</a></td></tr>
7674 <tr><td></td><td class="printindex-index-entry"><a href="#index-directories_002c-for-installation">directories, for installation</a></td><td class="printindex-index-section"><a href="#Installation-directories">Installation directories</a></td></tr>
7675 <tr><td></td><td class="printindex-index-entry"><a href="#index-directories_002c-top_002dlevel">directories, top-level</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7676 <tr><td></td><td class="printindex-index-entry"><a href="#index-discards-qualifiers-warning">discards qualifiers warning</a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7677 <tr><td></td><td class="printindex-index-entry"><a href="#index-dist-and-distcheck-targets-for-make"><code class="code">dist</code> and <code class="code">distcheck</code> targets for <code class="code">make</code></a></td><td class="printindex-index-section"><a href="#Build-distribution">Build distribution</a></td></tr>
7678 <tr><td></td><td class="printindex-index-entry"><a href="#index-distribution-tarball_002c-making">distribution tarball, making</a></td><td class="printindex-index-section"><a href="#Build-distribution">Build distribution</a></td></tr>
7679 <tr><td></td><td class="printindex-index-entry"><a href="#index-distro_002c-building-for">distro, building for</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7680 <tr><td></td><td class="printindex-index-entry"><a href="#index-dvipdfm_002dx"><code>dvipdfm-x</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7681 <tr><td></td><td class="printindex-index-entry"><a href="#index-dvipdfmx"><code>dvipdfmx</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7682 <tr><td></td><td class="printindex-index-entry"><a href="#index-dvisvgm"><code>dvisvgm</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvisvgm">Configure options for <samp class="file">texk/dvisvgm</samp></a></td></tr>
7683 <tr><td></td><td class="printindex-index-entry"><a href="#index-dvisvgm_002c-requires-C_002b_002b11"><code class="code">dvisvgm</code>, requires C++11</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7684 <tr><td colspan="3"><hr></td></tr>
7685 <tr><th id="Index_cp_letter-E">E</th></tr>
7686 <tr><td></td><td class="printindex-index-entry"><a href="#index-engine_002c-adding-new">engine, adding new</a></td><td class="printindex-index-section"><a href="#Adding-a-new-engine">Adding a new engine</a></td></tr>
7687 <tr><td></td><td class="printindex-index-entry"><a href="#index-engine_002c-building-one">engine, building one</a></td><td class="printindex-index-section"><a href="#Build-one-engine">Build one engine</a></td></tr>
7688 <tr><td></td><td class="printindex-index-entry"><a href="#index-environment-variables_002c-for-configure">environment variables, for <code class="code">configure</code></a></td><td class="printindex-index-section"><a href="#Configure-options">Configure options</a></td></tr>
7689 <tr><td></td><td class="printindex-index-entry"><a href="#index-exec_005fprefix"><code>exec_prefix</code></a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dmultiplatform"><code class="code">--enable-multiplatform</code></a></td></tr>
7690 <tr><td></td><td class="printindex-index-entry"><a href="#index-extending-TeX-Live">extending TeX&nbsp;Live</a></td><td class="printindex-index-section"><a href="#Extending-TeX-Live">Extending TeX&nbsp;Live</a></td></tr>
7691 <tr><td></td><td class="printindex-index-entry"><a href="#index-extern-functions"><code class="code">extern</code> functions</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7692 <tr><td colspan="3"><hr></td></tr>
7693 <tr><th id="Index_cp_letter-F">F</th></tr>
7694 <tr><td></td><td class="printindex-index-entry"><a href="#index-flags_002c-macros-for-library-and-header">flags, macros for library and header</a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7695 <tr><td></td><td class="printindex-index-entry"><a href="#index-fontconfig-library_002c-required-by-xetex"><code class="code">fontconfig</code> library, required by <code class="code">xetex</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7696 <tr><td></td><td class="printindex-index-entry"><a href="#index-freetype-cross-compiling"><code class="code">freetype</code> cross compiling</a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7697 <tr><td></td><td class="printindex-index-entry"><a href="#index-freetype-library"><code>freetype <span class="r">library</span></code></a></td><td class="printindex-index-section"><a href="#freetype-library"><code class="code">freetype</code> library</a></td></tr>
7698 <tr><td></td><td class="printindex-index-entry"><a href="#index-freetype_002dconfig"><code>freetype-config</code></a></td><td class="printindex-index-section"><a href="#freetype-library"><code class="code">freetype</code> library</a></td></tr>
7699 <tr><td></td><td class="printindex-index-entry"><a href="#index-freetype_002dconfig-1"><code>freetype-config</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7700 <tr><td></td><td class="printindex-index-entry"><a href="#index-FreeType_002c-requires-gmake">FreeType, requires <code class="code">gmake</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7701 <tr><td></td><td class="printindex-index-entry"><a href="#index-FT2_005fCONFIG"><code>FT2_CONFIG</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7702 <tr><td colspan="3"><hr></td></tr>
7703 <tr><th id="Index_cp_letter-G">G</th></tr>
7704 <tr><td></td><td class="printindex-index-entry"><a href="#index-gcc_002c-default-compilers"><code>gcc<span class="r">, default compilers</span></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7705 <tr><td></td><td class="printindex-index-entry"><a href="#index-general-setup-macros">general setup macros</a></td><td class="printindex-index-section"><a href="#General-setup-macros">General setup macros</a></td></tr>
7706 <tr><td></td><td class="printindex-index-entry"><a href="#index-generic-library-module_002c-adding">generic library module, adding</a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7707 <tr><td></td><td class="printindex-index-entry"><a href="#index-Ghostscript-location-for-Xdvik">Ghostscript location for Xdvik</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7708 <tr><td></td><td class="printindex-index-entry"><a href="#index-git_002dsvn"><code>git-svn</code></a></td><td class="printindex-index-section"><a href="#Transfer-from-Subversion-to-Github">Transfer from Subversion to Github</a></td></tr>
7709 <tr><td></td><td class="printindex-index-entry"><a href="#index-global-configure-options">global <code class="code">configure</code> options</a></td><td class="printindex-index-section"><a href="#Global-configure-options">Global configure options</a></td></tr>
7710 <tr><td></td><td class="printindex-index-entry"><a href="#index-gmake_002c-required"><code class="code">gmake</code>, required</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7711 <tr><td></td><td class="printindex-index-entry"><a href="#index-GNU-make_002c-required">GNU <code class="code">make</code>, required</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7712 <tr><td></td><td class="printindex-index-entry"><a href="#index-GNU-tools_002c-needed-for-building">GNU tools, needed for building</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7713 <tr><td></td><td class="printindex-index-entry"><a href="#index-GNU_002fLinux-distro">GNU/Linux distro</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7714 <tr><td></td><td class="printindex-index-entry"><a href="#index-Gnulib_002c-used-for-common-files">Gnulib, used for common files</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7715 <tr><td colspan="3"><hr></td></tr>
7716 <tr><th id="Index_cp_letter-H">H</th></tr>
7717 <tr><td></td><td class="printindex-index-entry"><a href="#index-HarfBuzz_002c-requires-C_002b_002b11">HarfBuzz, requires C++11</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7718 <tr><td colspan="3"><hr></td></tr>
7719 <tr><th id="Index_cp_letter-I">I</th></tr>
7720 <tr><td></td><td class="printindex-index-entry"><a href="#index-ICU-cross-compiling">ICU cross compiling</a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7721 <tr><td></td><td class="printindex-index-entry"><a href="#index-ICU-libraries">ICU libraries</a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7722 <tr><td></td><td class="printindex-index-entry"><a href="#index-ICU_005fCONFIG"><code>ICU_CONFIG</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7723 <tr><td></td><td class="printindex-index-entry"><a href="#index-icu_002dconfig"><code>icu-config</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7724 <tr><td></td><td class="printindex-index-entry"><a href="#index-ICU_002c-requires-C_002b_002b11">ICU, requires C++11</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7725 <tr><td></td><td class="printindex-index-entry"><a href="#index-infrastructure_002c-tools-needed-for">infrastructure, tools needed for</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7726 <tr><td></td><td class="printindex-index-entry"><a href="#index-inst_002f-top_002dlevel-directory"><samp class="file">inst/</samp> top-level directory</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7727 <tr><td></td><td class="printindex-index-entry"><a href="#index-install_002dtl_002c-TeX-Live-installer"><code>install-tl<span class="r">, TeX&nbsp;Live installer</span></code></a></td><td class="printindex-index-section"><a href="#Installing">Installing</a></td></tr>
7728 <tr><td></td><td class="printindex-index-entry"><a href="#index-installation-directories">installation directories</a></td><td class="printindex-index-section"><a href="#Installation-directories">Installation directories</a></td></tr>
7729 <tr><td></td><td class="printindex-index-entry"><a href="#index-installing">installing</a></td><td class="printindex-index-section"><a href="#Installing">Installing</a></td></tr>
7730 <tr><td></td><td class="printindex-index-entry"><a href="#index-interprocess-communication">interprocess communication</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7731 <tr><td></td><td class="printindex-index-entry"><a href="#index-introduction">introduction</a></td><td class="printindex-index-section"><a href="#Introduction">Introduction</a></td></tr>
7732 <tr><td></td><td class="printindex-index-entry"><a href="#index-iteration-through-sources_002c-by-configure-and-make">iteration through sources, by <code class="code">configure</code> and <code class="code">make</code></a></td><td class="printindex-index-section"><a href="#Build-iteration">Build iteration</a></td></tr>
7733 <tr><td colspan="3"><hr></td></tr>
7734 <tr><th id="Index_cp_letter-K">K</th></tr>
7735 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpathsea-library"><code>kpathsea <span class="r">library</span></code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7736 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpathsea_002eac"><code>kpathsea.ac</code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7737 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fADD_005fFLAGS"><code>KPSE_ADD_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7738 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fALL_005fSYSTEM_005fFLAGS"><code>KPSE_ALL_SYSTEM_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7739 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fBASIC"><code>KPSE_BASIC</code></a></td><td class="printindex-index-section"><a href="#General-setup-macros">General setup macros</a></td></tr>
7740 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCHECK_005fLATEX"><code>KPSE_CHECK_LATEX</code></a></td><td class="printindex-index-section"><a href="#Macros-for-programs">Macros for programs</a></td></tr>
7741 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCHECK_005fPDFLATEX"><code>KPSE_CHECK_PDFLATEX</code></a></td><td class="printindex-index-section"><a href="#Macros-for-programs">Macros for programs</a></td></tr>
7742 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCHECK_005fPERL"><code>KPSE_CHECK_PERL</code></a></td><td class="printindex-index-section"><a href="#Macros-for-programs">Macros for programs</a></td></tr>
7743 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCHECK_005fWIN32"><code>KPSE_CHECK_WIN32</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7744 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOMMON"><code>KPSE_COMMON</code></a></td><td class="printindex-index-section"><a href="#General-setup-macros">General setup macros</a></td></tr>
7745 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOMPILER_005fVISIBILITY"><code>KPSE_COMPILER_VISIBILITY</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7746 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOMPILER_005fWARNINGS"><code>KPSE_COMPILER_WARNINGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7747 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOND_005fMINGW32"><code>KPSE_COND_MINGW32</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7748 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOND_005fWIN32"><code>KPSE_COND_WIN32</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7749 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCOND_005fWIN32_005fWRAP"><code>KPSE_COND_WIN32_WRAP</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7750 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005fcv_005fcxx_005fhack"><code>kpse_cv_cxx_hack</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7751 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005fcv_005fhave_005fwin32"><code>kpse_cv_have_win32</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7752 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005fcv_005fvisibility_005fc_005bxx_005dflags"><code>kpse_cv_visibility_c[xx]flags</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7753 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005fcv_005fwarning_005fcflags"><code>kpse_cv_warning_cflags</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7754 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fCXX_005fHACK"><code>KPSE_CXX_HACK</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7755 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fENABLE_005fPROG"><code>KPSE_ENABLE_PROG</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7756 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLARGEFILE"><code>KPSE_LARGEFILE</code></a></td><td class="printindex-index-section"><a href="#Macros-for-libraries">Macros for libraries</a></td></tr>
7757 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLIB_005fFLAGS"><code>KPSE_<var class="var">LIB</var>_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7758 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLIB_005fFLAGS-1"><code>KPSE_<var class="var">LIB</var>_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7759 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLIB_005fSYSTEM_005fFLAGS"><code>KPSE_<var class="var">LIB</var>_SYSTEM_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7760 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLIBPNG_005fFLAGS"><code>KPSE_LIBPNG_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7761 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fLIBPNG_005fFLAGS-1"><code>KPSE_LIBPNG_FLAGS</code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7762 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005flibs_005fpkgs"><code>kpse_libs_pkgs</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7763 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fPROG_005fLEX"><code>KPSE_PROG_LEX</code></a></td><td class="printindex-index-section"><a href="#Macros-for-programs">Macros for programs</a></td></tr>
7764 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fRESTORE_005fFLAGS"><code>KPSE_RESTORE_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7765 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005ftexk_005fpkgs"><code>kpse_texk_pkgs</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7766 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005ftexlibs_005fpkgs"><code>kpse_texlibs_pkgs</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-TeX_002dspecific-library-module">Adding a new TeX-specific library module</a></td></tr>
7767 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fTRY_005fLIB"><code>KPSE_TRY_LIB</code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7768 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fTRY_005fLIB-1"><code>KPSE_TRY_LIB</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7769 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fTRY_005fLIBXX"><code>KPSE_TRY_LIBXX</code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7770 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fTRY_005fLIBXX-1"><code>KPSE_TRY_LIBXX</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7771 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_005futils_005fpkgs"><code>kpse_utils_pkgs</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7772 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fWIN32_005fCALL"><code>KPSE_WIN32_CALL</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7773 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fWITH_005fLIB"><code>KPSE_WITH_LIB</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7774 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSE_005fWITH_005fTEXLIB"><code>KPSE_WITH_TEXLIB</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-TeX_002dspecific-library-module">Adding a new TeX-specific library module</a></td></tr>
7775 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_002dlibpng_002dflags_002em4"><code>kpse-libpng-flags.m4</code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7776 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_002dpkgs_002em4"><code>kpse-pkgs.m4</code></a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7777 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpse_002dzlib_002dflags_002em4"><code>kpse-zlib-flags.m4</code></a></td><td class="printindex-index-section"><a href="#zlib-library"><code class="code">zlib</code> library</a></td></tr>
7778 <tr><td></td><td class="printindex-index-entry"><a href="#index-kpsewhich"><code>kpsewhich</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7779 <tr><td></td><td class="printindex-index-entry"><a href="#index-KPSEWHICH"><code>KPSEWHICH</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7780 <tr><td colspan="3"><hr></td></tr>
7781 <tr><th id="Index_cp_letter-L">L</th></tr>
7782 <tr><td></td><td class="printindex-index-entry"><a href="#index-large-file-support">large file support</a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7783 <tr><td></td><td class="printindex-index-entry"><a href="#index-LATEX"><code>LATEX</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7784 <tr><td></td><td class="printindex-index-entry"><a href="#index-layout-of-sources">layout of sources</a></td><td class="printindex-index-section"><a href="#Layout-and-infrastructure">Layout and infrastructure</a></td></tr>
7785 <tr><td></td><td class="printindex-index-entry"><a href="#index-LFS-_0028large-file-support_0029">LFS (large file support)</a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7786 <tr><td></td><td class="printindex-index-entry"><a href="#index-libexpat_002c-dependency-of-libfontconfig"><code>libexpat<span class="r">, dependency of <code class="code">libfontconfig</code></span></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7787 <tr><td></td><td class="printindex-index-entry"><a href="#index-libfontconfig_002c-hack-for-avoiding-linking-dependencies"><code>libfontconfig<span class="r">, hack for avoiding linking dependencies</span></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7788 <tr><td></td><td class="printindex-index-entry"><a href="#index-libfreetype"><code>libfreetype</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7789 <tr><td></td><td class="printindex-index-entry"><a href="#index-libfreetype_002c-and-const"><code class="code">libfreetype</code>, and <code class="code">const</code></a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7790 <tr><td></td><td class="printindex-index-entry"><a href="#index-libpng-library"><code>libpng <span class="r">library</span></code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7791 <tr><td></td><td class="printindex-index-entry"><a href="#index-library-module_002c-generic_002c-adding">library module, generic, adding</a></td><td class="printindex-index-section"><a href="#Adding-a-new-generic-library-module">Adding a new generic library module</a></td></tr>
7792 <tr><td></td><td class="printindex-index-entry"><a href="#index-library-module_002c-TeX_002dspecific_002c-adding">library module, TeX-specific, adding</a></td><td class="printindex-index-section"><a href="#Adding-a-new-TeX_002dspecific-library-module">Adding a new TeX-specific library module</a></td></tr>
7793 <tr><td></td><td class="printindex-index-entry"><a href="#index-library-modules">library modules</a></td><td class="printindex-index-section"><a href="#Library-modules">Library modules</a></td></tr>
7794 <tr><td></td><td class="printindex-index-entry"><a href="#index-library_002dspecific-configure-options">library-specific <code class="code">configure</code> options</a></td><td class="printindex-index-section"><a href="#Library_002dspecific-configure-options">Library-specific configure options</a></td></tr>
7795 <tr><td></td><td class="printindex-index-entry"><a href="#index-libsigsegv_002c-required-by-xindy"><code class="code">libsigsegv</code>, required by <code class="code">xindy</code></a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7796 <tr><td></td><td class="printindex-index-entry"><a href="#index-libstc_002b_002b_002c-statically-linking"><code>libstc++<span class="r">, statically linking</span></code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7797 <tr><td></td><td class="printindex-index-entry"><a href="#index-Libtool">Libtool</a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7798 <tr><td></td><td class="printindex-index-entry"><a href="#index-libtool_002c-hack-for-avoiding-excessive-linking"><code>libtool<span class="r">, hack for avoiding excessive linking</span></code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7799 <tr><td></td><td class="printindex-index-entry"><a href="#index-libXt"><code>libXt</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7800 <tr><td></td><td class="printindex-index-entry"><a href="#index-linked-scripts">linked scripts</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7801 <tr><td></td><td class="printindex-index-entry"><a href="#index-linking-C_002b_002b-libraries-statically">linking C++ libraries statically</a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7802 <tr><td></td><td class="printindex-index-entry"><a href="#index-lisp_002erun_002c-lisp_002eexe"><code>lisp.run<span class="r">,</span> lisp.exe</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7803 <tr><td></td><td class="printindex-index-entry"><a href="#index-LittleEndian-architectures">LittleEndian architectures</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7804 <tr><td colspan="3"><hr></td></tr>
7805 <tr><th id="Index_cp_letter-M">M</th></tr>
7806 <tr><td></td><td class="printindex-index-entry"><a href="#index-m4_002f-top_002dlevel-directory"><samp class="file">m4/</samp> top-level directory</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7807 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-for-compilers">macros, for compilers</a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7808 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-for-libraries">macros, for libraries</a></td><td class="printindex-index-section"><a href="#Macros-for-libraries">Macros for libraries</a></td></tr>
7809 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-for-library-and-header-flags">macros, for library and header flags</a></td><td class="printindex-index-section"><a href="#Macros-for-library-and-header-flags">Macros for library and header flags</a></td></tr>
7810 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-for-programs">macros, for programs</a></td><td class="printindex-index-section"><a href="#Macros-for-programs">Macros for programs</a></td></tr>
7811 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-for-Windows">macros, for Windows</a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7812 <tr><td></td><td class="printindex-index-entry"><a href="#index-macros_002c-general-setup">macros, general setup</a></td><td class="printindex-index-section"><a href="#General-setup-macros">General setup macros</a></td></tr>
7813 <tr><td></td><td class="printindex-index-entry"><a href="#index-MAKE"><code>MAKE</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7814 <tr><td></td><td class="printindex-index-entry"><a href="#index-make-_002dt"><code>make -t</code></a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7815 <tr><td></td><td class="printindex-index-entry"><a href="#index-make-rules_002c-verbose-vs_002e-silent"><code class="code">make</code> rules, verbose vs. silent</a></td><td class="printindex-index-section"><a href="#g_t_002d_002denable_002dsilent_002drules"><code class="code">--enable-silent-rules</code></a></td></tr>
7816 <tr><td></td><td class="printindex-index-entry"><a href="#index-Makefile_002eam"><code>Makefile.am</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7817 <tr><td></td><td class="printindex-index-entry"><a href="#index-mf_002dnowin"><code>mf-nowin</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7818 <tr><td></td><td class="printindex-index-entry"><a href="#index-mingw32"><code class="code">mingw32</code></a></td><td class="printindex-index-section"><a href="#Cross-configuring">Cross configuring</a></td></tr>
7819 <tr><td></td><td class="printindex-index-entry"><a href="#index-MINGW32_002c-Automake-conditional"><code>MINGW32<span class="r">, Automake conditional</span></code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7820 <tr><td></td><td class="printindex-index-entry"><a href="#index-mktex_002eac"><code>mktex.ac</code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7821 <tr><td></td><td class="printindex-index-entry"><a href="#index-mktextfm"><code>mktextfm</code></a></td><td class="printindex-index-section"><a href="#kpathsea-library"><code class="code">kpathsea</code> library</a></td></tr>
7822 <tr><td></td><td class="printindex-index-entry"><a href="#index-modules_002c-for-libraries">modules, for libraries</a></td><td class="printindex-index-section"><a href="#Library-modules">Library modules</a></td></tr>
7823 <tr><td></td><td class="printindex-index-entry"><a href="#index-modules_002c-for-programs">modules, for programs</a></td><td class="printindex-index-section"><a href="#Program-modules">Program modules</a></td></tr>
7824 <tr><td></td><td class="printindex-index-entry"><a href="#index-motif"><code>motif</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7825 <tr><td colspan="3"><hr></td></tr>
7826 <tr><th id="Index_cp_letter-N">N</th></tr>
7827 <tr><td></td><td class="printindex-index-entry"><a href="#index-native-cross-compilation">native cross compilation</a></td><td class="printindex-index-section"><a href="#Cross-compilation">Cross compilation</a></td></tr>
7828 <tr><td></td><td class="printindex-index-entry"><a href="#index-new-package-using-Autoconf-only">new package using Autoconf only</a></td><td class="printindex-index-section"><a href="#Extending-TeX-Live">Extending TeX&nbsp;Live</a></td></tr>
7829 <tr><td></td><td class="printindex-index-entry"><a href="#index-newprog_002dsrc_002c-original-source-subdirectory"><var class="var">newprog-src</var>, original source subdirectory</a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7830 <tr><td colspan="3"><hr></td></tr>
7831 <tr><th id="Index_cp_letter-O">O</th></tr>
7832 <tr><td></td><td class="printindex-index-entry"><a href="#index-OBJCXX_003dobjc_002dcompiler"><code>OBJCXX=<var class="var">objc-compiler</var></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7833 <tr><td></td><td class="printindex-index-entry"><a href="#index-one-engine_002c-building">one engine, building</a></td><td class="printindex-index-section"><a href="#Build-one-engine">Build one engine</a></td></tr>
7834 <tr><td></td><td class="printindex-index-entry"><a href="#index-one-package_002c-building">one package, building</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7835 <tr><td></td><td class="printindex-index-entry"><a href="#index-OpenGL_002c-required-for-Asymptote">OpenGL, required for Asymptote</a></td><td class="printindex-index-section"><a href="#asymptote"><code class="code">asymptote</code></a></td></tr>
7836 <tr><td></td><td class="printindex-index-entry"><a href="#index-operating-system-distribution_002c-building-for">operating system distribution, building for</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7837 <tr><td></td><td class="printindex-index-entry"><a href="#index-otangle"><code>otangle</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7838 <tr><td></td><td class="printindex-index-entry"><a href="#index-overall-build-process">overall build process</a></td><td class="printindex-index-section"><a href="#Building">Building</a></td></tr>
7839 <tr><td colspan="3"><hr></td></tr>
7840 <tr><th id="Index_cp_letter-P">P</th></tr>
7841 <tr><td></td><td class="printindex-index-entry"><a href="#index-parallel-build">parallel build</a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7842 <tr><td></td><td class="printindex-index-entry"><a href="#index-paths_002c-for-installation">paths, for installation</a></td><td class="printindex-index-section"><a href="#Installation-directories">Installation directories</a></td></tr>
7843 <tr><td></td><td class="printindex-index-entry"><a href="#index-PDF-files_002c-size-of">PDF files, size of</a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7844 <tr><td></td><td class="printindex-index-entry"><a href="#index-PDFLATEX"><code>PDFLATEX</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7845 <tr><td></td><td class="printindex-index-entry"><a href="#index-PERL"><code>PERL</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7846 <tr><td></td><td class="printindex-index-entry"><a href="#index-perl_002c-required-by-web2c_002c-etc_002e"><code class="code">perl</code>, required by <code class="code">web2c</code>, etc.</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7847 <tr><td></td><td class="printindex-index-entry"><a href="#index-PKG_005fCONFIG"><code>PKG_CONFIG</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7848 <tr><td></td><td class="printindex-index-entry"><a href="#index-plain_002etex_002c-not-in-source-tree"><code>plain.tex<span class="r">, not in source tree</span></code></a></td><td class="printindex-index-section"><a href="#Installing">Installing</a></td></tr>
7849 <tr><td></td><td class="printindex-index-entry"><a href="#index-png-library"><code>png <span class="r">library</span></code></a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7850 <tr><td></td><td class="printindex-index-entry"><a href="#index-PostScript-files_002c-size-of">PostScript files, size of</a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7851 <tr><td></td><td class="printindex-index-entry"><a href="#index-Preining_002c-Norbert">Preining, Norbert</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7852 <tr><td></td><td class="printindex-index-entry"><a href="#index-preloaded-binaries">preloaded binaries</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7853 <tr><td></td><td class="printindex-index-entry"><a href="#index-prerequisites-for-building">prerequisites for building</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7854 <tr><td></td><td class="printindex-index-entry"><a href="#index-program-module_002c-adding">program module, adding</a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7855 <tr><td></td><td class="printindex-index-entry"><a href="#index-program-modules">program modules</a></td><td class="printindex-index-section"><a href="#Program-modules">Program modules</a></td></tr>
7856 <tr><td></td><td class="printindex-index-entry"><a href="#index-program_002dspecific-configure-options">program-specific <code class="code">configure</code> options</a></td><td class="printindex-index-section"><a href="#Program_002dspecific-configure-options">Program-specific configure options</a></td></tr>
7857 <tr><td></td><td class="printindex-index-entry"><a href="#index-proxy-build-system">proxy build system</a></td><td class="printindex-index-section"><a href="#png-library"><code class="code">png</code> library</a></td></tr>
7858 <tr><td></td><td class="printindex-index-entry"><a href="#index-Python_002c-required-by-ICU">Python, required by ICU</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7859 <tr><td colspan="3"><hr></td></tr>
7860 <tr><th id="Index_cp_letter-R">R</th></tr>
7861 <tr><td></td><td class="printindex-index-entry"><a href="#index-reautoconf"><code>reautoconf</code></a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7862 <tr><td></td><td class="printindex-index-entry"><a href="#index-reautoconf_002c-for-new-program"><code>reautoconf<span class="r">, for new program</span></code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7863 <tr><td></td><td class="printindex-index-entry"><a href="#index-removing-build-directories">removing build directories</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7864 <tr><td></td><td class="printindex-index-entry"><a href="#index-requirements-for-building">requirements for building</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7865 <tr><td></td><td class="printindex-index-entry"><a href="#index-runscript_002eexe"><code>runscript.exe</code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7866 <tr><td colspan="3"><hr></td></tr>
7867 <tr><th id="Index_cp_letter-S">S</th></tr>
7868 <tr><td></td><td class="printindex-index-entry"><a href="#index-scripts_002dtargets_002elst"><code>scripts-targets.lst</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7869 <tr><td></td><td class="printindex-index-entry"><a href="#index-scripts_002c-linked-and-not-maintained">scripts, linked and not maintained</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7870 <tr><td></td><td class="printindex-index-entry"><a href="#index-scrolling_002c-smooth"><code>scrolling, smooth</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7871 <tr><td></td><td class="printindex-index-entry"><a href="#index-SED"><code>SED</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7872 <tr><td></td><td class="printindex-index-entry"><a href="#index-setup-macros_002c-general">setup macros, general</a></td><td class="printindex-index-section"><a href="#General-setup-macros">General setup macros</a></td></tr>
7873 <tr><td></td><td class="printindex-index-entry"><a href="#index-shared-libraries_002c-using-vs_002e-avoiding">shared libraries, using vs. avoiding</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7874 <tr><td></td><td class="printindex-index-entry"><a href="#index-size-of-PDF-and-PS-files">size of PDF and PS files</a></td><td class="printindex-index-section"><a href="#g_t_002d_002ddisable_002dlargefile"><code class="code">--disable-largefile</code></a></td></tr>
7875 <tr><td></td><td class="printindex-index-entry"><a href="#index-size-of-source-tree">size of source tree</a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7876 <tr><td></td><td class="printindex-index-entry"><a href="#index-source-code-declarations">source code declarations</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7877 <tr><td></td><td class="printindex-index-entry"><a href="#index-source-directory-building_002c-not-supported">source directory building, not supported</a></td><td class="printindex-index-section"><a href="#Building">Building</a></td></tr>
7878 <tr><td></td><td class="printindex-index-entry"><a href="#index-source-tree">source tree</a></td><td class="printindex-index-section"><a href="#Layout-and-infrastructure">Layout and infrastructure</a></td></tr>
7879 <tr><td></td><td class="printindex-index-entry"><a href="#index-squeeze"><code>squeeze</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7880 <tr><td></td><td class="printindex-index-entry"><a href="#index-squeeze_002fconfigure_002eac"><code>squeeze/configure.ac</code></a></td><td class="printindex-index-section"><a href="#xdvik-package"><code class="code">xdvik</code> package</a></td></tr>
7881 <tr><td></td><td class="printindex-index-entry"><a href="#index-static-functions"><code class="code">static</code> functions</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7882 <tr><td></td><td class="printindex-index-entry"><a href="#index-static-linking-for-C_002b_002b">static linking for C++</a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7883 <tr><td></td><td class="printindex-index-entry"><a href="#index-stpcpy"><code>stpcpy</code></a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7884 <tr><td></td><td class="printindex-index-entry"><a href="#index-Subversion-repository">Subversion repository</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7885 <tr><td></td><td class="printindex-index-entry"><a href="#index-support-files_002c-separate-from-build">support files, separate from build</a></td><td class="printindex-index-section"><a href="#Installing">Installing</a></td></tr>
7886 <tr><td></td><td class="printindex-index-entry"><a href="#index-symbolic-links_002c-used-for-scripts">symbolic links, used for scripts</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7887 <tr><td></td><td class="printindex-index-entry"><a href="#index-symlinks_002c-used-for-scripts">symlinks, used for scripts</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7888 <tr><td></td><td class="printindex-index-entry"><a href="#index-synctex">synctex</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7889 <tr><td></td><td class="printindex-index-entry"><a href="#index-synctex-1">synctex</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7890 <tr><td></td><td class="printindex-index-entry"><a href="#index-system-distribution_002c-building-for">system distribution, building for</a></td><td class="printindex-index-section"><a href="#Distro-builds">Distro builds</a></td></tr>
7891 <tr><td colspan="3"><hr></td></tr>
7892 <tr><th id="Index_cp_letter-T">T</th></tr>
7893 <tr><td></td><td class="printindex-index-entry"><a href="#index-t1utils-package"><code>t1utils <span class="r">package</span></code></a></td><td class="printindex-index-section"><a href="#t1utils-package"><code class="code">t1utils</code> package</a></td></tr>
7894 <tr><td></td><td class="printindex-index-entry"><a href="#index-tangle"><code>tangle</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7895 <tr><td></td><td class="printindex-index-entry"><a href="#index-tests_002c-running">tests, running</a></td><td class="printindex-index-section"><a href="#Overview-of-build-system">Overview of build system</a></td></tr>
7896 <tr><td></td><td class="printindex-index-entry"><a href="#index-TeX_002dspecific-library-module_002c-adding">TeX-specific library module, adding</a></td><td class="printindex-index-section"><a href="#Adding-a-new-TeX_002dspecific-library-module">Adding a new TeX-specific library module</a></td></tr>
7897 <tr><td></td><td class="printindex-index-entry"><a href="#index-texlive_002etlpdb_002c-TeX-Live-database"><code>texlive.tlpdb<span class="r">, TeX&nbsp;Live database</span></code></a></td><td class="printindex-index-section"><a href="#Installing">Installing</a></td></tr>
7898 <tr><td></td><td class="printindex-index-entry"><a href="#index-TEXMFCNF-for-running-standalone"><code>TEXMFCNF <span class="r">for running standalone</span></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7899 <tr><td></td><td class="printindex-index-entry"><a href="#index-TEXMFROOT-for-running-standalone"><code>TEXMFROOT <span class="r">for running standalone</span></code></a></td><td class="printindex-index-section"><a href="#Build-one-package">Build one package</a></td></tr>
7900 <tr><td></td><td class="printindex-index-entry"><a href="#index-tie"><code>tie</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7901 <tr><td></td><td class="printindex-index-entry"><a href="#index-timestamps_002c-in-repository">timestamps, in repository</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7902 <tr><td></td><td class="printindex-index-entry"><a href="#index-TL_005fMAKE_005fFLAGS"><code>TL_MAKE_FLAGS</code></a></td><td class="printindex-index-section"><a href="#Build-in-parallel">Build in parallel</a></td></tr>
7903 <tr><td></td><td class="printindex-index-entry"><a href="#index-TLpatches_002fpatch_002d_002e_002e_002e"><code>TLpatches/patch-...</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7904 <tr><td></td><td class="printindex-index-entry"><a href="#index-TLpatches_002fTL_002dChanges"><code>TLpatches/TL-Changes</code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7905 <tr><td></td><td class="printindex-index-entry"><a href="#index-tools_002c-for-building">tools, for building</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7906 <tr><td></td><td class="printindex-index-entry"><a href="#index-top_002dlevel-directories">top-level directories</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7907 <tr><td></td><td class="printindex-index-entry"><a href="#index-touching-files-to-avoid-rerunning">touching files to avoid rerunning</a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7908 <tr><td></td><td class="printindex-index-entry"><a href="#index-Travis_002dCI">Travis-CI</a></td><td class="printindex-index-section"><a href="#Continuous-integration">Continuous integration</a></td></tr>
7909 <tr><td></td><td class="printindex-index-entry"><a href="#index-travis_002eyml"><code>travis.yml</code></a></td><td class="printindex-index-section"><a href="#CI-testing-on-Travis_002dCI">CI testing on Travis-CI</a></td></tr>
7910 <tr><td></td><td class="printindex-index-entry"><a href="#index-type-cast-from-const_002c-avoiding">type cast from const, avoiding</a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7911 <tr><td colspan="3"><hr></td></tr>
7912 <tr><th id="Index_cp_letter-U">U</th></tr>
7913 <tr><td></td><td class="printindex-index-entry"><a href="#index-use_002dcommit_002dtimes_002c-Subversion"><code>use-commit-times<span class="r">, Subversion</span></code></a></td><td class="printindex-index-section"><a href="#Build-system-tools">Build system tools</a></td></tr>
7914 <tr><td colspan="3"><hr></td></tr>
7915 <tr><th id="Index_cp_letter-V">V</th></tr>
7916 <tr><td></td><td class="printindex-index-entry"><a href="#index-variable-declarations_002c-in-source-code">variable declarations, in source code</a></td><td class="printindex-index-section"><a href="#Declarations-and-definitions">Declarations and definitions</a></td></tr>
7917 <tr><td></td><td class="printindex-index-entry"><a href="#index-variables-for-configure">variables for <code class="code">configure</code></a></td><td class="printindex-index-section"><a href="#Variables-for-configure">Variables for configure</a></td></tr>
7918 <tr><td colspan="3"><hr></td></tr>
7919 <tr><th id="Index_cp_letter-W">W</th></tr>
7920 <tr><td></td><td class="printindex-index-entry"><a href="#index-WARNING_005fC_005bXX_005dFLAGS"><code>WARNING_C[XX]FLAGS</code></a></td><td class="printindex-index-section"><a href="#Macros-for-compilers">Macros for compilers</a></td></tr>
7921 <tr><td></td><td class="printindex-index-entry"><a href="#index-warning_002c-discards-qualifiers">warning, discards qualifiers</a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7922 <tr><td></td><td class="printindex-index-entry"><a href="#index-web2c-program"><code>web2c <span class="r">program</span></code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7923 <tr><td></td><td class="printindex-index-entry"><a href="#index-web2c_002eac"><code>web2c.ac</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7924 <tr><td></td><td class="printindex-index-entry"><a href="#index-wget"><code>wget</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7925 <tr><td></td><td class="printindex-index-entry"><a href="#index-WIN32_005fWRAP_002c-Automake-conditional"><code>WIN32_WRAP<span class="r">, Automake conditional</span></code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7926 <tr><td></td><td class="printindex-index-entry"><a href="#index-WIN32_002c-Automake-conditional"><code>WIN32<span class="r">, Automake conditional</span></code></a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7927 <tr><td></td><td class="printindex-index-entry"><a href="#index-Windows_002c-invoking-scripts-on">Windows, invoking scripts on</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7928 <tr><td></td><td class="printindex-index-entry"><a href="#index-Windows_002c-macros-for">Windows, macros for</a></td><td class="printindex-index-section"><a href="#Macros-for-Windows">Macros for Windows</a></td></tr>
7929 <tr><td></td><td class="printindex-index-entry"><a href="#index-withenable_002eac_002c-for-new-modules"><code>withenable.ac<span class="r">, for new modules</span></code></a></td><td class="printindex-index-section"><a href="#Adding-a-new-program-module">Adding a new program module</a></td></tr>
7930 <tr><td></td><td class="printindex-index-entry"><a href="#index-Work_002f-top_002dlevel-directory"><samp class="file">Work/</samp> top-level directory</a></td><td class="printindex-index-section"><a href="#Top_002dlevel-directories">Top-level directories</a></td></tr>
7931 <tr><td></td><td class="printindex-index-entry"><a href="#index-wrapper-binary-for-scripts-on-Windows">wrapper binary for scripts on Windows</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7932 <tr><td></td><td class="printindex-index-entry"><a href="#index-wrapper-build-system">wrapper build system</a></td><td class="printindex-index-section"><a href="#freetype-library"><code class="code">freetype</code> library</a></td></tr>
7933 <tr><td></td><td class="printindex-index-entry"><a href="#index-wrapper-for-scripts_002c-on-Windows">wrapper for scripts, on Windows</a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7934 <tr><td colspan="3"><hr></td></tr>
7935 <tr><th id="Index_cp_letter-X">X</th></tr>
7936 <tr><td></td><td class="printindex-index-entry"><a href="#index-X-toolkit">X toolkit</a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7937 <tr><td></td><td class="printindex-index-entry"><a href="#index-X11-development_002c-required-by-X-clients">X11 development, required by X clients</a></td><td class="printindex-index-section"><a href="#Prerequisites">Prerequisites</a></td></tr>
7938 <tr><td></td><td class="printindex-index-entry"><a href="#index-X11-headers_002c-and-const">X11 headers, and <code class="code">const</code></a></td><td class="printindex-index-section"><a href="#Const">Const</a></td></tr>
7939 <tr><td></td><td class="printindex-index-entry"><a href="#index-xasy"><code>xasy</code></a></td><td class="printindex-index-section"><a href="#asymptote"><code class="code">asymptote</code></a></td></tr>
7940 <tr><td></td><td class="printindex-index-entry"><a href="#index-xaw"><code>xaw</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7941 <tr><td></td><td class="printindex-index-entry"><a href="#index-xdvik"><code>xdvik</code></a></td><td class="printindex-index-section"><a href="#xdvik-package"><code class="code">xdvik</code> package</a></td></tr>
7942 <tr><td></td><td class="printindex-index-entry"><a href="#index-xdvik-1"><code>xdvik</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7943 <tr><td></td><td class="printindex-index-entry"><a href="#index-xdvipdfmx"><code>xdvipdfmx</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fdvipdfm_002dx">Configure options for <samp class="file">texk/dvipdfm-x</samp></a></td></tr>
7944 <tr><td></td><td class="printindex-index-entry"><a href="#index-xindy"><code>xindy</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7945 <tr><td></td><td class="printindex-index-entry"><a href="#index-xindy-1"><code>xindy</code></a></td><td class="printindex-index-section"><a href="#xindy-package"><code class="code">xindy</code> package</a></td></tr>
7946 <tr><td></td><td class="printindex-index-entry"><a href="#index-xindy-2"><code>xindy</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-utils_002fxindy">Configure options for <samp class="file">utils/xindy</samp></a></td></tr>
7947 <tr><td></td><td class="printindex-index-entry"><a href="#index-xindy-cross-compiling-requires-clisp"><code class="code">xindy</code> cross compiling requires <code class="code">clisp</code></a></td><td class="printindex-index-section"><a href="#Cross-problems">Cross problems</a></td></tr>
7948 <tr><td></td><td class="printindex-index-entry"><a href="#index-XInput"><code>XInput</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fxdvik">Configure options for <samp class="file">texk/xdvik</samp></a></td></tr>
7949 <tr><td></td><td class="printindex-index-entry"><a href="#index-Xlib"><code>Xlib</code></a></td><td class="printindex-index-section"><a href="#Configure-options-for-texk_002fweb2c">Configure options for <samp class="file">texk/web2c</samp></a></td></tr>
7950 <tr><td></td><td class="printindex-index-entry"><a href="#index-xz"><code>xz</code></a></td><td class="printindex-index-section"><a href="#Linked-scripts">Linked scripts</a></td></tr>
7951 <tr><td colspan="3"><hr></td></tr>
7952 <tr><th id="Index_cp_letter-Z">Z</th></tr>
7953 <tr><td></td><td class="printindex-index-entry"><a href="#index-zlib-library"><code>zlib <span class="r">library</span></code></a></td><td class="printindex-index-section"><a href="#zlib-library"><code class="code">zlib</code> library</a></td></tr>
7954 <tr><td colspan="3"><hr></td></tr>
7955 </table>
7956 <table class="cp-letters-footer-printindex"><tr><th>Jump to: &nbsp; </th><td><a class="summary-letter-printindex" href="#Index_cp_symbol-1"><b>-</b></a>
7957 &nbsp;
7958 <a class="summary-letter-printindex" href="#Index_cp_symbol-2"><b>$</b></a>
7959 &nbsp;
7960 <br>
7961 <a class="summary-letter-printindex" href="#Index_cp_letter-A"><b>A</b></a>
7962 &nbsp;
7963 <a class="summary-letter-printindex" href="#Index_cp_letter-B"><b>B</b></a>
7964 &nbsp;
7965 <a class="summary-letter-printindex" href="#Index_cp_letter-C"><b>C</b></a>
7966 &nbsp;
7967 <a class="summary-letter-printindex" href="#Index_cp_letter-D"><b>D</b></a>
7968 &nbsp;
7969 <a class="summary-letter-printindex" href="#Index_cp_letter-E"><b>E</b></a>
7970 &nbsp;
7971 <a class="summary-letter-printindex" href="#Index_cp_letter-F"><b>F</b></a>
7972 &nbsp;
7973 <a class="summary-letter-printindex" href="#Index_cp_letter-G"><b>G</b></a>
7974 &nbsp;
7975 <a class="summary-letter-printindex" href="#Index_cp_letter-H"><b>H</b></a>
7976 &nbsp;
7977 <a class="summary-letter-printindex" href="#Index_cp_letter-I"><b>I</b></a>
7978 &nbsp;
7979 <a class="summary-letter-printindex" href="#Index_cp_letter-K"><b>K</b></a>
7980 &nbsp;
7981 <a class="summary-letter-printindex" href="#Index_cp_letter-L"><b>L</b></a>
7982 &nbsp;
7983 <a class="summary-letter-printindex" href="#Index_cp_letter-M"><b>M</b></a>
7984 &nbsp;
7985 <a class="summary-letter-printindex" href="#Index_cp_letter-N"><b>N</b></a>
7986 &nbsp;
7987 <a class="summary-letter-printindex" href="#Index_cp_letter-O"><b>O</b></a>
7988 &nbsp;
7989 <a class="summary-letter-printindex" href="#Index_cp_letter-P"><b>P</b></a>
7990 &nbsp;
7991 <a class="summary-letter-printindex" href="#Index_cp_letter-R"><b>R</b></a>
7992 &nbsp;
7993 <a class="summary-letter-printindex" href="#Index_cp_letter-S"><b>S</b></a>
7994 &nbsp;
7995 <a class="summary-letter-printindex" href="#Index_cp_letter-T"><b>T</b></a>
7996 &nbsp;
7997 <a class="summary-letter-printindex" href="#Index_cp_letter-U"><b>U</b></a>
7998 &nbsp;
7999 <a class="summary-letter-printindex" href="#Index_cp_letter-V"><b>V</b></a>
8000 &nbsp;
8001 <a class="summary-letter-printindex" href="#Index_cp_letter-W"><b>W</b></a>
8002 &nbsp;
8003 <a class="summary-letter-printindex" href="#Index_cp_letter-X"><b>X</b></a>
8004 &nbsp;
8005 <a class="summary-letter-printindex" href="#Index_cp_letter-Z"><b>Z</b></a>
8006 &nbsp;
8007 </td></tr></table>
8008 </div>
8009
8010 </div>
8011 </div>
8012 <div class="footnotes-segment">
8013 <hr>
8014 <h4 class="footnotes-heading">Footnotes</h4>
8015
8016 <h5 class="footnote-body-heading"><a id="FOOT1" href="#DOCF1">(1)</a></h5>
8017 <p>There is one exception in TL: the
8018 <code class="code">tangle-sh</code> and related rules use <code class="code">$@</code> to mean the target
8019 name, a feature not present in all <code class="code">make</code>s. This could be
8020 alleviated by laborious editing, but since there&rsquo;s no way to avoid GNU
8021 <code class="code">make</code> for builds of the entire tree, it does not seem worth the
8022 trouble.</p>
8023 </div>
8024
8025
8026
8027 </body>
8028 </html>