This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Purge references to --netscape and --libpods, no longer in Pod::Html
[perl5.git] / ext / Pod-Html / bin / pod2html
1 =pod
2
3 =head1 NAME
4
5 pod2html - convert .pod files to .html files
6
7 =head1 SYNOPSIS
8
9     pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
10              --podpath=<name>:...:<name> --podroot=<name>
11              --recurse --norecurse --verbose
12              --index --noindex --title=<name>
13
14 =head1 DESCRIPTION
15
16 Converts files from pod format (see L<perlpod>) to HTML format.
17
18 =head1 ARGUMENTS
19
20 pod2html takes the following arguments:
21
22 =over 4
23
24 =item help
25
26   --help
27
28 Displays the usage message.
29
30 =item htmlroot
31
32   --htmlroot=name
33
34 Sets the base URL for the HTML files.  When cross-references are made,
35 the HTML root is prepended to the URL.
36
37 =item infile
38
39   --infile=name
40
41 Specify the pod file to convert.  Input is taken from STDIN if no
42 infile is specified.
43
44 =item outfile
45
46   --outfile=name
47
48 Specify the HTML file to create.  Output goes to STDOUT if no outfile
49 is specified.
50
51 =item podroot
52
53   --podroot=name
54
55 Specify the base directory for finding library pods.
56
57 =item podpath
58
59   --podpath=name:...:name
60
61 Specify which subdirectories of the podroot contain pod files whose
62 HTML converted forms can be linked-to in cross-references.
63
64 =item index
65
66   --index
67
68 Generate an index at the top of the HTML file (default behaviour).
69
70 =item noindex
71
72   --noindex
73
74 Do not generate an index at the top of the HTML file.
75
76
77 =item recurse
78
79   --recurse
80
81 Recurse into subdirectories specified in podpath (default behaviour).
82
83 =item norecurse
84
85   --norecurse
86
87 Do not recurse into subdirectories specified in podpath.
88
89 =item title
90
91   --title=title
92
93 Specify the title of the resulting HTML file.
94
95 =item verbose
96
97   --verbose
98
99 Display progress messages.
100
101 =back
102
103 =head1 AUTHOR
104
105 Tom Christiansen, E<lt>tchrist@perl.comE<gt>.
106
107 =head1 BUGS
108
109 See L<Pod::Html> for a list of known bugs in the translator.
110
111 =head1 SEE ALSO
112
113 L<perlpod>, L<Pod::Html>
114
115 =head1 COPYRIGHT
116
117 This program is distributed under the Artistic License.
118
119 =cut
120
121 use Pod::Html;
122
123 pod2html @ARGV;