summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/install-tl.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-06-29 01:19:02 +0000
committerKarl Berry <karl@freefriends.org>2013-06-29 01:19:02 +0000
commit0df5d3d0b19567d2bfb10388e63276e636cb5f46 (patch)
treea7b67ede016fa42496ee3daf8739159a0d0cc16f /Master/texmf-dist/doc/man/man1/install-tl.1
parent28634ff889a567fb276794e9932de0b5804da220 (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@31028 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/install-tl.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/install-tl.195
1 files changed, 49 insertions, 46 deletions
diff --git a/Master/texmf-dist/doc/man/man1/install-tl.1 b/Master/texmf-dist/doc/man/man1/install-tl.1
index 44cd5a8e78c..a60cb6edc65 100644
--- a/Master/texmf-dist/doc/man/man1/install-tl.1
+++ b/Master/texmf-dist/doc/man/man1/install-tl.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "INSTALL-TL 1"
-.TH INSTALL-TL 1 "2012-10-31" "perl v5.16.2" "User Contributed Perl Documentation"
+.TH INSTALL-TL 1 "2013-06-28" "perl v5.16.3" "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
@@ -168,6 +168,9 @@ For the full documentation of TeX Live, see
<http://tug.org/texlive/doc>.
.SH "OPTIONS"
.IX Header "OPTIONS"
+As usual, all options can be specified in any order, and with either a
+leading \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR. An argument value can be separated from its
+option by either a space or \f(CW\*(C`=\*(C'\fR.
.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.
@@ -264,26 +267,43 @@ 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.
+Normally options not relevant to the current platform are not shown
+(i.e., when running on Unix, Windows-specific options are omitted).
+Giving this command line option allows configuring settings in the
+final \f(CW\*(C`texlive.tlpdb\*(C'\fR 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
+If you have built your own set of TeX Live binaries (perhaps 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.
+allows you to specify 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 under your installation directory and this \f(CW\*(C`bin/custom/\*(C'\fR
+directory is what will be added to the path for the post-install
+actions. (By the way, for information on building TeX Live, see
+<http://tug.org/texlive/build.html>).
.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, -?"
+.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\-help\fR, \fB\-\-help\fR, \fB\-?\fR" 4
+.IX Item "-help, --help, -?"
Display this help and exit.
+.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
+\&\f(CW\*(C`tlpkg/texlive.tlpdb\*(C'\fR 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 interfaces. \s-1USE\s0 \s-1AT\s0 \s-1YOUR\s0 \s-1OWN\s0 \s-1RISK\s0.
.IP "\fB\-logfile\fR \fIfile\fR" 4
.IX Item "-logfile file"
Write both all messages (informational, debugging, warnings) to \fIfile\fR,
@@ -293,11 +313,6 @@ 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
@@ -311,28 +326,19 @@ For Windows only: configure for the current user, not for all users.
.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.
+For network installs, activating this option makes the installer try to
+set up a persistent connection using the \f(CW\*(C`Net::LWP\*(C'\fR 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, which typically yields a significant speed-up.
.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.
+Install for portable use, e.g., on a \s-1USB\s0 stick. Also selectable from
+within the perltk and text installers.
.IP "\fB\-print\-platform\fR" 4
.IX Item "-print-platform"
Print the TeX Live identifier for the detected platform
@@ -355,10 +361,10 @@ empty file, which will take all the defaults.
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
+change the collections being installed. But for convenience there is an
+exception to this within profiles: If the profile contains a variable
+for \f(CW\*(C`selected_scheme\*(C'\fR and \fIno\fR collection variables at all are defined
+in the profile, 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
@@ -379,15 +385,12 @@ 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.
+Include verbose 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 also been given the
+revisions of the used modules are reported, too.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
For ease in scripting and debugging, \f(CW\*(C`install\-tl\*(C'\fR will look for the