From 5c51046fb32e5ddf1ca3553dafd484fd7e024904 Mon Sep 17 00:00:00 2001 From: Reinhard Kotucha Date: Fri, 7 Sep 2007 20:53:21 +0000 Subject: TLPSRC.pm, TLPOBJ.pm: POD documentation fixed. git-svn-id: svn://tug.org/texlive/trunk@4905 c570f23f-e606-0410-a88d-b1316a301751 --- Master/tlpkg/TeXLive/TLPOBJ.pm | 177 ++++++++++++++++++++++------------------- Master/tlpkg/TeXLive/TLPSRC.pm | 147 ++++++++++++++++++---------------- 2 files changed, 174 insertions(+), 150 deletions(-) (limited to 'Master') diff --git a/Master/tlpkg/TeXLive/TLPOBJ.pm b/Master/tlpkg/TeXLive/TLPOBJ.pm index cefbeab1a0c..40f4e5f2d27 100644 --- a/Master/tlpkg/TeXLive/TLPOBJ.pm +++ b/Master/tlpkg/TeXLive/TLPOBJ.pm @@ -78,11 +78,11 @@ sub from_fh { } if ($line =~ /^ /) { if ( ($lastcmd eq "longdesc") || - ($lastcmd eq "runfiles") || - ($lastcmd eq "binfiles") || - ($lastcmd eq "docfiles") || - ($lastcmd eq "srcfiles") || - ($lastcmd eq "executes") || + ($lastcmd eq "runfiles") || + ($lastcmd eq "binfiles") || + ($lastcmd eq "docfiles") || + ($lastcmd eq "srcfiles") || + ($lastcmd eq "executes") || ($lastcmd eq "depend") ) { $line =~ s/^ /${lastcmd}continued /; } else { @@ -709,13 +709,13 @@ __END__ =head1 NAME -TeXLive::TLPOBJ - TeX Live Package Object access module +C -- TeX Live Package Object access module =head1 SYNOPSIS - use TeXLive::TLPOBJ; + use TeXLive::TLPOBJ; - my $tlpobj = TeXLive::TLPOBJ->new( name => "foobar" ); + my $tlpobj=TeXLive::TLPOBJ->new(name => "foobar"); =head1 DESCRIPTION @@ -742,33 +742,35 @@ I by one space. They differ only in the first line itself each of these items contains addition the sum of sizes of the single files (currently in bytes). - srcfiles size=NNNNNN - runfiles size=NNNNNN + srcfiles size=NNNNNN + runfiles size=NNNNNN =item C + The docfiles line itself is similar to the C and C lines above: - docfiles size=NNNNNN + docfiles size=NNNNNN But the lines listing the files are allowed to have additional tags: - /------- excerpt from achemso.tlpobj - |... - |docfiles size=1702468 - | texmf-dist/doc/latex/aeguill/README details="Package Readme" - | texmf-dist/doc/latex/achemso/achemso.pdf details="Package documentation" language="en" - |... + /------- excerpt from achemso.tlpobj + |... + |docfiles size=1702468 + | texmf-dist/doc/latex/aeguill/README details="Package Readme" + | texmf-dist/doc/latex/achemso/achemso.pdf details="Package documentation" language="en" + |... Currently only the tags C
and C are allowed. =item C -Since C are different for the different architectures one C -file can contain C lines for different architectures. The -architecture is specified on the C using the C tag. Thus, -C lines look like - binfiles arch=XXXX size=NNNNN +Since C are different for the different architectures one +C file can contain C lines for different +architectures. The architecture is specified on the C using +the CI tag. Thus, C lines look like + + binfiles arch=XXXX size=NNNNN =back @@ -780,39 +782,39 @@ with C<|> characters inserted to show the indentation: |revision 4427 |docfiles size=959434 | texmf/doc/dvips/dvips.html - | ... - |runfiles size=1702468 - | texmf/dvips/base/color.pro - | ... - | texmf/scripts/pkfix/pkfix.pl - |binfiles arch=i386-solaris size=329700 - | bin/i386-solaris/afm2tfm - | bin/i386-solaris/dvips - | bin/i386-solaris/pkfix - |binfiles arch=win32 size=161280 - | bin/win32/afm2tfm.exe - | bin/win32/dvips.exe - | bin/win32/pkfix.exe - |... + | ... + |runfiles size=1702468 + | texmf/dvips/base/color.pro + | ... + | texmf/scripts/pkfix/pkfix.pl + |binfiles arch=i386-solaris size=329700 + | bin/i386-solaris/afm2tfm + | bin/i386-solaris/dvips + | bin/i386-solaris/pkfix + |binfiles arch=win32 size=161280 + | bin/win32/afm2tfm.exe + | bin/win32/dvips.exe + | bin/win32/pkfix.exe + |... =head1 PACKAGE VARIABLES TeXLive::TLPOBJ has one package wide variable which is C where generated zip files are saved (if not otherwise specified. - TeXLive::TLPOBJ->zipdir("path/to/zip/dir"); + TeXLive::TLPOBJ->zipdir("path/to/zip/dir"); =head1 MEMBER ACCESS FUNCTIONS For any of the I a function - $tlpobj->key + $tlpobj->key is available, which returns the current value when called without an argument, and sets the respective value when called with an argument. For the TeX Catalogue Data the function - $tlpobj->cataloguedata + $tlpobj->cataloguedata returns and takes as argument a hash. @@ -825,10 +827,10 @@ architectures as keys. The size values are handled with these functions: - $tlpobj->docsize - $tlpobj->runsize - $tlpobj->srcsize - $tlpobj->binsize("arch1", ...) + $tlpobj->docsize + $tlpobj->runsize + $tlpobj->srcsize + $tlpobj->binsize("arch1", ...) which set or get the current value of the respective sizes. Note that also the C function returns (and takes as argument) a hash with the @@ -841,67 +843,76 @@ The following functions can be called for an C object: =over =item C -(constructor) returns a new C object. The arguments to the C -constructor can be in the usual hash representation for the different keys -above: - $tlpobj = TLPOBJ->new ( name => "foobar", shortdesc => "The foobar package" ); +The constructor C returns a new C object. The arguments +to the C constructor can be in the usual hash representation for +the different keys above: + + $tlpobj=TLPOBJ->new(name => "foobar", shortdesc => "The foobar package"); =item C + reads a C file. - $tlpobj = new TLPOBJ; - $tlpobj->from_file("path/to/the/tlpobj/file"); + $tlpobj = new TLPOBJ; + $tlpobj->from_file("path/to/the/tlpobj/file"); -=item C -read the textual representation of a TLPOBJ from an already opened file handle. -If C<$multi> is undefined (ie not given) then multiple tlpobj in the -same file are treated as errors. If C<$multi> is defined then returns -after reading one tlpobj. +=item C -Returns 1 if it found a tlpobj, otherwise 0 +read the textual representation of a TLPOBJ from an already opened +file handle. If C<$multi> is undefined (ie not given) then multiple +tlpobj in the same file are treated as errors. If C<$multi> is defined +then returns after reading one tlpobj. + +Returns C<1> if it found a C, otherwise C<0>. =item C -writes the textual representation of a C object to stdout, or the -filehandle if given: - $tlpsrc->writeout; - $tlpsrc->writeout(\*FILEHANDLE); +writes the textual representation of a C object to C, +or the filehandle if given: + + $tlpsrc->writeout; + $tlpsrc->writeout(\*FILEHANDLE); =item C -debugging function for comparison with tpm/tlps, will go away. -=item C -creates a zip file of the arch B files in the TLPOBJ -in $destdir (if not defined then TLPOBJ->zipdir is used). -The file name of the created zipfile is $zipname (if not -present $tlpobj->name.zip) +debugging function for comparison with C/C, will go away. + +=item C + +creates a zip file of the arch B files in the C +in C<$destdir> (if not defined then C<< TLPOBJ->zipdir >> is used). +The file name of the created zipfile is C<$zipname> (if not +present C<< $tlpobj->name.zip >>). -If the package contains "binfiles"; then zip files for +If the package contains C<"binfiles">, then zip files for all archs containing B the binfiles are created, and the zipfile name is C<$zipname.$arch.zip> -All the arch independent zip files B contain the -respective TLPOBJ file in - .tlpobj/$name.tlpobj -so C<$zipname.zip> does contain this tlpobj file, while -C<$zipname.$arch.zip> does NOT. +All the arch independent zip files B contain the respective +C file in C<.tlpobj/$name.tlpobj> so C<$zipname.zip> does +contain this tlpobj file, while C<$zipname.$arch.zip> does NOT. + +=item C -=item C recomputes the sizes based on the information present in C<$tltree>. -=item C +=item C + recomputes the revision based on the information present in C<$tltree>. -=item C +=item C + adds information from a C object (currently license, version, url, and updates docfiles with details and -languages tags if present in the Catalogue) +languages tags if present in the Catalogue). =item C -returns 1 if there are C, otherwise 0. + +returns C<1> if there are C, otherwise C<0>. =item C + If no argument is given returns the sum of C, C, C. @@ -909,16 +920,20 @@ If arguments are given, they are assumed to be architecture names, and it returns the above plus the sum of sizes of C for those architectures. -=item C<{add,remove}_{src,run,doc}files ( @files )> -adds or removes files to the respective list of files +=item C<{add,remove}_{src,run,doc}files(@files)> -=item C<{add,remove}_binfiles ($arch, @files)> -adds or removes files from the list of C for the given architecture +adds or removes files to the respective list of files. + +=item C<{add,remove}_binfiles($arch, @files)> + +adds or removes files from the list of C for the given architecture. + +=item C<{add,remove}_files($type, $files)> -=item C<{add,remove}_files ($type, $files)> adds or removes files for the given type (only for C, C, C). =item C + returns a list of all files of all types. =back diff --git a/Master/tlpkg/TeXLive/TLPSRC.pm b/Master/tlpkg/TeXLive/TLPSRC.pm index 71f5263c286..22c0d077b08 100644 --- a/Master/tlpkg/TeXLive/TLPSRC.pm +++ b/Master/tlpkg/TeXLive/TLPSRC.pm @@ -409,27 +409,27 @@ __END__ =head1 NAME -TeXLive::TLPSRC - TeX Live Package Source access module +C -- TeX Live Package Source access module =head1 SYNOPSIS - use TeXLive::TLPSRC; + use TeXLive::TLPSRC; - my $tlpsrc = TeXLive::TLPSRC->new( name => "foobar" ); - $tlpsrc->from_file("/some/tlpsrc/package.tlpsrc"); - $tlpsrc->from_file("package"); - $tlpsrc->writeout; - $tlpsrc->writeout(\*FILEHANDLE); + my $tlpsrc = TeXLive::TLPSRC->new(name => "foobar"); + $tlpsrc->from_file("/some/tlpsrc/package.tlpsrc"); + $tlpsrc->from_file("package"); + $tlpsrc->writeout; + $tlpsrc->writeout(\*FILEHANDLE); =head1 DESCRIPTION -The L module provide access to TeX Live Package Source +The C 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. =head1 FILE SPECIFICATION -A L file has to consist of non-empty lines (except that initial +A C file has to consist of non-empty lines (except that initial and final empty lines are ignored) of the form I @@ -440,11 +440,11 @@ C, or C. The interpretation of the respective I are: -=over +=over 6 =item C -identifies the package, C must consist only of [-_a-zA-Z0-9] +identifies the package, C must consist only of C<[-_a-zA-Z0-9]>. =item C @@ -461,8 +461,9 @@ package can be found in the TeX Catalogue. =item C -gives a one line description of the package. Susequent entries will overwrite -the former ones. In TeX Live only used for collections and schemes. +gives a one line description of the package. Subsequent entries will +overwrite the former ones. In TeX Live only used for collections and +schemes. =item C @@ -484,28 +485,29 @@ the following possible values are understood by the installers: =over 6 -=item C> +=item C IC<.map> -enables the font map file I in the F file. +enables the font map file IC<.map> in the C file. -=item C> +=item C IC<.map> -enables the font map file I> for Mixed mode in the F file. +enables the font map file IC<.map> for Mixed mode in the +C file. =item C activates all the hyphenation patterns found in -F in the generated -F file. +C in the generated +C file. =item C -activates all the formats present in F -in the generated F file. +activates all the formats present in C +in the generated C file. =back -=item C<(src|run|doc|bin)pattern I> +=item C<(src|run|doc|bin)pattern> I adds a pattern (see below) to the respective list of patterns. @@ -516,37 +518,38 @@ adds a pattern (see below) to the respective list of patterns. Patterns specify which files are to be included into a C at expansion time. Patterns are of the form - [PREFIX]TYPE PAT + [PREFIX]TYPE PAT where - PREFIX = + | +! | ! - TYPE = t | f | d | r + PREFIX = + | +! | ! + TYPE = t | f | d | r The meaning of the various pattern types is =over -=item C +=item CI -includes all files which match C where B the last component -of C can contain the usual glob characters * and ? (but no others!). +includes all files which match C where B the last +component of C can contain the usual glob characters C<*> and +C (but no others!). -=item C +=item CI includes all the files in and below the directory specified as C. -=item C +=item CI includes all the files in and below all directories of the form - word1/word2/.../wordN/.../any/dirs/.../wordL/ + word1/word2/.../wordN/.../any/dirs/.../wordL/ 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 C as another directory. -=item C +=item C I includes all files matching the regexp C @@ -557,73 +560,75 @@ patterns have the prefix C<+> (e.g., C<+f ...>), then the following patterns are B added at expansion time (but never written to the textual representation): -=over +=over 6 -=item runpattern +=item C for runpatterns of category C - t texmf-dist topdir $name + t texmf-dist topdir $name -where C is one of: bibtex context dvips fonts makeindex metafont -metapost mft omega scripts tex vtex. +where C is one of: C, C, C, C, +C, C, C, C, C, C, +C, C. For other categories B patterns are automatically added to the list of runpatterns. -=item docpattern +=item C -for docpattern of category C +for C of category C - t texmf-dist doc $name + t texmf-dist doc $name -for docpattern of category C +for C of category C - t texmf-doc doc $name + t texmf-doc doc $name -=item srcpattern +=item C -for srcpattern of category C +for C of category C - t texmf-dist source $name + t texmf-dist source $name -for srcpattern of category C +for C of category C - t texmf-doc source $name + t texmf-doc source $name =back binpatterns are never automatically added. -If the C contains the symbol ! the meaning of the pattern is +If the C contains the symbol C the meaning of the pattern is reversed, i.e., file matching this pattern are removed from the list of included files. =head2 arch expansion -In case the string C<${ARCH}> occurs in one C it is +In case the string C<${>IC<}> occurs in one C it is automatically expanded to the respective architecture. -=head2 bat/exe/dll for win32 +=head2 C for win32 -For C of the form C (i.e., also for a -binpattern of the form C) files F, -F, and F are also matched. +For Cs of the form C (i.e., also for a +binpattern of the form C) files C, +C, and C are also matched. -The above two properties allows to capture the binaries for all architectures -in one binpattern +The above two properties allows to capture the binaries for all +architectures in one binpattern - binpattern f bin/${ARCH}/dvips + binpattern f bin/${ARCH}/dvips -and would get F into the runfiles for arch=win32. +and would get C into the runfiles for C. -Note that the bat/exe expansion B works for patterns of the C type! +Note that the C/C expansion B works for patterns of +the C type! =head1 MEMBER ACCESS FUNCTIONS For any of the above I a function - $tlpsrc->key + $tlpsrc->key is available, which returns the current value when called without an argument, and sets the respective value when called with an argument. @@ -642,33 +647,37 @@ The following functions can be called for an C object: =over =item C -(constructor) returns a new C object. The arguments to the C -constructor can be in the usual hash representation for the different keys -above: - $tlpsrc = TLPSRC->new ( name => "foobar", shortdesc => "The foobar package" ); +The constructor C returns a new C object. The arguments +to the C constructor can be in the usual hash representation for +the different keys above: + + $tlpsrc=TLPSRC->new(name => "foobar", shortdesc => "The foobar package"); =item C + reads a C file from disk. C can either be a full path (if it's readable, it's used), or just a package identifier such as C. In the latter case, the directory searched is the C sibling of the C package directory where C was found. - $tlpsrc = new TeXLive::TLPSRC; - $tlpsrc->from_file("/path/to/the/tlpsrc/somepkg.tlpsrc"); - $tlpsrc->from_file("somepkg"); + $tlpsrc=new TeXLive::TLPSRC; + $tlpsrc->from_file("/path/to/the/tlpsrc/somepkg.tlpsrc"); + $tlpsrc->from_file("somepkg"); =item C + writes the textual representation of a C object to stdout, or the filehandle if given: - $tlpsrc->writeout; - $tlpsrc->writeout(\*FILEHANDLE); + $tlpsrc->writeout; + $tlpsrc->writeout(\*FILEHANDLE); =item C + creates a C object from a C object and a C object. This function does the necessary work to expand the manual data and -enrich it which the actual content from <$tltree> to a C object. +enrich it which the actual content from C<$tltree> to a C object. =back -- cgit v1.2.3