191f110e0Safresh1###### begin =include pod2usage.PL ##### 291f110e0Safresh1NAME 391f110e0Safresh1 pod2usage - print usage messages from embedded pod docs in files 491f110e0Safresh1 591f110e0Safresh1SYNOPSIS 691f110e0Safresh1 pod2usage [-help] [-man] [-exit *exitval*] [-output *outfile*] 791f110e0Safresh1 [-verbose *level*] [-pathlist *dirlist*] [-formatter 8b8851fccSafresh1 *module*] [-utf8] *file* 991f110e0Safresh1 1091f110e0Safresh1OPTIONS AND ARGUMENTS 1191f110e0Safresh1 -help Print a brief help message and exit. 1291f110e0Safresh1 1391f110e0Safresh1 -man Print this command's manual page and exit. 1491f110e0Safresh1 1591f110e0Safresh1 -exit *exitval* 1691f110e0Safresh1 The exit status value to return. 1791f110e0Safresh1 1891f110e0Safresh1 -output *outfile* 1991f110e0Safresh1 The output file to print to. If the special names "-" or ">&1" 2091f110e0Safresh1 or ">&STDOUT" are used then standard output is used. If ">&2" or 2191f110e0Safresh1 ">&STDERR" is used then standard error is used. 2291f110e0Safresh1 2391f110e0Safresh1 -verbose *level* 2491f110e0Safresh1 The desired level of verbosity to use: 2591f110e0Safresh1 2691f110e0Safresh1 1 : print SYNOPSIS only 2791f110e0Safresh1 2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections 2891f110e0Safresh1 3 : print the entire manpage (similar to running pod2text) 2991f110e0Safresh1 3091f110e0Safresh1 -pathlist *dirlist* 3191f110e0Safresh1 Specifies one or more directories to search for the input file 3291f110e0Safresh1 if it was not supplied with an absolute path. Each directory 3391f110e0Safresh1 path in the given list should be separated by a ':' on Unix (';' 3491f110e0Safresh1 on MSWin32 and DOS). 3591f110e0Safresh1 3691f110e0Safresh1 -formatter *module* 3791f110e0Safresh1 Which text formatter to use. Default is the Pod::Text manpage, 3891f110e0Safresh1 or for very old Perl versions the Pod::PlainText manpage. An 3991f110e0Safresh1 alternative would be e.g. the Pod::Text::Termcap manpage. 4091f110e0Safresh1 41b8851fccSafresh1 -utf8 This option assumes that the formatter (see above) understands 42b8851fccSafresh1 the option "utf8". It turns on generation of utf8 output. 43b8851fccSafresh1 4491f110e0Safresh1 *file* The pathname of a file containing pod documentation to be output 45*eac174f2Safresh1 in usage message format. If omitted, standard input is read - 46*eac174f2Safresh1 but the output is then formatted with the Pod::Text manpage only 47*eac174f2Safresh1 - unless a specific formatter has been specified with 48*eac174f2Safresh1 -formatter. 4991f110e0Safresh1 5091f110e0Safresh1DESCRIPTION 5191f110e0Safresh1 pod2usage will read the given input file looking for pod documentation 5291f110e0Safresh1 and will print the corresponding usage message. If no input file is 5391f110e0Safresh1 specified then standard input is read. 5491f110e0Safresh1 5591f110e0Safresh1 pod2usage invokes the pod2usage() function in the Pod::Usage module. 5691f110e0Safresh1 Please see the pod2usage() entry in the Pod::Usage manpage. 5791f110e0Safresh1 5891f110e0Safresh1SEE ALSO 59*eac174f2Safresh1 the Pod::Usage manpage, the pod2text manpage, the Pod::Text manpage, the 60*eac174f2Safresh1 Pod::Text::Termcap manpage, the perldoc manpage 6191f110e0Safresh1 6291f110e0Safresh1AUTHOR 6391f110e0Safresh1 Please report bugs using http://rt.cpan.org. 6491f110e0Safresh1 6591f110e0Safresh1 Brad Appleton <bradapp@enteract.com> 6691f110e0Safresh1 6791f110e0Safresh1 Based on code for pod2text(1) written by Tom Christiansen 6891f110e0Safresh1 <tchrist@mox.perl.com> 6991f110e0Safresh1 7091f110e0Safresh1###### end =include pod2usage.PL ##### 71