xref: /openbsd/gnu/usr.bin/perl/ext/Pod-Html/bin/pod2html (revision e0680481)

=pod

=head1 NAME

pod2html - convert .pod files to .html files

=head1 SYNOPSIS

    pod2html --help --htmldir=<name> --htmlroot=<URL>
             --infile=<name> --outfile=<name>
             --podpath=<name>:...:<name> --podroot=<name>
             --cachedir=<name> --flush --recurse --norecurse
             --quiet --noquiet --verbose --noverbose
             --index --noindex --backlink --nobacklink
             --header --noheader --poderrors --nopoderrors
             --css=<URL> --title=<name>

=head1 DESCRIPTION

Converts files from pod format (see L<perlpod>) to HTML format.

=head1 ARGUMENTS

pod2html takes the following arguments:

=over 4

=item backlink

  --backlink
  --nobacklink

Turn =head1 directives into links pointing to the top of the HTML file.
--nobacklink (which is the default behavior) does not create these backlinks.

=item cachedir

  --cachedir=name

Specify which directory is used for storing cache. Default directory is the
current working directory.

=item css

  --css=URL

Specify the URL of cascading style sheet to link from resulting HTML file.
Default is none style sheet.

=item flush

  --flush

Flush the cache.

=item header

  --header
  --noheader

Create header and footer blocks containing the text of the "NAME" section.
--noheader -- which is the default behavior -- does not create header or footer
blocks.

=item help

  --help

Displays the usage message.

=item htmldir

  --htmldir=name

Sets the directory to which all cross references in the resulting HTML file
will be relative. Not passing this causes all links to be absolute since this
is the value that tells Pod::Html the root of the documentation tree.

Do not use this and --htmlroot in the same call to pod2html; they are mutually
exclusive.

=item htmlroot

  --htmlroot=URL

Sets the base URL for the HTML files.  When cross-references are made, the
HTML root is prepended to the URL.

Do not use this if relative links are desired: use --htmldir instead.

Do not pass both this and --htmldir to pod2html; they are mutually exclusive.

=item index

  --index

Generate an index at the top of the HTML file (default behaviour).

=over 4

=item noindex

  --noindex

Do not generate an index at the top of the HTML file.

=back

=item infile

  --infile=name

Specify the pod file to convert.  Input is taken from STDIN if no
infile is specified.

=item outfile

  --outfile=name

Specify the HTML file to create.  Output goes to STDOUT if no outfile
is specified.

=item poderrors

  --poderrors
  --nopoderrors

Include a "POD ERRORS" section in the outfile if there were any POD errors in
the infile (default behaviour).  --nopoderrors does not create this "POD
ERRORS" section.

=item podpath

  --podpath=name:...:name

Specify which subdirectories of the podroot contain pod files whose
HTML converted forms can be linked-to in cross-references.

=item podroot

  --podroot=name

Specify the base directory for finding library pods.

=item quiet

  --quiet
  --noquiet

Don't display mostly harmless warning messages.  --noquiet -- which is the
default behavior -- I<does> display these mostly harmless warning messages (but
this is not the same as "verbose" mode).

=item recurse

  --recurse
  --norecurse

Recurse into subdirectories specified in podpath (default behaviour).
--norecurse does not recurse into these subdirectories.

=item title

  --title=title

Specify the title of the resulting HTML file.

=item verbose

  --verbose
  --noverbose

Display progress messages. --noverbose -- which is the default behavior --
does not display these progress messages.

=back

=head1 AUTHOR

Tom Christiansen, E<lt>tchrist@perl.comE<gt>.

=head1 BUGS

See L<Pod::Html> for a list of known bugs in the translator.

=head1 SEE ALSO

L<perlpod>, L<Pod::Html>

=head1 COPYRIGHT

This program is distributed under the Artistic License.

=cut

BEGIN { pop @INC if $INC[-1] eq '.' }
use Pod::Html;

pod2html @ARGV;