blob: ceac4f1f825596e748c077c9a8380b67aeddd56f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
|
###### begin =include pod2usage.PL #####
NAME
pod2usage - print usage messages from embedded pod docs in files
SYNOPSIS
pod2usage [-help] [-man] [-exit *exitval*] [-output *outfile*]
[-verbose *level*] [-pathlist *dirlist*] [-formatter
*module*] *file*
OPTIONS AND ARGUMENTS
-help Print a brief help message and exit.
-man 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).
-formatter *module*
Which text formatter to use. Default is the Pod::Text manpage,
or for very old Perl versions the Pod::PlainText manpage. An
alternative would be e.g. the Pod::Text::Termcap manpage.
*file* The pathname of a file containing pod documentation to be output
in usage message format (defaults to standard input).
DESCRIPTION
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 the pod2usage() entry in the Pod::Usage manpage.
SEE ALSO
the Pod::Usage manpage, the pod2text(1) manpage
AUTHOR
Please report bugs using http://rt.cpan.org.
Brad Appleton <bradapp@enteract.com>
Based on code for pod2text(1) written by Tom Christiansen
<tchrist@mox.perl.com>
###### end =include pod2usage.PL #####
|
