Installer: Early check whether the installation directory is writable
[msysgit.git] / bin / pod2html
blobefbff5133732c58833b7d328cf009b07dd940656
1 #!/usr/bin/perl
2 eval 'exec /usr/bin/perl -S $0 ${1+"$@"}'
3 if $running_under_some_shell;
4 =pod
6 =head1 NAME
8 pod2html - convert .pod files to .html files
10 =head1 SYNOPSIS
12 pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
13 --podpath=<name>:...:<name> --podroot=<name>
14 --libpods=<name>:...:<name> --recurse --norecurse --verbose
15 --index --noindex --title=<name>
17 =head1 DESCRIPTION
19 Converts files from pod format (see L<perlpod>) to HTML format.
21 =head1 ARGUMENTS
23 pod2html takes the following arguments:
25 =over 4
27 =item help
29 --help
31 Displays the usage message.
33 =item htmlroot
35 --htmlroot=name
37 Sets the base URL for the HTML files. When cross-references are made,
38 the HTML root is prepended to the URL.
40 =item infile
42 --infile=name
44 Specify the pod file to convert. Input is taken from STDIN if no
45 infile is specified.
47 =item outfile
49 --outfile=name
51 Specify the HTML file to create. Output goes to STDOUT if no outfile
52 is specified.
54 =item podroot
56 --podroot=name
58 Specify the base directory for finding library pods.
60 =item podpath
62 --podpath=name:...:name
64 Specify which subdirectories of the podroot contain pod files whose
65 HTML converted forms can be linked-to in cross-references.
67 =item libpods
69 --libpods=name:...:name
71 List of page names (eg, "perlfunc") which contain linkable C<=item>s.
73 =item netscape
75 --netscape
77 Use Netscape HTML directives when applicable.
79 =item nonetscape
81 --nonetscape
83 Do not use Netscape HTML directives (default).
85 =item index
87 --index
89 Generate an index at the top of the HTML file (default behaviour).
91 =item noindex
93 --noindex
95 Do not generate an index at the top of the HTML file.
98 =item recurse
100 --recurse
102 Recurse into subdirectories specified in podpath (default behaviour).
104 =item norecurse
106 --norecurse
108 Do not recurse into subdirectories specified in podpath.
110 =item title
112 --title=title
114 Specify the title of the resulting HTML file.
116 =item verbose
118 --verbose
120 Display progress messages.
122 =back
124 =head1 AUTHOR
126 Tom Christiansen, E<lt>tchrist@perl.comE<gt>.
128 =head1 BUGS
130 See L<Pod::Html> for a list of known bugs in the translator.
132 =head1 SEE ALSO
134 L<perlpod>, L<Pod::Html>
136 =head1 COPYRIGHT
138 This program is distributed under the Artistic License.
140 =cut
142 use Pod::Html;
144 pod2html @ARGV;