.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "POD2PROJDOCS 1p"
.TH POD2PROJDOCS 1p "2021-02-21" "perl v5.32.1" "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"
pod2projdocs \- generates CPAN like project documents from pod.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
pod2projdocs [options]
.PP
.Vb 11
\& Options:
\&    \-help         display this help and exist
\&    \-out          directory path that you want to generate documents into
\&    \-lib          your project\*(Aqs library\-root\-directory path
\&    \-title        your project\*(Aqs title
\&    \-desc         your project\*(Aqs description
\&    \-noindex      don\*(Aqt create index for all generated pages
\&    \-forcegen     generate documents each time, ignoring last modified timestamp
\&    \-nosourcecode suppress inclusion of the original source code in the generated output
\&    \-lang         set this language as xml:lang (default \*(Aqen\*(Aq)
\&    \-except       the files matches this regex won\*(Aqt be parsed
\&
\& You can set each option with their first character,
\& for example, you can write \-o instead of \-out.
\&
\& And you can generate documents from multiple library directories.
\&
\&  pod2projdocs \-o /path/to/outputdir \-l /path/to/lib1 \-l /path/to/lib2
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
generates \s-1CPAN\s0 like project documents from pod.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::ProjectDocs
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "Lyo Kato <lyo.kato@gmail.com>" 4
.IX Item "Lyo Kato <lyo.kato@gmail.com>"
.PD 0
.IP "Martin Gruner <https://github.com/mgruner> (current maintainer)" 4
.IX Item "Martin Gruner <https://github.com/mgruner> (current maintainer)"
.PD
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
.IP "© 2005 by Lyo Kato" 4
.IX Item "© 2005 by Lyo Kato"
.PD 0
.IP "© 2018 by Martin Gruner" 4
.IX Item "© 2018 by Martin Gruner"
.PD
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.5 or,
at your option, any later version of Perl 5 you may have available.