texlive[47907] Master: doc, consistency
commits+karl at tug.org
commits+karl at tug.org
Sun Jun 3 20:09:30 CEST 2018
Revision: 47907
http://tug.org/svn/texlive?view=revision&revision=47907
Author: karl
Date: 2018-06-03 20:09:29 +0200 (Sun, 03 Jun 2018)
Log Message:
-----------
doc, consistency
Modified Paths:
--------------
trunk/Master/install-tl
trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
trunk/Master/tlpkg/TeXLive/TLCrypto.pm
trunk/Master/tlpkg/TeXLive/TLTREE.pm
trunk/Master/tlpkg/TeXLive/TLWinGoo.pm
Modified: trunk/Master/install-tl
===================================================================
--- trunk/Master/install-tl 2018-06-03 00:23:59 UTC (rev 47906)
+++ trunk/Master/install-tl 2018-06-03 18:09:29 UTC (rev 47907)
@@ -288,11 +288,14 @@
close (REL_TL);
}
if ($::opt_verbosity > 0) {
- print "Revision of modules:";
+ print "Module revisions:";
print "\nTLConfig: " . TeXLive::TLConfig->module_revision();
+ print "\nTLCrypto: " . TeXLive::TLCrypto->module_revision();
+ print "\nTLDownload: ".TeXLive::TLDownload->module_revision();
+ print "\nTLPDB: " . TeXLive::TLPDB->module_revision();
+ print "\nTLPOBJ: " . TeXLive::TLPOBJ->module_revision();
+ print "\nTLTREE: " . TeXLive::TLTREE->module_revision();
print "\nTLUtils: " . TeXLive::TLUtils->module_revision();
- print "\nTLPOBJ: " . TeXLive::TLPOBJ->module_revision();
- print "\nTLPDB: " . TeXLive::TLPDB->module_revision();
print "\nTLWinGoo: " . TeXLive::TLWinGoo->module_revision() if win32();
print "\n";
}
@@ -2496,9 +2499,9 @@
=head1 DESCRIPTION
This installer creates a runnable TeX Live installation from various
-media, including over the network, from local hard disk, a DVD, etc.
-The installer works across all platforms supported by TeX Live. For
-information on initially downloading the TeX Live, see
+media, including over the network, from local hard disk, a DVD, etc. The
+installer works on all platforms supported by TeX Live. For information
+on initially downloading TeX Live, see
L<http://tug.org/texlive/acquire.html>.
The basic idea of TeX Live installation is for you to choose one of the
@@ -2517,7 +2520,7 @@
=head1 REFERENCES
-Post-installation configuration, package updates, and much more, are
+Post-installation configuration, package updates, and more, are
handled through B<tlmgr>(1), the TeX Live Manager
(L<http://tug.org/texlive/tlmgr.html>).
@@ -2588,50 +2591,29 @@
=item B<-repository> I<url|path>
Specify the package repository to be used as the source of the
-installation, either a local directory via C</path/to/directory> or a
-C<file:/> url, or a network location. See L</SUPPORTED URL SCHEMATA>
-for details.
+installation. In short, this can be a directory name or a url using
+http(s), ftp, or scp. The documentation for C<tlmgr> has the details
+(L<http://tug.org/texlive/doc/install-tl.html#OPTIONS>).
-The default is to pick a mirror automatically, using
+For installation, the default is to pick a mirror automatically, using
L<http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is
-used for the entire download. You can use the special argument C<ctan>
-as an abbreviation for this. See L<http://ctan.org> for more about CTAN
-and its mirrors.
+used for the entire download. You can use the special argument C<ctan>
+as an abbreviation for this. (See L<http://ctan.org> for more about CTAN
+and its mirrors.)
-If the repository is on the network, trailing C</> characters and/or
-trailing C</tlpkg> and C</archive> components are ignored. For example,
-you could choose a particular CTAN mirror with something like this:
-
- -repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet
-
-Of course a real hostname and its particular top-level CTAN directory
-have to be specified. The list of CTAN mirrors is available at
-L<http://ctan.org/mirrors>.
-
-If the repository is local, the installation type (compressed or live) is
-automatically determined, by checking for the presence of a
-C<archive> 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:
-
- -repository /local/TL/repository
-
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.
-For backward compatibility and convenience, C<--location> and C<--repo>
-are accepted as aliases for this option.
-
=item B<-select-repository>
-This option allows manual selection of a mirror from the current list of
-active CTAN 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.
+This option allows you to choose a particular mirror from the current
+list of active CTAN 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.
+It's useful when the (default) automatic redirection does not choose a
+good host for you.
=item B<-all-options>
@@ -2658,9 +2640,9 @@
=item B<-debug-translation>
-In GUI mode, this switch makes C<tlmgr> report any missing, or more
-likely untranslated, messages to standard error. Helpful for
-translators to see what remains to be done.
+In GUI mode, this options reports any missing, or more likely
+untranslated, messages to standard error. Helpful for translators to see
+what remains to be done.
=item B<-force-platform> I<platform>
@@ -2670,12 +2652,12 @@
=item B<-help>, B<--help>, B<-?>
-Display this help and exit. (This help is on the web at
-L<http://tug.org/texlive/doc/install-tl.html>). Sometimes the
-C<perldoc> and/or C<PAGER> programs on the system have problems,
-possibly resulting in control characters being literally output. This
-can't always be detected, but you can set the C<NOPERLDOC> environment
-variable and C<perldoc> will not be used.
+Display this help and exit. (This help is also on the web at
+L<http://tug.org/texlive/doc/install-tl.html>). Sometimes the C<perldoc>
+and/or C<PAGER> programs on the system have problems, possibly resulting
+in control characters being literally output. This can't always be
+detected, but you can set the C<NOPERLDOC> environment variable and
+C<perldoc> will not be used.
=item B<-in-place>
@@ -2708,14 +2690,10 @@
For the text mode installer only: do not clear the screen when entering
a new menu (for debugging purposes).
-=item B<-non-admin>
+=item B<-no-persistent-downloads>
-For Windows only: configure for the current user, not for all users.
-
=item B<-persistent-downloads>
-=item B<-no-persistent-downloads>
-
For network installs, activating this option makes the installer try to
set up a persistent connection using the C<Net::LWP> Perl module. This
opens only one connection between your computer and the server per
@@ -2734,6 +2712,10 @@
section of the C<tlmgr> documentation, e.g.,
L<http://tug.org/texlive/doc/tlmgr.html#CRYPTOGRAPHIC-VERIFICATION>
+=item B<-non-admin>
+
+For Windows only: configure for the current user, not for all users.
+
=item B<-portable>
Install for portable use, e.g., on a USB stick. Also selectable from
@@ -2771,8 +2753,8 @@
=item B<-version>, B<--version>
-Output version information and exit. If C<-v> has also been given the
-revisions of the used modules are reported, too.
+Output version information and exit. If C<-v> is also given, the
+versions of the TeX Live modules used are also reported.
=back
@@ -2907,45 +2889,11 @@
For more details on all of the above options, consult the TeX Live
installation manual, linked from L<http://tug.org/texlive/doc>.
-=head1 SUPPORTED URL SCHEMATA
-The following URL schemata are supported
-
-=over 4
-
-=item C<http://server/path/to/tlnet>
-
-Standard schema, is supported without any restrictions. If the (default)
-LWP method is used, this schema supports persistent connections.
-
-=item C<ftp://server/path/to/tlnet>
-
-If the (default) LWP method is used, this schema supports persistent connections.
-
-=item C<https://server/path/to/tlnet>
-
-If the (default) LWP method is used, this schema supports persistent connections.
-Some versions of C<wget> do not support this schema. Furthermore, even if
-C<wget> supports https, it might check the certificate. C<curl> generally
-supports https.
-
-=item C<user at machine:/path/to/tlnet>
-
-=item C<scp://user@machine/path/to/tlnet>
-
-=item C<ssh://user@machine/path/to/tlnet>
-
-These schemata use C<scp> to transfer files. The use of an C<ssh-agent>
-is highly recommended.
-
-=back
-
-
-
=head1 ENVIRONMENT VARIABLES
-For ease in scripting and debugging, C<install-tl> will look for the
-following environment variables. They are not of interest for normal
+For ease in scripting and debugging, C<install-tl> looks for the
+following environment variables. They are not of interest for normal
user installations.
=over 4
@@ -2956,41 +2904,10 @@
=item C<TL_DOWNLOAD_ARGS>
-These options allow selecting different download programs then the ones
-automatically selected by the installer. The order of selection is:
+These override the normal choice of a download program; see the C<tlmgr>
+documentation, e.g.,
+L<http://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>.
-=over 8
-
-=item 1.
-
-If the environment variable C<TEXLIVE_DOWNLOADER> is
-defined, use it; abort if the specified program doesn't work.
-Possible values: C<curl>, C<wget>.
-
-=item 2.
-
-If the environment variable C<TL_DOWNLOAD_PROGRAM> is
-defined (can be any value), use it together with
-C<TL_DOWNLOAD_ARGS>; abort if it doesn't work.
-
-=item 3.
-
-If LWP is available and working, use that (by far the most
-efficient method, as it supports persistent downloads).
-
-=item 4.
-
-If curl is available (from the system) and working, use that.
-
-=item 5.
-
-If wget is available (either from the system or TL) and working, use that.
-
-=back
-
-TL still provides C<wget> binaries for some platforms, so
-some download method should always be available.
-
=item C<TEXLIVE_INSTALL_ENV_NOCHECK>
Omit the check for environment variables containing the string C<tex>.
@@ -3004,7 +2921,7 @@
=item C<TEXLIVE_INSTALL_NO_WELCOME>
Omit printing the welcome message after successful installation, e.g.,
-for testing.
+when testing.
=item C<TEXLIVE_INSTALL_PREFIX>
Modified: trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2018-06-03 00:23:59 UTC (rev 47906)
+++ trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl 2018-06-03 18:09:29 UTC (rev 47907)
@@ -7457,22 +7457,89 @@
=item B<--repository> I<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 TLPDB, defined
-entirely in the file C<tlpkg/texlive.tlpdb>). The documentation for
-C<install-tl> has more details about this
-(L<http://tug.org/texlive/doc/install-tl.html>).
+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 TLPDB, which is given entirely in the
+file C<tlpkg/texlive.tlpdb>).
-C<--repository> changes the repository location only for the current
+This C<--repository> option changes the location only for the current
run; to make a permanent change, use C<option repository> (see the
L</option> action).
+As an example, you can choose a particular CTAN mirror with something
+like this:
+
+ -repository http://ctan.example.org/its/ctan/dir/systems/texlive/tlnet
+
+Of course a real hostname and its particular top-level CTAN directory
+have to be specified. The list of CTAN mirrors is available at
+L<http://ctan.org/mirrors>.
+
+Here's an example of using a local directory:
+
+ -repository /local/TL/repository
+
For backward compatibility and convenience, C<--location> and C<--repo>
are accepted as aliases for this option.
-See L</SUPPORTED URL SCHEMATA> for details on the supported schemata.
+Locations can be specified as any of the following:
+=over 4
+
+=item C</some/local/dir>
+
+=item C<file:/some/local/dir>
+
+Equivalent ways of specifying a local directory.
+
+=item C<ctan>
+
+=item C<http://mirror.ctan.org/systems/texlive/tlnet>
+
+Pick a CTAN mirror automatically, trying for one that is both nearby and
+up-to-date. The chosen mirror is used for the entire download. The bare
+C<ctan> is merely an alias for the full url. (See L<http://ctan.org> for
+more about CTAN and its mirrors.)
+
+=item C<http://server/path/to/tlnet>
+
+Standard HTTP. If the (default) LWP method is used, persistent
+connections are supported. TL can also use C<curl> or C<wget> to do the
+downloads, or an arbitrary user-specified program, as described in the
+C<tlmgr> documentation
+(L<http://tug.org/texlive/doc/tlmgr.html#ENVIRONMENT-VARIABLES>).
+
+=item C<https://server/path/to/tlnet>
+
+Again, if the (default) LWP method is used, this supports persistent
+connections. Unfortunately, some versions of C<wget> and C<curl> do not
+support https, and even when C<wget> 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.
+
+=item C<ftp://server/path/to/tlnet>
+
+If the (default) LWP method is used, persistent connections are
+supported.
+
+=item C<user at machine:/path/to/tlnet>
+
+=item C<scp://user@machine/path/to/tlnet>
+
+=item C<ssh://user@machine/path/to/tlnet>
+
+These forms are equivalent; they all use C<scp> to transfer files. Using
+C<ssh-agent> is recommended. (Info:
+L<https://en.wikipedia.org/wiki/OpenSSH>,
+L<https://en.wikipedia.org/wiki/Ssh-agent>.)
+
+=back
+
+If the repository is on the network, trailing C</> characters and/or
+trailing C</tlpkg> and/or C</archive> components are ignored.
+
=item B<--gui> [I<action>]
C<tlmgr> has a graphical interface as well as the command line
@@ -9534,44 +9601,13 @@
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.
-=head1 SUPPORTED URL SCHEMATA
+=head1 ENVIRONMENT VARIABLES
-The following URL schemata are supported
+C<tlmgr> uses many of the standard TeX environment variables, as
+reported by, e.g., C<tlmgr conf> (L</conf>).
-=over 4
-
-=item C<http://server/path/to/tlnet>
-
-Standard schema, is supported without any restrictions. If the (default)
-LWP method is used, this schema supports persistent connections.
-
-=item C<ftp://server/path/to/tlnet>
-
-If the (default) LWP method is used, this schema supports persistent connections.
-
-=item C<https://server/path/to/tlnet>
-
-If the (default) LWP method is used, this schema supports persistent connections.
-Some versions of C<wget> do not support this schema. Furthermore, even if
-C<wget> supports https, it might check the certificate. C<curl> generally
-supports https.
-
-=item C<user at machine:/path/to/tlnet>
-
-=item C<scp://user@machine/path/to/tlnet>
-
-=item C<ssh://user@machine/path/to/tlnet>
-
-These schemata use C<scp> to transfer files. The use of an C<ssh-agent>
-is highly recommended.
-
-=back
-
-
-=head1 ENVIRONMENT VARIABLES
-
-For ease in scripting and debugging, C<install-tl> will look for the
-following environment variables. They are not of interest for normal
+In addition, for ease in scripting and debugging, C<tlmgr> looks for the
+following environment variables. These are not of interest for normal
user installations.
=over 4
@@ -9587,8 +9623,7 @@
If the environment variable C<TEXLIVE_COMPRESSOR> is
defined, use it; abort if it doesn't work. Possible values:
-C<lz4>, C<gzip>, C<xz>.
-
+C<lz4>, C<gzip>, C<xz>. The necessary options are added internally.
=item 2.
@@ -9623,7 +9658,8 @@
If the environment variable C<TEXLIVE_DOWNLOADER> is
defined, use it; abort if the specified program doesn't work.
-Possible values: C<curl>, C<wget>.
+Possible values: C<curl>, C<wget>. The necessary options are added
+internally.
=item 2.
Modified: trunk/Master/tlpkg/TeXLive/TLCrypto.pm
===================================================================
--- trunk/Master/tlpkg/TeXLive/TLCrypto.pm 2018-06-03 00:23:59 UTC (rev 47906)
+++ trunk/Master/tlpkg/TeXLive/TLCrypto.pm 2018-06-03 18:09:29 UTC (rev 47907)
@@ -9,9 +9,9 @@
use Digest::MD5;
use TeXLive::TLConfig;
-use TeXLive::TLUtils qw(debug ddebug win32 which platform conv_to_w32_path tlwarn tldie);
+use TeXLive::TLUtils qw(debug ddebug win32 which platform
+ conv_to_w32_path tlwarn tldie);
-
my $svnrev = '$Revision$';
my $_modulerevision = ($svnrev =~ m/: ([0-9]+) /) ? $1 : "unknown";
sub module_revision { return $_modulerevision; }
Modified: trunk/Master/tlpkg/TeXLive/TLTREE.pm
===================================================================
--- trunk/Master/tlpkg/TeXLive/TLTREE.pm 2018-06-03 00:23:59 UTC (rev 47906)
+++ trunk/Master/tlpkg/TeXLive/TLTREE.pm 2018-06-03 18:09:29 UTC (rev 47907)
@@ -13,9 +13,7 @@
} else {
$_modulerevision = "unknown";
}
-sub module_revision {
- return $_modulerevision;
-}
+sub module_revision { return $_modulerevision; }
use TeXLive::TLUtils;
Modified: trunk/Master/tlpkg/TeXLive/TLWinGoo.pm
===================================================================
--- trunk/Master/tlpkg/TeXLive/TLWinGoo.pm 2018-06-03 00:23:59 UTC (rev 47906)
+++ trunk/Master/tlpkg/TeXLive/TLWinGoo.pm 2018-06-03 18:09:29 UTC (rev 47907)
@@ -18,9 +18,7 @@
} else {
$_modulerevision = "unknown";
}
-sub module_revision {
- return $_modulerevision;
-}
+sub module_revision { return $_modulerevision; }
=pod
More information about the tex-live-commits
mailing list