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