mingw/html/lib/Pod/Perldoc/ToText.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>Pod::Perldoc::ToText - let Perldoc render Pod as plaintext</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;Pod::Perldoc::ToText - let Perldoc render Pod as plaintext</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  23         <li><a href="#synopsis">SYNOPSIS</a></li>
  24         <li><a href="#description">DESCRIPTION</a></li>
  25         <li><a href="#caveat">CAVEAT</a></li>
  26         <li><a href="#see_also">SEE ALSO</a></li>
  27         <li><a href="#copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></li>
  28         <li><a href="#author">AUTHOR</a></li>
  29 </ul>
  30 <!-- INDEX END -->
  31
  32 <hr />
  33 <p>
  34 </p>
  35 <h1><a name="name">NAME</a></h1>
  36 <p>Pod::Perldoc::ToText - let Perldoc render Pod as plaintext</p>
  37 <p>
  38 </p>
  39 <hr />
  40 <h1><a name="synopsis">SYNOPSIS</a></h1>
  41 <pre>
  42   <a href="//C|\msysgit\mingw\html/pod/perldoc.html">perldoc</a> -o text Some::Modulename</pre>
  43 <p>
  44 </p>
  45 <hr />
  46 <h1><a name="description">DESCRIPTION</a></h1>
  47 <p>This is a ``plug-in'' class that allows Perldoc to use
  48 Pod::Text as a formatter class.</p>
  49 <p>It supports the following options, which are explained in
  50 <a href="file://C|\msysgit\mingw\html/lib/Pod/Text.html">the Pod::Text manpage</a>: alt, indent, loose, quotes, sentence, width</p>
  51 <p>For example:</p>
  52 <pre>
  53   <a href="//C|\msysgit\mingw\html/pod/perldoc.html">perldoc</a> -o text -w indent:5 Some::Modulename</pre>
  54 <p>
  55 </p>
  56 <hr />
  57 <h1><a name="caveat">CAVEAT</a></h1>
  58 <p>This module may change to use a different text formatter class in the
  59 future, and this may change what options are supported.</p>
  60 <p>
  61 </p>
  62 <hr />
  63 <h1><a name="see_also">SEE ALSO</a></h1>
  64 <p><a href="file://C|\msysgit\mingw\html/lib/Pod/Text.html">the Pod::Text manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/Pod/Perldoc.html">the Pod::Perldoc manpage</a></p>
  65 <p>
  66 </p>
  67 <hr />
  68 <h1><a name="copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></h1>
  69 <p>Copyright (c) 2002 Sean M. Burke.  All rights reserved.</p>
  70 <p>This library is free software; you can redistribute it and/or modify it
  71 under the same terms as Perl itself.</p>
  72 <p>This program is distributed in the hope that it will be useful, but
  73 without any warranty; without even the implied warranty of
  74 merchantability or fitness for a particular purpose.</p>
  75 <p>
  76 </p>
  77 <hr />
  78 <h1><a name="author">AUTHOR</a></h1>
  79 <p>Sean M. Burke <code>sburke@cpan.org</code>
  80
  81 </p>
  82 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  83 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  84 <big><strong><span class="block">&nbsp;Pod::Perldoc::ToText - let Perldoc render Pod as plaintext</span></strong></big>
  85 </td></tr>
  86 </table>
  87
  88 </body>
  89
  90 </html>