pod2latex.html
来自「perl教程」· HTML 代码 · 共 204 行
HTML
204 行
<?xml version="1.0" ?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<!-- saved from url=(0017)http://localhost/ -->
<script language="JavaScript" src="../displayToc.js"></script>
<script language="JavaScript" src="../tocParas.js"></script>
<script language="JavaScript" src="../tocTab.js"></script>
<link rel="stylesheet" type="text/css" href="../scineplex.css">
<title>pod2latex - convert pod documentation to latex format</title>
<link rel="stylesheet" href="../Active.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>
<body>
<script>writelinks('__top__',1);</script>
<h1><a>pod2latex - convert pod documentation to latex format</a></h1>
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#options_and_arguments">OPTIONS AND ARGUMENTS</a></li>
<li><a href="#bugs">BUGS</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#author">AUTHOR</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>pod2latex - convert pod documentation to latex format</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
pod2latex *.pm</pre>
<pre>
pod2latex -out mytex.tex *.pod</pre>
<pre>
pod2latex -full -sections 'DESCRIPTION|NAME' SomeDir</pre>
<pre>
pod2latex -prefile h.tex -postfile t.tex my.pod</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p><code>pod2latex</code> is a program to convert POD format documentation
(<a href="../lib/Pod/perlpod.html">the perlpod manpage</a>) into latex. It can process multiple input documents at a
time and either generate a latex file per input document or a single
combined output file.</p>
<p>
</p>
<hr />
<h1><a name="options_and_arguments">OPTIONS AND ARGUMENTS</a></h1>
<p>This section describes the supported command line options. Minimum
matching is supported.</p>
<dl>
<dt><strong><a name="item__2dout"><strong>-out</strong></a></strong>
<dd>
<p>Name of the output file to be used. If there are multiple input pods
it is assumed that the intention is to write all translated output
into a single file. <code>.tex</code> is appended if not present. If the
argument is not supplied, a single document will be created for each
input file.</p>
</dd>
</li>
<dt><strong><a name="item__2dfull"><strong>-full</strong></a></strong>
<dd>
<p>Creates a complete <code>latex</code> file that can be processed immediately
(unless <code>=for/=begin</code> directives are used that rely on extra packages).
Table of contents and index generation commands are included in the
wrapper <code>latex</code> code.</p>
</dd>
</li>
<dt><strong><a name="item__2dsections"><strong>-sections</strong></a></strong>
<dd>
<p>Specify pod sections to include (or remove if negated) in the
translation. See <a href="../lib/Pod/Select.html#section_specifications">SECTION SPECIFICATIONS in the Pod::Select manpage</a> for the
format to use for <em>section-spec</em>. This option may be given multiple
times on the command line.This is identical to the similar option in
the <code>podselect()</code> command.</p>
</dd>
</li>
<dt><strong><a name="item__2dmodify"><strong>-modify</strong></a></strong>
<dd>
<p>This option causes the output <code>latex</code> to be slightly
modified from the input pod such that when a <code>=head1 NAME</code>
is encountered a section is created containing the actual
pod name (rather than <strong>NAME</strong>) and all subsequent <code>=head1</code>
directives are treated as subsections. This has the advantage
that the description of a module will be in its own section
which is helpful for including module descriptions in documentation.
Also forces <code>latex</code> label and index entries to be prefixed by the
name of the module.</p>
</dd>
</li>
<dt><strong><a name="item__2dh1level"><strong>-h1level</strong></a></strong>
<dd>
<p>Specifies the <code>latex</code> section that is equivalent to a <code>H1</code> pod
directive. This is an integer between 0 and 5 with 0 equivalent to a
<code>latex</code> chapter, 1 equivalent to a <code>latex</code> section etc. The default
is 1 (<code>H1</code> equivalent to a latex section).</p>
</dd>
</li>
<dt><strong><a name="item__2dhelp"><strong>-help</strong></a></strong>
<dd>
<p>Print a brief help message and exit.</p>
</dd>
</li>
<dt><strong><a name="item__2dman"><strong>-man</strong></a></strong>
<dd>
<p>Print the manual page and exit.</p>
</dd>
</li>
<dt><strong><a name="item__2dverbose"><strong>-verbose</strong></a></strong>
<dd>
<p>Print information messages as each document is processed.</p>
</dd>
</li>
<dt><strong><a name="item__2dpreamble"><strong>-preamble</strong></a></strong>
<dd>
<p>A user-supplied preamble for the LaTeX code. Multiple values
are supported and appended in order separated by "\n".
See <strong>-prefile</strong> for reading the preamble from a file.</p>
</dd>
</li>
<dt><strong><a name="item__2dpostamble"><strong>-postamble</strong></a></strong>
<dd>
<p>A user supplied postamble for the LaTeX code. Multiple values
are supported and appended in order separated by "\n".
See <strong>-postfile</strong> for reading the postamble from a file.</p>
</dd>
</li>
<dt><strong><a name="item__2dprefile"><strong>-prefile</strong></a></strong>
<dd>
<p>A user-supplied preamble for the LaTeX code to be read from the
named file. Multiple values are supported and appended in
order. See <strong>-preamble</strong>.</p>
</dd>
</li>
<dt><strong><a name="item__2dpostfile"><strong>-postfile</strong></a></strong>
<dd>
<p>A user-supplied postamble for the LaTeX code to be read from the
named file. Multiple values are supported and appended in
order. See <strong>-postamble</strong>.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="bugs">BUGS</a></h1>
<p>Known bugs are:</p>
<ul>
<li>
<p>Cross references between documents are not resolved when multiple
pod documents are converted into a single output <code>latex</code> file.</p>
</li>
<li>
<p>Functions and variables are not automatically recognized
and they will therefore not be marked up in any special way
unless instructed by an explicit pod command.</p>
</li>
</ul>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="../lib/Pod/LaTeX.html">the Pod::LaTeX manpage</a></p>
<p>
</p>
<hr />
<h1><a name="author">AUTHOR</a></h1>
<p>Tim Jenness <<a href="mailto:tjenness@cpan.org">tjenness@cpan.org</a>></p>
<p>This program is free software; you can redistribute it
and/or modify it under the same terms as Perl itself.</p>
<p>Copyright (C) 2000, 2003, 2004 Tim Jenness. All Rights Reserved.</p>
</body>
</html>
⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?