CONTENTS

• NAME
• SYNOPSIS
• OPTIONS AND ARGUMENTS
• DESCRIPTION
• SEE ALSO
• AUTHOR

#NAME

pod2usage - print usage messages from embedded pod docs in files

#SYNOPSIS

#pod2usage

[-help] [-man] [-exitexitval] [-outputoutfile] [-verboselevel] [-pathlistdirlist] [-formattermodule]file

#OPTIONS AND ARGUMENTS

#-help

Print a brief help message and exit.

#-man

Print this command's manual page and exit.

#-exitexitval

The exit status value to return.

#-outputoutfile

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.

#-verboselevel

The desired level of verbosity to use:

1 : print SYNOPSIS only2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections3 : print the entire manpage (similar to running pod2text)

#-pathlistdirlist

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).

#-formattermodule

Which text formatter to use. Default isPod::Text, or for very old Perl versionsPod::PlainText. An alternative would be e.g.Pod::Text::Termcap.

#file

The pathname of a file containing pod documentation to be output in usage message 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 then standard input is read.

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

#SEE ALSO

Pod::Usage,pod2text(1)

#AUTHOR

Please report bugs usinghttp://rt.cpan.org.

Brad Appleton <bradapp@enteract.com>

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

Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.

The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.