codekingpro/portable-devtools

1#!/usr/bin/perl2    eval 'exec /usr/bin/perl -S $0 ${1+"$@"}'3	if 0; # ^ Run only under a shell4=pod5 6=head1 NAME7 8pod2html - convert .pod files to .html files9 10=head1 SYNOPSIS11 12    pod2html --help --htmldir=<name> --htmlroot=<URL>13             --infile=<name> --outfile=<name>14             --podpath=<name>:...:<name> --podroot=<name>15             --cachedir=<name> --flush --recurse --norecurse16             --quiet --noquiet --verbose --noverbose17             --index --noindex --backlink --nobacklink18             --header --noheader --poderrors --nopoderrors19             --css=<URL> --title=<name>20 21=head1 DESCRIPTION22 23Converts files from pod format (see L<perlpod>) to HTML format.24 25=head1 ARGUMENTS26 27pod2html takes the following arguments:28 29=over 430 31=item backlink32 33  --backlink34  --nobacklink35 36Turn =head1 directives into links pointing to the top of the HTML file.37--nobacklink (which is the default behavior) does not create these backlinks.38 39=item cachedir40 41  --cachedir=name42 43Specify which directory is used for storing cache. Default directory is the44current working directory.45 46=item css47 48  --css=URL49 50Specify the URL of cascading style sheet to link from resulting HTML file.51Default is none style sheet.52 53=item flush54 55  --flush56 57Flush the cache.58 59=item header60 61  --header62  --noheader63 64Create header and footer blocks containing the text of the "NAME" section.65--noheader -- which is the default behavior -- does not create header or footer66blocks.67 68=item help69 70  --help71 72Displays the usage message.73 74=item htmldir75 76  --htmldir=name77 78Sets the directory to which all cross references in the resulting HTML file79will be relative. Not passing this causes all links to be absolute since this80is the value that tells Pod::Html the root of the documentation tree.81 82Do not use this and --htmlroot in the same call to pod2html; they are mutually83exclusive.84 85=item htmlroot86 87  --htmlroot=URL88 89Sets the base URL for the HTML files.  When cross-references are made, the90HTML root is prepended to the URL.91 92Do not use this if relative links are desired: use --htmldir instead.93 94Do not pass both this and --htmldir to pod2html; they are mutually exclusive.95 96=item index97 98  --index99 100Generate an index at the top of the HTML file (default behaviour).101 102=over 4103 104=item noindex105 106  --noindex107 108Do not generate an index at the top of the HTML file.109 110=back111 112=item infile113 114  --infile=name115 116Specify the pod file to convert.  Input is taken from STDIN if no117infile is specified.118 119=item outfile120 121  --outfile=name122 123Specify the HTML file to create.  Output goes to STDOUT if no outfile124is specified.125 126=item poderrors127 128  --poderrors129  --nopoderrors130 131Include a "POD ERRORS" section in the outfile if there were any POD errors in132the infile (default behaviour).  --nopoderrors does not create this "POD133ERRORS" section.134 135=item podpath136 137  --podpath=name:...:name138 139Specify which subdirectories of the podroot contain pod files whose140HTML converted forms can be linked-to in cross-references.141 142=item podroot143 144  --podroot=name145 146Specify the base directory for finding library pods.147 148=item quiet149 150  --quiet151  --noquiet152 153Don't display mostly harmless warning messages.  --noquiet -- which is the154default behavior -- I<does> display these mostly harmless warning messages (but155this is not the same as "verbose" mode).156 157=item recurse158 159  --recurse160  --norecurse161 162Recurse into subdirectories specified in podpath (default behaviour).163--norecurse does not recurse into these subdirectories.164 165=item title166 167  --title=title168 169Specify the title of the resulting HTML file.170 171=item verbose172 173  --verbose174  --noverbose175 176Display progress messages. --noverbose -- which is the default behavior --177does not display these progress messages.178 179=back180 181=head1 AUTHOR182 183Tom Christiansen, E<lt>tchrist@perl.comE<gt>.184 185=head1 BUGS186 187See L<Pod::Html> for a list of known bugs in the translator.188 189=head1 SEE ALSO190 191L<perlpod>, L<Pod::Html>192 193=head1 COPYRIGHT194 195This program is distributed under the Artistic License.196 197=cut198 199BEGIN { pop @INC if $INC[-1] eq '.' }200use Pod::Html;201 202pod2html @ARGV;203