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