ch04_13.htm

by Randal L. Schwartz and Tom Phoenix ISBN 0-596-00132-0 Third Edition, published July 2001. (See

<dt><i><em class="emphasis">-h</em></i></dt>
<dd>
Displays help message.</p>
</dd>


<dt><i><em class="emphasis">-l</em></i></dt>
<dd>
Displays full path to the module.</p>
</dd>


<dt><i><em class="emphasis">-m</em></i></dt>
<dd>
Displays entire module, both code and pod text, without formatting
the pod.
</p>
</dd>


<dt><i><em class="emphasis">-t</em></i></dt>
<dd>
Displays using text formatter instead of nroff. Faster, but output is
less fancy.
</p>
</dd>


<dt><i><em class="emphasis">-u</em></i></dt>
<dd>
Unformatted. Finds and displays the document without formatting it.</p>
</dd>


<dt><i><em class="emphasis">-v</em></i></dt>
<dd>
Verbose. Describes search for the file, showing directories searched
and where file was found.
</p>
</dd>

</dl>


<p><em class="emphasis">perldoc</em> applies switches found in the PERLDOC
environment variable before those from the command line. It searches
directories specified by the PERL5LIB, PERLLIB (if PERL5LIB
isn't defined), and PATH environment variables.
</p>

</div>

<a name="INDEX-846" /><a name="INDEX-847" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>pod2fm</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
pod2fm [<em class="replaceable">options</em>] <em class="replaceable">file</em>
</pre><p><a name="INDEX-846" /><a name="INDEX-847" />Translates pod to FrameMaker
format.
</p>
<h4 class="refsect1">Options</h4>

<dl>
<dt><i><em class="emphasis">-book [</em><em class="replaceable"><tt>bookname</em><em class="emphasis">]</tt></em></i></dt>
<dd>
If set, creates FrameMaker book file. If not specified,
<em class="replaceable"><tt>bookname</tt></em> defaults to
<tt class="literal">perl</tt>; filename extension is
<em class="emphasis">.book</em> in either case.
</p>
</dd>


<dt><i>-[no]doc</i></dt>
<dd>
Whether to convert a MIF-format <em class="emphasis">.doc</em> output file
to binary FrameMaker format. Default is <em class="emphasis">-doc</em>.
</p>
</dd>


<dt><i>-format type</i></dt>
<dd>
Which format to copy from the template document specified with the
<em class="emphasis">-template</em> option. Type can be a comma-separated
list, and <em class="emphasis">-format</em> can also be specified more
than once. Legal types are:
</p>

<a name="ch04-34-fm2xml" /><table border="1" cellpadding="3">



<tr>
<th>
<p>Type</p>
</th>
<th>
<p>Description</p>
</th>
</tr>


<tr>
<td>
<p><tt class="literal">all</tt></p>
</td>
<td>
<p>All types (the default)</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Character</tt></p>
</td>
<td>
<p>Character formats</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Paragraph</tt></p>
</td>
<td>
<p>Paragraph formats</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Page</tt></p>
</td>
<td>
<p>Master page layouts</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Reference</tt></p>
</td>
<td>
<p>Reference page layouts</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Table</tt></p>
</td>
<td>
<p>Table formats</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Variables</tt></p>
</td>
<td>
<p>Variable definitions</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Math</tt></p>
</td>
<td>
<p>Math definitions</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Cross</tt></p>
</td>
<td>
<p>Cross-reference definitions</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Color</tt></p>
</td>
<td>
<p>Color definitions</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Conditional</tt></p>
</td>
<td>
<p>Conditional text definitions</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Break</tt></p>
</td>
<td>
<p>Preserves page breaks; controls how the other types are used</p>
</td>
</tr>
<tr>
<td>
<p><tt class="literal">Other</tt></p>
</td>
<td>
<p>Preserves other format changes; controls how the other types are used</p>
</td>
</tr>

</table><p>
</dd>


<dt><i>-[no]index</i></dt>
<dd>
Whether to generate an index. Defaults to
<em class="emphasis">-noindex</em>.
</p>
</dd>


<dt><i>-[no]lock</i></dt>
<dd>
Whether to lock file as read-only so you can use hypertext marker
feature. Defaults to <em class="emphasis">-nolock</em>.
</p>
</dd>


<dt><i>-[no]mmlonly</i></dt>
<dd>
Whether to stop execution after generating the MML version of the
file. Default is <em class="emphasis">-nommlonly</em>.
</p>
</dd>


<dt><i>-[no]open</i></dt>
<dd>
Whether to try to open the book after creating it; requires the
<em class="emphasis">-book</em> option.
</p>
</dd>


<dt><i>-template document</i></dt>
<dd>
Specifies a template document for <em class="emphasis">pod2fm</em> copies
a format for use in formatting the output.
<em class="emphasis">document</em> is the path to the template document.
</p>
</dd>


<dt><i>-[no]toc</i></dt>
<dd>
Whether to generate a table of contents. Defaults to
<em class="emphasis">-notoc</em>.
</p>
</dd>

</dl>

</div>

<a name="INDEX-848" /><a name="INDEX-849" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>pod2html</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
pod2html [<em class="replaceable">options</em>] <em class="replaceable">inputfile</em>
</pre><p><a name="INDEX-848" /><a name="INDEX-849" />Translates files from pod to HTML
format. Wrapper around the standard module Pod::Html; see <a href="ch08_01.htm">Chapter 8, "Standard Modules"</a> for the options, which are passed to Pod::Html
as arguments.
</p></div>

<a name="INDEX-850" /><a name="INDEX-851" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>pod2latex</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
pod2latex <em class="replaceable">inputfile</em>
</pre><p><a name="INDEX-850" /><a name="INDEX-851" />Translates files from pod to LaTeX
format. Writes output to a file with <em class="emphasis">.tex</em>
extension.
</p></div>

<a name="INDEX-852" /><a name="INDEX-853" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>pod2man</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
pod2man [<em class="replaceable">options</em>] <em class="replaceable">inputfile</em>
</pre><p><a name="INDEX-852" /><a name="INDEX-853" />Translates pod directives in
file <em class="emphasis">inputfile</em> to Unix manpage format. Converts
pod-tagged text to nroff source that can be viewed by the
<em class="emphasis">man</em> command, or troff for typesetting.
</p>
<h4 class="refsect1">Options</h4>

<dl>
<dt><b><tt class="literal">--center=</tt><em class="replaceable">string</em></b></dt>
<dd>
Sets centered header to <em class="replaceable"><tt>string</tt></em>. Defaults
to "User Contributed Perl
Documentation" unless <tt class="literal">-\-official</tt>
flag is set, in which case it defaults to "Perl
Programmers Reference Guide."
</p>
</dd>


<dt><b><tt class="literal">--date=</tt><em class="replaceable">string</em></b></dt>
<dd>
Sets left-hand footer string to <tt class="literal">date</tt>.</p>
</dd>


<dt><b><tt class="literal">--fixed=</tt><em class="replaceable">font</em></b></dt>
<dd>
Specifies the fixed-width font to use for code examples.</p>
</dd>


<dt><b><tt class="literal">--lax</tt></b></dt>
<dd>
If set, ignores missing sections.</p>
</dd>


<dt><b><tt class="literal">--official</tt></b></dt>
<dd>
If set, uses default header as shown for
<em class="emphasis">-\-center</em> above.
</p>
</dd>


<dt><b><tt class="literal">--release=</tt><em class="replaceable">rel</em></b></dt>
<dd>
Sets centered footer. Defaults to current Perl release.</p>
</dd>


<dt><b><tt class="literal">--section=</tt><em class="replaceable">manext</em></b></dt>
<dd>
Sets manpage section for nroff .TH macro. Default is
<tt class="literal">3</tt> (functions) if filename ends in
<em class="emphasis">.pm</em>; otherwise <tt class="literal">1</tt> (user
commands).
</p>
</dd>

</dl>

</div>

<a name="INDEX-854" /><a name="INDEX-855" /><a name="INDEX-856" /><a name="INDEX-857" /><a name="INDEX-858" /><a name="INDEX-859" /><a name="INDEX-860" /><a name="INDEX-861" /><div class="refentry"><table width="515" border="0" cellpadding="5"><tr><td align="left"><font size="+1"><b>pod2text</b></font></td><td align="right"><i></i></td></tr></table><hr width="515" size="3" noshade="true" align="left" color="black" /><pre>
pod2text &lt; <em class="replaceable">input</em>
</pre><p><a name="INDEX-854" /><a name="INDEX-855" />Translates pod to text and displays it. A
wrapper around the Pod::Text module.
</p>
<h4 class="refsect1">Options</h4>

<dl>
<dt><b><tt class="literal">--help</tt></b></dt>
<dd>
Displays help information.</p>
</dd>


<dt><b><tt class="literal">--htmlroot=</tt><em class="replaceable">name</em></b></dt>
<dd>
Sets base URL for the HTML files to <em class="replaceable"><tt>name</tt></em>.</p>
</dd>


<dt><b><tt class="literal">--index</tt></b></dt>
<dd>
Generates index at top of the HTML file (default).</p>
</dd>


<dt><b><tt class="literal">--infile=</tt><em class="replaceable">name</em></b></dt>
<dd>
Converts pod file <em class="replaceable"><tt>name</tt></em>. Default is to take
input from STDIN.
</p>
</dd>


<dt><b><tt class="literal">--libpods=</tt><em class="replaceable">name</em><tt class="literal">:...:</tt><em class="replaceable">name</em></b></dt>
<dd>
List of page names (e.g.,
"perlfunc") that contain linkable
<tt class="literal">=item</tt> s.
</p>
</dd>


<dt><b><tt class="literal">--outfile=</tt><em class="replaceable">name</em></b></dt>
<dd>
Creates HTML file <em class="replaceable"><tt>name</tt></em>. Default is to send
output to STDOUT.
</p>
</dd>


<dt><b><tt class="literal">--podroot=</tt><em class="replaceable">name</em></b></dt>
<dd>
Uses <em class="replaceable"><tt>name</tt></em> as base directory for finding
library pods.
</p>
</dd>


<dt><b><tt class="literal">--podpath=</tt><em class="replaceable">name</em><tt class="literal">:...:</tt><em class="replaceable">name</em></b></dt>
<dd>
Lists <em class="emphasis">podroot</em> subdirectories with pod files
whose HTML-converted forms can be linked to in cross-references.
</p>
</dd>


<dt><b><tt class="literal">--netscape</tt></b></dt>
<dd>
Uses Netscape HTML directives when applicable.</p>
</dd>


<dt><b><tt class="literal">--noindex</tt></b></dt>
<dd>
Does not generate index at top of the HTML file.</p>
</dd>


<dt><b><tt class="literal">--nonetscape</tt></b></dt>
<dd>
Does not use Netscape HTML directives (default).</p>
</dd>


<dt><b><tt class="literal">--norecurse</tt></b></dt>
<dd>
Does not recurse into subdirectories specified in
<em class="emphasis">podpath</em>.
</p>
</dd>


<dt><b><tt class="literal">--recurse</tt></b></dt>
<dd>
Recurses into subdirectories specified in
<em class="emphasis">podpath</em> (default).
</p>
</dd>


<dt><b><tt class="literal">--title=</tt><em class="replaceable">title</em></b></dt>
<dd>
Specifies title for the resulting HTML file.</p>
</dd>


<dt><b><tt class="literal">--verbose</tt></b></dt>
<dd>
Displays progress messages<a name="INDEX-856" /><a name="INDEX-857" /><a name="INDEX-858" /><a name="INDEX-859" /><a name="INDEX-860" /><a name="INDEX-861" />. 
</p>
</dd>

</dl>


</div>
</div>


<hr width="684" align="left" />
<div class="navbar"><table width="684" border="0"><tr><td align="left" valign="top" width="228"><a href="ch04_12.htm"><img src="../gifs/txtpreva.gif" alt="Previous" border="0" /></a></td><td align="center" valign="top" width="228"><a href="index.htm"><img src="../gifs/txthome.gif" alt="Home" border="0" /></a></td><td align="right" valign="top" width="228"><a href="ch05_01.htm"><img src="../gifs/txtnexta.gif" alt="Next" border="0" /></a></td></tr><tr><td align="left" valign="top" width="228">4.12. Formats</td><td align="center" valign="top" width="228"><a href="index/index.htm"><img src="../gifs/index.gif" alt="Book Index" border="0" /></a></td><td align="right" valign="top" width="228">5. Function Reference</td></tr></table></div>
<hr width="684" align="left" />

<img src="../gifs/navbar.gif" usemap="#library-map" border="0" alt="Library Navigation Links" />
<p><p><font size="-1"><a href="copyrght.htm">Copyright &copy; 2002</a> O'Reilly &amp; Associates. All rights reserved.</font></p>

<map name="library-map">
<area shape="rect" coords="1,0,85,94" href="../index.htm"><area shape="rect" coords="86,1,178,103" href="../lwp/index.htm"><area shape="rect" coords="180,0,265,103" href="../lperl/index.htm"><area shape="rect" coords="267,0,353,105" href="../perlnut/index.htm"><area shape="rect" coords="354,1,446,115" href="../prog/index.htm"><area shape="rect" coords="448,0,526,132" href="../tk/index.htm"><area shape="rect" coords="528,1,615,119" href="../cookbook/index.htm"><area shape="rect" coords="617,0,690,135" href="../pxml/index.htm">
</map>

</body></html>