mingw/html/lib/Pod/Perldoc/ToRtf.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::ToRtf - let Perldoc render Pod as RTF</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::ToRtf - let Perldoc render Pod as RTF</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="#see_also">SEE ALSO</a></li>
  26         <li><a href="#copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></li>
  27         <li><a href="#author">AUTHOR</a></li>
  28 </ul>
  29 <!-- INDEX END -->
  30
  31 <hr />
  32 <p>
  33 </p>
  34 <h1><a name="name">NAME</a></h1>
  35 <p>Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF</p>
  36 <p>
  37 </p>
  38 <hr />
  39 <h1><a name="synopsis">SYNOPSIS</a></h1>
  40 <pre>
  41   <a href="//C|\msysgit\mingw\html/pod/perldoc.html">perldoc</a> -o rtf Some::Modulename</pre>
  42 <p>
  43 </p>
  44 <hr />
  45 <h1><a name="description">DESCRIPTION</a></h1>
  46 <p>This is a ``plug-in'' class that allows Perldoc to use
  47 Pod::Simple::RTF as a formatter class.</p>
  48 <p>This is actually a Pod::Simple::RTF subclass, and inherits
  49 all its options.</p>
  50 <p>You have to have Pod::Simple::RTF installed (from the Pod::Simple dist),
  51 or this module won't work.</p>
  52 <p>If Perldoc is running under MSWin and uses this class as a formatter,
  53 the output will be opened with <em>write.exe</em> or whatever program is
  54 specified in the environment variable <code>RTFREADER</code>. For example, to
  55 specify that RTF files should be opened the same as they are when you
  56 double-click them, you would do <code>set RTFREADER=start.exe</code> in your
  57 <em>autoexec.bat</em>.</p>
  58 <p>Handy tip: put <code>set PERLDOC=-ortf</code> in your <em>autoexec.bat</em>
  59 and that will set this class as the default formatter to run when
  60 you do <code>perldoc whatever</code>.</p>
  61 <p>
  62 </p>
  63 <hr />
  64 <h1><a name="see_also">SEE ALSO</a></h1>
  65 <p><a href="file://C|\msysgit\mingw\html/Pod/Simple/RTF.html">the Pod::Simple::RTF manpage</a>, <a href="file://C|\msysgit\mingw\html/Pod/Simple.html">the Pod::Simple manpage</a>, <a href="file://C|\msysgit\mingw\html/lib/Pod/Perldoc.html">the Pod::Perldoc manpage</a></p>
  66 <p>
  67 </p>
  68 <hr />
  69 <h1><a name="copyright_and_disclaimers">COPYRIGHT AND DISCLAIMERS</a></h1>
  70 <p>Copyright (c) 2002 Sean M. Burke.  All rights reserved.</p>
  71 <p>This library is free software; you can redistribute it and/or modify it
  72 under the same terms as Perl itself.</p>
  73 <p>This program is distributed in the hope that it will be useful, but
  74 without any warranty; without even the implied warranty of
  75 merchantability or fitness for a particular purpose.</p>
  76 <p>
  77 </p>
  78 <hr />
  79 <h1><a name="author">AUTHOR</a></h1>
  80 <p>Sean M. Burke <code>sburke@cpan.org</code>
  81
  82 </p>
  83 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  84 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  85 <big><strong><span class="block">&nbsp;Pod::Perldoc::ToRtf - let Perldoc render Pod as RTF</span></strong></big>
  86 </td></tr>
  87 </table>
  88
  89 </body>
  90
  91 </html>