summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/tlmgr.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-04-14 01:43:00 +0000
committerKarl Berry <karl@freefriends.org>2013-04-14 01:43:00 +0000
commit414cc0066ba3c72aa5f54c3c61a9ccec6d32861f (patch)
tree1322778137235138b142f25cde65fea0e84c3ed7 /Master/texmf-dist/doc/man/man1/tlmgr.1
parent56a5484a009213508c32f04457d0c69aef2c87bc (diff)
/home/texlive/karl/Master/tlpkg/bin/tl-update-auto
git-svn-id: svn://tug.org/texlive/trunk@29912 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.1101
1 files changed, 100 insertions, 1 deletions
diff --git a/Master/texmf-dist/doc/man/man1/tlmgr.1 b/Master/texmf-dist/doc/man/man1/tlmgr.1
index ebd032dac80..61978dc9379 100644
--- a/Master/texmf-dist/doc/man/man1/tlmgr.1
+++ b/Master/texmf-dist/doc/man/man1/tlmgr.1
@@ -124,7 +124,7 @@
.\" ========================================================================
.\"
.IX Title "TLMGR 1"
-.TH TLMGR 1 "2013-04-12" "perl v5.16.3" "User Contributed Perl Documentation"
+.TH TLMGR 1 "2013-04-14" "perl v5.16.3" "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
@@ -266,6 +266,12 @@ debugging.
In \s-1GUI\s0 mode, this switch makes \f(CW\*(C`tlmgr\*(C'\fR report any missing, or more
likely untranslated, messages to standard error. This can help
translators to see what remains to be done.
+.IP "\fB\-\-usermode\fR" 4
+.IX Item "--usermode"
+Activates the user mode, see \*(L"\s-1USER\s0 \s-1MODE\s0\*(R" below.
+.IP "\fB\-\-usertree\fR \fIdir\fR" 4
+.IX Item "--usertree dir"
+Uses \fIdir\fR as user tree in user mode, seel \*(L"\s-1USER\s0 \s-1MODE\s0\*(R" below.
.PP
The standard options for TeX Live programs are also accepted:
\&\f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR, \f(CW\*(C`\-\-version\*(C'\fR, \f(CW\*(C`\-q\*(C'\fR (no informational messages), \f(CW\*(C`\-v\*(C'\fR
@@ -1182,6 +1188,99 @@ Also, \f(CW\*(C`update \-\-list\*(C'\fR is still performed regardless of this op
If the package on the server is older than the package already installed
(e.g., if the selected mirror is out of date), \f(CW\*(C`tlmgr\*(C'\fR does not
downgrade. Also, packages for uninstalled platforms are not installed.
+.SS "init-usertree"
+.IX Subsection "init-usertree"
+sets up the default user tree (\f(CW\*(C`TEXMFHOME\*(C'\fR) or the one specified
+on the command line using \f(CW\*(C`\-\-usertree\*(C'\fR for user mode management.
+See \*(L"\s-1USER\s0 \s-1MODE\s0\*(R" below.
+.SH "USER MODE"
+.IX Header "USER MODE"
+\&\fB\s-1WARNING\s0\fR \fB\s-1WARNING\s0\fR \fB\s-1WARNING\s0\fR
+This is very much work in progress
+and experimental. Expect breakage, and the need to reinstall your
+user tree a new.
+.PP
+\&\f(CW\*(C`tlmgr\*(C'\fR provides a restricted way to manage arbitrary texmf trees
+in the same way as the installation. This allows a user without write
+permissions to the installation location to update/install packages
+into a user tree.
+.PP
+\&\f(CW\*(C`tlmgr\*(C'\fR is set into user mode by giving the command line option
+\&\f(CW\*(C`\-\-usermode\*(C'\fR. It will not switch automatically, nor does it support
+a config file by now. Thus, this option has to be given every time.
+.PP
+This mode of \f(CW\*(C`tlmgr\*(C'\fR works on a user tree, which by default will be
+the value of \f(CW\*(C`TEXMFHOME\*(C'\fR, but can be overridden with the command line
+option \f(CW\*(C`\-\-usertree\*(C'\fR. In the following when we speak of the user tree
+we mean either \f(CW\*(C`TEXMFHOME\*(C'\fR or the one given on the command line.
+.PP
+Not all actions are allowed in user mode, \f(CW\*(C`tlmgr\*(C'\fR will warn you and
+not carry out this action. The actions of \f(CW\*(C`tlmgr\*(C'\fR can be classified into
+those that don't need write permissions and thus are working the same
+in user mode or normal mode. Currently these are
+\&\fBhelp\fR, \fBversion\fR, \fBsearch\fR, \fBshow\fR, \fBlist\fR, \fBcheck\fR, \fBprint-arch\fR.
+.PP
+Most of the actions dealing with package management on the other hand
+need write permissions, and behave differently:
+\&\fBinstall\fR, \fBupdate\fR, \fBremove\fR, \fBoption\fR, \fBpaper\fR, \fBgenerate\fR,
+\&\fBbackup\fR, \fBrestore\fR, \fBuninstall\fR, \fBsymlinks\fR.
+.PP
+Currently not supported (and probably will never be) is the \fBarch\fR
+action.
+.PP
+As for the \fBgui\fR action it is currently not supported, but might be
+in future.
+.PP
+Before using \f(CW\*(C`tlmgr\*(C'\fR in user mode, you have to set up the user tree
+with the \fBinit-usertree\fR action. This will create \f(CW\*(C`USERTREE/web2c\*(C'\fR,
+\&\f(CW\*(C`USERTREE/tlpkg/tlpobj\*(C'\fR and set up a minimal \f(CW\*(C`USERTREE/tlpkg/texlive.tlpdb\*(C'\fR.
+From then on you can use the supported actions as normal by adding
+the \f(CW\*(C`\-\-usermode\*(C'\fR command line switch.
+.PP
+In user mode the file \f(CW\*(C`USERTREE/tlpkg/texlive.tlpdb\*(C'\fR contains only the
+packages that have been installed into the user tree \f(CW\*(C`USERTREE\*(C'\fR using
+\&\f(CW\*(C`tlmgr\*(C'\fR, plus additional options in the virtual package
+00texlive.installation (like with the main installation's texlive.tlpdb).
+.PP
+All actions on packages in user mode can only be carried out on packages
+that are marked as \fBrelocatable\fR. Basically that means that the contained
+files all reside in the \f(CW\*(C`texmd\-dist\*(C'\fR tree. \fB\s-1NOTE\s0\fR That already excludes
+all binary packages! Of the currently about 1900 packages the majority,
+currently about 1750, are relocatable, i.e., they can be installed into
+a user tree.
+.PP
+Description of changes of actions in user mode:
+.SS "install"
+.IX Subsection "install"
+in usermode the tlmgr action install will check that the package
+and all depending packages are either all relocated, or those that
+are not relocated are already installed in the system installation.
+If this is true it will unpack all containers to be installed into
+the user tree (\s-1TEXMFHOME\s0 or the value of \-\-user\-tree) and add the
+respective packages to the user texlive.tlpdb (creating it if there
+has non be created till now).
+.PP
+Currently installing a collection installs all depending packages,
+but in contrast to normal mode does not install depending collections.
+So in *normal* mode tlmgr install collection-context would install
+collection-metapost, c\-basic, c\-documentation-base, too. In *usermode*
+only the packages mentioned in collection-context are installed.
+.SS "backup, restore, remove, update"
+.IX Subsection "backup, restore, remove, update"
+in usermode the tlmgr action update will check that all packages
+to be updated are installed in the user tree, otherwise it behaves
+exactely like the system tlmgr.
+.SS "option"
+.IX Subsection "option"
+only acts upon the user's texlive.tlpdb
+.SS "paper"
+.IX Subsection "paper"
+changes configuration files in user tree
+.SS "generate"
+.IX Subsection "generate"
+creates configuration files in user tree
+.PP
+\&\fB\s-1WARNING\s0 \s-1WARNING\s0 \s-1WARNING\s0\fR Be again warned that this is very experimental!
.SH "TLMGR CONFIGURATION FILE"
.IX Header "TLMGR CONFIGURATION FILE"
A small subset of the command line options can be set in a config file