source: for-distributions/trunk/bin/windows/perl/bin/pod2html.bat@ 14489

Last change on this file since 14489 was 14489, checked in by oranfry, 17 years ago

upgrading to perl 5.8

File size: 2.7 KB
Line 
1@rem = '--*-Perl-*--
2@echo off
3if "%OS%" == "Windows_NT" goto WinNT
4perl -x -S "%0" %1 %2 %3 %4 %5 %6 %7 %8 %9
5goto endofperl
6:WinNT
7perl -x -S %0 %*
8if NOT "%COMSPEC%" == "%SystemRoot%\system32\cmd.exe" goto endofperl
9if %errorlevel% == 9009 echo You do not have Perl in your PATH.
10if errorlevel 1 goto script_failed_so_exit_with_non_zero_val 2>nul
11goto endofperl
12@rem ';
13#!perl
14#line 15
15 eval 'exec c:\shaoqunWu\perl\bin\perl.exe -S $0 ${1+"$@"}'
16 if $running_under_some_shell;
17=pod
18
19=head1 NAME
20
21pod2html - convert .pod files to .html files
22
23=head1 SYNOPSIS
24
25 pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
26 --podpath=<name>:...:<name> --podroot=<name>
27 --libpods=<name>:...:<name> --recurse --norecurse --verbose
28 --index --noindex --title=<name>
29
30=head1 DESCRIPTION
31
32Converts files from pod format (see L<perlpod>) to HTML format.
33
34=head1 ARGUMENTS
35
36pod2html takes the following arguments:
37
38=over 4
39
40=item help
41
42 --help
43
44Displays the usage message.
45
46=item htmlroot
47
48 --htmlroot=name
49
50Sets the base URL for the HTML files. When cross-references are made,
51the HTML root is prepended to the URL.
52
53=item infile
54
55 --infile=name
56
57Specify the pod file to convert. Input is taken from STDIN if no
58infile is specified.
59
60=item outfile
61
62 --outfile=name
63
64Specify the HTML file to create. Output goes to STDOUT if no outfile
65is specified.
66
67=item podroot
68
69 --podroot=name
70
71Specify the base directory for finding library pods.
72
73=item podpath
74
75 --podpath=name:...:name
76
77Specify which subdirectories of the podroot contain pod files whose
78HTML converted forms can be linked-to in cross-references.
79
80=item libpods
81
82 --libpods=name:...:name
83
84List of page names (eg, "perlfunc") which contain linkable C<=item>s.
85
86=item netscape
87
88 --netscape
89
90Use Netscape HTML directives when applicable.
91
92=item nonetscape
93
94 --nonetscape
95
96Do not use Netscape HTML directives (default).
97
98=item index
99
100 --index
101
102Generate an index at the top of the HTML file (default behaviour).
103
104=item noindex
105
106 --noindex
107
108Do not generate an index at the top of the HTML file.
109
110
111=item recurse
112
113 --recurse
114
115Recurse into subdirectories specified in podpath (default behaviour).
116
117=item norecurse
118
119 --norecurse
120
121Do not recurse into subdirectories specified in podpath.
122
123=item title
124
125 --title=title
126
127Specify the title of the resulting HTML file.
128
129=item verbose
130
131 --verbose
132
133Display progress messages.
134
135=back
136
137=head1 AUTHOR
138
139Tom Christiansen, E<lt>[email protected]<gt>.
140
141=head1 BUGS
142
143See L<Pod::Html> for a list of known bugs in the translator.
144
145=head1 SEE ALSO
146
147L<perlpod>, L<Pod::Html>
148
149=head1 COPYRIGHT
150
151This program is distributed under the Artistic License.
152
153=cut
154
155use Pod::Html;
156
157pod2html @ARGV;
158
159__END__
160:endofperl
Note: See TracBrowser for help on using the repository browser.