summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/tlmgr.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2015-01-09 02:19:09 +0000
committerKarl Berry <karl@freefriends.org>2015-01-09 02:19:09 +0000
commit097fbc358af3af5a8d2018a4171169120d324018 (patch)
treead6848af2b3b72fcd9386b485d925b0afba46a96 /Master/texmf-dist/doc/man/man1/tlmgr.1
parentee847524ecb73d49c4e758e485b11423720c85dd (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@36002 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/tlmgr.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/tlmgr.1142
1 files changed, 80 insertions, 62 deletions
diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1
index e41ffa702ac..04e3e408c84 100644
--- a/Master/texmf-dist/doc/man/man1/tlmgr.1
+++ b/Master/texmf-dist/doc/man/man1/tlmgr.1
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "TLMGR 1"
-.TH TLMGR 1 "2014-12-16" "perl v5.20.1" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2015-01-08" "perl v5.20.1" "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
@@ -604,21 +604,26 @@ default user tree (\f(CW\*(C`TEXMFHOME\*(C'\fR), or one specified on the command
with \f(CW\*(C`\-\-usertree\*(C'\fR. See \*(L"\s-1USER MODE\*(R"\s0 below.
.SS "install [\fIoption\fP]... \fIpkg\fP..."
.IX Subsection "install [option]... pkg..."
-Install each \fIpkg\fR given on the command line. By default this installs
-all packages on which the given \fIpkg\fRs are dependent, also. Options:
+Install each \fIpkg\fR given on the command line, if it is not already
+installed. (It does not touch existing packages; see the \f(CW\*(C`update\*(C'\fR
+action for how to get the latest version of a package.)
+.PP
+By default this also installs all packages on which the given \fIpkg\fRs are
+dependent. Options:
+.IP "\fB\-\-dry\-run\fR" 4
+.IX Item "--dry-run"
+Nothing is actually installed; instead, the actions to be performed are
+written to the terminal.
.IP "\fB\-\-file\fR" 4
.IX Item "--file"
Instead of fetching a package from the installation repository, use
the package files given on the command line. These files must
be standard TeX Live package files (with contained tlpobj file).
-.IP "\fB\-\-reinstall\fR" 4
-.IX Item "--reinstall"
-Reinstall a package (including dependencies for collections) even if it
-already seems to be installed (i.e, is present in the \s-1TLPDB\s0). This is
-useful to recover from accidental removal of files in the hierarchy.
-.Sp
-When re-installing, only dependencies on normal packages are followed
-(i.e., not those of category Scheme or Collection).
+.IP "\fB\-\-force\fR" 4
+.IX Item "--force"
+If updates to \f(CW\*(C`tlmgr\*(C'\fR itself (or other parts of the basic
+infrastructure) are present, \f(CW\*(C`tlmgr\*(C'\fR will bail out and not perform the
+installation unless this option is given. Not recommended.
.IP "\fB\-\-no\-depends\fR" 4
.IX Item "--no-depends"
Do not install dependencies. (By default, installing a package ensures
@@ -631,15 +636,30 @@ package \f(CW\*(C`foo\*(C'\fR, the package \f(CW\*(C`foo.i386\-linux\*(C'\fR wil
an \f(CW\*(C`i386\-linux\*(C'\fR system. This option suppresses this behavior, and also
implies \f(CW\*(C`\-\-no\-depends\*(C'\fR. Don't use it unless you are sure of what you
are doing.
-.IP "\fB\-\-dry\-run\fR" 4
-.IX Item "--dry-run"
-Nothing is actually installed; instead, the actions to be performed are
-written to the terminal.
-.IP "\fB\-\-force\fR" 4
-.IX Item "--force"
-If updates to \f(CW\*(C`tlmgr\*(C'\fR itself (or other parts of the basic
-infrastructure) are present, \f(CW\*(C`tlmgr\*(C'\fR will bail out and not perform the
-installation unless this option is given. Not recommended.
+.IP "\fB\-\-reinstall\fR" 4
+.IX Item "--reinstall"
+Reinstall a package (including dependencies for collections) even if it
+already seems to be installed (i.e, is present in the \s-1TLPDB\s0). This is
+useful to recover from accidental removal of files in the hierarchy.
+.Sp
+When re-installing, only dependencies on normal packages are followed
+(i.e., not those of category Scheme or Collection).
+.IP "\fB\-\-with\-doc\fR" 4
+.IX Item "--with-doc"
+.PD 0
+.IP "\fB\-\-with\-src\fR" 4
+.IX Item "--with-src"
+.PD
+While not recommended, the \f(CW\*(C`install\-tl\*(C'\fR program provides an option to
+omit installation of all documentation and/or source files. (By
+default, everything is installed.) After such an installation, you may
+find that you want the documentation or source files for a given package
+after all. You can get them by using these options in conjunction with
+\&\f(CW\*(C`\-\-reinstall\*(C'\fR, as in (using the \f(CW\*(C`fontspec\*(C'\fR package as the example):
+.Sp
+.Vb 1
+\& tlmgr install \-\-reinstall \-\-with\-doc \-\-with\-src fontspec
+.Ve
.SS "option"
.IX Subsection "option"
.IP "\fBoption [show]\fR" 4
@@ -871,42 +891,6 @@ set to 1 (the default), only new associations are added; if it is set to
Print the TeX Live identifier for the detected platform
(hardware/operating system) combination to standard output, and exit.
\&\f(CW\*(C`\-\-print\-arch\*(C'\fR is a synonym.
-.SS "restore [\-\-backupdir \fIdir\fP] [\-\-all | \fIpkg\fP [\fIrev\fP]]"
-.IX Subsection "restore [--backupdir dir] [--all | pkg [rev]]"
-Restore a package from a previously-made backup.
-.PP
-If \f(CW\*(C`\-\-all\*(C'\fR is given, try to restore the latest revision of all
-package backups found in the backup directory.
-.PP
-Otherwise, if neither \fIpkg\fR nor \fIrev\fR are given, list the available backup
-revisions for all packages.
-.PP
-With \fIpkg\fR given but no \fIrev\fR, list all available backup revisions of
-\&\fIpkg\fR.
-.PP
-When listing available packages tlmgr shows the revision and in
-parenthesis the creation time if available (in format yyyy-mm-dd hh:mm).
-.PP
-With both \fIpkg\fR and \fIrev\fR, tries to restore the package from the
-specified backup.
-.PP
-Options:
-.IP "\fB\-\-all\fR" 4
-.IX Item "--all"
-Try to restore the latest revision of all package backups found in the
-backup directory. Additional non-option arguments (like \fIpkg\fR) are not
-allowed.
-.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
-.IX Item "--backupdir directory"
-Specify the directory where the backups are to be found. If not given it
-will be taken from the configuration setting in the \s-1TLPDB.\s0
-.IP "\fB\-\-dry\-run\fR" 4
-.IX Item "--dry-run"
-Nothing is actually restored; instead, the actions to be performed are
-written to the terminal.
-.IP "\fB\-\-force\fR" 4
-.IX Item "--force"
-Don't ask questions.
.SS "remove [\fIoption\fP]... \fIpkg\fP..."
.IX Subsection "remove [option]... pkg..."
Remove each \fIpkg\fR specified. Removing a collection removes all package
@@ -966,6 +950,40 @@ given on the command line, not keeping previous settings
.Sp
In all cases, one of the repositories must be tagged as \f(CW\*(C`main\*(C'\fR;
otherwise, all operations will fail!
+.SS "restore [\-\-backupdir \fIdir\fP] [\-\-all | \fIpkg\fP [\fIrev\fP]]"
+.IX Subsection "restore [--backupdir dir] [--all | pkg [rev]]"
+Restore a package from a previously-made backup.
+.PP
+If \f(CW\*(C`\-\-all\*(C'\fR is given, try to restore the latest revision of all
+package backups found in the backup directory.
+.PP
+Otherwise, if neither \fIpkg\fR nor \fIrev\fR are given, list the available
+backup revisions for all packages. With \fIpkg\fR given but no \fIrev\fR,
+list all available backup revisions of \fIpkg\fR.
+.PP
+When listing available packages tlmgr shows the revision, and in
+parenthesis the creation time if available (in format yyyy-mm-dd hh:mm).
+.PP
+If (and only if) both \fIpkg\fR and a valid revision number \fIrev\fR are
+specified, try to restore the package from the specified backup.
+.PP
+Options:
+.IP "\fB\-\-all\fR" 4
+.IX Item "--all"
+Try to restore the latest revision of all package backups found in the
+backup directory. Additional non-option arguments (like \fIpkg\fR) are not
+allowed.
+.IP "\fB\-\-backupdir\fR \fIdirectory\fR" 4
+.IX Item "--backupdir directory"
+Specify the directory where the backups are to be found. If not given it
+will be taken from the configuration setting in the \s-1TLPDB.\s0
+.IP "\fB\-\-dry\-run\fR" 4
+.IX Item "--dry-run"
+Nothing is actually restored; instead, the actions to be performed are
+written to the terminal.
+.IP "\fB\-\-force\fR" 4
+.IX Item "--force"
+Don't ask questions.
.SS "search [\fIoption\fP...] \fIwhat\fP"
.IX Subsection "search [option...] what"
\fIsearch [\fIoption\fI...] \-\-file \fIwhat\fI\fR
@@ -1235,8 +1253,8 @@ currently in TeX Live the vast majority are relocatable and can be
installed into a user tree.
.PP
Description of changes of actions in user mode:
-.SS "user mode install"
-.IX Subsection "user mode install"
+.SS "User mode install"
+.IX Subsection "User mode install"
In user mode, the \f(CW\*(C`install\*(C'\fR action checks that the package and all
dependencies are all either relocated or already installed in the system
installation. If this is the case, it unpacks all containers to be
@@ -1250,13 +1268,13 @@ collections. For example, in normal mode \f(CW\*(C`tlmgr install
collection\-context\*(C'\fR would install \f(CW\*(C`collection\-basic\*(C'\fR and other
collections, while in user mode, \fIonly\fR the packages mentioned in
\&\f(CW\*(C`collection\-context\*(C'\fR are installed.
-.SS "user mode backup; restore; remove; update"
-.IX Subsection "user mode backup; restore; remove; update"
+.SS "User mode backup, restore, remove, update"
+.IX Subsection "User mode backup, restore, remove, update"
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.
-.SS "user mode generate; option; paper"
-.IX Subsection "user mode generate; option; paper"
+.SS "User mode generate, option, paper"
+.IX Subsection "User mode generate, option, paper"
In user mode, these actions operate only on the user tree's
configuration files and/or \f(CW\*(C`texlive.tlpdb\*(C'\fR.
creates configuration files in user tree