☺唐鳳☻ > Pod-HtmlHelp > pod2chm

Download:
Pod-HtmlHelp-1.1.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

pod2chm - convert .pod files to .chm files

SYNOPSIS ^

    pod2chm --help --htmlroot=<name> --infile=<name> --outfile=<name>
            --podpath=<name>:...:<name> --podroot=<name>
            --libpods=<name>:...:<name> --recurse --norecurse --verbose
            --index --noindex --title=<name>

DESCRIPTION ^

Converts files from pod format (see perlpod) to Microsoft HtmlHelp format (.chm).

ARGUMENTS ^

pod2chm takes the following arguments:

help
  --help

Displays the usage message.

htmlroot
  --htmlroot=name

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

infile
  --infile=name

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

outfile
  --outfile=name

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

podroot
  --podroot=name

Specify the base directory for finding library pods.

podpath
  --podpath=name:...:name

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

libpods
  --libpods=name:...:name

List of page names (eg, "perlfunc") which contain linkable =items.

netscape
  --netscape

Use Netscape HTML directives when applicable.

nonetscape
  --nonetscape

Do not use Netscape HTML directives (default).

index
  --index

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

noindex
  --noindex

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

recurse
  --recurse

Recurse into subdirectories specified in podpath (default behaviour).

norecurse
  --norecurse

Do not recurse into subdirectories specified in podpath.

title
  --title=title

Specify the title of the resulting HTML file.

verbose
  --verbose

Display progress messages.

AUTHOR ^

Autrijus Tang, <autrijus@autrijus.org>.

BUGS ^

See Pod::HtmlHelp for a list of known bugs in the translator.

SEE ALSO ^

perlpod, Pod::HtmlHelp

COPYRIGHT ^

Copyright 2001, 2002 by Autrijus Tang <autrijus@autrijus.org>.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

See http://www.perl.com/perl/misc/Artistic.html

syntax highlighting: