home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _419e7ca9dbdb6e5bb31cb0cf29ec8311 < prev    next >
Text File  |  2000-03-23  |  7KB  |  209 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Pod::Html - module to convert pod files to HTML</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Pod::Html - module to convert pod files to HTML</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#arguments">ARGUMENTS</A></LI>
  26.     <LI><A HREF="#example">EXAMPLE</A></LI>
  27.     <LI><A HREF="#environment">ENVIRONMENT</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  30.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>Pod::Html - module to convert pod files to HTML</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Linux</LI>
  43. <LI>Solaris</LI>
  44. <LI>Windows</LI>
  45. </UL>
  46. <HR>
  47. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  48. <PRE>
  49.     use Pod::Html;
  50.     pod2html([options]);</PRE>
  51. <P>
  52. <HR>
  53. <H1><A NAME="description">DESCRIPTION</A></H1>
  54. <P>Converts files from pod format (see <A HREF="../../lib/Pod/perlpod.html">the perlpod manpage</A>) to HTML format.  It
  55. can automatically generate indexes and cross-references, and it keeps
  56. a cache of things it knows how to cross-reference.</P>
  57. <P>
  58. <HR>
  59. <H1><A NAME="arguments">ARGUMENTS</A></H1>
  60. <P>Pod::Html takes the following arguments:</P>
  61. <DL>
  62. <DT><STRONG><A NAME="item_backlink">backlink</A></STRONG><BR>
  63. <DD>
  64. <PRE>
  65.     --backlink="Back to Top"</PRE>
  66. <P>Adds ``Back to Top'' links in front of every HEAD1 heading (except for
  67. the first).  By default, no backlink are being generated.</P>
  68. <DT><STRONG><A NAME="item_css">css</A></STRONG><BR>
  69. <DD>
  70. <PRE>
  71.     --css=stylesheet</PRE>
  72. <P>Specify the URL of a cascading style sheet.</P>
  73. <DT><STRONG><A NAME="item_flush">flush</A></STRONG><BR>
  74. <DD>
  75. <PRE>
  76.     --flush</PRE>
  77. <P>Flushes the item and directory caches.</P>
  78. <DT><STRONG><A NAME="item_header">header</A></STRONG><BR>
  79. <DD>
  80. <PRE>
  81.     --header
  82.     --noheader</PRE>
  83. <P>Creates header and footer blocks containing the text of the NAME
  84. section.  By default, no headers are being generated.</P>
  85. <DT><STRONG><A NAME="item_help">help</A></STRONG><BR>
  86. <DD>
  87. <PRE>
  88.     --help</PRE>
  89. <P>Displays the usage message.</P>
  90. <DT><STRONG><A NAME="item_htmldir">htmldir</A></STRONG><BR>
  91. <DD>
  92. <PRE>
  93.     --htmldir=name</PRE>
  94. <P>Sets the directory in which the resulting HTML file is placed.  This
  95. is used to generate relative links to other files. Not passing this
  96. causes all links to be absolute, since this is the value that tells
  97. Pod::Html the root of the documentation tree.</P>
  98. <DT><STRONG><A NAME="item_htmlroot">htmlroot</A></STRONG><BR>
  99. <DD>
  100. <PRE>
  101.     --htmlroot=name</PRE>
  102. <P>Sets the base URL for the HTML files.  When cross-references are made,
  103. the HTML root is prepended to the URL.</P>
  104. <DT><STRONG><A NAME="item_index">index</A></STRONG><BR>
  105. <DD>
  106. <PRE>
  107.     --index
  108.     --noindex</PRE>
  109. <P>Generate an index at the top of the HTML file.  This is the default
  110. behaviour.</P>
  111. <DT><STRONG><A NAME="item_infile">infile</A></STRONG><BR>
  112. <DD>
  113. <PRE>
  114.     --infile=name</PRE>
  115. <P>Specify the pod file to convert.  Input is taken from STDIN if no
  116. infile is specified.</P>
  117. <DT><STRONG><A NAME="item_libpods">libpods</A></STRONG><BR>
  118. <DD>
  119. <PRE>
  120.     --libpods=name:...:name</PRE>
  121. <P>List of page names (eg, ``perlfunc'') which contain linkable <CODE>=item</CODE>s.</P>
  122. <DT><STRONG><A NAME="item_netscape">netscape</A></STRONG><BR>
  123. <DD>
  124. <PRE>
  125.     --netscape
  126.     --nonetscape</PRE>
  127. <P>Use Netscape HTML directives when applicable.  By default, they will
  128. <STRONG>not</STRONG> be used.</P>
  129. <DT><STRONG><A NAME="item_outfile">outfile</A></STRONG><BR>
  130. <DD>
  131. <PRE>
  132.     --outfile=name</PRE>
  133. <P>Specify the HTML file to create.  Output goes to STDOUT if no outfile
  134. is specified.</P>
  135. <DT><STRONG><A NAME="item_podpath">podpath</A></STRONG><BR>
  136. <DD>
  137. <PRE>
  138.     --podpath=name:...:name</PRE>
  139. <P>Specify which subdirectories of the podroot contain pod files whose
  140. HTML converted forms can be linked-to in cross-references.</P>
  141. <DT><STRONG><A NAME="item_podroot">podroot</A></STRONG><BR>
  142. <DD>
  143. <PRE>
  144.     --podroot=name</PRE>
  145. <P>Specify the base directory for finding library pods.</P>
  146. <DT><STRONG><A NAME="item_quiet">quiet</A></STRONG><BR>
  147. <DD>
  148. <PRE>
  149.     --quiet
  150.     --noquiet</PRE>
  151. <P>Don't display <EM>mostly harmless</EM> warning messages.  These messages
  152. will be displayed by default.  But this is not the same as <A HREF="#item_verbose"><CODE>verbose</CODE></A>
  153. mode.</P>
  154. <DT><STRONG><A NAME="item_recurse">recurse</A></STRONG><BR>
  155. <DD>
  156. <PRE>
  157.     --recurse
  158.     --norecurse</PRE>
  159. <P>Recurse into subdirectories specified in podpath (default behaviour).</P>
  160. <DT><STRONG><A NAME="item_title">title</A></STRONG><BR>
  161. <DD>
  162. <PRE>
  163.     --title=title</PRE>
  164. <P>Specify the title of the resulting HTML file.</P>
  165. <DT><STRONG><A NAME="item_verbose">verbose</A></STRONG><BR>
  166. <DD>
  167. <PRE>
  168.     --verbose
  169.     --noverbose</PRE>
  170. <P>Display progress messages.  By default, they won't be displayed.</P>
  171. </DL>
  172. <P>
  173. <HR>
  174. <H1><A NAME="example">EXAMPLE</A></H1>
  175. <PRE>
  176.     pod2html("pod2html",
  177.              "--podpath=lib:ext:pod:vms", 
  178.              "--podroot=/usr/src/perl",
  179.              "--htmlroot=/perl/nmanual",
  180.              "--libpods=<A HREF="../../lib/Pod/perlfunc.html">perlfunc</A>:<A HREF="../../lib/Pod/perlguts.html">perlguts</A>:<A HREF="../../lib/Pod/perlvar.html">perlvar</A>:<A HREF="../../lib/Pod/perlrun.html">perlrun</A>:<A HREF="../../lib/Pod/perlop.html">perlop</A>",
  181.              "--recurse",
  182.              "--infile=foo.pod",
  183.              "--outfile=/perl/nmanual/foo.html");</PRE>
  184. <P>
  185. <HR>
  186. <H1><A NAME="environment">ENVIRONMENT</A></H1>
  187. <P>Uses $Config{pod2html} to setup default options.</P>
  188. <P>
  189. <HR>
  190. <H1><A NAME="author">AUTHOR</A></H1>
  191. <P>Tom Christiansen, <<A HREF="mailto:tchrist@perl.com">tchrist@perl.com</A>>.</P>
  192. <P>
  193. <HR>
  194. <H1><A NAME="see also">SEE ALSO</A></H1>
  195. <P><A HREF="../../lib/Pod/perlpod.html">the perlpod manpage</A></P>
  196. <P>
  197. <HR>
  198. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  199. <P>This program is distributed under the Artistic License.</P>
  200. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  201. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  202. <STRONG><P CLASS=block> Pod::Html - module to convert pod files to HTML</P></STRONG>
  203. </TD></TR>
  204. </TABLE>
  205.  
  206. </BODY>
  207.  
  208. </HTML>
  209.