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 <http://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 (<http://tug.org/texlive/tlmgr.html>).
39 The most up-to-date version of this installer documentation is on the
41 Internet at <http://tug.org/texlive/doc/install-tl.html>.
42 For the full documentation of TeX Live, see
44 <http://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 "perltk" (see below) GUI
53 installer.
54 If module is given loads the given installer module. Currently the
56 following modules are supported:
57 "text"
59 The text mode user interface (default on Unix systems). Same
60 as the "-no-gui" option.
61 "wizard"
63 The wizard mode user interface (default on Windows), asking
64 only minimal questions before installing all of TeX Live.
65 "perltk"
67 The expert GUI installer, providing access to more options.
68 Can also be invoked on Windows by running
69 "install-tl-advanced.bat".
70 The "perltk" and "wizard" modules, and thus also when calling with
72 bare "-gui" (with no module), require the Perl/Tk module
73 (<http://tug.org/texlive/distro.html#perltk>); if Perl/Tk is not
74 available, installation continues in text mode.
75 -no-gui
77 Use the text mode installer (default except on Windows).
78 -lang llcode
80 By default, the GUI tries to deduce your language from the
81 environment (on Windows via the registry, on Unix via
82 "LC_MESSAGES"). If that fails you can select a different language
83 by giving this option with a language code (based on ISO 639-1).
84 Currently supported (but not necessarily completely translated)
85 are: English (en, default), Czech (cs), German (de), French (fr),
86 Italian (it), Japanese (ja), Dutch (nl), Polish (pl), Brazilian
87 Portuguese (pt_BR), Russian (ru), Slovak (sk), Slovenian (sl),
88 Serbian (sr), Ukrainian (uk), Vietnamese (vi), simplified Chinese
89 (zh_CN), and traditional Chinese (zh_TW).
90 -repository url|path
92 Specify the package repository to be used as the source of the
93 installation. In short, this can be a directory name or a url using
94 http(s), ftp, or scp. The documentation for "tlmgr" has the details
95 (<http://tug.org/texlive/doc/tlmgr.html#OPTIONS>).
96 For installation, the default is to pick a mirror automatically,
98 using <http://mirror.ctan.org/systems/texlive/tlnet>; the chosen
99 mirror is used for the entire download. You can use the special
100 argument "ctan" as an abbreviation for this. (See <http://ctan.org>
101 for more about CTAN and its mirrors.)
102 After installation is complete, you can use that installation as
104 the repository for another installation. If you chose to install
105 less than the full scheme containing all packages, the list of
106 available schemes will be adjusted accordingly.
107 -select-repository
109 This option allows you to choose a particular mirror from the
110 current list of active CTAN mirrors. This option is supported in
111 all installer modes (text, wizard, perltk), and will also offer to
112 install from local media if available, or from a repository
113 specified on the command line. It's useful when the (default)
114 automatic redirection does not choose a good host for you.
115 -all-options
117 Normally options not relevant to the current platform are not shown
118 (e.g., when running on Unix, Windows-specific options are omitted).
119 Giving this command line option allows configuring such "foreign"
120 settings.
121 -custom-bin path
123 If you have built your own set of TeX Live binaries (perhaps
124 because your platform was not supported by TeX Live out of the
125 box), this option allows you to specify the path to a directory
126 where the binaries for the current system are present. The
127 installation will continue as usual, but at the end all files from
128 path are copied over to "bin/custom/" under your installation
129 directory and this "bin/custom/" directory is what will be added to
130 the path for the post-install actions. To install multiple custom
131 binary sets, manully rename "custom" before doing each.
132 For more information on custom binaries, see
134 <http://tug.org/texlive/custom-bin.html>. For general information
135 on building TeX Live, see <http://tug.org/texlive/build.html>.
136 -debug-translation
138 In GUI mode, this options reports any missing, or more likely
139 untranslated, messages to standard error. Helpful for translators
140 to see what remains to be done.
141 -force-platform platform
143 Instead of auto-detecting the current platform, use platform.
144 Binaries for this platform must be present and they must actually
145 be runnable, or installation will fail. "-force-arch" is a
146 synonym.
147 -help, --help, -?
149 Display this help and exit. (This help is also on the web at
150 <http://tug.org/texlive/doc/install-tl.html>). Sometimes the
151 "perldoc" and/or "PAGER" programs on the system have problems,
152 possibly resulting in control characters being literally output.
153 This can't always be detected, but you can set the "NOPERLDOC"
154 environment variable and "perldoc" will not be used.
155 -in-place
157 This is a quick-and-dirty installation option in case you already
158 have an rsync or svn checkout of TeX Live. It will use the
159 checkout as-is and will just do the necessary post-install. Be
160 warned that the file "tlpkg/texlive.tlpdb" may be rewritten, that
161 removal has to be done manually, and that the only realistic way to
162 maintain this installation is to redo it from time to time. This
163 option is not available via the installer interfaces. USE AT YOUR
164 OWN RISK.
165 -init-from-profile profile_file
167 Similar to -profile (see "PROFILES" below), but only initializes
168 the installation configuration from profile_file and then starts
169 the interactive session.
170 -logfile file
172 Write both all messages (informational, debugging, warnings) to
173 file, in addition to standard output or standard error.
174 If this option is not given, the installer will create a log file
176 in the root of the writable installation tree, for example,
177 "/usr/local/texlive/YYYY/install-tl.log" for the YYYY release.
178 -no-cls
180 For the text mode installer only: do not clear the screen when
181 entering a new menu (for debugging purposes).
182 -no-persistent-downloads
184 -persistent-downloads
185 For network installs, activating this option makes the installer
186 try to set up a persistent connection using the "Net::LWP" Perl
187 module. This opens only one connection between your computer and
188 the server per session and reuses it, instead of initiating a new
189 download for each package, which typically yields a significant
190 speed-up.
191 This option is turned on by default, and the installation program
193 will fall back to using "wget" if this is not possible. To disable
194 usage of LWP and persistent connections, use
195 "-no-persistent-downloads".
196 -no-verify-downloads
198 By default, if a GnuPG "gpg" binary is found in PATH, downloads are
199 verified against a cryptographic signature. This option disables
200 such verification. The full description is in the Crytographic
201 Verification section of the "tlmgr" documentation, e.g.,
202 <http://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
203 -non-admin
205 For Windows only: configure for the current user, not for all
206 users.
207 -portable
209 Install for portable use, e.g., on a USB stick. Also selectable
210 from within the perltk and text installers.
211 -print-platform
213 Print the TeX Live identifier for the detected platform
214 (hardware/operating system) combination to standard output, and
215 exit. "-print-arch" is a synonym.
216 -profile profile_file
218 Load profile_file and do the installation with no user interaction,
219 that is, a batch (unattended) install. See "PROFILES" below.
220 -q Omit normal informational messages.
222 -scheme scheme
224 Schemes are the highest level of package grouping in TeX Live; the
225 default is to use the "full" scheme, which includes everything.
226 This option overrides that default. You can change the scheme
227 again before the actual installation with the usual menu. The
228 scheme argument may optionally have a prefix "scheme-". The list
229 of supported scheme names depends on what your package repository
230 provides; see the interactive menu list.
231 -v Include verbose debugging messages; repeat for maximum debugging:
233 "-v -v". (Further repeats are accepted but ignored.)
234 -version, --version
236 Output version information and exit. If "-v" is also given, the
237 versions of the TeX Live modules used are also reported.
238
240 A profile file contains all the values needed to perform an
241 installation. After a normal installation has finished, a profile for
242 that exact installation is written to the file "tlpkg/texlive.profile".
243 In addition, from the text menu one can select "P" to save the current
244 setup as a profile at any time. Such a profile file can be given as
245 the argument to "-profile", for example to redo the exact same
246 installation on a different system. Alternatively, you can use a
247 custom profile, most easily created by starting from a generated one
248 and changing values, or an empty file, which will take all the
249 defaults.
250 Within a profile file, each line consists of
252 variable [value]
254 except for comment lines starting with "#". The possible variable
256 names are listed below. Values, when present, are either 0 or 1 for
257 booleans, or strings (which must be specified without any quote
258 characters). Leading whitespace is ignored.
259 If the variable "selected_scheme" is defined and no collection
261 variables at all are defined, then the collections required by the
262 specified scheme (which might change over time) are installed, without
263 explicitly listing them. This eases maintenance of profile files. If
264 any collections are specified in a profile, though, then all desired
265 collections must be given explicitly.
266 For example, a line
268 selected_scheme scheme-small
270 along with definitions for the installation directories (given below
272 under "path options") suffices to install the "small" scheme with all
273 default options. The schemes are described in the "S" menu in the text
274 installer, or equivalent.
275 Besides "selected_scheme", here is the list of variable names supported
277 in a profile:
278 collection options (prefix "collection-")
280 Collections are specified with a variable name with the prefix
282 "collection-" followed by a collection name; there is no value. For
283 instance, "collection-basic". The collections are described in the "C"
284 menu.
285 Schemes and collections (and packages) are ultimately defined by the
287 files in the "tlpkg/tlpsrc/" source directory.
288 path options
290 It is best to define all of these, even though they may not be used in
292 the installation, so as to avoid unintentionally getting a default
293 value that could cause problems later.
294 TEXDIR
296 TEXMFCONFIG
297 TEXMFVAR
298 TEXMFHOME
299 TEXMFLOCAL
300 TEXMFSYSCONFIG
301 TEXMFSYSVAR
302 installer options (prefix "instopt_")
304 "instopt_adjustpath" (default 0 on Unix, 1 on Windows)
306 Adjust "PATH" environment variable.
307 "instopt_adjustrepo" (default 1)
309 Set remote repository to a multiplexed CTAN mirror after
310 installation; see "-repository" above.
311 "instopt_letter" (default 0)
313 Set letter size paper as the default, instead of a4.
314 "instopt_portable" (default 0)
316 Install for portable use, e.g., on a USB stick.
317 "instopt_write18_restricted" (default 1)
319 Enable "\write18" for a restricted set of programs.
320 tlpdb options (prefix "tlpdbopt_")
322 The definitive list is given in "tlpkg/TeXLive/TLConfig.pm", in
324 %TeXLive::TLConfig::TLPDBOptions, together with explanations. All
325 items given there except for "tlpdbopt_location" can be specified.
326 Here is the current list:
327 tlpdbopt_autobackup
329 tlpdbopt_backupdir
330 tlpdbopt_create_formats
331 tlpdbopt_desktop_integration
332 tlpdbopt_file_assocs
333 tlpdbopt_generate_updmap
334 tlpdbopt_install_docfiles
335 tlpdbopt_install_srcfiles
336 tlpdbopt_post_code
337 tlpdbopt_sys_bin
338 tlpdbopt_sys_info
339 tlpdbopt_sys_man
340 tlpdbopt_w32_multi_user
341 platform options (prefix "binary_")
343 For each supported platform in TeX Live (directories under "bin/"), the
345 variable "binary_"PLATFORM can be set. For example:
346 binary_x86_64-linux
348 If no "binary_" variable is specified, the default is whatever the
350 current machine is running.
351 In releases before 2017, many profile variables had different names
353 (not documented here; see the "install-tl" source). They are accepted
354 and transformed to the names given above. When a profile is written,
355 the names above are always used.
356 For more details on all of the above options, consult the TeX Live
358 installation manual, linked from <http://tug.org/texlive/doc>.
359
361 For ease in scripting and debugging, "install-tl" looks for the
362 following environment variables. They are not of interest for normal
363 user installations.
364 "TEXLIVE_DOWNLOADER"
366 "TL_DOWNLOAD_PROGRAM"
367 "TL_DOWNLOAD_ARGS"
368 These override the normal choice of a download program; see the
369 "tlmgr" documentation, e.g.,
370 <http://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>.
371 "TEXLIVE_INSTALL_ENV_NOCHECK"
373 Omit the check for environment variables containing the string
374 "tex". People developing TeX-related software are likely to have
375 many such variables.
376 "TEXLIVE_INSTALL_NO_CONTEXT_CACHE"
378 Omit creating the ConTeXt cache. This is useful for
379 redistributors.
380 "TEXLIVE_INSTALL_NO_WELCOME"
382 Omit printing the welcome message after successful installation,
383 e.g., when testing.
384 "TEXLIVE_INSTALL_PREFIX"
386 "TEXLIVE_INSTALL_TEXDIR"
387 "TEXLIVE_INSTALL_TEXMFCONFIG"
388 "TEXLIVE_INSTALL_TEXMFVAR"
389 "TEXLIVE_INSTALL_TEXMFHOME"
390 "TEXLIVE_INSTALL_TEXMFLOCAL"
391 "TEXLIVE_INSTALL_TEXMFSYSCONFIG"
392 "TEXLIVE_INSTALL_TEXMFSYSVAR"
393 Specify the respective directories. "TEXLIVE_INSTALL_PREFIX"
394 defaults to "/usr/local/texlive", while "TEXLIVE_INSTALL_TEXDIR"
395 defaults to the release directory within that prefix, e.g.,
396 "/usr/local/texlive/2016". All the defaults can be seen by running
397 the installer interactively and then typing "D" for the directory
398 menu.
399 "NOPERLDOC"
401 Don't try to run the "--help" message through "perldoc".
402
404 This script and its documentation were written for the TeX Live
405 distribution (<http://tug.org/texlive>) and both are licensed under the
406 GNU General Public License Version 2 or later.
407 $Id: install-tl 47947 2018-06-06 23:58:12Z preining $
409perl v5.26.2 2018-06-06 INSTALL-TL(1)