.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.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" ''
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
. if \nF \{
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\"
.\" 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 "POD2DOCBOOK 1p"
.TH POD2DOCBOOK 1p "2015-06-08" "perl v5.20.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
pod2docbook \- Convert POD data to DocBook SGML
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
pod2docbook [\fB\-\-help\fR]
[\fB\-\-doctype\fR=\fBarticle\fR|\fBchapter\fR|\fBsection\fR|\fBrefentry\fR]
[\fB\-\-title\fR=\fItitle\fR] [\fB\-\-spaces\fR=\fI#\ spaces\ per\ indent\ level\fR]
[\fB\-\-fix\-double\-quotes\fR] [\fB\-\-no\-header\fR]
[\fB\-\-base\-id\fR=\fIidstring\fR]
[\fIinfile\fR\ [\fIoutfile\fR]]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBpod2docbook\fR converts files from pod format (see perlpod) to
DocBook 4.2 \s-1SGML \s0(see ). The program itself
is merely a driver for the Pod::2::DocBook class; if you're interested in
details of pod-to-SGML translation see Pod::2::DocBook.
.SH "OPTIONS AND ARGUMENTS"
.IX Header "OPTIONS AND ARGUMENTS"
.IP "[\fB\-\-help\fR]" 4
.IX Item "[--help]"
Print usage and exit.
.IP "[\fB\-\-doctype\fR=\fBarticle\fR|\fBchapter\fR|\fBsection\fR|\fBrefentry\fR]" 4
.IX Item "[--doctype=article|chapter|section|refentry]"
Specifies the document type for the output file; the default is
\&\fBsection\fR.
.IP "[\fB\-\-title\fR=\fItitle\fR]" 4
.IX Item "[--title=title]"
Specifies the document title. The default is \fIinfile\fR, if it is
supplied, or empty string otherwise.
.IP "[\fB\-\-spaces\fR=\fI# spaces per indent level\fR]" 4
.IX Item "[--spaces=# spaces per indent level]"
Specifies the number of spaces per indent level in the \s-1SGML\s0 output;
the default is 2.
.IP "[\fB\-\-fix\-double\-quotes\fR]" 4
.IX Item "[--fix-double-quotes]"
Replace pairs of double quotes in regular paragraphs with and
(see Pod::2::DocBook for details).
.IP "[\fB\-\-no\-header\fR]" 4
.IX Item "[--no-header]"
Omit the \s-1DOCTYPE\s0 line from the output.
.IP "\fIinfile\fR" 4
.IX Item "infile"
The name of the file from which to read pod source; if not supplied,
\&\s-1STDIN\s0 is used for input.
.IP "\fIoutfile\fR" 4
.IX Item "outfile"
The name of the file to which to write \s-1SGML\s0; if not supplied, \s-1STDOUT\s0
is used for output.
.IP "[\fB\-\-base\-id\fR=\fIidstring\fR]" 4
.IX Item "[--base-id=idstring]"
The root element of the \fB\-\-doctype\fR will have the \fIidstring\fR set for attribute \fIid\fR.
The default is an input file name \*(L"cleaned up\*(R" to conform with \s-1XML\s0 restriction for
characteds used in id strings. (\s-1SEE \s0)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
pod2docbook, perlpod, Pod::DocBook,
\&\s-1SVN\s0 repo \- ,
,
\&\fIdoc/\fR + \fIexamples/pod2docbook\-docbook/\fR for Pod::2::DocBook
DocBook documentation
.PP
DocBook related links: ,
,
.SH "AUTHOR"
.IX Header "AUTHOR"
Alligator Descartes wrote a module called
Pod::2::DocBook, which was later maintained by Jan Iven
. That module was based on the original pod2html
by Tom Christiansen .
.PP
Nandu Shah wrote Pod::DocBook, which is
unrelated to the previous module (even though they both perform the
same function). ()
.PP
Jozef Kutej renamed the module to Pod::2::DocBook
because Nandus version was buried in the \s-1CPAN\s0 archive as an
\&\*(L"\s-1UNAUTHORIZED RELEASE\*(R".\s0
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2004, Nandu Shah
.PP
Copyright 2008, Jozef Kutej
.PP
This library is free software; you may redistribute it and/or modify
it under the same terms as Perl itself