add TLPDB->available_architectures

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

1 files changed, 258 insertions, 0 deletions

diff --git a/Master/tlpkg/man/TeXLive-TLPDB.1 b/Master/tlpkg/man/TeXLive-TLPDB.1
new file mode 100644
index 00000000000..c8bbb500470
--- /dev/null
+++ b/Master/tlpkg/man/TeXLive-TLPDB.1
@@ -0,0 +1,258 @@
+.\" 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::TLPDB 3"
+.TH TeXLive::TLPDB 3 "2007-11-03" "perl v5.8.8" "User Contributed Perl Documentation"
+.SH "NAME"
+\&\f(CW\*(C`TeXLive::TLPDB\*(C'\fR \-\- A database of TeX Live Packages
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\&  use TeXLive::TLPDB;
+.Ve
+.PP
+.Vb 2
+\&  TeXLive::TLPDB\->new ();
+\&  TeXLive::TLPDB\->new (location => "/path/to/texlive.tlpdb");
+.Ve
+.PP
+.Vb 10
+\&  $tlpdb\->location("/path/to/texlive.tlpdb");
+\&  $tlpdb\->from_file($filename);
+\&  $tlpdb\->writeout;
+\&  $tlpdb\->writeout(FILEHANDLE);
+\&  $tlpdb\->save;
+\&  $tlpdb\->available_architectures();
+\&  $tlpdb\->add_objpkg($tlpobj);
+\&  $tlpdb\->get_package("packagename");
+\&  $tlpdb\->list_packages;
+\&  $tlpdb\->package_revision("packagename");
+.Ve
+.PP
+.Vb 2
+\&  TeXLive::TLPDB\->listdir([$dir]);
+\&  $tlpdb\->generate_listfiles([$destdir]);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+.ie n .IP """TeXLive::TLPDB\->new""" 6
+.el .IP "\f(CWTeXLive::TLPDB\->new\fR" 6
+.IX Item "TeXLive::TLPDB->new"
+.PD 0
+.ie n .IP """TeXLive::TLPDB\->new(location => ""$filename"")""" 6
+.el .IP "\f(CWTeXLive::TLPDB\->new(location => ``$filename'')\fR" 6
+.IX Item "TeXLive::TLPDB->new(location => ""$filename"")"
+.PD
+\&\f(CW\*(C`TeXLive::TLPDB\->new\*(C'\fR creates a new \f(CW\*(C`TLPDB\*(C'\fR object. If the
+argument \f(CW\*(C`location\*(C'\fR is given it will be initialized from this
+location.  \f(CW$filename\fR is usually \f(CW\*(C`/path/to/texlive.tlpdb\*(C'\fR.  If
+\&\f(CW$filename\fR begins with \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR, the program \f(CW\*(C`wget\*(C'\fR
+is used to download the file.
+.ie n .IP """$tlpdb\->add_tlpobj($tlpobj)""" 6
+.el .IP "\f(CW$tlpdb\->add_tlpobj($tlpobj)\fR" 6
+.IX Item "$tlpdb->add_tlpobj($tlpobj)"
+The \f(CW\*(C`add_tlpobj\*(C'\fR adds an object of the type \s-1TLPOBJ\s0 to the \s-1TLPDB\s0.
+.ie n .IP """$tlpdb\->from_file($filename)""" 6
+.el .IP "\f(CW$tlpdb\->from_file($filename)\fR" 6
+.IX Item "$tlpdb->from_file($filename)"
+The \f(CW\*(C`from_file\*(C'\fR function initializes the \f(CW\*(C`TLPDB\*(C'\fR in case the
+location was not given at generation time.  If \f(CW$filename\fR begins
+with \f(CW\*(C`http://\*(C'\fR or \f(CW\*(C`ftp://\*(C'\fR, the program \f(CW\*(C`wget\*(C'\fR is used to download
+the file.
+.ie n .IP """$tlpdb\->writeout""" 6
+.el .IP "\f(CW$tlpdb\->writeout\fR" 6
+.IX Item "$tlpdb->writeout"
+.PD 0
+.ie n .IP """$tlpdb\->writeout(FILEHANDLE)""" 6
+.el .IP "\f(CW$tlpdb\->writeout(FILEHANDLE)\fR" 6
+.IX Item "$tlpdb->writeout(FILEHANDLE)"
+.PD
+The \f(CW\*(C`writeout\*(C'\fR function writes the database to \f(CW\*(C`STDOUT\*(C'\fR, or 
+the file handle given as argument.
+.ie n .IP """$tlpdb\->save""" 6
+.el .IP "\f(CW$tlpdb\->save\fR" 6
+.IX Item "$tlpdb->save"
+The \f(CW\*(C`save\*(C'\fR functions saves the \f(CW\*(C`TLPDB\*(C'\fR to the file which has been set
+as location. If the location is undefined, die.
+.ie n .IP """$tlpdb\->available_architectures""" 6
+.el .IP "\f(CW$tlpdb\->available_architectures\fR" 6
+.IX Item "$tlpdb->available_architectures"
+The \f(CW\*(C`available_architectures\*(C'\fR functions returns the list of available 
+architectures by checking for binfiles in the \*(L"bin\-tex\*(R" \s-1TLPOBJ\s0. If this
+package does not exist, die.
+.ie n .IP """$tlpdb\->get_package(""packagename"")""" 6
+.el .IP "\f(CW$tlpdb\->get_package(``packagename'')\fR" 6
+.IX Item "$tlpdb->get_package(""packagename"")"
+The \f(CW\*(C`get_package\*(C'\fR function returns a reference to a \f(CW\*(C`TLPOBJ\*(C'\fR object
+in case its name the the argument name coincide.
+.ie n .IP """$tlpdb\->list_packages""" 6
+.el .IP "\f(CW$tlpdb\->list_packages\fR" 6
+.IX Item "$tlpdb->list_packages"
+The \f(CW\*(C`list_packages\*(C'\fR function returns the list of all included packages.
+.ie n .IP """$tlpdb\->package_revision(""packagename"")""" 6
+.el .IP "\f(CW$tlpdb\->package_revision(``packagename'')\fR" 6
+.IX Item "$tlpdb->package_revision(""packagename"")"
+The \f(CW\*(C`package_revision\*(C'\fR function returns the revision number of the
+package named in the first argument.
+.ie n .IP """$tlpdb\->generate_packagelist""" 6
+.el .IP "\f(CW$tlpdb\->generate_packagelist\fR" 6
+.IX Item "$tlpdb->generate_packagelist"
+The \f(CW\*(C`generate_packagelist\*(C'\fR lists all available \s-1TL\s0 Packages together
+with their revisions.
+.ie n .IP """$tlpdb\->generate_listfiles""" 6
+.el .IP "\f(CW$tlpdb\->generate_listfiles\fR" 6
+.IX Item "$tlpdb->generate_listfiles"
+.PD 0
+.ie n .IP """$tlpdb\->generate_listfiles($destdir)""" 6
+.el .IP "\f(CW$tlpdb\->generate_listfiles($destdir)\fR" 6
+.IX Item "$tlpdb->generate_listfiles($destdir)"
+.PD
+The \f(CW\*(C`generate_listfiles\*(C'\fR generates the list files for the old 
+installers. This function will probably go away.
+.ie n .IP """$tlpdb\->location(""/path/to/texlive.tlpdb"")""" 6
+.el .IP "\f(CW$tlpdb\->location(``/path/to/texlive.tlpdb'')\fR" 6
+.IX Item "$tlpdb->location(""/path/to/texlive.tlpdb"")"
+The function \f(CW\*(C`location\*(C'\fR allows to read and set the location of the
+text file of the TeX Live database, by default named \f(CW\*(C`texlive.tlpdb\*(C'\fR.
+.ie n .IP """$tlpdb\->listdir""" 6
+.el .IP "\f(CW$tlpdb\->listdir\fR" 6
+.IX Item "$tlpdb->listdir"
+The function \f(CW\*(C`listdir\*(C'\fR allows to read and set the packages variable
+specifiying where generated list files are created.
+.PP
+The modules TeXLive::TLPSRC, TeXLive::TLPOBJ, 
+TeXLive::TLTREE, TeXLive::TLUtils and the
+document Perl\-API.txt and the specification in the TeX Live
+repository trunk/Master/tlpkg/doc/.
+.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.