1INSTALL-TL(1) User Contributed Perl Documentation INSTALL-TL(1)
2
6 install-tl - TeX Live cross-platform installer
7
9 install-tl [option]...
10 install-tl-windows.bat [option]...
12 install-tl-advanced.bat [option]...
14
16 This installer creates a runnable TeX Live installation from various
17 media, including over the network, from local hard disk, a DVD, etc.
18 The installer works on all platforms supported by TeX Live. For
19 information on initially downloading TeX Live, see
20 <https://tug.org/texlive/acquire.html>.
21 The basic idea of TeX Live installation is for you to choose one of the
23 top-level schemes, each of which is defined as a different set of
24 collections and packages, where a collection is a set of packages, and
25 a package is what contains actual files.
26 Within the installer, you can choose a scheme, and further customize
28 the set of collections to install, but not the set of the packages. To
29 work at the package level, use "tlmgr" (reference just below) after the
30 initial installation is complete.
31 The default is "scheme-full", which installs everything, and this is
33 highly recommended.
34
36 Post-installation configuration, package updates, and more, are handled
37 through tlmgr(1), the TeX Live Manager
38 (<https://tug.org/texlive/tlmgr.html>).
39 The most up-to-date version of this installer documentation is on the
41 Internet at <https://tug.org/texlive/doc/install-tl.html>.
42 For the full documentation of TeX Live, see
44 <https://tug.org/texlive/doc>.
45
47 As usual, all options can be specified in any order, and with either a
48 leading "-" or "--". An argument value can be separated from its
49 option by either a space or "=".
50 -gui [[=]module]
52 If no module is given, starts the Tcl/Tk (see below) GUI installer.
53 If module is given loads the given installer module. Currently the
55 following modules are supported:
56 "text"
58 The text mode user interface (default on Unix systems,
59 including Macs). Same as the "-no-gui" option.
60 "tcl" (or "perltk" or "wizard" or "expert" or nothing)
62 The Tcl/Tk user interface (default on Windows). It starts with
63 a small number of configuration options, roughly equivalent to
64 what the former wizard option offers, but a button "Advanced"
65 takes you to a screen with roughly the same options as the
66 former "perltk" interface.
67 The default GUI requires Tcl/Tk. This is standard on Macs (although
69 it is considered deprecated since Catalina) and is often already
70 installed on GNU/Linux, or can be easily installed through a distro
71 package manager. For Windows, TeX Live provides a Tcl/Tk runtime.
72 -no-gui
74 Use the text mode installer (default except on Windows and Macs).
75 -lang llcode
77 By default, the Tcl GUI uses the language detection built into
78 Tcl/Tk. If that fails you can select a different language by giving
79 this option with a language code (based on ISO 639-1). Currently
80 supported (but not necessarily completely translated) are: English
81 (en, default), Czech (cs), German (de), French (fr), Italian (it),
82 Japanese (ja), Dutch (nl), Polish (pl), Brazilian Portuguese
83 (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl), Serbian (sr),
84 Ukrainian (uk), Vietnamese (vi), simplified Chinese (zh_CN), and
85 traditional Chinese (zh_TW).
86 -repository url|path
88 Specify the package repository to be used as the source of the
89 installation. In short, this can be a directory name or a url using
90 http(s), ftp, or scp. The documentation for "tlmgr" has the details
91 (<https://tug.org/texlive/doc/tlmgr.html#OPTIONS>).
92 For installation, the default is to pick a mirror automatically,
94 using <https://mirror.ctan.org/systems/texlive/tlnet>; the chosen
95 mirror is used for the entire download. You can use the special
96 argument "ctan" as an abbreviation for this. (See
97 <https://ctan.org> for more about CTAN and its mirrors.)
98 After installation is complete, you can use that installation as
100 the repository for another installation. If you chose to install
101 less than the full scheme containing all packages, the list of
102 available schemes will be adjusted accordingly.
103 -select-repository
105 This option allows you to choose a particular mirror from the
106 current list of active CTAN mirrors. This option is supported in
107 the "text" and "gui" installer modes, and will also offer to
108 install from local media if available, or from a repository
109 specified on the command line. It's useful when the (default)
110 automatic redirection does not choose a good host for you.
111 -all-options
113 Normally options not relevant to the current platform are not shown
114 (e.g., when running on Unix, Windows-specific options are omitted).
115 Giving this command line option allows configuring such "foreign"
116 settings.
117 -custom-bin path
119 If you have built your own set of TeX Live binaries (perhaps
120 because your platform was not supported by TeX Live out of the
121 box), this option allows you to specify the path to a directory
122 where the binaries for the current system are present. The
123 installation will continue as usual, but at the end all files from
124 path are copied over to "bin/custom/" under your installation
125 directory and this "bin/custom/" directory is what will be added to
126 the path for the post-install actions. To install multiple custom
127 binary sets, manually rename "custom" before doing each.
128 For more information on custom binaries, see
130 <https://tug.org/texlive/custom-bin.html>. For general information
131 on building TeX Live, see <https://tug.org/texlive/build.html>.
132 -debug-translation
134 In the former Perl/Tk GUI modes, this option reported any missing,
135 or more likely untranslated, messages to standard error. Not yet
136 implemented for the Tcl interface. Helpful for translators to see
137 what remains to be done.
138 -force-platform platform
140 Instead of auto-detecting the current platform, use platform.
141 Binaries for this platform must be present and they must actually
142 be runnable, or installation will fail. "-force-arch" is a
143 synonym.
144 -help, --help, -?
146 Display this help and exit. (This help is also on the web at
147 <https://tug.org/texlive/doc/install-tl.html>). Sometimes the
148 "perldoc" and/or "PAGER" programs on the system have problems,
149 possibly resulting in control characters being literally output.
150 This can't always be detected, but you can set the "NOPERLDOC"
151 environment variable and "perldoc" will not be used.
152 -in-place
154 This is a quick-and-dirty installation option in case you already
155 have an rsync or svn checkout of TeX Live. It will use the
156 checkout as-is and will just do the necessary post-install. Be
157 warned that the file "tlpkg/texlive.tlpdb" may be rewritten, that
158 removal has to be done manually, and that the only realistic way to
159 maintain this installation is to redo it from time to time. This
160 option is not available via the installer interfaces. USE AT YOUR
161 OWN RISK.
162 -init-from-profile profile_file
164 Similar to -profile (see "PROFILES" below), but only initializes
165 the installation configuration from profile_file and then starts a
166 normal interactive session. Environment variables are not ignored.
167 -logfile file
169 Write both all messages (informational, debugging, warnings) to
170 file, in addition to standard output or standard error.
171 If this option is not given, the installer will create a log file
173 in the root of the writable installation tree, for example,
174 "/usr/local/texlive/YYYY/install-tl.log" for the YYYY release.
175 -no-cls
177 For the text mode installer only: do not clear the screen when
178 entering a new menu (for debugging purposes).
179 -no-persistent-downloads
181 -persistent-downloads
182 For network installs, activating this option makes the installer
183 try to set up a persistent connection using the "Net::LWP" Perl
184 module. This opens only one connection between your computer and
185 the server per session and reuses it, instead of initiating a new
186 download for each package, which typically yields a significant
187 speed-up.
188 This option is turned on by default, and the installation program
190 will fall back to using "wget" if this is not possible. To disable
191 usage of LWP and persistent connections, use
192 "-no-persistent-downloads".
193 -no-verify-downloads
195 By default, if a GnuPG "gpg" binary is found in PATH, downloads are
196 verified against a cryptographic signature. This option disables
197 such verification. The full description is in the Crytographic
198 Verification section of the "tlmgr" documentation, e.g.,
199 <https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
200 -non-admin
202 For Windows only: configure for the current user, not for all
203 users.
204 -portable
206 Install for portable use, e.g., on a USB stick. Also selectable
207 from within the perltk and text installers.
208 -print-platform
210 Print the TeX Live identifier for the detected platform
211 (hardware/operating system) combination to standard output, and
212 exit. "-print-arch" is a synonym.
213 -profile profile_file
215 Load profile_file and do the installation with no user interaction,
216 that is, a batch (unattended) install. Environment variables are
217 ignored. See "PROFILES" below.
218 -q Omit normal informational messages.
220 -scheme scheme
222 Schemes are the highest level of package grouping in TeX Live; the
223 default is to use the "full" scheme, which includes everything.
224 This option overrides that default. You can change the scheme
225 again before the actual installation with the usual menu. The
226 scheme argument may optionally have a prefix "scheme-". The list
227 of supported scheme names depends on what your package repository
228 provides; see the interactive menu list.
229 -v Include verbose debugging messages; repeat for maximum debugging:
231 "-v -v". (Further repeats are accepted but ignored.)
232 -version, --version
234 Output version information and exit. If "-v" is also given, the
235 versions of the TeX Live modules used are also reported.
236
238 A profile file contains all the values needed to perform an
239 installation. After a normal installation has finished, a profile for
240 that exact installation is written to the file "tlpkg/texlive.profile".
241 In addition, from the text menu one can select "P" to save the current
242 setup as a profile at any time.
243 Such a profile file can be given as the argument to "-profile", for
245 example to redo the exact same installation on a different system.
246 Alternatively, you can use a custom profile, most easily created by
247 starting from a generated one and changing values, or an empty file,
248 which will take all the defaults.
249 As mentioned above, the installer only supports selection by scheme and
251 collections, not individual packages, so packages cannot be specified
252 in profile files either. Use "tlmgr" to work at the package level.
253 Within a profile file, each line consists of
255 variable [value]
257 except for comment lines starting with "#". The possible variable
259 names are listed below. Values, when present, are either 0 or 1 for
260 booleans, or strings (which must be specified without any quote
261 characters). Leading whitespace is ignored.
262 If the variable "selected_scheme" is defined and no collection
264 variables at all are defined, then the collections required by the
265 specified scheme (which might change over time) are installed, without
266 explicitly listing them. This eases maintenance of profile files. If
267 any collections are specified in a profile, though, then all desired
268 collections must be given explicitly.
269 For example, a line
271 selected_scheme scheme-small
273 along with definitions for the installation directories (given below
275 under "path options") suffices to install the "small" scheme with all
276 default options. The schemes are described in the "S" menu in the text
277 installer, or equivalent.
278 Besides "selected_scheme", here is the list of variable names supported
280 in a profile:
281 collection options (prefix "collection-")
283 Collections are specified with a variable name with the prefix
285 "collection-" followed by a collection name; there is no value. For
286 instance, "collection-basic". The collections are described in the "C"
287 menu.
288 Schemes and collections (and packages) are ultimately defined by the
290 files in the "tlpkg/tlpsrc/" source directory.
291 path options
293 It is best to define all of these, even though they may not be used in
295 the installation, so as to avoid unintentionally getting a default
296 value that could cause problems later.
297 TEXDIR
299 TEXMFCONFIG
300 TEXMFVAR
301 TEXMFHOME
302 TEXMFLOCAL
303 TEXMFSYSCONFIG
304 TEXMFSYSVAR
305 installer options (prefix "instopt_")
307 "instopt_adjustpath" (default 0 on Unix, 1 on Windows)
309 Adjust "PATH" environment variable.
310 "instopt_adjustrepo" (default 1)
312 Set remote repository to a multiplexed CTAN mirror after
313 installation; see "-repository" above.
314 "instopt_letter" (default 0)
316 Set letter size paper as the default, instead of a4.
317 "instopt_portable" (default 0)
319 Install for portable use, e.g., on a USB stick.
320 "instopt_write18_restricted" (default 1)
322 Enable "\write18" for a restricted set of programs.
323 tlpdb options (prefix "tlpdbopt_")
325 The definitive list is given in "tlpkg/TeXLive/TLConfig.pm", in the
327 hash %TeXLive::TLConfig::TLPDBOptions, together with explanations. All
328 items given there except for "tlpdbopt_location" can be specified.
329 Here is the current list:
330 tlpdbopt_autobackup
332 tlpdbopt_backupdir
333 tlpdbopt_create_formats
334 tlpdbopt_desktop_integration
335 tlpdbopt_file_assocs
336 tlpdbopt_generate_updmap
337 tlpdbopt_install_docfiles
338 tlpdbopt_install_srcfiles
339 tlpdbopt_post_code
340 tlpdbopt_sys_bin
341 tlpdbopt_sys_info
342 tlpdbopt_sys_man
343 tlpdbopt_w32_multi_user
344 platform options (prefix "binary_")
346 For each supported platform in TeX Live (directories under "bin/"), the
348 variable "binary_"PLATFORM can be set with value 1. For example:
349 binary_x86_64-linux 1
351 If no "binary_" settings are made, the default is whatever the current
353 machine is running.
354 In releases before 2017, many profile variables had different names
356 (not documented here; see the "install-tl" source). They are accepted
357 and transformed to the names given above. When a profile is written,
358 the names above are always used.
359 For more details on all of the above options, consult the TeX Live
361 installation manual, linked from <https://tug.org/texlive/doc>.
362
364 For ease in scripting and debugging, "install-tl" looks for the
365 following environment variables. They are not of interest for normal
366 user installations.
367 "TEXLIVE_DOWNLOADER"
369 "TL_DOWNLOAD_PROGRAM"
370 "TL_DOWNLOAD_ARGS"
371 These override the normal choice of a download program; see the
372 "tlmgr" documentation, e.g.,
373 <https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>.
374 "TEXLIVE_INSTALL_ENV_NOCHECK"
376 Omit the check for environment variables containing the string
377 "tex". People developing TeX-related software are likely to have
378 many such variables.
379 "TEXLIVE_INSTALL_NO_CONTEXT_CACHE"
381 Omit creating the ConTeXt cache. This is useful for
382 redistributors.
383 "TEXLIVE_INSTALL_NO_RESUME"
385 Omit check for installing on top of a previous installation and
386 then asking about importing previous settings.
387 "TEXLIVE_INSTALL_NO_WELCOME"
389 Omit printing the welcome message after successful installation,
390 e.g., when testing.
391 "TEXLIVE_INSTALL_PAPER"
393 Set the default paper size for all relevant programs; must be
394 either "letter" or "a4". The default is "a4".
395 "TEXLIVE_INSTALL_PREFIX"
397 "TEXLIVE_INSTALL_TEXDIR"
398 "TEXLIVE_INSTALL_TEXMFCONFIG"
399 "TEXLIVE_INSTALL_TEXMFVAR"
400 "TEXLIVE_INSTALL_TEXMFHOME"
401 "TEXLIVE_INSTALL_TEXMFLOCAL"
402 "TEXLIVE_INSTALL_TEXMFSYSCONFIG"
403 "TEXLIVE_INSTALL_TEXMFSYSVAR"
404 Specify the respective directories. "TEXLIVE_INSTALL_PREFIX"
405 defaults to "/usr/local/texlive", while "TEXLIVE_INSTALL_TEXDIR"
406 defaults to the release directory within that prefix, e.g.,
407 "/usr/local/texlive/2016". All the defaults can be seen by running
408 the installer interactively and then typing "D" for the directory
409 menu.
410 "NOPERLDOC"
412 Don't try to run the "--help" message through "perldoc".
413
415 This script and its documentation were written for the TeX Live
416 distribution (<https://tug.org/texlive>) and both are licensed under
417 the GNU General Public License Version 2 or later.
418 $Id: install-tl 58931 2021-04-20 22:20:56Z karl $
420perl v5.32.1 2021-04-20 INSTALL-TL(1)