diff options
author | Graydon, Tracy <tracy.graydon@intel.com> | 2012-08-31 11:34:41 -0700 |
---|---|---|
committer | Graydon, Tracy <tracy.graydon@intel.com> | 2012-08-31 11:34:41 -0700 |
commit | d31c43e62fd5483de3604ef825522501eece7feb (patch) | |
tree | 176c351869a67eaf8347faba2e1f3a60fa9caeaf /bin/collateindex.pl.1 | |
download | docbook-style-dsssl-2.0alpha.tar.gz docbook-style-dsssl-2.0alpha.tar.bz2 docbook-style-dsssl-2.0alpha.zip |
TIVI-153: Add docbook-style-dssl as dep for iputilsHEADsubmit/trunk/20120831.183452accepted/trunk/20120904.1915411.0_branch2.0alpha1.0
Diffstat (limited to 'bin/collateindex.pl.1')
-rw-r--r-- | bin/collateindex.pl.1 | 214 |
1 files changed, 214 insertions, 0 deletions
diff --git a/bin/collateindex.pl.1 b/bin/collateindex.pl.1 new file mode 100644 index 0000000..a1b7020 --- /dev/null +++ b/bin/collateindex.pl.1 @@ -0,0 +1,214 @@ +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" +.\" 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. | will give a +.\" real vertical bar. \*(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-|\(bv\*(Tr +.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 "COLLATEINDEX 1" +.TH COLLATEINDEX 1 "2004-11-04" "docbook-dsssl 1.79" "DocBook DSSSL" +.SH "NAME" +collateindex.pl \- generate DocBook index files +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBcollateindex.pl\fR [\fB\-f\fR] [\fB\-g\fR] [\fB\-i\fR \fIid\fR] [\fB\-I\fR \fIscope\fR] [\fB\-N\fR] + [\fB\-o\fR \fIfile\fR] [\fB\-p\fR] [\fB\-P\fR \fIfile\fR] [\fB\-q\fR] [\fB\-s\fR \fIname\fR] + [\fB\-S\fR \fIscope\fR] [\fB\-t\fR \fIname\fR] [\fB\-x\fR] \fIfile\fR +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +\&\fBcollateindex.pl\fR creates index data for DocBook \s-1XML\s0 or \s-1SGML\s0 files. +.SH "OPTIONS" +.IX Header "OPTIONS" +.IP "\fB\-f\fR" 5 +.IX Item "-f" +Force the output file to be written, even if it appears to have been +edited by hand. +.IP "\fB\-g\fR" 5 +.IX Item "-g" +Group terms with IndexDiv based on the first letter of the term (or +its SortAs attribute). (This might not handle all language environments.) +.IP "\fB\-i\fR \fIid\fR" 5 +.IX Item "-i id" +The \s-1ID\s0 to use for the <index> tag. +.IP "\fB\-I\fR \fIscope\fR" 5 +.IX Item "-I scope" +The implied scope, must be \f(CW\*(C`all\*(C'\fR, \f(CW\*(C`local\*(C'\fR, or \f(CW\*(C`global\*(C'\fR. IndexTerms +which do not specify a scope will have the implied scope. If +unspecified, \f(CW\*(C`all\*(C'\fR is assumed. +.IP "\fB\-N\fR" 5 +.IX Item "-N" +New index (generates an empty index file). +.IP "\fB\-o\fR \fIfile\fR" 5 +.IX Item "-o file" +Output to \fIfile\fR. Defaults to \fIstdout\fR. +.IP "\fB\-p\fR" 5 +.IX Item "-p" +Link to points in the document. The default is to link to the closest +containing section. +.IP "\fB\-P\fR \fIfile\fR" 5 +.IX Item "-P file" +Read a preamble from \fIfile\fR. The contents of \fIfile\fR will be +inserted before the <index> tag. +.IP "\fB\-q\fR" 5 +.IX Item "-q" +Run quietly. +.IP "\fB\-s\fR \fIname\fR" 5 +.IX Item "-s name" +Name the IndexDiv that contains symbols. The default is \f(CW\*(C`Symbols\*(C'\fR. +Meaningless if \fB\-g\fR is not used. +.IP "\fB\-S\fR \fIscope\fR" 5 +.IX Item "-S scope" +Scope of the index, must be \f(CW\*(C`all\*(C'\fR, \f(CW\*(C`local\*(C'\fR, or \f(CW\*(C`global\*(C'\fR. If +unspecified, \f(CW\*(C`all\*(C'\fR is assumed. +.IP "\fB\-t\fR \fIname\fR" 5 +.IX Item "-t name" +Title for the index. +.IP "\fB\-x\fR" 5 +.IX Item "-x" +Make a SetIndex. +.IP "\fB\-V\fR" 5 +.IX Item "-V" +Print version number and exit. +.IP "\fIfile\fR" 5 +.IX Item "file" +The file containing index data generated with the DocBook \s-1DSSSL\s0 +\&\s-1HTML\s0 stylesheet (usually called \fI\s-1HTML\s0.index\fR). +.SH "EXAMPLE" +.IX Header "EXAMPLE" +\&\fBcollateindex.pl\fR \fB\-o\fR \fIindex.sgml\fR \fI\s-1HTML\s0.index\fR +.SH "EXIT STATUS" +.IX Header "EXIT STATUS" +.IP "\fB0\fR" 5 +.IX Item "0" +Success +.IP "\fB1\fR" 5 +.IX Item "1" +Failure +.SH "AUTHOR" +.IX Header "AUTHOR" +Norm Walsh <ndw@nwalsh.com> +.PP +Minor updates by Adam Di Carlo <adam@onshore.com> and Peter Eisentraut <peter_e@gmx.net> |