add tlmgr.1 man page to texmf/doc/man/man1 and bin-texlive.tlpsrc

git-svn-id: svn://tug.org/texlive/trunk@7865 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 347 insertions, 0 deletions

diff --git a/Master/texmf/doc/man/man1/tlmgr.1 b/Master/texmf/doc/man/man1/tlmgr.1
new file mode 100644
index 00000000000..747fed1eead
--- /dev/null
+++ b/Master/texmf/doc/man/man1/tlmgr.1
@@ -0,0 +1,346 @@
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings.  \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
+.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+.    ds -- \(*W-
+.    ds PI pi
+.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
+.    ds L" ""
+.    ds R" ""
+.    ds C` ""
+.    ds C' ""
+'br\}
+.el\{\
+.    ds -- \|\(em\|
+.    ds PI \(*p
+.    ds L" ``
+.    ds R" ''
+'br\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+.    de IX
+.    tm Index:\\$1\t\\n%\t"\\$2"
+..
+.    nr % 0
+.    rr F
+.\}
+.\"
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
+.    \" fudge factors for nroff and troff
+.if n \{\
+.    ds #H 0
+.    ds #V .8m
+.    ds #F .3m
+.    ds #[ \f1
+.    ds #] \fP
+.\}
+.if t \{\
+.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+.    ds #V .6m
+.    ds #F 0
+.    ds #[ \&
+.    ds #] \&
+.\}
+.    \" simple accents for nroff and troff
+.if n \{\
+.    ds ' \&
+.    ds ` \&
+.    ds ^ \&
+.    ds , \&
+.    ds ~ ~
+.    ds /
+.\}
+.if t \{\
+.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+.    \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+.    \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+.    \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+.    ds : e
+.    ds 8 ss
+.    ds o a
+.    ds d- d\h'-1'\(ga
+.    ds D- D\h'-1'\(hy
+.    ds th \o'bp'
+.    ds Th \o'LP'
+.    ds ae ae
+.    ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "TLMGR 1"
+.TH TLMGR 1 "2008-05-05" "perl v5.8.8" "User Contributed Perl Documentation"
+.SH "NAME"
+tlmgr \- the TeX Live Manager
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+tlmgr [\s-1OPTIONS\s0] \s-1ACTION\s0 ...
+.SH "ACTION"
+.IX Header "ACTION"
+.IP "\fBhelp\fR" 8
+.IX Item "help"
+Gives this help page.
+.IP "\fBgui\fR" 8
+.IX Item "gui"
+Starts the \s-1GUI\s0. Currently not all options of the cmd line version are
+supported in the \s-1GUI\s0.
+.IP "\fBinstall [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8
+.IX Item "install [options] pkg1 [pkg2 [pkg3 ...]]"
+Install all packages given on the cmdline. By default this installs all
+dependencies, too. See below for the option \fB\-\-no\-depends\fR.
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.IP "\fB\-\-no\-depends\fR" 16
+.IX Item "--no-depends"
+Do not install dependencies. If this option is not given installing
+a package will check that all dependencies of this package are fulfilled.
+.IP "\fB\-\-dry\-run\fR" 16
+.IX Item "--dry-run"
+Enables the chicken
+mode, i.e., nothing is actually installed but the actions to be performed
+are written to the terminal.
+.RE
+.RS 8
+.RE
+.IP "\fBupdate [options]\fR" 8
+.IX Item "update [options]"
+Update all packages if newer ones are available
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.IP "\fB\-\-dry\-run\fR" 16
+.IX Item "--dry-run"
+Enables the chicken
+mode, i.e., nothing is actually installed but the actions to be performed
+are written to the terminal.
+.RE
+.RS 8
+.RE
+.IP "\fBremove [options] pkg1 [pkg2 [pkg3 ...]]\fR" 8
+.IX Item "remove [options] pkg1 [pkg2 [pkg3 ...]]"
+Remove all packages given on the cmdline. Removing a collection will
+remove all dependencies, too, unless with option \fB\-\-no\-depends\fR.
+.Sp
+Removing a package which is referenced as a dependency in another
+collection or scheme will not succeed unless the \fB\-\-force\fR option is given.
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.IP "\fB\-\-no\-depends\fR" 16
+.IX Item "--no-depends"
+Do not remove depending packages.
+.IP "\fB\-\-force\fR" 16
+.IX Item "--force"
+When removing a package or collection would invalidate a dependency
+of another collection/scheme, the package will not be removed and
+a warning issued. With this options the package will be removed
+unconditionally. Use with care.
+.IP "\fB\-\-dry\-run\fR" 16
+.IX Item "--dry-run"
+Enables the chicken
+mode, i.e., nothing is actually removed but the actions to be performed
+are written to the terminal.
+.RE
+.RS 8
+.RE
+.IP "\fBdefault show\fR" 8
+.IX Item "default show"
+.PD 0
+.ie n .IP "\fBdefault \fB""key""\fB [\f(BI""value""\fB]\fR" 8
+.el .IP "\fBdefault \f(CBkey\fB [\f(CBvalue\fB]\fR" 8
+.IX Item "default key [value]"
+.PD
+The first form shows the default settings as saved in the TeX Live Database.
+.Sp
+In the second form if the \f(CW\*(C`value\*(C'\fR is missing the setting is showed, while
+with \f(CW\*(C`value\*(C'\fR present the setting is set to \f(CW\*(C`value\*(C'\fR.
+.Sp
+Possible values for \f(CW\*(C`key\*(C'\fR are: \f(CW\*(C`location\*(C'\fR (default installation source),
+\&\f(CW\*(C`formats\*(C'\fR (create formats at installation time),
+\&\f(CW\*(C`docfiles\*(C'\fR (install documentation files),
+\&\f(CW\*(C`srcfiles\*(C'\fR (install source files).
+.IP "\fBpaper a4\fR" 8
+.IX Item "paper a4"
+.PD 0
+.IP "\fBpaper letter\fR" 8
+.IX Item "paper letter"
+.IP "\fB[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]\fR" 8
+.IX Item "[xdvi|dvips|pdftex|dvipdfm|dvipdfmx] paper [help|papersize]"
+.PD
+Configures the system wide paper settings, either for all programs in
+one go, or for the given program on the command line.
+.IP "\fBarch list\fR" 8
+.IX Item "arch list"
+Prints the list of arch-os available at the default install location.
+.IP "\fBarch add [arch [arch [...]]]\fR" 8
+.IX Item "arch add [arch [arch [...]]]"
+Adds binaries for the given architectures to the installtion.
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.IP "\fB\-\-dry\-run\fR" 16
+.IX Item "--dry-run"
+For installation and removal of packages, this options enables the chicken
+mode, i.e., nothing is actually installed but the actions to be performed
+are written to the terminal.
+.Sp
+Note that for all other type of options but package installation and removal
+this options does \fB\s-1NOT\s0\fR work!
+.RE
+.RS 8
+.RE
+.IP "\fBsearch [\-\-file] what\fR" 8
+.IX Item "search [--file] what"
+Search the names, short and long descriptions of all locally installed packages
+for the given argument (interpreted as regexp).
+.Sp
+With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere
+in the path, and returning each package with the respective hit.
+.IP "\fBglobalsearch [\-\-file] what\fR" 8
+.IX Item "globalsearch [--file] what"
+Search the names, short and long descriptions of all packages available on
+the install media.
+.Sp
+With the \fB\-\-file\fR argument searches for files containing \f(CW\*(C`what\*(C'\fR somewhere
+in the path, and returning each package with the respective hit.
+.IP "\fBshow [pkg [pkg [...]]]\fR" 8
+.IX Item "show [pkg [pkg [...]]]"
+Shows for each given package the name, category, installation status,
+short and long description. Does search in the remote installation
+source for finding the package if it is not installed.
+.IP "\fBlist [collections|schemes]\fR" 8
+.IX Item "list [collections|schemes]"
+Without argument lists all packages available at the default install
+location, prefixing those already installed with \*(L"i \*(R".
+.Sp
+With arguments lists only collections or schemes.
+.IP "\fBuninstall\fR" 8
+.IX Item "uninstall"
+Uninstalls the TeX Live installation.
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.IP "\fB\-\-force\fR" 16
+.IX Item "--force"
+Do not ask for confirmation, remove immediately.
+.RE
+.RS 8
+.RE
+.IP "\fBgenerate language\fR" 8
+.IX Item "generate language"
+.PD 0
+.IP "\fBgenerate fmtutil\fR" 8
+.IX Item "generate fmtutil"
+.IP "\fBgenerate updmap\fR" 8
+.IX Item "generate updmap"
+.PD
+\&\fB\s-1WARNING\s0\fR Using these option will overwrite any user changes done in
+the respective files. Please think twice before using it.
+.Sp
+These function regenerate the three config files language.dat, fmtutil.cnf,
+and updmap.cfg from the information present in the local \s-1TLPDB\s0. If files
+language\-local.dat, fmtutil\-local.cnf, or updmap\-local.cfg are present
+under \s-1TEMXFLOCAL\s0 in the respective directories stuff there will be 
+simply merged into the final files. So be careful what to put there.
+.Sp
+Especially with updmap.cfg this function is dangerous because it will
+remove all maps which have been manually enabled (via updmap-sys \-\-enable),
+so be careful.
+.Sp
+\&\fBSupported options\fR
+.RS 8
+.ie n .IP """\-\-dest""\fR \fIoutput file" 16
+.el .IP "\f(CW\-\-dest\fR \fIoutput file\fR" 16
+.IX Item "--dest output file"
+specifies the output file (defaults to the respective location in \s-1TEXMFSYSVAR\s0).
+.ie n .IP """\-\-localcfg""\fR \fIlocal conf file" 16
+.el .IP "\f(CW\-\-localcfg\fR \fIlocal conf file\fR" 16
+.IX Item "--localcfg local conf file"
+specifies the (optional) local additions (defaults to the respective location
+in \s-1TEXMFSYSVAR\s0).
+.RE
+.RS 8
+.RE
+.SH "OPTIONS"
+.IX Header "OPTIONS"
+.IP "\fB\-\-location\fR \fIlocation\fR" 8
+.IX Item "--location location"
+Overrides the location as found in the tlpdb of the installation. Specifies
+the location from which packages should be installed or updated.
+.IP "\fB\-\-netarchive\fR \fIdir\fR" 8
+.IX Item "--netarchive dir"
+Overrides the default settings for netarchive. Should be used with care.
+.IP "\fB\-\-diskarchive\fR \fIdir\fR" 8
+.IX Item "--diskarchive dir"
+Overrides the default settings for diskarchive. Should be used with care.
+.PP
+The standard options \f(CW\*(C`\-\-help/\-h/\-?\*(C'\fR and \f(CW\*(C`\-\-debug\*(C'\fR are also accepted.
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+The \fBtlmgr\fR manages an existing TeX Live installation.
+.SH "AUTHORS AND COPYRIGHT"
+.IX Header "AUTHORS AND COPYRIGHT"
+This script and its documentation were written for the TeX Live
+distribution (<http://tug.org/texlive>) and both are licensed under the
+\&\s-1GNU\s0 General Public License Version 2 or later.
diff --git a/Master/tlpkg/tlpsrc/bin-texlive.tlpsrc b/Master/tlpkg/tlpsrc/bin-texlive.tlpsrc
index 9edbec2c232..ff397cc3685 100644
--- a/Master/tlpkg/tlpsrc/bin-texlive.tlpsrc
+++ b/Master/tlpkg/tlpsrc/bin-texlive.tlpsrc
@@ -14,6 +14,7 @@ runpattern f texmf/scripts/texlive/rungs.tlu
 runpattern d texmf/scripts/texlive/lua
 runpattern d texmf/scripts/texlive/tlmgrgui
 runpattern f texmf/web2c/updmap-hdr.cfg
+docpattern f texmf/doc/man/man1/tlmgr.1
 binpattern f bin/${ARCH}/tlmgr
 binpattern f bin/${ARCH}/rungs
 binpattern f bin/${ARCH}/tl-w32-wrapper.texlua