summaryrefslogtreecommitdiff
path: root/Master/texmf
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-08-24 00:29:03 +0000
committerKarl Berry <karl@freefriends.org>2009-08-24 00:29:03 +0000
commitfdfd6dbf46e203c457844916ea7cb2d0e20ae31b (patch)
tree3f96bbe3b76e55b47d17cdd8e569563ee79ce64d /Master/texmf
parent740f6b80e4779aa32d4ff1a1cc9f8ee81e9245ec (diff)
endless doc tweaks
git-svn-id: svn://tug.org/texlive/trunk@14836 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf')
-rwxr-xr-xMaster/texmf/scripts/texlive/tlmgr.pl89
1 files changed, 48 insertions, 41 deletions
diff --git a/Master/texmf/scripts/texlive/tlmgr.pl b/Master/texmf/scripts/texlive/tlmgr.pl
index 17bf0080c16..1cf3384557a 100755
--- a/Master/texmf/scripts/texlive/tlmgr.pl
+++ b/Master/texmf/scripts/texlive/tlmgr.pl
@@ -3682,7 +3682,7 @@ included and supported, but C<tlmgr> is now preferred.)
The most up-to-date version of this documentation is available at
L<http://tug.org/texlive/tlmgr.html>, along with procedures for updating
-tlmgr itself, disaster recovery when it's broken, and test versions.
+C<tlmgr> itself, disaster recovery when it's broken, and test versions.
=head1 OPTIONS
@@ -3740,8 +3740,8 @@ Windows to avoid command windows disappearing.
=item B<-debug-translation>
-This switch will make tlmgr report any missing or probably
-untranslated messages in GUI mode to STDERR.
+This switch will make C<tlmgr> report any missing or probably
+untranslated messages in GUI mode to standard error.
=back
@@ -3751,7 +3751,7 @@ C<--help/-h/-?>, C<--version>, C<-q> (no informational messages), C<-v>
the TeXLive::TLUtils documentation.
The C<--version> option shows version information about the TeX Live
-release as well as the C<tlmgr> script itself. If paired with C<-v>,
+release and about the C<tlmgr> script itself. If paired with C<-v>,
revision number for the used TeX Live Perl modules are shown, too.
=head1 ACTIONS
@@ -3808,9 +3808,9 @@ written to the terminal.
=item B<--force>
-If updates to the tlmgr itself (and the underlying infrastructure) are
-present tlmgr will bail out and not perform the installation unless this option
-is given.
+If updates to C<tlmgr> itself (or other parts of the basic
+infrastructure) are present, C<tlmgr> will bail out and not perform the
+installation unless this option is given. Not recommended.
=back
@@ -3825,8 +3825,8 @@ must be specified. Options:
=item B<--all>
-Update all installed packages except for tlmgr itself. Thus, if updates
-to tlmgr itself are present, this will simply give an error, unless also
+Update all installed packages except for C<tlmgr> itself. Thus, if updates
+to C<tlmgr> itself are present, this will simply give an error, unless also
the option C<--force> or C<--self> is given. (See below.)
In addition to updating the installed packages, during the update of a
@@ -3834,7 +3834,7 @@ collection the local installation is (by default) synchronized to the
status of the collection on the server, for both additions and removals.
Specifically, if a package has been removed on the server (and thus has
-also been removed from the respective collection), tlmgr will remove the
+also been removed from the respective collection), C<tlmgr> will remove the
package also on the local installation. This is called ``auto-remove''
and is announced as such when using the option C<--list>. This
auto-removal can be suppressed using the option C<--no-auto-remove>.
@@ -3853,12 +3853,12 @@ C<--reinstall-forcibly-removed>.
=item B<--self>
-Update tlmgr itself (that is, the infrastructure packages) if updates to
+Update C<tlmgr> itself (that is, the infrastructure packages) if updates to
it are present. On Windows this includes updates to the private Perl
interpreter shipped inside TeX Live.
If this option is given together with C<--all> or a list of packages
-then tlmgr will be updated first and, if this update the new version
+then C<tlmgr> will be updated first and, if this update the new version
will be restarted to complete the rest of the updates.
In brief:
@@ -3879,20 +3879,20 @@ written to the terminal. This is a more detailed report than C<--list>.
=item B<--force>
-Force update of normal packages, without updating tlmgr itself
+Force update of normal packages, without updating C<tlmgr> itself
(unless the C<--self> option is also given). Not recommended.
Also, C<update --list> is still performed regardless of this option.
=item B<--no-auto-remove>
-Under normal circumstances tlmgr tries to remove packages which have
+Under normal circumstances C<tlmgr> tries to remove packages which have
disappeared on the server when called with C<--all>, as described
above. This prevents any such removals.
=item B<--no-auto-install>
-Under normal circumstances tlmgr will install packages which are
+Under normal circumstances C<tlmgr> will install packages which are
new on the server when called with C<--all>. This prevents any such
automatic installation. Note that after this the packages that
would have been auto-installed will be considered as
@@ -3908,10 +3908,10 @@ is equivalent to
=item B<--reinstall-forcibly-removed>
-Under normal circumstances tlmgr will not install packages that it
+Under normal circumstances C<tlmgr> will not install packages that it
considers forcibly removed (that is, removed with `remove --force' or
whose installation was prohibited by --no-auto-install during an
-earlier update). This option makes tlmgr consider all these packages
+earlier update). This option makes C<tlmgr> consider all these packages
as new and re-install them. This can be used to syncronize an
installation with the server's idea of what is available by calling
@@ -3919,24 +3919,24 @@ installation with the server's idea of what is available by calling
=item B<--backup> and B<--backupdir> I<directory>
-These two options control the creation of backups of packages before an
-update is started; that is, the backup is of the package as it's
-installed. If neither of the two are given, no backup package will be
-saved. If C<--backupdir> is given and specifies a writable directory
-then a backup will be made in that location. If only C<--backup> is
-given, then a backup will be made to the directory previously set via
-the C<option> action (see below). If both are given then a backup will
-be made to the specified I<directory>.
+These two options control the creation of backups of packages I<before>
+updating; that is, backup of packages as currently installed. If
+neither of these options are given, no backup package will be saved. If
+C<--backupdir> is given and specifies a writable directory then a backup
+will be made in that location. If only C<--backup> is given, then a
+backup will be made to the directory previously set via the C<option>
+action (see below). If both are given then a backup will be made to the
+specified I<directory>.
You can set options via the C<option> action to automatically create
backups for all packages, and/or keep only a certain number of
-backups. Please see the C<option> action for details.
+backups. Please see the C<option> action for details.
-C<tlmgr> always makes a temporary backup when updating packages, in case
-of download or other failure during an update. The purpose of this
-C<--backup> option is to allow you to save a persistent backup in case
-the actual I<content> of the update causes problems, e.g., introduces an
-incompatibility.
+C<tlmgr> unconditionally makes a temporary backup when updating
+packages, in case of download or other failure during an update. In
+contrast, the purpose of this C<--backup> option is to allow you to save
+a persistent backup in case the actual I<content> of the update causes
+problems, e.g., introduces an incompatibility.
The C<restore> action explains how to restore from a backup.
@@ -4089,7 +4089,7 @@ displayed. If I<value> is present, I<key> is set to I<value>.
Possible values for I<key> are (but see B<tlmgr option showall> for
the definitive list):
- location (default installation location),
+ location (default installation source),
formats (create formats at installation time),
docfiles (install documentation files),
srcfiles (install source files),
@@ -4099,9 +4099,9 @@ the definitive list):
sys_man (location where man pages are linked to by action path)
sys_info (location where info pages are linked to by action path)
-One common use of C<option> is if you originally installed from DVD, and
-want to permanently change the installation to get further updates from
-the Internet. To do this, you can run
+One common use of C<option> is to permanently change the installation to
+get further updates from the Internet, after originally installing from
+DVD. To do this, you can run
tlmgr option location http://mirror.ctan.org/systems/texlive/tlnet
@@ -4129,21 +4129,26 @@ Or you can use:
tlmgr option -- autobackup -1
-The C<--> avoids having the C<-1> treated as an option. (In general,
-C<--> stops parsing for arguments at the point where it appears; this is
-a general feature of option parsing.)
+The C<--> avoids having the C<-1> treated as an option. (For most
+programs, C<--> stops parsing for arguments at the point where it
+appears; this is a general feature of option parsing.)
+
=head2 conf
-This option to tlmgr mimicks the B<texconfig conf> call, but works on
+Show general configuration information for TeX Live, including active
+configuration files, path settings, and more.
+
+This option to C<tlmgr> mimics the C<texconfig conf> call, but works on
all supported platforms.
+
=head2 path [--w32mode=user|admin] [add|remove]
-On unix adds or removes symlinks for binaries, man pages, and info pages
+On Unix adds or removes symlinks for binaries, man pages, and info pages
in the directories specified by the respective options (see above).
-On W32 based systems the registry part where the binary directory is
+On Windows, the registry part where the binary directory is
added or removed is determined in the following way:
If the user has admin rights, and the option C<--w32mode> is not given,
@@ -4182,6 +4187,7 @@ For the postaction C<fileassoc> the mode can be set with C<--fileassocmode>.
If it is set to 1, only new assocations are added, if it is set to 2,
all associations are set to the TeX Live programs.
+
=head2 paper
=over 4
@@ -4216,6 +4222,7 @@ longstanding C<texconfig> script, which supports other configuration
settings for some programs, notably C<dvips>. C<tlmgr> does not support
those extra settings at present.
+
=head2 arch list|add|remove I<arch>...
C<arch list> lists the TeX Live names of all the architectures