texlive[47874] Master: add docs for TEXLIVE_DOWNLOADER, _COMPRESSOR,

[commits+preining at tug.org]

Revision: 47874
          http://tug.org/svn/texlive?view=revision&revision=47874
Author:   preining
Date:     2018-05-30 03:33:07 +0200 (Wed, 30 May 2018)
Log Message:
-----------
add docs for TEXLIVE_DOWNLOADER, _COMPRESSOR, and selection order

Modified Paths:
--------------
    trunk/Master/install-tl
    trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl

Modified: trunk/Master/install-tl
===================================================================
--- trunk/Master/install-tl	2018-05-30 01:32:59 UTC (rev 47873)
+++ trunk/Master/install-tl	2018-05-30 01:33:07 UTC (rev 47874)
@@ -2589,9 +2589,8 @@
 
 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 via a C<http://>, C<https://>, or
-C<ftp://> url.  (No other protocols are supported, and C<https://> may
-not work on all platforms.)
+C<file:/> url, or a network location. See L</SUPPORTED URL SCHEMATA>
+for details.
 
 The default is to pick a mirror automatically, using
 L<http://mirror.ctan.org/systems/texlive/tlnet>; the chosen mirror is
@@ -2908,6 +2907,41 @@
 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
@@ -2916,6 +2950,47 @@
 
 =over 4
 
+=item C<TEXLIVE_DOWNLOADER>
+
+=item C<TL_DOWNLOAD_PROGRAM>
+
+=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:
+
+=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>.

Modified: trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl	2018-05-30 01:32:59 UTC (rev 47873)
+++ trunk/Master/texmf-dist/scripts/texlive/tlmgr.pl	2018-05-30 01:33:07 UTC (rev 47874)
@@ -7471,6 +7471,8 @@
 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.
+
 =item B<--gui> [I<action>]
 
 C<tlmgr> has a graphical interface as well as the command line
@@ -9532,6 +9534,124 @@
 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
+
+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
+user installations.
+
+=over 4
+
+=item C<TEXLIVE_COMPRESSOR>
+
+This option allows selecting a different compressor program for
+backups and intermediate rollback containers. The order of selection is:
+
+=over 8
+
+=item 1.
+
+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>.
+  
+
+=item 2.
+
+If lz4 is available (either from the system or TL) and working, use that.
+
+=item 3.
+
+If gzip is available (from the system) and working, use that.
+
+=item 4.
+
+If xz is available (either from the system or TL) and working, use that.
+  
+=back
+
+lz4 and gzip are much faster in creating tlmgr's local backups.
+The unconditional use of xz for the tlnet containers is unaffected,
+to minimize download sizes.
+
+=item C<TEXLIVE_DOWNLOADER>
+
+=item C<TL_DOWNLOAD_PROGRAM>
+
+=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:
+
+=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.
+
+=back
+
+
 =head1 AUTHORS AND COPYRIGHT
 
 This script and its documentation were written for the TeX Live