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