summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/tlmgr.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/tlmgr.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/tlmgr.1113
1 files changed, 98 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1
index e5a92defdc0..dfac10e4ed1 100644
--- a/Master/texmf-dist/doc/man/man1/tlmgr.1
+++ b/Master/texmf-dist/doc/man/man1/tlmgr.1
@@ -129,7 +129,7 @@
.\" ========================================================================
.\"
.IX Title "TLMGR 1"
-.TH TLMGR 1 "2018-06-02" "perl v5.26.2" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2018-06-03" "perl v5.26.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
@@ -204,22 +204,102 @@ non-option argument will be the main action. In all cases,
between an option name and its value.
.IP "\fB\-\-repository\fR \fIurl|path\fR" 4
.IX Item "--repository url|path"
-Specifies the package repository from which packages should be installed
-or updated, overriding the default package repository found in the
-installation's TeX Live Package Database (a.k.a. the \s-1TLPDB,\s0 defined
-entirely in the file \f(CW\*(C`tlpkg/texlive.tlpdb\*(C'\fR).
+Specify the package repository from which packages should be installed
+or updated, either a local directory or network location, as below. This
+overridesthe default package repository found in the installation's TeX
+Live Package Database (a.k.a. the \s-1TLPDB,\s0 which is given entirely in the
+file \f(CW\*(C`tlpkg/texlive.tlpdb\*(C'\fR).
.Sp
-The documentation for \f(CW\*(C`install\-tl\*(C'\fR has more details about this
-(<http://tug.org/texlive/doc/install\-tl.html#OPTIONS>). In short, you can
-specify a directory name, http(s) or ftp url, or
-\&\f(CW\*(C`scp://user@machine/path/to/tlnet\*(C'\fR.
-.Sp
-\&\f(CW\*(C`\-\-repository\*(C'\fR changes the repository location only for the current
+This \f(CW\*(C`\-\-repository\*(C'\fR option changes the location only for the current
run; to make a permanent change, use \f(CW\*(C`option repository\*(C'\fR (see the
\&\*(L"option\*(R" action).
.Sp
+As an example, you can 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 directory
+have to be specified. The list of \s-1CTAN\s0 mirrors is available at
+<http://ctan.org/mirrors>.
+.Sp
+Here's an example of using a local directory:
+.Sp
+.Vb 1
+\& \-repository /local/TL/repository
+.Ve
+.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.
+.Sp
+Locations can be specified as any of the following:
+.RS 4
+.ie n .IP """/some/local/dir""" 4
+.el .IP "\f(CW/some/local/dir\fR" 4
+.IX Item "/some/local/dir"
+.PD 0
+.ie n .IP """file:/some/local/dir""" 4
+.el .IP "\f(CWfile:/some/local/dir\fR" 4
+.IX Item "file:/some/local/dir"
+.PD
+Equivalent ways of specifying a local directory.
+.ie n .IP """ctan""" 4
+.el .IP "\f(CWctan\fR" 4
+.IX Item "ctan"
+.PD 0
+.ie n .IP """http://mirror.ctan.org/systems/texlive/tlnet""" 4
+.el .IP "\f(CWhttp://mirror.ctan.org/systems/texlive/tlnet\fR" 4
+.IX Item "http://mirror.ctan.org/systems/texlive/tlnet"
+.PD
+Pick a \s-1CTAN\s0 mirror automatically, trying for one that is both nearby and
+up-to-date. The chosen mirror is used for the entire download. The bare
+\&\f(CW\*(C`ctan\*(C'\fR is merely an alias for the full url. (See <http://ctan.org> for
+more about \s-1CTAN\s0 and its mirrors.)
+.ie n .IP """http://server/path/to/tlnet""" 4
+.el .IP "\f(CWhttp://server/path/to/tlnet\fR" 4
+.IX Item "http://server/path/to/tlnet"
+Standard \s-1HTTP.\s0 If the (default) \s-1LWP\s0 method is used, persistent
+connections are supported. \s-1TL\s0 can also use \f(CW\*(C`curl\*(C'\fR or \f(CW\*(C`wget\*(C'\fR to do the
+downloads, or an arbitrary user-specified program, as described in the
+\&\f(CW\*(C`tlmgr\*(C'\fR documentation
+(<http://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT\-VARIABLES>).
+.ie n .IP """https://server/path/to/tlnet""" 4
+.el .IP "\f(CWhttps://server/path/to/tlnet\fR" 4
+.IX Item "https://server/path/to/tlnet"
+Again, if the (default) \s-1LWP\s0 method is used, this supports persistent
+connections. Unfortunately, some versions of \f(CW\*(C`wget\*(C'\fR and \f(CW\*(C`curl\*(C'\fR do not
+support https, and even when \f(CW\*(C`wget\*(C'\fR supports https, certificates may be
+rejected even when the certificate is fine, due to a lack of local
+certificate roots. The simplest workaround for this problem is to use
+http or ftp.
+.ie n .IP """ftp://server/path/to/tlnet""" 4
+.el .IP "\f(CWftp://server/path/to/tlnet\fR" 4
+.IX Item "ftp://server/path/to/tlnet"
+If the (default) \s-1LWP\s0 method is used, persistent connections are
+supported.
+.ie n .IP """user@machine:/path/to/tlnet""" 4
+.el .IP "\f(CWuser@machine:/path/to/tlnet\fR" 4
+.IX Item "user@machine:/path/to/tlnet"
+.PD 0
+.ie n .IP """scp://user@machine/path/to/tlnet""" 4
+.el .IP "\f(CWscp://user@machine/path/to/tlnet\fR" 4
+.IX Item "scp://user@machine/path/to/tlnet"
+.ie n .IP """ssh://user@machine/path/to/tlnet""" 4
+.el .IP "\f(CWssh://user@machine/path/to/tlnet\fR" 4
+.IX Item "ssh://user@machine/path/to/tlnet"
+.PD
+These forms are equivalent; they all use \f(CW\*(C`scp\*(C'\fR to transfer files. Using
+\&\f(CW\*(C`ssh\-agent\*(C'\fR is recommended. (Info:
+<https://en.wikipedia.org/wiki/OpenSSH>,
+<https://en.wikipedia.org/wiki/Ssh\-agent>.)
+.RE
+.RS 4
+.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/or \f(CW\*(C`/archive\*(C'\fR components are ignored.
+.RE
.IP "\fB\-\-gui\fR [\fIaction\fR]" 4
.IX Item "--gui [action]"
\&\f(CW\*(C`tlmgr\*(C'\fR has a graphical interface as well as the command line
@@ -2092,9 +2172,12 @@ If you are developing a program that uses this output, and find that
changes would be helpful, do not hesitate to write the mailing list.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
-For ease in scripting and debugging, \f(CW\*(C`tlmgr\*(C'\fR looks for the following
-environment variables. They are not of interest for normal user
-installations.
+\&\f(CW\*(C`tlmgr\*(C'\fR uses many of the standard TeX environment variables, as
+reported by, e.g., \f(CW\*(C`tlmgr conf\*(C'\fR (\*(L"conf\*(R").
+.PP
+In addition, for ease in scripting and debugging, \f(CW\*(C`tlmgr\*(C'\fR looks for the
+following environment variables. These are not of interest for normal
+user installations.
.ie n .IP """TEXLIVE_COMPRESSOR""" 4
.el .IP "\f(CWTEXLIVE_COMPRESSOR\fR" 4
.IX Item "TEXLIVE_COMPRESSOR"
@@ -2160,4 +2243,4 @@ 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.
.PP
-\&\f(CW$Id:\fR tlmgr.pl 47874 2018\-05\-30 01:33:07Z preining $
+\&\f(CW$Id:\fR tlmgr.pl 47907 2018\-06\-03 18:09:29Z karl $