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