r9804 - /trunk/libxml-sax-perl/update-perl-sax-parsers.8

Tue Nov 27 18:56:29 UTC 2007

Author: ntyni-guest
Date: Tue Nov 27 18:56:29 2007
New Revision: 9804

URL: http://svn.debian.org/wsvn/?sc=1&rev=9804
Log:
update manpage

Modified:
    trunk/libxml-sax-perl/update-perl-sax-parsers.8

Modified: trunk/libxml-sax-perl/update-perl-sax-parsers.8
URL: http://svn.debian.org/wsvn/trunk/libxml-sax-perl/update-perl-sax-parsers.8?rev=9804&op=diff
==============================================================================

--- trunk/libxml-sax-perl/update-perl-sax-parsers.8 (original)
+++ trunk/libxml-sax-perl/update-perl-sax-parsers.8 Tue Nov 27 18:56:29 2007
@@ -7,7 +7,7 @@
 .\" ----------------------------------------------------------------------
 .\"
 .\" ----------------------------------------------------------------------
-.TH UPDATE-PERL-SAX-PARSERS 8 "Sep 2003" "0.2" "Debian"
+.TH UPDATE-PERL-SAX-PARSERS 8 "Nov 2007" "0.3" "Debian"
 .\"
 .\" ----------------------------------------------------------------------
 .SH NAME
@@ -34,7 +34,7 @@
 .B update-perl-sax-parsers
 inserts, updates and removes individual Perl SAX parser module info
 files in the directory
-.I /etc/perl/XML/SAX/ParserDetails.d
+.I /var/lib/libxml-sax-perl/ParserDetails.d
 and the overall Perl SAX parser modules info file
 .IR /etc/perl/XML/SAX/ParserDetails.ini .
 .\"
@@ -44,16 +44,18 @@
 .B --add
 Adds the per-module info file for the indicated Perl SAX parser module
 to the directory
-.IR /etc/perl/XML/SAX/ParserDetails.d .
+.IR /var/lib/libxml-sax-perl/ParserDetails.d .
 .TP
 .B --remove
 Removes the per-module info file for Perl SAX parser module from the
 directory
-.IR /etc/perl/XML/SAX/ParserDetails.d .
+.IR /var/lib/libxml-sax-perl/ParserDetails.d .
 .TP
 .B --update
 updates the overall Perl SAX parser modules info file
 .IR /etc/perl/XML/SAX/ParserDetails.ini .
+The modules will be listed in an order of ascending priority. See
+the PARSER PRIORITIES section below.
 .TP
 .B --directory
 When used with
@@ -66,11 +68,22 @@
 .B --update
 indicates the ParserDetails.d directories to be used as source for
 generating the ParserDetails.ini file.  Default is
-.IR /etc/perl/XML/SAX/ParserDetails.d .
+.IR /var/lib/libxml-sax-perl/ParserDetails.d .
 .TP
 .B --file
 Indicates the ParserDetails.ini file up be updated.  Default is
 .IR /etc/perl/XML/SAX/ParserDetails.ini .
+.TP
+.B --priority XX
+Specifies the priority of the SAX parser module to be added
+removed. The default value is 50. The priority will be encoded
+to the filename of the ParserDetails.d entry. See the PARSER PRIORITIES
+section below.
+
+This option was added in version 0.3 of 
+.B update-perl-sax-parsers .
+Use the value "0" to disable the encoding and match the behaviour
+of earlier versions of the script.
 .TP
 .B --quiet
 Prevents any diagnostic output.
@@ -85,8 +98,30 @@
 Display the usage information and exits.
 .\"
 .\" ----------------------------------------------------------------------
+.SH PARSER PRIORITIES
+Starting with version 0.3 of 
+.B update-perl-sax-parsers ,
+the parsers are assigned a priority value that is encoded into the names
+of the files in the ParserDetails.d directory. Specifically, the file
+name will be "XX-Some::Module", where XX denotes the priority and Some::Module
+is the name of the parser module.
+
+When
+.B --update
+is called, the parsers are listed in an order of ascending priority
+into the 
+.IR ParserDetails.ini
+file. The last parser in the file, ie. the one with the highest priority,
+is the
+.B default
+XML::SAX parser.
+
+Parsers with the same priority are sorted alphabetically by their name.
+This is contrary to the behaviour of earlier versions, where the
+sort order was undefined and depended on underlying the file system.
+.\"
+.\" ----------------------------------------------------------------------
 .SH NOTE
-.TP
 Installing the original package from CPAN into /usr/local breaks the
 Debian package, since the former is in Perl's @INC before the latter.
 So, please don't do this.


