the road to new texdoc handling:

- allow tags "details" and "language" for docfiles
- allow catalogue-* keys in a TLPOBJ file
- TLPOBJ.pm: add update_from_catalogue which updates some information
- adapt the tlpsrc2tlpdb script to take another argument -catalogue
  in which case the database is build with catalogue information included


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

1 files changed, 52 insertions, 16 deletions

diff --git a/Master/tlpkg/man/TeXLive-TLPOBJ.1 b/Master/tlpkg/man/TeXLive-TLPOBJ.1
index e9d47d3f9cf..5ce64690b55 100644
--- a/Master/tlpkg/man/TeXLive-TLPOBJ.1
+++ b/Master/tlpkg/man/TeXLive-TLPOBJ.1
@@ -128,8 +128,8 @@
 .rm #[ #] #H #V #F C
 .\" ========================================================================
 .\"
-.IX Title "TeXLive::TLPOBJ 3"
-.TH TeXLive::TLPOBJ 3 "2007-06-27" "perl v5.8.8" "User Contributed Perl Documentation"
+.IX Title "TLPOBJ 3"
+.TH TLPOBJ 3 "2007-07-12" "perl v5.8.8" "User Contributed Perl Documentation"
 .SH "NAME"
 TeXLive::TLPOBJ \- TeX Live Package Object access module
 .SH "SYNOPSIS"
@@ -150,23 +150,46 @@ files describing a self-contained package.
 Please see TeXLive::TLPSRC documentation for the specification. The
 only differences are that the various \f(CW*pattern\fR keys are invalid, and
 instead there are the respective \f(CW*files\fR keys described below. Furthermore
-one more \fIkey\fR is allowed, \f(CW\*(C`revision\*(C'\fR which specifies the maximum of 
-all last changed revision of files contained in the package.
+some more \fIkeys\fR is allowed: \f(CW\*(C`revision\*(C'\fR which specifies the maximum of 
+all last changed revision of files contained in the package, and anything
+starting with \f(CW\*(C`catalogue\-\*(C'\fR specifying information coming from the
+TeX Catalogue.
 .PP
 All these keys have in common that the are followed by a list of files
 \&\fBintended\fR by one space. They differ only in the first line itself
 (described below).
-.ie n .IP """srcfiles""\fR, \f(CW""docfiles""\fR, \f(CW""runfiles""" 4
-.el .IP "\f(CWsrcfiles\fR, \f(CWdocfiles\fR, \f(CWrunfiles\fR" 4
-.IX Item "srcfiles, docfiles, runfiles"
+.ie n .IP """srcfiles""\fR, \f(CW""runfiles""" 4
+.el .IP "\f(CWsrcfiles\fR, \f(CWrunfiles\fR" 4
+.IX Item "srcfiles, runfiles"
 each of these three items contains in addition the sum of sizes of the
 single files (currently in byte, but this may change).
 .Sp
-.Vb 3
+.Vb 2
 \&        srcfiles size=NNNNNN
-\&        docfiles size=NNNNNN
 \&        runfiles size=NNNNNN
 .Ve
+.ie n .IP """docfiles""" 4
+.el .IP "\f(CWdocfiles\fR" 4
+.IX Item "docfiles"
+The docfiles line itself is similar to the \f(CW\*(C`srcfiles\*(C'\fR and \f(CW\*(C`runfiles\*(C'\fR lines
+above:
+.Sp
+.Vb 1
+\&        docfiles size=NNNNNN
+.Ve
+.Sp
+But the lines listing the files are allowed to have additional tags:
+.Sp
+.Vb 6
+\&        /\-\-\-\-\-\-\- 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"
+\&        |...
+.Ve
+.Sp
+Currently only the tags \f(CW\*(C`details\*(C'\fR and \f(CW\*(C`language\*(C'\fR are allowed.
 .ie n .IP """runfiles""" 4
 .el .IP "\f(CWrunfiles\fR" 4
 .IX Item "runfiles"
@@ -215,7 +238,14 @@ For any of the \fIkeys\fR a function
 .Ve
 .PP
 is available, which returns the current value when called without an argument,
-and sets the respective value when called with an argument.
+and sets the respective value when called with an argument. For the 
+TeX Catalogue Data the function
+.PP
+.Vb 1
+\&        $tlpobj\->cataloguedata
+.Ve
+.PP
+returns and takes as argument a hash.
 .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, \f(CW\*(C`revision\*(C'\fR are single scalars.
@@ -305,6 +335,12 @@ recomputes the sizes based on the information present in \f(CW$tltree\fR.
 .el .IP "\f(CWrecompute_revision ($tltree)\fR" 4
 .IX Item "recompute_revision ($tltree)"
 recomputes the revision based on the information present in \f(CW$tltree\fR.
+.ie n .IP """update_from_catalogue ($texcatalogue)""" 4
+.el .IP "\f(CWupdate_from_catalogue ($texcatalogue)\fR" 4
+.IX Item "update_from_catalogue ($texcatalogue)"
+adds information from a \f(CW\*(C`TeXCatalogue\*(C'\fR object 
+(currently license, version, url, and updates docfiles with details and
+languages tags if present in the Catalogue)
 .ie n .IP """is_arch_dependent""" 4
 .el .IP "\f(CWis_arch_dependent\fR" 4
 .IX Item "is_arch_dependent"
@@ -328,12 +364,12 @@ adds or removes files from the list of \f(CW\*(C`binfiles\*(C'\fR for the given
 .el .IP "\f(CW{add,remove}_files ($type, $files)\fR" 4
 .IX Item "{add,remove}_files ($type, $files)"
 adds or removes files for the given type (only for \f(CW\*(C`run\*(C'\fR, \f(CW\*(C`src\*(C'\fR, \f(CW\*(C`doc\*(C'\fR).
-.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::TLPSRC,
-TeXLive::TLPDB, TeXLive::TLTREE.
+TeXLive::TLPDB, TeXLive::TLTREE, TeXLive::TeXCatalogue.
+.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.