Tag | Description |
---|---|
pod2usage | [-help] [-man] [-exit exitval] [-output outfile] [-verbose level] [-pathlist dirlist] file |
Tag | Description | |
---|---|---|
-help | Print a brief help message and exit. | |
-man | Print this commands 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:
| |
-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). |
pod2usage invokes the pod2usage() function in the Pod::Usage module. Please see pod2usage() in Pod::Usage.
Brad Appleton <bradapp@enteract.com>
Based on code for pod2text(1) written by
Tom Christiansen <tchrist@mox.perl.com>
Advertisements |