summaryrefslogtreecommitdiff
path: root/Master/tlpkg/man/TeXLive::TLPSRC.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/tlpkg/man/TeXLive::TLPSRC.1')
-rw-r--r--Master/tlpkg/man/TeXLive::TLPSRC.1383
1 files changed, 383 insertions, 0 deletions
diff --git a/Master/tlpkg/man/TeXLive::TLPSRC.1 b/Master/tlpkg/man/TeXLive::TLPSRC.1
new file mode 100644
index 00000000000..1841f7f51f9
--- /dev/null
+++ b/Master/tlpkg/man/TeXLive::TLPSRC.1
@@ -0,0 +1,383 @@
+.\" 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 "TeXLive::TLPSRC 3"
+.TH TeXLive::TLPSRC 3 "2007-06-27" "perl v5.8.8" "User Contributed Perl Documentation"
+.SH "NAME"
+TeXLive::TLPSRC \- TeX Live Package Source access module
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use TeXLive::TLPSRC;
+.Ve
+.PP
+.Vb 4
+\& my $tlpsrc = TeXLive::TLPSRC\->new( name => "foobar" );
+\& $tlpsrc\->from_file("package.tlpsrc");
+\& $tlpsrc\->writeout;
+\& $tlpsrc\->writeout(\e*FILEHANDLE);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+The TeXLive::TLPSRC module provide access to TeX Live Package Source
+files, which contains all the information which cannot be automatically
+derived from the files in the TeX Live subversion repository.
+.SH "FILE SPECIFICATION"
+.IX Header "FILE SPECIFICATION"
+A tlpsrc file has to consist of non-empty lines (initial and final
+empty lines are ignored) of the form
+.PP
+\&\fIkey value\fR
+.PP
+where \fIkey\fR can be \f(CW\*(C`name\*(C'\fR, \f(CW\*(C`category\*(C'\fR, \f(CW\*(C`shortdesc\*(C'\fR, \f(CW\*(C`longdesc\*(C'\fR,
+\&\f(CW\*(C`catalogue\*(C'\fR, \f(CW\*(C`runpattern\*(C'\fR, \f(CW\*(C`srcpattern\*(C'\fR, \f(CW\*(C`docpattern\*(C'\fR, \f(CW\*(C`binpattern\*(C'\fR,
+\&\f(CW\*(C`execute\*(C'\fR, or \f(CW\*(C`depend\*(C'\fR.
+.PP
+The interpretation of the respective \fIvalues\fR are:
+.ie n .IP """name""" 4
+.el .IP "\f(CWname\fR" 4
+.IX Item "name"
+identifies the package, \f(CW\*(C`value\*(C'\fR must consist only of [\-_a\-zA\-Z0\-9]
+.ie n .IP """category""" 4
+.el .IP "\f(CWcategory\fR" 4
+.IX Item "category"
+identifies the category into which this package belongs. Possible categories
+are \f(CW\*(C`Collection\*(C'\fR, \f(CW\*(C`Scheme\*(C'\fR, \f(CW\*(C`TLCore\*(C'\fR, \f(CW\*(C`Documentation\*(C'\fR, \f(CW\*(C`Package\*(C'\fR.
+Note that there is no inherent checking whether a \f(CW\*(C`tlpsrc\*(C'\fR file called
+\&\f(CW\*(C`collection\-something\*(C'\fR actually belongs to the category \f(CW\*(C`Collection\*(C'\fR.
+Most packages will fall into the \f(CW\*(C`Package\*(C'\fR category.
+.ie n .IP """catalogue""" 4
+.el .IP "\f(CWcatalogue\fR" 4
+.IX Item "catalogue"
+(currently not used in TeX Live) identifies the name under which this
+package can be found in the TeX Catalogue.
+.ie n .IP """shortdesc""" 4
+.el .IP "\f(CWshortdesc\fR" 4
+.IX Item "shortdesc"
+gives a one line description of the package. Susequent entries will overwrite
+the former ones. In TeX Live only used for collections and schemes.
+.ie n .IP """longdesc""" 4
+.el .IP "\f(CWlongdesc\fR" 4
+.IX Item "longdesc"
+gives a long description of the package. Susequent entries are added up
+to a long text. In TeX Live only used for collections and schemes.
+.ie n .IP """depend""" 4
+.el .IP "\f(CWdepend\fR" 4
+.IX Item "depend"
+gives the list of dependencies of the package in the form
+.Sp
+\&\fICategory\fR/\fIName\fR
+.Sp
+All the depend lines contribute to the dependencies of the package.
+.ie n .IP """execute""" 4
+.el .IP "\f(CWexecute\fR" 4
+.IX Item "execute"
+gives a free form entry of install time jobs to be executed. Currently
+the following possible values are understood by the installers:
+.RS 4
+.ie n .IP """execute addMap \f(CIfont.map\f(CW""" 6
+.el .IP "\f(CWexecute addMap \f(CIfont.map\f(CW\fR" 6
+.IX Item "execute addMap font.map"
+enables the font map file \fIfont.map\fR in the \fIupdmap.cfg\fR file.
+.ie n .IP """execute addMixedMap \f(CIfont.map\f(CW""" 6
+.el .IP "\f(CWexecute addMixedMap \f(CIfont.map\f(CW\fR" 6
+.IX Item "execute addMixedMap font.map"
+enables the font map file \fIfont.map\fR> for Mixed mode in the \fIupdmap.cfg\fR file.
+.ie n .IP """execute BuildLanguageDat NN""" 6
+.el .IP "\f(CWexecute BuildLanguageDat NN\fR" 6
+.IX Item "execute BuildLanguageDat NN"
+activates all the hyphenation patterns found in
+\&\fIMaster/texmf/tex/generic/config/language.NN.dat\fR in the generated
+\&\fIlanguage.dat\fR file.
+.ie n .IP """execute BuildFormat FMTCFG""" 6
+.el .IP "\f(CWexecute BuildFormat FMTCFG\fR" 6
+.IX Item "execute BuildFormat FMTCFG"
+activates all the formats present in \fIMaster/texmf/fmtutil/format.FMTCFG.cnf\fR
+in the generated \fIfmtutil.cnf\fR file.
+.RE
+.RS 4
+.RE
+.ie n .IP """(src|run|doc|bin)pattern \f(CIpattern\f(CW""" 4
+.el .IP "\f(CW(src|run|doc|bin)pattern \f(CIpattern\f(CW\fR" 4
+.IX Item "(src|run|doc|bin)pattern pattern"
+adds a pattern (see below) to the respective list of patterns.
+.SH "PATTERNS"
+.IX Header "PATTERNS"
+Patterns specify which files are to be included into a \f(CW\*(C`tlpobj\*(C'\fR at
+expansion time. Patterns are of the form
+.PP
+.Vb 1
+\& [PREFIX]TYPE PAT
+.Ve
+.PP
+where
+.PP
+.Vb 2
+\& PREFIX = + | +! | !
+\& TYPE = t | f | d | r
+.Ve
+.PP
+The meaning of the various pattern types is
+.ie n .IP """f path""" 4
+.el .IP "\f(CWf path\fR" 4
+.IX Item "f path"
+includes all files which match \f(CW\*(C`path\*(C'\fR where \fBonly\fR the last component
+of \f(CW\*(C`path\*(C'\fR can contain the usual glob characters * and ? (but no others!).
+.ie n .IP """d path""" 4
+.el .IP "\f(CWd path\fR" 4
+.IX Item "d path"
+includes all the files in and below the directory specified as \f(CW\*(C`path\*(C'\fR.
+.ie n .IP """t word1 ... wordN worldL""" 4
+.el .IP "\f(CWt word1 ... wordN worldL\fR" 4
+.IX Item "t word1 ... wordN worldL"
+includes all the files in and below all directories of the form
+.Sp
+.Vb 1
+\& word1/word2/.../wordN/.../any/dirs/.../wordL/
+.Ve
+.Sp
+i.e., the first words but the last form the prefix of the path, then
+there can be an arbitrary nesting of directories, followed by \f(CW\*(C`wordL\*(C'\fR
+as another directory.
+.ie n .IP """r regexp""" 4
+.el .IP "\f(CWr regexp\fR" 4
+.IX Item "r regexp"
+includes all files matching the regexp \f(CW\*(C`/^regexp$/\*(C'\fR
+.PP
+In the case that one of the pattern sections is empty or \fBall\fR the provided
+patterns have the prefix \f(CW\*(C`+\*(C'\fR (e.g., \f(CW\*(C`+f ...\*(C'\fR), then the following patterns
+are \fBautomatically\fR added at expansion time (but never written to the
+textual representation):
+.IP "runpattern" 4
+.IX Item "runpattern"
+for runpatterns of category \f(CW\*(C`Package\*(C'\fR
+.Sp
+.Vb 1
+\& t texmf\-dist topdir $name
+.Ve
+.Sp
+where \f(CW\*(C`topdir\*(C'\fR is one of: bibtex context dvips fonts makeindex metafont
+metapost mft omega scripts tex vtex.
+.Sp
+For other categories \fBno\fR patterns are automatically added to the
+list of runpatterns.
+.IP "docpattern" 4
+.IX Item "docpattern"
+for docpattern of category \f(CW\*(C`Package\*(C'\fR
+.Sp
+.Vb 1
+\& t texmf\-dist doc $name
+.Ve
+.Sp
+for docpattern of category \f(CW\*(C`Documentation\*(C'\fR
+.Sp
+.Vb 1
+\& t texmf\-doc doc $name
+.Ve
+.IP "srcpattern" 4
+.IX Item "srcpattern"
+for srcpattern of category \f(CW\*(C`Package\*(C'\fR
+.Sp
+.Vb 1
+\& t texmf\-dist source $name
+.Ve
+.Sp
+for srcpattern of category \f(CW\*(C`Documentation\*(C'\fR
+.Sp
+.Vb 1
+\& t texmf\-doc source $name
+.Ve
+.PP
+binpatterns are never automatically added.
+.PP
+If the \f(CW\*(C`PREFIX\*(C'\fR contains the symbol ! the meaning of the pattern is
+reversed, i.e., file matching this pattern are removed from the list
+of included files.
+.SH "MEMBER ACCESS FUNCTIONS"
+.IX Header "MEMBER ACCESS FUNCTIONS"
+For any of the above \fIkeys\fR a function
+.PP
+.Vb 1
+\& $tlpsrc\->key
+.Ve
+.PP
+is available, which returns the current value when called without an argument,
+and sets the respective value when called with an argument.
+.PP
+Arguments and return values for \f(CW\*(C`name\*(C'\fR, \f(CW\*(C`category\*(C'\fR, \f(CW\*(C`shortdesc\*(C'\fR,
+\&\f(CW\*(C`longdesc\*(C'\fR, \f(CW\*(C`catalogue\*(C'\fR are single scalars. Arguments and return values
+for \f(CW\*(C`depends\*(C'\fR, \f(CW\*(C`executes\*(C'\fR, and the various \f(CW\*(C`patterns\*(C'\fR are lists.
+.SH "OTHER FUNCTIONS"
+.IX Header "OTHER FUNCTIONS"
+The following functions can be called for an \f(CW\*(C`TLPSRC\*(C'\fR object:
+.ie n .IP """new""" 4
+.el .IP "\f(CWnew\fR" 4
+.IX Item "new"
+(constructor) returns a new \f(CW\*(C`TLPSRC\*(C'\fR object. The arguments to the \f(CW\*(C`new\*(C'\fR
+constructor can be in the usual hash representation for the different keys
+above:
+.Sp
+.Vb 1
+\& $tlpsrc = TLPSRC\->new ( name => "foobar", shortdesc => "The foobar package" );
+.Ve
+.ie n .IP """from_file(""filename"")""" 4
+.el .IP "\f(CWfrom_file(``filename'')\fR" 4
+.IX Item "from_file(""filename"")"
+reads a \f(CW\*(C`tlpsrc\*(C'\fR file.
+.Sp
+.Vb 2
+\& $tlpsrc = new TLPSRC;
+\& $tlpsrc\->from_file("path/to/the/tlpsrc/file");
+.Ve
+.ie n .IP """writeout""" 4
+.el .IP "\f(CWwriteout\fR" 4
+.IX Item "writeout"
+writes the textual representation of a \f(CW\*(C`TLPSRC\*(C'\fR object to stdout, or the
+filehandle if given:
+.Sp
+.Vb 2
+\& $tlpsrc\->writeout;
+\& $tlpsrc\->writeout(\e*FILEHANDLE);
+.Ve
+.ie n .IP """make_tlpobj($tltree)""" 4
+.el .IP "\f(CWmake_tlpobj($tltree)\fR" 4
+.IX Item "make_tlpobj($tltree)"
+creates a \f(CW\*(C`TLPOBJ\*(C'\fR object from a \f(CW\*(C`TLPSRC\*(C'\fR object and a \f(CW\*(C`TLTREE\*(C'\fR object.
+This function does the necessary work to expand the manual data and
+enrich it which the actual content from <$tltree> to a \f(CW\*(C`TLPOBJ\*(C'\fR object.
+.SH "AUTHORS AND COPYRIGHT"
+.IX Header "AUTHORS AND COPYRIGHT"
+This module and its documentation was written by
+Norbert Preining <\fIpreining@logic.at\fR> for the TeX Live distribution and both
+are licensed under the \s-1GNU\s0 General Public License Version 2 or later.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+The modules TeXLive::TLUtils, TeXLive::TLPOBJ,
+TeXLive::TLPDB, TeXLive::TLTREE.