153 lines
3.7 KiB
HTML
153 lines
3.7 KiB
HTML
|
||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
<HTML><HEAD><TITLE>Man page of POD2USAGE</TITLE>
|
||
</HEAD><BODY>
|
||
<H1>POD2USAGE</H1>
|
||
Section: Perl Programmers Reference Guide (1)<BR>Updated: 2020-10-19<BR><A HREF="#index">Index</A>
|
||
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<A NAME="lbAB"> </A>
|
||
<H2>NAME</H2>
|
||
|
||
pod2usage - print usage messages from embedded pod docs in files
|
||
<A NAME="lbAC"> </A>
|
||
<H2>SYNOPSIS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="1"><B>pod2usage</B><DD>
|
||
|
||
|
||
[<B>-help</B>]
|
||
[<B>-man</B>]
|
||
[<B>-exit</B> <I>exitval</I>]
|
||
[<B>-output</B> <I>outfile</I>]
|
||
[<B>-verbose</B> <I>level</I>]
|
||
[<B>-pathlist</B> <I>dirlist</I>]
|
||
[<B>-formatter</B> <I>module</I>]
|
||
[<B>-utf8</B>]
|
||
<I>file</I>
|
||
</DL>
|
||
<A NAME="lbAD"> </A>
|
||
<H2>OPTIONS AND ARGUMENTS</H2>
|
||
|
||
|
||
|
||
<DL COMPACT>
|
||
<DT id="2"><B>-help</B><DD>
|
||
|
||
|
||
Print a brief help message and exit.
|
||
<DT id="3"><B>-man</B><DD>
|
||
|
||
|
||
Print this command's manual page and exit.
|
||
<DT id="4"><B>-exit</B> <I>exitval</I><DD>
|
||
|
||
|
||
The exit status value to return.
|
||
<DT id="5"><B>-output</B> <I>outfile</I><DD>
|
||
|
||
|
||
The output file to print to. If the special names ``-'' or ``>&1'' or ``>&STDOUT''
|
||
are used then standard output is used. If ``>&2'' or ``>&STDERR'' is used then
|
||
standard error is used.
|
||
<DT id="6"><B>-verbose</B> <I>level</I><DD>
|
||
|
||
|
||
The desired level of verbosity to use:
|
||
|
||
|
||
<P>
|
||
|
||
|
||
|
||
|
||
<PRE>
|
||
1 : print SYNOPSIS only
|
||
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
|
||
3 : print the entire manpage (similar to running pod2text)
|
||
|
||
</PRE>
|
||
|
||
|
||
<DT id="7"><B>-pathlist</B> <I>dirlist</I><DD>
|
||
|
||
|
||
Specifies one or more directories to search for the input file if it
|
||
was not supplied with an absolute path. Each directory path in the given
|
||
list should be separated by a ':' on Unix (';' on MSWin32 and <FONT SIZE="-1">DOS</FONT>).
|
||
<DT id="8"><B>-formatter</B> <I>module</I><DD>
|
||
|
||
|
||
Which text formatter to use. Default is Pod::Text, or for very old
|
||
Perl versions Pod::PlainText. An alternative would be e.g.
|
||
Pod::Text::Termcap.
|
||
<DT id="9"><B>-utf8</B><DD>
|
||
|
||
|
||
This option assumes that the formatter (see above) understands the option
|
||
``utf8''. It turns on generation of utf8 output.
|
||
<DT id="10"><I>file</I><DD>
|
||
|
||
|
||
The pathname of a file containing pod documentation to be output in
|
||
usage message format (defaults to standard input).
|
||
</DL>
|
||
<A NAME="lbAE"> </A>
|
||
<H2>DESCRIPTION</H2>
|
||
|
||
|
||
|
||
<B>pod2usage</B> will read the given input file looking for pod
|
||
documentation and will print the corresponding usage message.
|
||
If no input file is specified then standard input is read.
|
||
<P>
|
||
|
||
<B>pod2usage</B> invokes the <B>pod2usage()</B> function in the <B>Pod::Usage</B>
|
||
module. Please see ``<B>pod2usage()</B>'' in Pod::Usage.
|
||
<A NAME="lbAF"> </A>
|
||
<H2>SEE ALSO</H2>
|
||
|
||
|
||
|
||
Pod::Usage, <B><A HREF="/cgi-bin/man/man2html?1+pod2text">pod2text</A></B>(1)
|
||
<A NAME="lbAG"> </A>
|
||
<H2>AUTHOR</H2>
|
||
|
||
|
||
|
||
Please report bugs using <<A HREF="http://rt.cpan.org">http://rt.cpan.org</A>>.
|
||
<P>
|
||
|
||
Brad Appleton <<A HREF="mailto:bradapp@enteract.com">bradapp@enteract.com</A>>
|
||
<P>
|
||
|
||
Based on code for <B><A HREF="/cgi-bin/man/man2html?1+pod2text">pod2text</A>(1)</B> written by
|
||
Tom Christiansen <<A HREF="mailto:tchrist@mox.perl.com">tchrist@mox.perl.com</A>>
|
||
<P>
|
||
|
||
<HR>
|
||
<A NAME="index"> </A><H2>Index</H2>
|
||
<DL>
|
||
<DT id="11"><A HREF="#lbAB">NAME</A><DD>
|
||
<DT id="12"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
||
<DT id="13"><A HREF="#lbAD">OPTIONS AND ARGUMENTS</A><DD>
|
||
<DT id="14"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
||
<DT id="15"><A HREF="#lbAF">SEE ALSO</A><DD>
|
||
<DT id="16"><A HREF="#lbAG">AUTHOR</A><DD>
|
||
</DL>
|
||
<HR>
|
||
This document was created by
|
||
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
||
using the manual pages.<BR>
|
||
Time: 00:05:24 GMT, March 31, 2021
|
||
</BODY>
|
||
</HTML>
|