1INSTALL-TL(1)         User Contributed Perl Documentation        INSTALL-TL(1)
2
3
4

NAME

6       install-tl - TeX Live cross-platform installer
7

SYNOPSIS

9       install-tl [option]...
10
11       install-tl-windows.bat [option]...
12
13       install-tl-advanced.bat [option]...
14

DESCRIPTION

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
22       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
27       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
32       The default is "scheme-full", which installs everything, and this is
33       highly recommended.
34

REFERENCES

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
40       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
43       For the full documentation of TeX Live, see
44       <https://tug.org/texlive/doc>.
45

OPTIONS

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
51       -gui [[=]module]
52           If no module is given, starts the Tcl/Tk (see below) GUI installer.
53
54           If module is given loads the given installer module. Currently the
55           following modules are supported:
56
57           "text"
58               The text mode user interface (default on Unix systems).  Same
59               as the "-no-gui" option.
60
61           "tcl"
62               The Tcl/Tk user interface (default on Macs and Windows).  It
63               starts with a small number of configuration options, roughly
64               equivalent to what the wizard option below offers, but a button
65               "Advanced" takes you to a screen with roughly the same options
66               as the "perltk" interface.
67
68           "wizard"
69               The wizard mode user interface, asking only minimal questions
70               before installing all of TeX Live.
71
72           "expert"
73               A generic name for, currently, "perltk"; it may select a
74               different GUI in the future.
75
76           "perltk"
77               The expert GUI installer, providing access to more options.
78
79           The "perltk" and "wizard" modules require the Perl/Tk module
80           (<https://tug.org/texlive/distro.html#perltk>). if Perl/Tk is not
81           available, installation continues in text mode, except on Windows,
82           where all gui options except "text" are diverted to the default
83           "tcl" GUI.
84
85           The "tcl" GUI requires Tcl/Tk. This is standard on Macs and is
86           often already installed on GNU/Linux. For Windows, TeX Live
87           provides a Tcl/Tk runtime.
88
89       -no-gui
90           Use the text mode installer (default except on Windows and Macs).
91
92       -lang llcode
93           By default, the GUI tries to deduce your language from the
94           environment. The Tcl GUI uses the language detection built into
95           Tcl/Tk; the Perl/Tk GUIs use the "LC_MESSAGES" environment
96           variable. If that fails you can select a different language by
97           giving this option with a language code (based on ISO 639-1).
98           Currently supported (but not necessarily completely translated)
99           are: English (en, default), Czech (cs), German (de), French (fr),
100           Italian (it), Japanese (ja), Dutch (nl), Polish (pl), Brazilian
101           Portuguese (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl),
102           Serbian (sr), Ukrainian (uk), Vietnamese (vi), simplified Chinese
103           (zh_CN), and traditional Chinese (zh_TW).
104
105       -repository url|path
106           Specify the package repository to be used as the source of the
107           installation. In short, this can be a directory name or a url using
108           http(s), ftp, or scp. The documentation for "tlmgr" has the details
109           (<https://tug.org/texlive/doc/tlmgr.html#OPTIONS>).
110
111           For installation, the default is to pick a mirror automatically,
112           using <http://mirror.ctan.org/systems/texlive/tlnet>; the chosen
113           mirror is used for the entire download. You can use the special
114           argument "ctan" as an abbreviation for this. (See
115           <https://ctan.org> for more about CTAN and its mirrors.)
116
117           After installation is complete, you can use that installation as
118           the repository for another installation.  If you chose to install
119           less than the full scheme containing all packages, the list of
120           available schemes will be adjusted accordingly.
121
122       -select-repository
123           This option allows you to choose a particular mirror from the
124           current list of active CTAN mirrors. This option is supported in
125           the "text", "wizard" and "perltk" installer modes, and will also
126           offer to install from local media if available, or from a
127           repository specified on the command line. It's useful when the
128           (default) automatic redirection does not choose a good host for
129           you.
130
131       -all-options
132           Normally options not relevant to the current platform are not shown
133           (e.g., when running on Unix, Windows-specific options are omitted).
134           Giving this command line option allows configuring such "foreign"
135           settings.
136
137       -custom-bin path
138           If you have built your own set of TeX Live binaries (perhaps
139           because your platform was not supported by TeX Live out of the
140           box), this option allows you to specify the path to a directory
141           where the binaries for the current system are present.  The
142           installation will continue as usual, but at the end all files from
143           path are copied over to "bin/custom/" under your installation
144           directory and this "bin/custom/" directory is what will be added to
145           the path for the post-install actions.  To install multiple custom
146           binary sets, manually rename "custom" before doing each.
147
148           For more information on custom binaries, see
149           <https://tug.org/texlive/custom-bin.html>.  For general information
150           on building TeX Live, see <https://tug.org/texlive/build.html>.
151
152       -debug-translation
153           In the Perl/Tk GUI modes, this option reports any missing, or more
154           likely untranslated, messages to standard error. Helpful for
155           translators to see what remains to be done.
156
157       -force-platform platform
158           Instead of auto-detecting the current platform, use platform.
159           Binaries for this platform must be present and they must actually
160           be runnable, or installation will fail.  "-force-arch" is a
161           synonym.
162
163       -help, --help, -?
164           Display this help and exit. (This help is also on the web at
165           <https://tug.org/texlive/doc/install-tl.html>). Sometimes the
166           "perldoc" and/or "PAGER" programs on the system have problems,
167           possibly resulting in control characters being literally output.
168           This can't always be detected, but you can set the "NOPERLDOC"
169           environment variable and "perldoc" will not be used.
170
171       -in-place
172           This is a quick-and-dirty installation option in case you already
173           have an rsync or svn checkout of TeX Live.  It will use the
174           checkout as-is and will just do the necessary post-install.  Be
175           warned that the file "tlpkg/texlive.tlpdb" may be rewritten, that
176           removal has to be done manually, and that the only realistic way to
177           maintain this installation is to redo it from time to time.  This
178           option is not available via the installer interfaces.  USE AT YOUR
179           OWN RISK.
180
181       -init-from-profile profile_file
182           Similar to -profile (see "PROFILES" below), but only initializes
183           the installation configuration from profile_file and then starts a
184           normal interactive session. Environment variables are not ignored.
185
186       -logfile file
187           Write both all messages (informational, debugging, warnings) to
188           file, in addition to standard output or standard error.
189
190           If this option is not given, the installer will create a log file
191           in the root of the writable installation tree, for example,
192           "/usr/local/texlive/YYYY/install-tl.log" for the YYYY release.
193
194       -no-cls
195           For the text mode installer only: do not clear the screen when
196           entering a new menu (for debugging purposes).
197
198       -no-persistent-downloads
199       -persistent-downloads
200           For network installs, activating this option makes the installer
201           try to set up a persistent connection using the "Net::LWP" Perl
202           module.  This opens only one connection between your computer and
203           the server per session and reuses it, instead of initiating a new
204           download for each package, which typically yields a significant
205           speed-up.
206
207           This option is turned on by default, and the installation program
208           will fall back to using "wget" if this is not possible.  To disable
209           usage of LWP and persistent connections, use
210           "-no-persistent-downloads".
211
212       -no-verify-downloads
213           By default, if a GnuPG "gpg" binary is found in PATH, downloads are
214           verified against a cryptographic signature. This option disables
215           such verification.  The full description is in the Crytographic
216           Verification section of the "tlmgr" documentation, e.g.,
217           <https://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
218
219       -non-admin
220           For Windows only: configure for the current user, not for all
221           users.
222
223       -portable
224           Install for portable use, e.g., on a USB stick.  Also selectable
225           from within the perltk and text installers.
226
227       -print-platform
228           Print the TeX Live identifier for the detected platform
229           (hardware/operating system) combination to standard output, and
230           exit.  "-print-arch" is a synonym.
231
232       -profile profile_file
233           Load profile_file and do the installation with no user interaction,
234           that is, a batch (unattended) install.  Environment variables are
235           ignored. See "PROFILES" below.
236
237       -q  Omit normal informational messages.
238
239       -scheme scheme
240           Schemes are the highest level of package grouping in TeX Live; the
241           default is to use the "full" scheme, which includes everything.
242           This option overrides that default.  You can change the scheme
243           again before the actual installation with the usual menu.  The
244           scheme argument may optionally have a prefix "scheme-".  The list
245           of supported scheme names depends on what your package repository
246           provides; see the interactive menu list.
247
248       -v  Include verbose debugging messages; repeat for maximum debugging:
249           "-v -v".  (Further repeats are accepted but ignored.)
250
251       -version, --version
252           Output version information and exit.  If "-v" is also given, the
253           versions of the TeX Live modules used are also reported.
254

PROFILES

256       A profile file contains all the values needed to perform an
257       installation.  After a normal installation has finished, a profile for
258       that exact installation is written to the file "tlpkg/texlive.profile".
259       In addition, from the text menu one can select "P" to save the current
260       setup as a profile at any time.
261
262       Such a profile file can be given as the argument to "-profile", for
263       example to redo the exact same installation on a different system.
264       Alternatively, you can use a custom profile, most easily created by
265       starting from a generated one and changing values, or an empty file,
266       which will take all the defaults.
267
268       As mentioned above, the installer only supports selection by scheme and
269       collections, not individual packages, so packages cannot be specified
270       in profile files either. Use "tlmgr" to work at the package level.
271
272       Within a profile file, each line consists of
273
274       variable [value]
275
276       except for comment lines starting with "#".  The possible variable
277       names are listed below.  Values, when present, are either 0 or 1 for
278       booleans, or strings (which must be specified without any quote
279       characters).  Leading whitespace is ignored.
280
281       If the variable "selected_scheme" is defined and no collection
282       variables at all are defined, then the collections required by the
283       specified scheme (which might change over time) are installed, without
284       explicitly listing them.  This eases maintenance of profile files.  If
285       any collections are specified in a profile, though, then all desired
286       collections must be given explicitly.
287
288       For example, a line
289
290         selected_scheme scheme-small
291
292       along with definitions for the installation directories (given below
293       under "path options") suffices to install the "small" scheme with all
294       default options.  The schemes are described in the "S" menu in the text
295       installer, or equivalent.
296
297       Besides "selected_scheme", here is the list of variable names supported
298       in a profile:
299
300       collection options (prefix "collection-")
301
302       Collections are specified with a variable name with the prefix
303       "collection-" followed by a collection name; there is no value.  For
304       instance, "collection-basic".  The collections are described in the "C"
305       menu.
306
307       Schemes and collections (and packages) are ultimately defined by the
308       files in the "tlpkg/tlpsrc/" source directory.
309
310       path options
311
312       It is best to define all of these, even though they may not be used in
313       the installation, so as to avoid unintentionally getting a default
314       value that could cause problems later.
315
316         TEXDIR
317         TEXMFCONFIG
318         TEXMFVAR
319         TEXMFHOME
320         TEXMFLOCAL
321         TEXMFSYSCONFIG
322         TEXMFSYSVAR
323
324       installer options (prefix "instopt_")
325
326       "instopt_adjustpath" (default 0 on Unix, 1 on Windows)
327           Adjust "PATH" environment variable.
328
329       "instopt_adjustrepo" (default 1)
330           Set remote repository to a multiplexed CTAN mirror after
331           installation; see "-repository" above.
332
333       "instopt_letter" (default 0)
334           Set letter size paper as the default, instead of a4.
335
336       "instopt_portable" (default 0)
337           Install for portable use, e.g., on a USB stick.
338
339       "instopt_write18_restricted" (default 1)
340           Enable "\write18" for a restricted set of programs.
341
342       tlpdb options (prefix "tlpdbopt_")
343
344       The definitive list is given in "tlpkg/TeXLive/TLConfig.pm", in the
345       hash %TeXLive::TLConfig::TLPDBOptions, together with explanations.  All
346       items given there except for "tlpdbopt_location" can be specified.
347       Here is the current list:
348
349         tlpdbopt_autobackup
350         tlpdbopt_backupdir
351         tlpdbopt_create_formats
352         tlpdbopt_desktop_integration
353         tlpdbopt_file_assocs
354         tlpdbopt_generate_updmap
355         tlpdbopt_install_docfiles
356         tlpdbopt_install_srcfiles
357         tlpdbopt_post_code
358         tlpdbopt_sys_bin
359         tlpdbopt_sys_info
360         tlpdbopt_sys_man
361         tlpdbopt_w32_multi_user
362
363       platform options (prefix "binary_")
364
365       For each supported platform in TeX Live (directories under "bin/"), the
366       variable "binary_"PLATFORM can be set with value 1.  For example:
367
368         binary_x86_64-linux 1
369
370       If no "binary_" settings are made, the default is whatever the current
371       machine is running.
372
373       In releases before 2017, many profile variables had different names
374       (not documented here; see the "install-tl" source).  They are accepted
375       and transformed to the names given above.  When a profile is written,
376       the names above are always used.
377
378       For more details on all of the above options, consult the TeX Live
379       installation manual, linked from <https://tug.org/texlive/doc>.
380

ENVIRONMENT VARIABLES

382       For ease in scripting and debugging, "install-tl" looks for the
383       following environment variables. They are not of interest for normal
384       user installations.
385
386       "TEXLIVE_DOWNLOADER"
387       "TL_DOWNLOAD_PROGRAM"
388       "TL_DOWNLOAD_ARGS"
389           These override the normal choice of a download program; see the
390           "tlmgr" documentation, e.g.,
391           <https://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>.
392
393       "TEXLIVE_INSTALL_ENV_NOCHECK"
394           Omit the check for environment variables containing the string
395           "tex".  People developing TeX-related software are likely to have
396           many such variables.
397
398       "TEXLIVE_INSTALL_NO_CONTEXT_CACHE"
399           Omit creating the ConTeXt cache.  This is useful for
400           redistributors.
401
402       "TEXLIVE_INSTALL_NO_RESUME"
403           Omit check for installing on top of a previous installation and
404           then asking about importing previous settings.
405
406       "TEXLIVE_INSTALL_NO_WELCOME"
407           Omit printing the welcome message after successful installation,
408           e.g., when testing.
409
410       "TEXLIVE_INSTALL_PAPER"
411           Set the default paper size for all relevant programs; must be
412           either "letter" or "a4". The default is "a4".
413
414       "TEXLIVE_INSTALL_PREFIX"
415       "TEXLIVE_INSTALL_TEXDIR"
416       "TEXLIVE_INSTALL_TEXMFCONFIG"
417       "TEXLIVE_INSTALL_TEXMFVAR"
418       "TEXLIVE_INSTALL_TEXMFHOME"
419       "TEXLIVE_INSTALL_TEXMFLOCAL"
420       "TEXLIVE_INSTALL_TEXMFSYSCONFIG"
421       "TEXLIVE_INSTALL_TEXMFSYSVAR"
422           Specify the respective directories.  "TEXLIVE_INSTALL_PREFIX"
423           defaults to "/usr/local/texlive", while "TEXLIVE_INSTALL_TEXDIR"
424           defaults to the release directory within that prefix, e.g.,
425           "/usr/local/texlive/2016".  All the defaults can be seen by running
426           the installer interactively and then typing "D" for the directory
427           menu.
428
429       "NOPERLDOC"
430           Don't try to run the "--help" message through "perldoc".
431
433       This script and its documentation were written for the TeX Live
434       distribution (<https://tug.org/texlive>) and both are licensed under
435       the GNU General Public License Version 2 or later.
436
437       $Id: install-tl 55126 2020-05-13 17:27:10Z karl $
438
439
440
441perl v5.30.2                      2020-05-13                     INSTALL-TL(1)
Impressum