1###### begin =include pod2usage.PL ##### 2NAME 3 pod2usage - print usage messages from embedded pod docs in files 4 5SYNOPSIS 6 pod2usage [-help] [-man] [-exit *exitval*] [-output *outfile*] 7 [-verbose *level*] [-pathlist *dirlist*] *file* 8 9OPTIONS AND ARGUMENTS 10 -help Print a brief help message and exit. 11 12 -man Print this command's manual page and exit. 13 14 -exit *exitval* 15 The exit status value to return. 16 17 -output *outfile* 18 The output file to print to. If the special names "-" or ">&1" 19 or ">&STDOUT" are used then standard output is used. If ">&2" or 20 ">&STDERR" is used then standard error is used. 21 22 -verbose *level* 23 The desired level of verbosity to use: 24 25 1 : print SYNOPSIS only 26 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections 27 3 : print the entire manpage (similar to running pod2text) 28 29 -pathlist *dirlist* 30 Specifies one or more directories to search for the input file 31 if it was not supplied with an absolute path. Each directory 32 path in the given list should be separated by a ':' on Unix (';' 33 on MSWin32 and DOS). 34 35 *file* The pathname of a file containing pod documentation to be output 36 in usage mesage format (defaults to standard input). 37 38DESCRIPTION 39 pod2usage will read the given input file looking for pod documentation 40 and will print the corresponding usage message. If no input file is 41 specifed than standard input is read. 42 43 pod2usage invokes the pod2usage() function in the Pod::Usage module. 44 Please see the pod2usage() entry in the Pod::Usage manpage. 45 46SEE ALSO 47 the Pod::Usage manpage, the pod2text(1) manpage 48 49AUTHOR 50 Please report bugs using http://rt.cpan.org. 51 52 Brad Appleton <bradapp@enteract.com> 53 54 Based on code for pod2text(1) written by Tom Christiansen 55 <tchrist@mox.perl.com> 56 57###### end =include pod2usage.PL ##### 58