diff options
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/install-tl.1')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/install-tl.1 | 434 |
1 files changed, 434 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1 new file mode 100644 index 00000000000..44cd5a8e78c --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/install-tl.1 @@ -0,0 +1,434 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "INSTALL-TL 1" +.TH INSTALL-TL 1 "2012-10-31" "perl v5.16.2" "User Contributed Perl Documentation" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +install\-tl \- TeX Live cross\-platform installer +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +install-tl [\fIoption\fR]... +.PP +install\-tl.bat [\fIoption\fR]... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +This installer creates a runnable TeX Live installation from various +media, including over the network. The installer works across all +platforms supported by TeX Live. For information on initially +downloading the TeX Live, see <http://tug.org/texlive/acquire.html>. +.PP +The basic idea of TeX Live installation is to choose one of the +top-level \fIschemes\fR, each of which is defined as a different set of +\&\fIcollections\fR and \fIpackages\fR, where a collection is a set of packages, +and a package is what contains actual files. +.PP +Within the installer, you can choose a scheme, and further customize the +set of collections to install, but not the set of the packages. To do +that, use \f(CW\*(C`tlmgr\*(C'\fR (reference below) after the initial installation is +completely. +.PP +The default is \f(CW\*(C`scheme\-full\*(C'\fR, to install everything, and this is highly +recommended. +.SH "REFERENCES" +.IX Header "REFERENCES" +Post-installation configuration, package updates, and much more, are +handled through \fBtlmgr\fR(1), the TeX Live Manager +(<http://tug.org/texlive/tlmgr.html>). +.PP +The most up-to-date version of this documentation is on the Internet at +http://tug.org/texlive/doc/install\-tl.html <http://tug.org/texlive/doc/install-tl.html>. +.PP +For the full documentation of TeX Live, see +<http://tug.org/texlive/doc>. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-gui\fR [[=]\fImodule\fR]" 4 +.IX Item "-gui [[=]module]" +If no \fImodule\fR is given starts the \f(CW\*(C`perltk\*(C'\fR (see below) \s-1GUI\s0 installer. +.Sp +If \fImodule\fR is given loads the given installer module. Currently the +following modules are supported: +.RS 4 +.ie n .IP """text""" 8 +.el .IP "\f(CWtext\fR" 8 +.IX Item "text" +The text mode user interface (default on Unix systems). Same as the +\&\f(CW\*(C`\-no\-gui\*(C'\fR option. +.ie n .IP """wizard""" 8 +.el .IP "\f(CWwizard\fR" 8 +.IX Item "wizard" +The wizard mode user interface (default on Windows), asking only minimal +questions before installing all of TeX Live. +.ie n .IP """perltk""" 8 +.el .IP "\f(CWperltk\fR" 8 +.IX Item "perltk" +The expert \s-1GUI\s0 installer, providing access to more options. +Can also be invoked on Windows by running \f(CW\*(C`install\-tl\-advanced.bat\*(C'\fR. +.RE +.RS 4 +.Sp +The \f(CW\*(C`perltk\*(C'\fR and \f(CW\*(C`wizard\*(C'\fR modules, and thus also when calling with a +bare \f(CW\*(C`\-gui\*(C'\fR (without \fImodule\fR), requires the Perl/Tk module +(<http://tug.org/texlive/distro.html#perltk>); if Perl/Tk is not +available, installation continues in text mode. +.RE +.IP "\fB\-no\-gui\fR" 4 +.IX Item "-no-gui" +Use the text mode installer (default except on Windows). +.IP "\fB\-lang\fR \fIllcode\fR" 4 +.IX Item "-lang llcode" +By default, the \s-1GUI\s0 tries to deduce your language from the environment +(on Windows via the registry, on Unix via \f(CW\*(C`LC_MESSAGES\*(C'\fR). If that fails +you can select a different language by giving this option with a +language code (based on \s-1ISO\s0 639\-1). Currently supported (but not +necessarily completely translated) are: English (en, default), Czech +(cs), German (de), French (fr), Italian (it), Japanese (ja), Dutch (nl), +Polish (pl), Brazilian Portuguese (pt_BR), Russian (ru), Slovak (sk), +Slovenian (sl), Serbian (sr), Vietnamese (vi), simplified Chinese +(zh_CN), and traditional Chinese (zh_TW). +.IP "\fB\-repository\fR \fIurl|path\fR" 4 +.IX Item "-repository url|path" +Specify the package repository to be used as the source of the +installation, either a local directory via \f(CW\*(C`/path/to/directory\*(C'\fR or a +\&\f(CW\*(C`file:/\*(C'\fR url, or a network location via a \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR url. +(No other protocols are supported.) +.Sp +The default is to pick a mirror automatically, using +<http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is +used for the entire download. You can use the special argument \f(CW\*(C`ctan\*(C'\fR +as an abbreviation for this. See <http://ctan.org> for more about \s-1CTAN\s0 +and its mirrors. +.Sp +If the repository is on the network, trailing \f(CW\*(C`/\*(C'\fR characters and/or +trailing \f(CW\*(C`/tlpkg\*(C'\fR and \f(CW\*(C`/archive\*(C'\fR components are ignored. For example, +you could choose a particular \s-1CTAN\s0 mirror with something like this: +.Sp +.Vb 1 +\& \-repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet +.Ve +.Sp +Of course a real hostname and its particular top-level \s-1CTAN\s0 path +have to be specified. The list of \s-1CTAN\s0 mirrors is available at +<http://ctan.org/mirrors>. +.Sp +If the repository is local, the installation type (compressed or live) is +automatically determined, by checking for the presence of a +\&\f(CW\*(C`archive\*(C'\fR directory relative to the root. Compressed is +preferred if both are available, since it is faster. Here's an example +of using a local directory: +.Sp +.Vb 1 +\& \-repository /local/TL/repository +.Ve +.Sp +After installation is complete, you can use that installation as the +repository for another installation. If you chose to install less than +the full scheme containing all packages, the list of available schemes +will be adjusted accordingly. +.Sp +For backward compatibility and convenience, \f(CW\*(C`\-\-location\*(C'\fR and \f(CW\*(C`\-\-repo\*(C'\fR +are accepted as aliases for this option. +.IP "\fB\-select\-repository\fR" 4 +.IX Item "-select-repository" +This option allows manual selection of a mirror from the current list of +active \s-1CTAN\s0 mirrors. This option is supported in all installer modes +(text, wizard, perltk), and will also offer to install from local media +if available, or from a repository specified on the command line (see +above). It's useful when the (default) automatic redirection does not +choose a good host for you. +.IP "\fB\-all\-options\fR" 4 +.IX Item "-all-options" +Normally options not regarding the current platform are not shown. +Giving this cmd line option allows to configure settings in the +final tlpdb that do not have any immediate effect. +.IP "\fB\-custom\-bin\fR \fIpath\fR" 4 +.IX Item "-custom-bin path" +If you have built your own binaries for your system (probably because +your platform was not supported by TeX Live out of the box), this option +allows you to give the \fIpath\fR to a directory where the binaries for the +current system are present. The installation will continue as usual, but +at the end all files from \fIpath\fR are copied over to \f(CW\*(C`bin/custom\*(C'\fR in +your installation folder and this directory will be added to the path +for the post-install actions. +.IP "\fB\-debug\-translation\fR" 4 +.IX Item "-debug-translation" +In \s-1GUI\s0 mode, this switch makes \f(CW\*(C`tlmgr\*(C'\fR report any missing, or more +likely untranslated, messages to standard error. Helpful for +translators to see what remains to be done. +.IP "\fB\-\-help\fR, \fB\-help\fR, \fB\-?\fR" 4 +.IX Item "--help, -help, -?" +Display this help and exit. +.IP "\fB\-logfile\fR \fIfile\fR" 4 +.IX Item "-logfile file" +Write both all messages (informational, debugging, warnings) to \fIfile\fR, +in addition to standard output or standard error. +.Sp +If this option is not given, the installer will create a log file +in the root of the writable installation tree, +for example, \f(CW\*(C`/usr/local/texlive/YYYY/install\-tl.log\*(C'\fR for the \fI\s-1YYYY\s0\fR +release. +.IP "\fB\-force\-platform\fR \fIplatform\fR" 4 +.IX Item "-force-platform platform" +Instead of auto-detecting the current platform, use \fIplatform\fR. +Binaries for this platform must be present and they must actually be +runnable, or installation will fail. \f(CW\*(C`\-force\-arch\*(C'\fR is a synonym. +.IP "\fB\-no\-cls\fR" 4 +.IX Item "-no-cls" +(only for text mode installer) do not clear the screen when entering +a new menu (for debugging purposes). +.IP "\fB\-non\-admin\fR" 4 +.IX Item "-non-admin" +For Windows only: configure for the current user, not for all users. +.IP "\fB\-\-persistent\-downloads\fR" 4 +.IX Item "--persistent-downloads" +.PD 0 +.IP "\fB\-\-no\-persistent\-downloads\fR" 4 +.IX Item "--no-persistent-downloads" +.PD +For net installs, activating this option makes the installer try to set up a +persistent connection using the Net::LWP Perl module. +This opens only one connection between your computer and the server +per session and reuses it, instead of initiating a new download for +each package. +.Sp +This option is turned on by default, and the installation program will +fall back to using \f(CW\*(C`wget\*(C'\fR if this is not possible. To disable usage of +\&\s-1LWP\s0 and persistent connections, use \f(CW\*(C`\-\-no\-persistent\-downloads\*(C'\fR. +.IP "\fB\-portable\fR" 4 +.IX Item "-portable" +Install for portable use on e.g. a \s-1USB\s0 stick. Also selectable from +within the perltk\- and text installers. +.IP "\fB\-in\-place\fR" 4 +.IX Item "-in-place" +This is a quick-and-dirty installation option in case you already +have an rsync\- or svn checkout of TeX Live. It will use the checkout +as-is and will just do the necessary post-install. Be warned that +the file tlpkg/texlive.tlpdb may be rewritten, that removal has +to be done manually, and that the only realistic way to maintain +this installation is to redo it from time to time. This option is +not available via the installer interface. \s-1USE\s0 \s-1AT\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1RISK\s0. +.IP "\fB\-print\-platform\fR" 4 +.IX Item "-print-platform" +Print the TeX Live identifier for the detected platform +(hardware/operating system) combination to standard output, and exit. +\&\f(CW\*(C`\-print\-arch\*(C'\fR is a synonym. +.IP "\fB\-profile\fR \fIprofile\fR" 4 +.IX Item "-profile profile" +Load the file \fIprofile\fR and do the installation with no user +interaction, that is, a batch (unattended) install. +.Sp +A \fIprofile\fR file contains all the values needed to perform an +installation. After a normal installation has finished, a profile for +that exact installation is written to the file +DEST/tlpkg/texlive.profile. That file can be given as the argument to +\&\f(CW\*(C`\-profile\*(C'\fR to redo the exact same installation on a different system, +for example. Alternatively, you can use a custom profile, most easily +created by starting from a generated one and changing values, or an +empty file, which will take all the defaults. +.Sp +Normally a profile has to specify the value \f(CW1\fR for each collection to +be installed, even if the scheme is specified. This follows from the +logic of the installer in that you can first select a scheme and then +change the collections being installed. But there is one exception to +this, for convenience: If the profile contains a variable for +\&\f(CW\*(C`selected_scheme\*(C'\fR and \fIno\fR collection variables are defined in the +profile at all, then the collections which the specified scheme requires +are installed. +.Sp +Thus, a line \f(CW\*(C`selected_scheme scheme\-medium\*(C'\fR together with the +definitions of the installation directories (\f(CW\*(C`TEXDIR\*(C'\fR, \f(CW\*(C`TEXMFHOME\*(C'\fR, +\&\f(CW\*(C`TEXMFLOCAL\*(C'\fR, \f(CW\*(C`TEXMFSYSCONFIG\*(C'\fR, \f(CW\*(C`TEXMFSYSVAR\*(C'\fR) suffices to install +the medium scheme with all default options. +.IP "\fB\-q\fR" 4 +.IX Item "-q" +Omit normal informational messages. +.IP "\fB\-scheme\fR \fIscheme\fR" 4 +.IX Item "-scheme scheme" +Schemes are the highest level of package grouping in TeX Live; the +default is to use the \f(CW\*(C`full\*(C'\fR scheme, which includes everything. This +option overrides that default. You can change the scheme again before +the actual installation with the usual menu. The \fIscheme\fR argument may +optionally have a prefix \f(CW\*(C`scheme\-\*(C'\fR. The list of supported scheme names +depends on what your package repository provides; see the interactive +menu list. +.IP "\fB\-v\fR" 4 +.IX Item "-v" +Include debugging messages; repeat for maximum debugging, as in \f(CW\*(C`\-v +\&\-v\*(C'\fR. (Further repeats are accepted but ignored.) +.IP "\fB\-\-version\fR, \fB\-version\fR" 4 +.IX Item "--version, -version" +Output version information and exit. +If \f(CW\*(C`\-v\*(C'\fR has been given the revisions of the used modules are reported, too. +.PP +As usual, all options can be specified with either \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR, and +arguments can be separated from their options by either a space or \f(CW\*(C`=\*(C'\fR. +.SH "ENVIRONMENT VARIABLES" +.IX Header "ENVIRONMENT VARIABLES" +For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR will look for the +following environment variables. They are not of interest in normal +user installations. +.ie n .IP """TEXLIVE_INSTALL_ENV_NOCHECK""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_ENV_NOCHECK\fR" 4 +.IX Item "TEXLIVE_INSTALL_ENV_NOCHECK" +Omit the check for environment variables containing the string \f(CW\*(C`tex\*(C'\fR. +People developing TeX-related software are likely to have many such +variables. +.ie n .IP """TEXLIVE_INSTALL_NO_CONTEXT_CACHE""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_NO_CONTEXT_CACHE\fR" 4 +.IX Item "TEXLIVE_INSTALL_NO_CONTEXT_CACHE" +Omit creating the ConTeXt cache. This is useful for redistributors. +.ie n .IP """TEXLIVE_INSTALL_PREFIX""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_PREFIX\fR" 4 +.IX Item "TEXLIVE_INSTALL_PREFIX" +.PD 0 +.ie n .IP """TEXLIVE_INSTALL_TEXMFCONFIG""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFCONFIG\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFCONFIG" +.ie n .IP """TEXLIVE_INSTALL_TEXMFHOME""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFHOME\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFHOME" +.ie n .IP """TEXLIVE_INSTALL_TEXMFLOCAL""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFLOCAL\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFLOCAL" +.ie n .IP """TEXLIVE_INSTALL_TEXMFSYSCONFIG""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFSYSCONFIG\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFSYSCONFIG" +.ie n .IP """TEXLIVE_INSTALL_TEXMFSYSVAR""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFSYSVAR\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFSYSVAR" +.ie n .IP """TEXLIVE_INSTALL_TEXMFVAR""" 4 +.el .IP "\f(CWTEXLIVE_INSTALL_TEXMFVAR\fR" 4 +.IX Item "TEXLIVE_INSTALL_TEXMFVAR" +.PD +Specify the respective directories. +.SH "AUTHORS AND COPYRIGHT" +.IX Header "AUTHORS AND COPYRIGHT" +This script and its documentation were written for the TeX Live +distribution (<http://tug.org/texlive>) and both are licensed under the +\&\s-1GNU\s0 General Public License Version 2 or later. |