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