From add3d8683677b558254f61267e1dc6830c9c73da Mon Sep 17 00:00:00 2001
From: Karl Berry dvips
. tlmgr
does not support
settings.
Next: tlmgr pinning, Previous: tlmgr paper, Up: tlmgr ACTIONS [Contents][Index]
On Unix, merely adds or removes symlinks for binaries, man pages, and info pages in the system directories specified by the respective options (see the option description above). Does not change any @@ -5179,59 +5005,55 @@ is issued that the caller does not have enough privileges.
Next: tlmgr platform, Previous: tlmgr path, Up: tlmgr ACTIONS [Contents][Index]
The pinning
action manages the pinning file, see Pinning below.
pinning show
Shows the current pinning data.
pinning add
repo pkgglob...Pins the packages matching the pkgglob(s) to the repository repo.
pinning remove
repo pkgglob...Any packages recorded in the pinning file matching the <pkgglob>s for the given repository repo are removed.
pinning remove repo --all
Remove all pinning data for repository repo.
Next: tlmgr postaction, Previous: tlmgr pinning, Up: tlmgr ACTIONS [Contents][Index]
platform list
lists the TeX Live names of all the platforms
(a.k.a. architectures), (i386-linux
, ...) available at the package
repository.
@@ -5257,7 +5079,7 @@ platform instead of auto detection.
Nothing is actually installed; instead, the actions to be performed are written to the terminal.
@@ -5268,20 +5090,18 @@ written to the terminal.Next: tlmgr print-platform, Previous: tlmgr platform, Up: tlmgr ACTIONS [Contents][Index]
Carry out the postaction shortcut
, fileassoc
, or script
given
as the second required argument in install or remove mode (which is the
first required argument), for either the packages given on the command
@@ -5291,7 +5111,7 @@ line, or for all if --all
is given.
If the option --w32mode
is given the value user
, all actions will
only be carried out in the user-accessible parts of the
registry/filesystem, while the value admin
selects the system-wide
@@ -5300,7 +5120,7 @@ enough permissions, using --w32mode=admin
will not succeed.
--fileassocmode
specifies the action for file associations. If it is
set to 1 (the default), only new associations are added; if it is set to
2, all associations are set to the TeX Live programs. (See also
@@ -5308,7 +5128,7 @@ set to 1 (the default), only new associations are added; if it is set to
Carry out the postactions for all packages
Next: tlmgr print-platform-info, Previous: tlmgr postaction, Up: tlmgr ACTIONS [Contents][Index]
Print the TeX Live identifier for the detected platform
(hardware/operating system) combination to standard output, and exit.
--print-arch
is a synonym.
Next: tlmgr remove [option...] pkg..., Previous: tlmgr print-platform, Up: tlmgr ACTIONS [Contents][Index]
Print the TeX Live platform identifier, TL platform long name, and original output from guess.
Next: tlmgr repository, Previous: tlmgr print-platform-info, Up: tlmgr ACTIONS [Contents][Index]
Remove each pkg specified. Removing a collection removes all package
dependencies (unless --no-depends
is specified), but not any
@@ -5358,16 +5172,16 @@ package, dependencies are never removed. Options:
Uninstalls all of TeX Live, asking for confirmation unless --force
is
also specified.
These options behave just as with the (update)update action (q.v.), except they apply to making backups of packages before they are removed. The default is to make such a backup, that is, to save a copy of packages before removal. @@ -5376,17 +5190,17 @@ such a backup, that is, to save a copy of packages before removal.
Do not remove dependent packages.
See above under install (and beware).
By default, removal of a package or collection that is a dependency of
another collection or scheme is not allowed. With this option, the
package will be removed unconditionally. Use with care.
@@ -5398,7 +5212,7 @@ updated, and will be mentioned as forcibly removed
in the output of
Nothing is actually removed; instead, the actions to be performed are written to the terminal.
@@ -5406,29 +5220,27 @@ written to the terminal.Next: tlmgr restore, Previous: tlmgr remove [option...] pkg..., Up: tlmgr ACTIONS [Contents][Index]
This action manages the list of repositories. See (MULTIPLE_REPOSITORIES) below for detailed explanations.
The first form (list
) lists all configured repositories and the
@@ -5452,20 +5264,18 @@ otherwise, all operations will fail!
Next: tlmgr search, Previous: tlmgr repository, Up: tlmgr ACTIONS [Contents][Index]
Restore a package from a previously-made backup.
If --all
is given, try to restore the latest revision of all
@@ -5485,31 +5295,31 @@ specified, try to restore the package from the specified backup.
Try to restore the latest revision of all package backups found in the backup directory. Additional non-option arguments (like pkg) are not allowed.
Specify the directory where the backups are to be found. If not given it will be taken from the configuration setting in the TLPDB.
Nothing is actually restored; instead, the actions to be performed are written to the terminal.
Don’t ask questions.
When listing backups, the option
Next: tlmgr shell, Previous: tlmgr restore, Up: tlmgr ACTIONS [Contents][Index] By default, search the names, short descriptions, and long descriptions
of all locally installed packages for the argument what, interpreted
as a (Perl) regular expression.
@@ -5547,23 +5355,23 @@ as a (Perl) regular expression.
List all filenames containing what.
Search everything: package names, descriptions and filenames.
Search the TeX Live Database of the installation medium, instead of the
local installation.
Restrict the search of package names and descriptions (but not
filenames) to match only full words. For example, searching for
Next: tlmgr show, Previous: tlmgr search, Up: tlmgr ACTIONS [Contents][Index] Starts an interactive mode, where tlmgr prompts for commands. This can
be used directly, or for scripting. The first line of output is
@@ -5599,43 +5405,43 @@ the session.
Print Print pointers to this documentation.
Print tlmgr version information.
Exit.
Restart Explicitly load the local or remote, respectively, TLPDB.
Save the local TLPDB, presumably after other operations have changed it.
Get the value of var, or set it to val. Possible var names:
Next: tlmgr uninstall, Previous: tlmgr shell, Up: tlmgr ACTIONS [Contents][Index] Synonym for info.
Next: tlmgr update [option...] [pkg...], Previous: tlmgr show, Up: tlmgr ACTIONS [Contents][Index] Synonym for remove.
Previous: tlmgr uninstall, Up: tlmgr ACTIONS [Contents][Index] Updates the packages given as arguments to the latest version available
at the installation source. Either Update all installed packages except for Update Nothing is actually installed; instead, the actions to be performed are
written to the terminal. This is a more detailed report than Concisely list the packages which would be updated, newly installed, or
removed, without actually changing anything.
If Exclude pkg from the update process. If this option is given more
than once, its arguments accumulate.
By default, Under normal circumstances Under normal circumstances These two options control the creation of backups of packages before
updating; that is, backup of packages as currently installed. If
neither options is given, no backup will made. If If you call for updating a package normally all depending packages
will also be checked for updates and updated if necessary. This switch
suppresses this behavior.
See above under install (and beware).
Force update of normal packages, without updating
Next: tlmgr CRYPTOGRAPHIC VERIFICATION, Previous: tlmgr ACTIONS, Up: tlmgr [Contents][Index] There are two configuration files for This allows distributors to include the
Next: tlmgr USER MODE, Previous: tlmgr CONFIGURATION FILE FOR TLMGR, Up: tlmgr [Contents][Index] Additional trusted keys can be added using the The executable used for GnuPG is searched as follows: If the environment
variable
Next: tlmgr MULTIPLE REPOSITORIES, Previous: tlmgr CRYPTOGRAPHIC VERIFICATION, Up: tlmgr [Contents][Index] Description of changes of actions in user mode:
In user mode, the
Next: tlmgr User mode generate, option, paper, Previous: tlmgr User mode install, Up: tlmgr USER MODE [Contents][Index] In user mode, these actions check that all packages to be acted on are
installed in the user tree before proceeding; otherwise, they behave
just as in normal mode.
Previous: tlmgr User mode backup, restore, remove, update, Up: tlmgr USER MODE [Contents][Index] In user mode, these actions operate only on the user tree’s
configuration files and/or
Next: tlmgr GUI FOR TLMGR, Previous: tlmgr USER MODE, Up: tlmgr [Contents][Index] The main TeX Live repository contains a vast array of packages.
Nevertheless, additional local repositories can be useful to provide
@@ -6197,18 +5981,16 @@ taken from the new repository, by specifying so-called “pinning”
rules, described next.
When a package A summary of the
Next: tlmgr MACHINE-READABLE OUTPUT, Previous: tlmgr MULTIPLE REPOSITORIES, Up: tlmgr [Contents][Index] The graphical user interface for
Next: tlmgr Menu bar, Up: tlmgr GUI FOR TLMGR [Contents][Index]
Next: tlmgr Package list area, Up: tlmgr Main display [Contents][Index] The first part of the main display allows you to specify (filter) which
packages are shown. By default, all are shown. Changes here are
@@ -6343,34 +6119,34 @@ reflected right away.
Select whether to show all packages (the default), only those installed,
only those not installed, or only those with update available.
Select which categories are shown: packages, collections, and/or
schemes. These are briefly explained in the DESCRIPTION section
above.
Select packages matching for a specific pattern. By default, this
searches both descriptions and filenames. You can also select a subset
for searching.
Select packages to those selected, those not selected, or all. Here,
“selected” means that the checkbox in the beginning of the line of a
package is ticked.
To the right there are three buttons: select all packages, select none
(a.k.a. deselect all), and reset all these filters to the defaults,
i.e., show all available.
@@ -6379,13 +6155,11 @@ i.e., show all available.
Next: tlmgr Main display action buttons, Previous: tlmgr Display configuration area, Up: tlmgr Main display [Contents][Index] The second are of the main display lists all installed packages. If a
repository is loaded, those that are available but not installed are
@@ -6398,18 +6172,18 @@ further details: the long description, included files, etc.
Used to select particular packages; some of the action buttons (see
below) work only on the selected packages.
The name (identifier) of the package as given in the database.
If the package is installed the TeX Live revision number for the
installed package will be shown. If there is a catalogue version given
in the database for this package, it will be shown in parentheses.
@@ -6418,7 +6192,7 @@ guaranteed to reflect what is actually installed.
If a repository has been loaded the revision of the package in the
repository (if present) is shown. As with the local column, if a
catalogue version is provided it will be displayed. And also as with
@@ -6426,26 +6200,24 @@ the local column, the catalogue version may be stale.
The short description of the package.
Previous: tlmgr Package list area, Up: tlmgr Main display [Contents][Index] Below the list of packages are several buttons:
This calls Update only the selected packages.
Install the selected packages; acts like Removes the selected packages; acts like Makes a backup of the selected packages; acts like
Next: tlmgr GUI options, Previous: tlmgr Main display, Up: tlmgr GUI FOR TLMGR [Contents][Index] The following entries can be found in the menu bar:
The items here load various repositories: the default as specified in
the TeX Live database, the default network repository, the repository
specified on the command line (if any), and an arbitrarily
@@ -6502,7 +6272,7 @@ manually-entered one. Also has the so-necessary Provides access to several groups of options: Provides access to several actions: update the filename database (aka
Provides access to the TeX Live manual (also on the web at
http://tug.org/texlive/doc.html) and the usual “About” box.
Previous: tlmgr Menu bar, Up: tlmgr GUI FOR TLMGR [Contents][Index] Some generic Perl/Tk options can be specified with Set background color.
Set font, e.g., Set foreground color.
Set the X geometry, e.g., Pass the arbitrary X resource string xresource.
Next: tlmgr AUTHORS AND COPYRIGHT, Previous: tlmgr GUI FOR TLMGR, Up: tlmgr [Contents][Index] With the The output format is as follows:
The location may be a url (including The count is simply a decimal number, the sum of the sizes of all the
packages that need updating or installing (which are listed subsequently).
The TeX Live package identifier, with a possible platform suffix for
executables. For instance, The status of the package update. One character, as follows:
The package was removed on the server.
The package was removed in the local installation, even though a
collection depended on it. (E.g., the user ran Normal update is needed.
Reversed non-update: the locally-installed version is newer than the
version on the server.
Automatically-determined need for installation, the package is new on
the server and is (most probably) part of an installed collection.
Package will be installed and isn’t present in the local installation
(action install).
Package is already present but will be reinstalled (action install).
The revision number of the installed package, or The revision number of the package on the server, or The size in bytes of the package on the server. The sum of all the
package sizes is given in the The run time since start of installations or updates.
The estimated total time.
Previous: tlmgr Machine-readable The output format is as follows:
Previous: tlmgr MACHINE-READABLE OUTPUT, Up: tlmgr [Contents][Index] This script and its documentation were written for the TeX Live
distribution (http://tug.org/texlive) and both are licensed under the
@@ -6792,18 +6552,14 @@ GNU General Public License Version 2 or later.
--json
turn on JSON output.
The format is an array of JSON objects (name
, rev
, date
).
For details see tlpkg/doc/JSON-formats.txt
, format definition: TLBACKUPS
.
@@ -5522,23 +5332,21 @@ If both --json
and --data
are given, --json
-
-B.6.26 search
+B.6.26 search
table
with this option will not output packages containing the word
@@ -5576,13 +5384,11 @@ filenames) to match only full words. For example, searching for
-
-B.6.27 shell
+B.6.27 shell
protocol n
, the current protocol version.
tlmgr shell
with the original command line; most useful when
developing tlmgr
.
debug-translation
, machine-readable
, no-execute-actions
,
require-verification
, verify-downloads
, repository
, and
@@ -5651,35 +5457,29 @@ current default prompt.
-
-B.6.28 show
+B.6.28 show
-
-B.6.29 uninstall
+B.6.29 uninstall
-
-B.6.30 update [option...] [pkg...]
+B.6.30 update [option...] [pkg...]
--all
or at least one pkg name
@@ -5687,7 +5487,7 @@ must be specified. Options:
tlmgr
itself. Thus, if
updates to tlmgr
itself are present, this will simply give an error,
unless also the option --force
or --self
is given. (See below.)
@@ -5720,7 +5520,7 @@ due to a slow link), see the --exclude
option below.
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.
@@ -5739,13 +5539,13 @@ updates.
--list
.
--all
is also given, all available updates are listed.
@@ -5760,7 +5560,7 @@ given, those packages are checked for updates.
update-exclude
.
tlmgr
tries to remove packages which have disappeared on
the server, as described above under --all
. This option prevents
such removals, either for all packages (with --all
), or for just the
@@ -5792,7 +5592,7 @@ authors. Therefore this is not recommend.
tlmgr
will install packages which are new
on the server, as described above under --all
. This option prevents
any such automatic installation, either for all packages (with
@@ -5812,7 +5612,7 @@ server, then
tlmgr
will not install packages that have
been forcibly removed by the user; that is, removed with remove
--force
, or whose installation was prohibited by --no-auto-install
@@ -5826,10 +5626,10 @@ installation with the server’s idea of what is available:
--backupdir
is
@@ -5852,19 +5652,19 @@ incompatibility.
tlmgr
itself
(unless the --self
option is also given). Not recommended.
-
-B.7 CONFIGURATION FILE FOR TLMGR
+B.7 CONFIGURATION FILE FOR TLMGR
tlmgr
: One is system-wide in
TEXMFSYSCONFIG/tlmgr/config
, and the other is user-specific in
@@ -5915,28 +5713,28 @@ ignored. All other lines must look like:
@@ -5944,7 +5742,7 @@ ignored. All other lines must look like:
auto-remove
, value 0 or 1 (default 1), same as command-line option.gui-expertmode
, value 0 or 1 (default 1). This switches between the full GUI and a simplified GUI with only the most common settings.gui-lang
llcode, with a language code value as with the command-line option.no-checksums
, value 0 or 1 (default 0, see below).persistent-downloads
, value 0 or 1 (default 1), same as command-line option.require-verification
, value 0 or 1 (default 0), same as command-line option.update-exclude
, value: comma-separated list of packages (no space allowed). Same as the command line option --exclude
for the action update
.verify-downloads
, value 0 or 1 (default 1), same as command-line option.
allowed-actions
action1 [,action,...] The value is a comma-separated list of tlmgr
actions which are allowed to be executed when tlmgr
is invoked in system mode (that is, without --usermode
).tlmgr
in their packaging, but
allow only a restricted set of actions that do not interfere with their
distro package manager. For native TeX Live installations, it doesn’t
@@ -5969,13 +5767,11 @@ Perl and pure Lua modules, are much too slow to be usable in our
context.) no-checksums
avoids the warning.
-
-B.8 CRYPTOGRAPHIC VERIFICATION
+B.8 CRYPTOGRAPHIC VERIFICATION
tlmgr
and install-tl
perform cryptographic verification if
possible. If verification is performed and successful, the programs
@@ -6013,18 +5809,16 @@ of these keys are obtainable from the standard key servers.
key
action.
-
• tlmgr Configuration of GnuPG invocation:
+ • tlmgr Configuration of GnuPG invocation
-
-B.8.1 Configuration of GnuPG invocation
+B.8.1 Configuration of GnuPG invocation
TL_GNUPG
is set, it is tested and used; otherwise gpg
is
@@ -6036,13 +5830,11 @@ value for --homedir
, and TL_GNUPGARGS
, which replaces
options --no-secmem-warning --no-permission-warning
.
-
-B.9 USER MODE
+B.9 USER MODE
tlmgr
provides a restricted way, called “user mode”, to manage
arbitrary texmf trees in the same way as the main installation. For
@@ -6097,22 +5889,20 @@ installed into a user tree.
-
-B.9.1 User mode install
+B.9.1 User mode install
install
action checks that the package and all
dependencies are all either relocated or already installed in the system
@@ -6133,39 +5923,33 @@ the user’s updmap.cfg
in USERTREE/web2c/
is made
regenerated from the list of installed packages.
-
-B.9.2 User mode backup, restore, remove, update
+B.9.2 User mode backup, restore, remove, update
-
-B.9.3 User mode generate, option, paper
+B.9.3 User mode generate, option, paper
texlive.tlpdb
.
creates configuration files in user tree
-
-B.10 MULTIPLE REPOSITORIES
+B.10 MULTIPLE REPOSITORIES
-
• tlmgr Pinning:
+ • tlmgr Pinning
-
-B.10.1 Pinning
+B.10.1 Pinning
foo
is pinned to a repository, a package foo
in any
other repository, even if it has a higher revision number, will not be
@@ -6271,13 +6053,11 @@ from a given repository:
tlmgr pinning
actions is given above.
-
-B.11 GUI FOR TLMGR
+B.11 GUI FOR TLMGR
tlmgr
requires Perl/Tk
http://search.cpan.org/search?query=perl%2Ftk. For Windows the
@@ -6302,40 +6082,36 @@ repository. To load a different repository, see the tlmgr
menu ite
information about what is going on.
-
• tlmgr Main display:
+
-• tlmgr Main display
• tlmgr Menu bar:
+
-• tlmgr Menu bar
• tlmgr GUI options:
+ • tlmgr GUI options
-
-B.11.1 Main display
+B.11.1 Main display
-
-B.11.1.1 Display configuration area
+B.11.1.1 Display configuration area
-
-B.11.1.2 Package list area
+B.11.1.2 Package list area
-
-B.11.1.3 Main display action buttons
+B.11.1.3 Main display action buttons
tlmgr update --all
, i.e., tries to update all available
packages. Below this button is a toggle to allow reinstallation of
previously removed packages as part of this action.
@@ -6455,26 +6227,26 @@ where the checkbox at the beginning of the package line is ticked.
tlmgr install
, i.e., also
installs dependencies. Thus, installing a collection installs all its
constituent packages.
tlmgr remove
, i.e., it will
also remove dependencies of collections (but not dependencies of normal
packages).
tlmgr backup
. This
action needs the option backupdir
set (see Options -
General>).
backupdir
set (see Options -
G
-
-B.11.2 Menu bar
+B.11.2 Menu bar
tlmgr
menuquit
operation.
Options menu
Paper
(configuration of
default paper sizes), Platforms
(only on Unix, configuration of the
supported/installed platforms), GUI Language
(select language used in
@@ -6522,7 +6292,7 @@ installation; e.g., when a package is renamed.
Actions menu
ls-R
, mktexlsr
, texhash
), rebuild all formats (fmtutil-sys
--all
), update the font map database (updmap-sys
), restore from a backup
@@ -6534,7 +6304,7 @@ on Windows).
Help menu
-
-B.11.3 GUI options
+B.11.3 GUI options
tlmgr gui
to
control the display:
-background
color-font "
fontname fontsize "
tlmgr gui -font "helvetica 18"
. The argument to
-font
must be quoted, i.e., passed as a single string.
-foreground
color-geometry
geomspectlmgr gui -geometry 1024x512-0+0
creates
the window of (approximately) the given size in the upper-right corner
of the display.
-xrm
xresource
-
-B.12 MACHINE-READABLE OUTPUT
+B.12 MACHINE-READABLE OUTPUT
--machine-readable
option, tlmgr
writes to stdout in the
fixed line-oriented format described here, and the usual informational
@@ -6609,20 +6375,18 @@ information it needs by reading stdout.
option actions.
-
• tlmgr Machine-readable update
and install
output:
+
-• tlmgr Machine-readable update
and install
output
• tlmgr Machine-readable option
output:
+ • tlmgr Machine-readable option
output
-
-B.12.1 Machine-readable
+update
and install
outputB.12.1 Machine-readable
update
and install
output
location-url
locationfile:///foo/bar/...
), or a
directory name (/foo/bar
). It is the package repository from which
the new package information was drawn.
total-bytes
count
pdftex
and pdftex.i386-linux
are given
as two separate packages, one on each line.
d
f
tlmgr remove
--force
.)
u
r
a
i
I
-
if it is not
present locally.
-
if it is not
present on the server.
total-bytes
header field mentioned above.
-
-update
and install
output, Up: tlmgr MACHINE-READABLE OUTPUT [Contents][Index]B.12.2 Machine-readable
+option
outputB.12.2 Machine-readable
option
output
-
-B.13 AUTHORS AND COPYRIGHT
+B.13 AUTHORS AND COPYRIGHT
-
-Index
+Index