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 across all platforms supported by TeX Live. For
19 information on initially downloading the 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 much more, are
37 handled 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, either a local directory via "/path/to/directory" or
94 a "file:/" url, or a network location via a "http://", "https://",
95 or "ftp://" url. (No other protocols are supported, and "https://"
96 may not work on all platforms.)
97 The default is to pick a mirror automatically, using
99 <http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror
100 is used for the entire download. You can use the special argument
101 "ctan" as an abbreviation for this. See <http://ctan.org> for more
102 about CTAN and its mirrors.
103 If the repository is on the network, trailing "/" characters and/or
105 trailing "/tlpkg" and "/archive" components are ignored. For
106 example, you could choose a particular CTAN mirror with something
107 like this:
108 -repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet
110 Of course a real hostname and its particular top-level CTAN
112 directory have to be specified. The list of CTAN mirrors is
113 available at <http://ctan.org/mirrors>.
114 If the repository is local, the installation type (compressed or
116 live) is automatically determined, by checking for the presence of
117 a "archive" directory relative to the root. Compressed is
118 preferred if both are available, since it is faster. Here's an
119 example of using a local directory:
120 -repository /local/TL/repository
122 After installation is complete, you can use that installation as
124 the repository for another installation. If you chose to install
125 less than the full scheme containing all packages, the list of
126 available schemes will be adjusted accordingly.
127 For backward compatibility and convenience, "--location" and
129 "--repo" are accepted as aliases for this option.
130 -select-repository
132 This option allows manual selection of a mirror from the current
133 list of active CTAN mirrors. This option is supported in all
134 installer modes (text, wizard, perltk), and will also offer to
135 install from local media if available, or from a repository
136 specified on the command line (see above). It's useful when the
137 (default) automatic redirection does not choose a good host for
138 you.
139 -all-options
141 Normally options not relevant to the current platform are not shown
142 (e.g., when running on Unix, Windows-specific options are omitted).
143 Giving this command line option allows configuring such "foreign"
144 settings.
145 -custom-bin path
147 If you have built your own set of TeX Live binaries (perhaps
148 because your platform was not supported by TeX Live out of the
149 box), this option allows you to specify the path to a directory
150 where the binaries for the current system are present. The
151 installation will continue as usual, but at the end all files from
152 path are copied over to "bin/custom/" under your installation
153 directory and this "bin/custom/" directory is what will be added to
154 the path for the post-install actions. To install multiple custom
155 binary sets, manully rename "custom" before doing each.
156 For more information on custom binaries, see
158 <http://tug.org/texlive/custom-bin.html>. For general information
159 on building TeX Live, see <http://tug.org/texlive/build.html>.
160 -debug-translation
162 In GUI mode, this switch makes "tlmgr" report any missing, or more
163 likely untranslated, messages to standard error. Helpful for
164 translators to see what remains to be done.
165 -force-platform platform
167 Instead of auto-detecting the current platform, use platform.
168 Binaries for this platform must be present and they must actually
169 be runnable, or installation will fail. "-force-arch" is a
170 synonym.
171 -help, --help, -?
173 Display this help and exit. (This help is on the web at
174 <http://tug.org/texlive/doc/install-tl.html>). Sometimes the
175 "perldoc" and/or "PAGER" programs on the system have problems,
176 possibly resulting in control characters being literally output.
177 This can't always be detected, but you can set the "NOPERLDOC"
178 environment variable and "perldoc" will not be used.
179 -in-place
181 This is a quick-and-dirty installation option in case you already
182 have an rsync or svn checkout of TeX Live. It will use the
183 checkout as-is and will just do the necessary post-install. Be
184 warned that the file "tlpkg/texlive.tlpdb" may be rewritten, that
185 removal has to be done manually, and that the only realistic way to
186 maintain this installation is to redo it from time to time. This
187 option is not available via the installer interfaces. USE AT YOUR
188 OWN RISK.
189 -init-from-profile profile_file
191 Similar to -profile (see "PROFILES" below), but only initializes
192 the installation configuration from profile_file and then starts
193 the interactive session.
194 -logfile file
196 Write both all messages (informational, debugging, warnings) to
197 file, in addition to standard output or standard error.
198 If this option is not given, the installer will create a log file
200 in the root of the writable installation tree, for example,
201 "/usr/local/texlive/YYYY/install-tl.log" for the YYYY release.
202 -no-cls
204 For the text mode installer only: do not clear the screen when
205 entering a new menu (for debugging purposes).
206 -non-admin
208 For Windows only: configure for the current user, not for all
209 users.
210 -persistent-downloads
212 -no-persistent-downloads
213 For network installs, activating this option makes the installer
214 try to set up a persistent connection using the "Net::LWP" Perl
215 module. This opens only one connection between your computer and
216 the server per session and reuses it, instead of initiating a new
217 download for each package, which typically yields a significant
218 speed-up.
219 This option is turned on by default, and the installation program
221 will fall back to using "wget" if this is not possible. To disable
222 usage of LWP and persistent connections, use
223 "-no-persistent-downloads".
224 -no-verify-downloads
226 By default, if a GnuPG "gpg" binary is found in PATH, downloads are
227 verified against a cryptographic signature. This option disables
228 such verification. The full description is in the Crytographic
229 Verification section of the "tlmgr" documentation, e.g.,
230 <http://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
231 -portable
233 Install for portable use, e.g., on a USB stick. Also selectable
234 from within the perltk and text installers.
235 -print-platform
237 Print the TeX Live identifier for the detected platform
238 (hardware/operating system) combination to standard output, and
239 exit. "-print-arch" is a synonym.
240 -profile profile_file
242 Load profile_file and do the installation with no user interaction,
243 that is, a batch (unattended) install. See "PROFILES" below.
244 -q Omit normal informational messages.
246 -scheme scheme
248 Schemes are the highest level of package grouping in TeX Live; the
249 default is to use the "full" scheme, which includes everything.
250 This option overrides that default. You can change the scheme
251 again before the actual installation with the usual menu. The
252 scheme argument may optionally have a prefix "scheme-". The list
253 of supported scheme names depends on what your package repository
254 provides; see the interactive menu list.
255 -v Include verbose debugging messages; repeat for maximum debugging:
257 "-v -v". (Further repeats are accepted but ignored.)
258 -version, --version
260 Output version information and exit. If "-v" has also been given
261 the revisions of the used modules are reported, too.
262
264 A profile file contains all the values needed to perform an
265 installation. After a normal installation has finished, a profile for
266 that exact installation is written to the file "tlpkg/texlive.profile".
267 In addition, from the text menu one can select "P" to save the current
268 setup as a profile at any time. Such a profile file can be given as
269 the argument to "-profile", for example to redo the exact same
270 installation on a different system. Alternatively, you can use a
271 custom profile, most easily created by starting from a generated one
272 and changing values, or an empty file, which will take all the
273 defaults.
274 Within a profile file, each line consists of
276 variable [value]
278 except for comment lines starting with "#". The possible variable
280 names are listed below. Values, when present, are either 0 or 1 for
281 booleans, or strings (which must be specified without any quote
282 characters). Leading whitespace is ignored.
283 If the variable "selected_scheme" is defined and no collection
285 variables at all are defined, then the collections required by the
286 specified scheme (which might change over time) are installed, without
287 explicitly listing them. This eases maintenance of profile files. If
288 any collections are specified in a profile, though, then all desired
289 collections must be given explicitly.
290 For example, a line
292 selected_scheme scheme-small
294 along with definitions for the installation directories (given below
296 under "path options") suffices to install the "small" scheme with all
297 default options. The schemes are described in the "S" menu in the text
298 installer, or equivalent.
299 Besides "selected_scheme", here is the list of variable names supported
301 in a profile:
302 collection options (prefix "collection-")
304 Collections are specified with a variable name with the prefix
306 "collection-" followed by a collection name; there is no value. For
307 instance, "collection-basic". The collections are described in the "C"
308 menu.
309 Schemes and collections (and packages) are ultimately defined by the
311 files in the "tlpkg/tlpsrc/" source directory.
312 path options
314 It is best to define all of these, even though they may not be used in
316 the installation, so as to avoid unintentionally getting a default
317 value that could cause problems later.
318 TEXDIR
320 TEXMFCONFIG
321 TEXMFVAR
322 TEXMFHOME
323 TEXMFLOCAL
324 TEXMFSYSCONFIG
325 TEXMFSYSVAR
326 installer options (prefix "instopt_")
328 "instopt_adjustpath" (default 0 on Unix, 1 on Windows)
330 Adjust "PATH" environment variable.
331 "instopt_adjustrepo" (default 1)
333 Set remote repository to a multiplexed CTAN mirror after
334 installation; see "-repository" above.
335 "instopt_letter" (default 0)
337 Set letter size paper as the default, instead of a4.
338 "instopt_portable" (default 0)
340 Install for portable use, e.g., on a USB stick.
341 "instopt_write18_restricted" (default 1)
343 Enable "\write18" for a restricted set of programs.
344 tlpdb options (prefix "tlpdbopt_")
346 The definitive list is given in "tlpkg/TeXLive/TLConfig.pm", in
348 %TeXLive::TLConfig::TLPDBOptions, together with explanations. All
349 items given there except for "tlpdbopt_location" can be specified.
350 Here is the current list:
351 tlpdbopt_autobackup
353 tlpdbopt_backupdir
354 tlpdbopt_create_formats
355 tlpdbopt_desktop_integration
356 tlpdbopt_file_assocs
357 tlpdbopt_generate_updmap
358 tlpdbopt_install_docfiles
359 tlpdbopt_install_srcfiles
360 tlpdbopt_post_code
361 tlpdbopt_sys_bin
362 tlpdbopt_sys_info
363 tlpdbopt_sys_man
364 tlpdbopt_w32_multi_user
365 platform options (prefix "binary_")
367 For each supported platform in TeX Live (directories under "bin/"), the
369 variable "binary_"PLATFORM can be set. For example:
370 binary_x86_64-linux
372 If no "binary_" variable is specified, the default is whatever the
374 current machine is running.
375 In releases before 2017, many profile variables had different names
377 (not documented here; see the "install-tl" source). They are accepted
378 and transformed to the names given above. When a profile is written,
379 the names above are always used.
380 For more details on all of the above options, consult the TeX Live
382 installation manual, linked from <http://tug.org/texlive/doc>.
383
385 For ease in scripting and debugging, "install-tl" will look for the
386 following environment variables. They are not of interest for normal
387 user installations.
388 "TEXLIVE_INSTALL_ENV_NOCHECK"
390 Omit the check for environment variables containing the string
391 "tex". People developing TeX-related software are likely to have
392 many such variables.
393 "TEXLIVE_INSTALL_NO_CONTEXT_CACHE"
395 Omit creating the ConTeXt cache. This is useful for
396 redistributors.
397 "TEXLIVE_INSTALL_NO_WELCOME"
399 Omit printing the welcome message after successful installation,
400 e.g., for testing.
401 "TEXLIVE_INSTALL_PREFIX"
403 "TEXLIVE_INSTALL_TEXDIR"
404 "TEXLIVE_INSTALL_TEXMFCONFIG"
405 "TEXLIVE_INSTALL_TEXMFVAR"
406 "TEXLIVE_INSTALL_TEXMFHOME"
407 "TEXLIVE_INSTALL_TEXMFLOCAL"
408 "TEXLIVE_INSTALL_TEXMFSYSCONFIG"
409 "TEXLIVE_INSTALL_TEXMFSYSVAR"
410 Specify the respective directories. "TEXLIVE_INSTALL_PREFIX"
411 defaults to "/usr/local/texlive", while "TEXLIVE_INSTALL_TEXDIR"
412 defaults to the release directory within that prefix, e.g.,
413 "/usr/local/texlive/2016". All the defaults can be seen by running
414 the installer interactively and then typing "D" for the directory
415 menu.
416 "NOPERLDOC"
418 Don't try to run the "--help" message through "perldoc".
419
421 This script and its documentation were written for the TeX Live
422 distribution (<http://tug.org/texlive>) and both are licensed under the
423 GNU General Public License Version 2 or later.
424 $Id: install-tl 44201 2017-05-05 15:33:32Z karl $
426perl v5.24.1 2017-05-05 INSTALL-TL(1)