home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b7d3bd743d6e8453b2bc5b3b087de330 < prev    next >
Text File  |  2000-03-23  |  7KB  |  175 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Pod::Text - Convert POD data to formatted ASCII text</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::Text - Convert POD data to formatted ASCII text</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="#diagnostics">DIAGNOSTICS</A></LI>
  26.     <LI><A HREF="#restrictions">RESTRICTIONS</A></LI>
  27.     <LI><A HREF="#notes">NOTES</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29.     <LI><A HREF="#author">AUTHOR</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>Pod::Text - Convert POD data to formatted ASCII text</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.     use Pod::Text;
  49.     my $parser = Pod::Text->new (sentence => 0, width => 78);</PRE>
  50. <PRE>
  51.     # Read POD from STDIN and write to STDOUT.
  52.     $parser->parse_from_filehandle;</PRE>
  53. <PRE>
  54.     # Read POD from file.pod and write to file.txt.
  55.     $parser->parse_from_file ('file.pod', 'file.txt');</PRE>
  56. <P>
  57. <HR>
  58. <H1><A NAME="description">DESCRIPTION</A></H1>
  59. <P>Pod::Text is a module that can convert documentation in the POD format (the
  60. preferred language for documenting Perl) into formatted ASCII.  It uses no
  61. special formatting controls or codes whatsoever, and its output is therefore
  62. suitable for nearly any device.</P>
  63. <P>As a derived class from Pod::Parser, Pod::Text supports the same methods and
  64. interfaces.  See <A HREF="../../lib/Pod/Parser.html">the Pod::Parser manpage</A> for all the details; briefly, one creates a
  65. new parser with <CODE>Pod::Text->new()</CODE> and then calls either
  66. <CODE>parse_from_filehandle()</CODE> or parse_from_file().</P>
  67. <P><CODE>new()</CODE> can take options, in the form of key/value pairs, that control the
  68. behavior of the parser.  The currently recognized options are:</P>
  69. <DL>
  70. <DT><STRONG><A NAME="item_alt">alt</A></STRONG><BR>
  71. <DD>
  72. If set to a true value, selects an alternate output format that, among other
  73. things, uses a different heading style and marks <CODE>=item</CODE> entries with a
  74. colon in the left margin.  Defaults to false.
  75. <P></P>
  76. <DT><STRONG><A NAME="item_indent">indent</A></STRONG><BR>
  77. <DD>
  78. The number of spaces to indent regular text, and the default indentation for
  79. <CODE>=over</CODE> blocks.  Defaults to 4.
  80. <P></P>
  81. <DT><STRONG><A NAME="item_loose">loose</A></STRONG><BR>
  82. <DD>
  83. If set to a true value, a blank line is printed after a <CODE>=head1</CODE> heading.
  84. If set to false (the default), no blank line is printed after <CODE>=head1</CODE>,
  85. although one is still printed after <CODE>=head2</CODE>.  This is the default because
  86. it's the expected formatting for manual pages; if you're formatting
  87. arbitrary text documents, setting this to true may result in more pleasing
  88. output.
  89. <P></P>
  90. <DT><STRONG><A NAME="item_sentence">sentence</A></STRONG><BR>
  91. <DD>
  92. If set to a true value, Pod::Text will assume that each sentence ends in two
  93. spaces, and will try to preserve that spacing.  If set to false, all
  94. consecutive whitespace in non-verbatim paragraphs is compressed into a
  95. single space.  Defaults to true.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_width">width</A></STRONG><BR>
  98. <DD>
  99. The column at which to wrap text on the right-hand side.  Defaults to 76.
  100. <P></P></DL>
  101. <P>The standard Pod::Parser method <CODE>parse_from_filehandle()</CODE> takes up to two
  102. arguments, the first being the file handle to read POD from and the second
  103. being the file handle to write the formatted output to.  The first defaults
  104. to STDIN if not given, and the second defaults to STDOUT.  The method
  105. <CODE>parse_from_file()</CODE> is almost identical, except that its two arguments are the
  106. input and output disk files instead.  See <A HREF="../../lib/Pod/Parser.html">the Pod::Parser manpage</A> for the specific
  107. details.</P>
  108. <P>
  109. <HR>
  110. <H1><A NAME="diagnostics">DIAGNOSTICS</A></H1>
  111. <DL>
  112. <DT><STRONG><A NAME="item_Bizarre_space_in_item">Bizarre space in item</A></STRONG><BR>
  113. <DD>
  114. (W) Something has gone wrong in internal <CODE>=item</CODE> processing.  This message
  115. indicates a bug in Pod::Text; you should never see it.
  116. <P></P>
  117. <DT><STRONG><A NAME="item_Can%27t_open_%25s_for_reading%3A_%25s">Can't open %s for reading: %s</A></STRONG><BR>
  118. <DD>
  119. (F) Pod::Text was invoked via the compatibility mode <CODE>pod2text()</CODE> interface
  120. and the input file it was given could not be opened.
  121. <P></P>
  122. <DT><STRONG><A NAME="item_Unknown_escape%3A_%25s">Unknown escape: %s</A></STRONG><BR>
  123. <DD>
  124. (W) The POD source contained an <CODE>E<></CODE> escape that Pod::Text didn't
  125. know about.
  126. <P></P>
  127. <DT><STRONG><A NAME="item_Unknown_sequence%3A_%25s">Unknown sequence: %s</A></STRONG><BR>
  128. <DD>
  129. (W) The POD source contained a non-standard internal sequence (something of
  130. the form <CODE>X<></CODE>) that Pod::Text didn't know about.
  131. <P></P>
  132. <DT><STRONG><A NAME="item_Unmatched_%3Dback">Unmatched =back</A></STRONG><BR>
  133. <DD>
  134. (W) Pod::Text encountered a <CODE>=back</CODE> command that didn't correspond to an
  135. <CODE>=over</CODE> command.
  136. <P></P></DL>
  137. <P>
  138. <HR>
  139. <H1><A NAME="restrictions">RESTRICTIONS</A></H1>
  140. <P>Embedded Ctrl-As (octal 001) in the input will be mapped to spaces on
  141. output, due to an internal implementation detail.</P>
  142. <P>
  143. <HR>
  144. <H1><A NAME="notes">NOTES</A></H1>
  145. <P>This is a replacement for an earlier Pod::Text module written by Tom
  146. Christiansen.  It has a revamped interface, since it now uses Pod::Parser,
  147. but an interface roughly compatible with the old Pod::Text::pod2text()
  148. function is still available.  Please change to the new calling convention,
  149. though.</P>
  150. <P>The original Pod::Text contained code to do formatting via termcap
  151. sequences, although it wasn't turned on by default and it was problematic to
  152. get it to work at all.  This rewrite doesn't even try to do that, but a
  153. subclass of it does.  Look for <A HREF="../../lib/Pod/Text/Termcap.html">Pod::Text::Termcap</A>.</P>
  154. <P>
  155. <HR>
  156. <H1><A NAME="see also">SEE ALSO</A></H1>
  157. <P><A HREF="../../lib/Pod/Parser.html">Pod::Parser</A>, <A HREF="../../lib/Pod/Text/Termcap.html">Pod::Text::Termcap</A>,
  158. <CODE>pod2text(1)</CODE></P>
  159. <P>
  160. <HR>
  161. <H1><A NAME="author">AUTHOR</A></H1>
  162. <P>Russ Allbery <<A HREF="mailto:rra@stanford.edu">rra@stanford.edu</A>>, based <EM>very</EM> heavily on the
  163. original Pod::Text by Tom Christiansen <<A HREF="mailto:tchrist@mox.perl.com">tchrist@mox.perl.com</A>> and
  164. its conversion to Pod::Parser by Brad Appleton
  165. <<A HREF="mailto:bradapp@enteract.com">bradapp@enteract.com</A>>.</P>
  166. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  167. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  168. <STRONG><P CLASS=block> Pod::Text - Convert POD data to formatted ASCII text</P></STRONG>
  169. </TD></TR>
  170. </TABLE>
  171.  
  172. </BODY>
  173.  
  174. </HTML>
  175.