mingw/html/lib/Pod/Text/Termcap.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::Text::Termcap - Convert POD data to ASCII text with format escapes</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::Text::Termcap - Convert POD data to ASCII text with format escapes</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="#notes">NOTES</a></li>
  26         <li><a href="#see_also">SEE ALSO</a></li>
  27         <li><a href="#author">AUTHOR</a></li>
  28         <li><a href="#copyright_and_license">COPYRIGHT AND LICENSE</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::Text::Termcap - Convert POD data to ASCII text with format escapes</p>
  37 <p>
  38 </p>
  39 <hr />
  40 <h1><a name="synopsis">SYNOPSIS</a></h1>
  41 <pre>
  42     use Pod::Text::Termcap;
  43     my $parser = Pod::Text::Termcap-&gt;new (sentence =&gt; 0, width =&gt; 78);</pre>
  44 <pre>
  45     # Read POD from STDIN and write to STDOUT.
  46     $parser-&gt;parse_from_filehandle;</pre>
  47 <pre>
  48     # Read POD from file.pod and write to file.txt.
  49     $parser-&gt;parse_from_file ('file.pod', 'file.txt');</pre>
  50 <p>
  51 </p>
  52 <hr />
  53 <h1><a name="description">DESCRIPTION</a></h1>
  54 <p>Pod::Text::Termcap is a simple subclass of Pod::Text that highlights output
  55 text using the correct termcap escape sequences for the current terminal.
  56 Apart from the format codes, it in all ways functions like Pod::Text.  See
  57 <a href="file://C|\msysgit\mingw\html/lib/Pod/Text.html">the Pod::Text manpage</a> for details and available options.</p>
  58 <p>
  59 </p>
  60 <hr />
  61 <h1><a name="notes">NOTES</a></h1>
  62 <p>This module uses Term::Cap to retrieve the formatting escape sequences for
  63 the current terminal, and falls back on the ECMA-48 (the same in this
  64 regard as ANSI X3.64 and ISO 6429, the escape codes also used by DEC VT100
  65 terminals) if the bold, underline, and reset codes aren't set in the
  66 termcap information.</p>
  67 <p>
  68 </p>
  69 <hr />
  70 <h1><a name="see_also">SEE ALSO</a></h1>
  71 <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/Parser.html">the Pod::Parser manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/Term/Cap.html">the Term::Cap manpage</a></p>
  72 <p>The current version of this module is always available from its web site at
  73 <a href="http://www.eyrie.org/~eagle/software/podlators/">http://www.eyrie.org/~eagle/software/podlators/</a>.  It is also part of the
  74 Perl core distribution as of 5.6.0.</p>
  75 <p>
  76 </p>
  77 <hr />
  78 <h1><a name="author">AUTHOR</a></h1>
  79 <p>Russ Allbery &lt;<a href="mailto:rra@stanford.edu">rra@stanford.edu</a>&gt;.</p>
  80 <p>
  81 </p>
  82 <hr />
  83 <h1><a name="copyright_and_license">COPYRIGHT AND LICENSE</a></h1>
  84 <p>Copyright 1999, 2001, 2002 by Russ Allbery &lt;<a href="mailto:rra@stanford.edu">rra@stanford.edu</a>&gt;.</p>
  85 <p>This program is free software; you may redistribute it and/or modify it
  86 under the same terms as Perl itself.</p>
  87 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  88 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  89 <big><strong><span class="block">&nbsp;Pod::Text::Termcap - Convert POD data to ASCII text with format escapes</span></strong></big>
  90 </td></tr>
  91 </table>
  92
  93 </body>
  94
  95 </html>