Linux Commands Examples

A great documentation place for Linux commands


print usage messages from embedded pod docs in files

see also : pod2text



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

add an example, a script, a trick and tips

: email address (won't be displayed)
: name

Step 2

Thanks for this example ! - It will be moderated and published shortly.

Feel free to post other examples
Oops ! There is a tiny cockup. A damn 404 cockup. Please contact the loosy team who maintains and develops this wonderful site by clicking in the mighty feedback button on the side of the page. Say what happened. Thanks!


no example yet ...

... Feel free to add your own example above to help other Linux-lovers !


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 the pod2usage() function in the Pod::Usage module. Please see "pod2usage()" in Pod::Usage.

options and arguments


Print a brief help message and exit.


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


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

see also

Pod::Usage, pod2text


Please report bugs using <>.

Brad Appleton <bradapp[:at:]enteract[:dot:]com>

Based on code for pod2text(1) written by Tom Christiansen <tchrist[:at:]mox.perl[:dot:]com>

How can this site be more helpful to YOU ?

give  feedback