pod2usage(1) Mac OS X Manual Page

Mac Dev Center Mac OS X Reference Library General Mac OS X Man Pages

This manual page is for Mac OS X version 10.6.3

If you are running a different version of Mac OS X, view the documentation locally:

In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

For more information about the manual page format, see the manual page for manpages(5).
For more information about this technology, look for other documentation in the Apple Reference Library.
For general information about writing shell scripts, read Shell Scripting Primer.


POD2USAGE(1)                          Perl Programmers Reference Guide                          POD2USAGE(1)



NAME
       pod2usage - print usage messages from embedded pod docs in files

SYNOPSIS
       pod2usage   [-help] [-man] [-exit exitval] [-output outfile] [-verbose level] [-pathlist dirlist]
                   file

OPTIONS AND ARGUMENTS
       -help   Print a brief help message and exit.

       -man    Print this command's manual page and exit.

       -exit exitval
               The exit status value to return.

       -output outfile
               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.

       -verbose level
               The desired level of verbosity to use:

                   1 : print SYNOPSIS only
                   2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections
                   3 : print the entire manpage (similar to running pod2text)

       -pathlist dirlist
               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 DOS).

       file    The pathname of a file containing pod documentation to be output in usage mesage format
               (defaults to standard input).

DESCRIPTION
       pod2usage will read the given input file looking for pod documentation and will print the
       corresponding usage message.  If no input file is specified than standard input is read.

       pod2usage invokes the pod2usage() function in the Pod::Usage module. Please see "pod2usage()" in
       Pod::Usage.

SEE ALSO
       Pod::Usage, pod2text(1)

AUTHOR
       Please report bugs using <http://rt.cpan.org>.

       Brad Appleton <bradapp@enteract.com>

       Based on code for pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>



perl v5.10.0                                     2009-06-24                                     POD2USAGE(1)

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors: Report errors in the content of this documentation to the Perl project. (See perlbug(1) for submission instructions.)
Bug reports: Report bugs in the functionality of the described tool or API to Apple through Bug Reporter and to the Perl project using perlbug(1).
Formatting problems: Report formatting mistakes in the online version of these pages with the feedback links below.

Did this document help you?