1=pod 2 3=head1 NAME 4 5pod2html - convert .pod files to .html files 6 7=head1 SYNOPSIS 8 9 pod2html --help --htmldir=<name> --htmlroot=<URL> 10 --infile=<name> --outfile=<name> 11 --podpath=<name>:...:<name> --podroot=<name> 12 --cachedir=<name> --flush --recurse --norecurse 13 --quiet --noquiet --verbose --noverbose 14 --index --noindex --backlink --nobacklink 15 --header --noheader --poderrors --nopoderrors 16 --css=<URL> --title=<name> 17 18=head1 DESCRIPTION 19 20Converts files from pod format (see L<perlpod>) to HTML format. 21 22=head1 ARGUMENTS 23 24pod2html takes the following arguments: 25 26=over 4 27 28=item backlink 29 30 --backlink 31 --nobacklink 32 33Turn =head1 directives into links pointing to the top of the HTML file. 34--nobacklink (which is the default behavior) does not create these backlinks. 35 36=item cachedir 37 38 --cachedir=name 39 40Specify which directory is used for storing cache. Default directory is the 41current working directory. 42 43=item css 44 45 --css=URL 46 47Specify the URL of cascading style sheet to link from resulting HTML file. 48Default is none style sheet. 49 50=item flush 51 52 --flush 53 54Flush the cache. 55 56=item header 57 58 --header 59 --noheader 60 61Create header and footer blocks containing the text of the "NAME" section. 62--noheader -- which is the default behavior -- does not create header or footer 63blocks. 64 65=item help 66 67 --help 68 69Displays the usage message. 70 71=item htmldir 72 73 --htmldir=name 74 75Sets the directory to which all cross references in the resulting HTML file 76will be relative. Not passing this causes all links to be absolute since this 77is the value that tells Pod::Html the root of the documentation tree. 78 79Do not use this and --htmlroot in the same call to pod2html; they are mutually 80exclusive. 81 82=item htmlroot 83 84 --htmlroot=URL 85 86Sets the base URL for the HTML files. When cross-references are made, the 87HTML root is prepended to the URL. 88 89Do not use this if relative links are desired: use --htmldir instead. 90 91Do not pass both this and --htmldir to pod2html; they are mutually exclusive. 92 93=item index 94 95 --index 96 97Generate an index at the top of the HTML file (default behaviour). 98 99=over 4 100 101=item noindex 102 103 --noindex 104 105Do not generate an index at the top of the HTML file. 106 107=back 108 109=item infile 110 111 --infile=name 112 113Specify the pod file to convert. Input is taken from STDIN if no 114infile is specified. 115 116=item outfile 117 118 --outfile=name 119 120Specify the HTML file to create. Output goes to STDOUT if no outfile 121is specified. 122 123=item poderrors 124 125 --poderrors 126 --nopoderrors 127 128Include a "POD ERRORS" section in the outfile if there were any POD errors in 129the infile (default behaviour). --nopoderrors does not create this "POD 130ERRORS" section. 131 132=item podpath 133 134 --podpath=name:...:name 135 136Specify which subdirectories of the podroot contain pod files whose 137HTML converted forms can be linked-to in cross-references. 138 139=item podroot 140 141 --podroot=name 142 143Specify the base directory for finding library pods. 144 145=item quiet 146 147 --quiet 148 --noquiet 149 150Don't display mostly harmless warning messages. --noquiet -- which is the 151default behavior -- I<does> display these mostly harmless warning messages (but 152this is not the same as "verbose" mode). 153 154=item recurse 155 156 --recurse 157 --norecurse 158 159Recurse into subdirectories specified in podpath (default behaviour). 160--norecurse does not recurse into these subdirectories. 161 162=item title 163 164 --title=title 165 166Specify the title of the resulting HTML file. 167 168=item verbose 169 170 --verbose 171 --noverbose 172 173Display progress messages. --noverbose -- which is the default behavior -- 174does not display these progress messages. 175 176=back 177 178=head1 AUTHOR 179 180Tom Christiansen, E<lt>tchrist@perl.comE<gt>. 181 182=head1 BUGS 183 184See L<Pod::Html> for a list of known bugs in the translator. 185 186=head1 SEE ALSO 187 188L<perlpod>, L<Pod::Html> 189 190=head1 COPYRIGHT 191 192This program is distributed under the Artistic License. 193 194=cut 195 196BEGIN { pop @INC if $INC[-1] eq '.' } 197use Pod::Html; 198 199pod2html @ARGV; 200