usage.html
来自「perl教程」· HTML 代码 · 共 487 行 · 第 1/3 页
HTML
487 行
<?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>pod2usage - print a usage message from embedded pod documentation</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__',2);</script>
<h1><a>pod2usage - print a usage message from embedded pod documentation</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="#arguments">ARGUMENTS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#examples">EXAMPLES</a></li>
<ul>
<li><a href="#recommended_use">Recommended Use</a></li>
</ul>
<li><a href="#caveats">CAVEATS</a></li>
<li><a href="#author">AUTHOR</a></li>
<li><a href="#acknowledgements">ACKNOWLEDGEMENTS</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Pod::Usage, <code>pod2usage()</code> - print a usage message from embedded pod documentation</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
use Pod::Usage</pre>
<pre>
<span class="keyword">my</span> <span class="variable">$message_text</span> <span class="operator">=</span> <span class="string">"This text precedes the usage message."</span><span class="operator">;</span>
<span class="keyword">my</span> <span class="variable">$exit_status</span> <span class="operator">=</span> <span class="number">2</span><span class="operator">;</span> <span class="comment">## The exit status to use</span>
<span class="keyword">my</span> <span class="variable">$verbose_level</span> <span class="operator">=</span> <span class="number">0</span><span class="operator">;</span> <span class="comment">## The verbose level to use</span>
<span class="keyword">my</span> <span class="variable">$filehandle</span> <span class="operator">=</span> <span class="operator">\</span><span class="variable">*STDERR</span><span class="operator">;</span> <span class="comment">## The filehandle to write to</span>
</pre>
<pre>
<span class="variable">pod2usage</span><span class="operator">(</span><span class="variable">$message_text</span><span class="operator">);</span>
</pre>
<pre>
<span class="variable">pod2usage</span><span class="operator">(</span><span class="variable">$exit_status</span><span class="operator">);</span>
</pre>
<pre>
<span class="variable">pod2usage</span><span class="operator">(</span> <span class="operator">{</span> <span class="string">-message</span> <span class="operator">=></span> <span class="variable">$message_text</span> <span class="operator">,</span>
<span class="string">-exitval</span> <span class="operator">=></span> <span class="variable">$exit_status</span> <span class="operator">,</span>
<span class="string">-verbose</span> <span class="operator">=></span> <span class="variable">$verbose_level</span><span class="operator">,</span>
<span class="string">-output</span> <span class="operator">=></span> <span class="variable">$filehandle</span> <span class="operator">}</span> <span class="operator">);</span>
</pre>
<pre>
<span class="variable">pod2usage</span><span class="operator">(</span> <span class="string">-msg</span> <span class="operator">=></span> <span class="variable">$message_text</span> <span class="operator">,</span>
<span class="string">-exitval</span> <span class="operator">=></span> <span class="variable">$exit_status</span> <span class="operator">,</span>
<span class="string">-verbose</span> <span class="operator">=></span> <span class="variable">$verbose_level</span><span class="operator">,</span>
<span class="string">-output</span> <span class="operator">=></span> <span class="variable">$filehandle</span> <span class="operator">);</span>
</pre>
<pre>
pod2usage( -verbose => 2,
-no<a href="../../lib/Pod/perldoc.html">perldoc</a> => 1 )</pre>
<p>
</p>
<hr />
<h1><a name="arguments">ARGUMENTS</a></h1>
<p><strong>pod2usage</strong> should be given either a single argument, or a list of
arguments corresponding to an associative array (a "hash"). When a single
argument is given, it should correspond to exactly one of the following:</p>
<ul>
<li>
<p>A string containing the text of a message to print <em>before</em> printing
the usage message</p>
</li>
<li>
<p>A numeric value corresponding to the desired exit status</p>
</li>
<li>
<p>A reference to a hash</p>
</li>
</ul>
<p>If more than one argument is given then the entire argument list is
assumed to be a hash. If a hash is supplied (either as a reference or
as a list) it should contain one or more elements with the following
keys:</p>
<dl>
<dt><strong><a name="item__2dmessage"><code>-message</code></a></strong>
<dt><strong><a name="item__2dmsg"><code>-msg</code></a></strong>
<dd>
<p>The text of a message to print immediately prior to printing the
program's usage message.</p>
</dd>
</li>
<dt><strong><a name="item__2dexitval"><code>-exitval</code></a></strong>
<dd>
<p>The desired exit status to pass to the <strong>exit()</strong> function.
This should be an integer, or else the string "NOEXIT" to
indicate that control should simply be returned without
terminating the invoking process.</p>
</dd>
</li>
<dt><strong><a name="item__2dverbose"><code>-verbose</code></a></strong>
<dd>
<p>The desired level of "verboseness" to use when printing the usage
message. If the corresponding value is 0, then only the "SYNOPSIS"
section of the pod documentation is printed. If the corresponding value
is 1, then the "SYNOPSIS" section, along with any section entitled
"OPTIONS", "ARGUMENTS", or "OPTIONS AND ARGUMENTS" is printed. If the
corresponding value is 2 or more then the entire manpage is printed.</p>
</dd>
<dd>
<p>The special verbosity level 99 requires to also specify the -section
parameter; then these sections are extracted (see <a href="../../lib/Pod/Select.html">the Pod::Select manpage</a>)
and printed.</p>
</dd>
</li>
<dt><strong><a name="item__2dsection"><code>-section</code></a></strong>
<dd>
<p>A string representing a selection list for sections to be printed
when -verbose is set to 99, e.g. <code>"NAME|SYNOPSIS|DESCRIPTION|VERSION"</code>.</p>
</dd>
</li>
<dt><strong><a name="item__2doutput"><code>-output</code></a></strong>
<dd>
<p>A reference to a filehandle, or the pathname of a file to which the
usage message should be written. The default is <code>\*STDERR</code> unless the
exit value is less than 2 (in which case the default is <code>\*STDOUT</code>).</p>
</dd>
</li>
<dt><strong><a name="item__2dinput"><code>-input</code></a></strong>
<dd>
<p>A reference to a filehandle, or the pathname of a file from which the
invoking script's pod documentation should be read. It defaults to the
file indicated by <a href="../../lib/Pod/perlvar.html#item__0"><code>$0</code></a> (<a href="../../lib/Pod/perlvar.html#item__program_name"><code>$PROGRAM_NAME</code></a> for users of <em>English.pm</em>).</p>
</dd>
</li>
<dt><strong><a name="item__2dpathlist"><code>-pathlist</code></a></strong>
<dd>
⌨️ 快捷键说明
复制代码Ctrl + C
搜索代码Ctrl + F
全屏模式F11
增大字号Ctrl + =
减小字号Ctrl + -
显示快捷键?