Annotated edit history of
pod2usage(1) version 1, including all changes.
View license author blame.
| Rev |
Author |
# |
Line |
| 1 |
perry |
1 |
POD2USAGE |
| |
|
2 |
!!!POD2USAGE |
| |
|
3 |
NAME |
| |
|
4 |
SYNOPSIS |
| |
|
5 |
OPTIONS AND ARGUMENTS |
| |
|
6 |
DESCRIPTION |
| |
|
7 |
SEE ALSO |
| |
|
8 |
AUTHOR |
| |
|
9 |
---- |
| |
|
10 |
!!NAME |
| |
|
11 |
|
| |
|
12 |
|
| |
|
13 |
pod2usage - print usage messages from embedded pod docs in files |
| |
|
14 |
!!SYNOPSIS |
| |
|
15 |
|
| |
|
16 |
|
| |
|
17 |
__pod2usage__ |
| |
|
18 |
|
| |
|
19 |
|
| |
|
20 |
[[__-help__] [[__-man__] [[__-exit__ ''exitval''] |
| |
|
21 |
[[__-output__ ''outfile''] [[__-verbose__ |
| |
|
22 |
''level''] [[__-pathlist__ ''dirlist''] |
| |
|
23 |
''file'' |
| |
|
24 |
!!OPTIONS AND ARGUMENTS |
| |
|
25 |
|
| |
|
26 |
|
| |
|
27 |
__-help__ |
| |
|
28 |
|
| |
|
29 |
|
| |
|
30 |
Print a brief help message and exit. |
| |
|
31 |
|
| |
|
32 |
|
| |
|
33 |
__-man__ |
| |
|
34 |
|
| |
|
35 |
|
| |
|
36 |
Print this command's manual page and exit. |
| |
|
37 |
|
| |
|
38 |
|
| |
|
39 |
__-exit__ ''exitval'' |
| |
|
40 |
|
| |
|
41 |
|
| |
|
42 |
The exit status value to return. |
| |
|
43 |
|
| |
|
44 |
|
| |
|
45 |
__-output__ ''outfile'' |
| |
|
46 |
|
| |
|
47 |
|
| |
|
48 |
The output file to print to. If the special names ``-'' or |
| |
|
49 |
`` |
| |
|
50 |
|
| |
|
51 |
|
| |
|
52 |
__-verbose__ ''level'' |
| |
|
53 |
|
| |
|
54 |
|
| |
|
55 |
The desired level of verbosity to use: |
| |
|
56 |
|
| |
|
57 |
|
| |
|
58 |
1 : print SYNOPSIS only |
| |
|
59 |
2 : print SYNOPSIS sections and any OPTIONS/ARGUMENTS sections |
| |
|
60 |
3 : print the entire manpage (similar to running pod2text) |
| |
|
61 |
|
| |
|
62 |
|
| |
|
63 |
__-pathlist__ ''dirlist'' |
| |
|
64 |
|
| |
|
65 |
|
| |
|
66 |
Specifies one or more directories to search for the input |
| |
|
67 |
file if it was not supplied with an absolute path. Each |
| |
|
68 |
directory path in the given list should be separated by a |
| |
|
69 |
':' on Unix (';' on MSWin32 and DOS |
| |
|
70 |
). |
| |
|
71 |
|
| |
|
72 |
|
| |
|
73 |
''file'' |
| |
|
74 |
|
| |
|
75 |
|
| |
|
76 |
The pathname of a file containing pod documentation to be |
| |
|
77 |
output in usage mesage format (defaults to standard |
| |
|
78 |
input). |
| |
|
79 |
!!DESCRIPTION |
| |
|
80 |
|
| |
|
81 |
|
| |
|
82 |
__pod2usage__ will read the given input file looking for |
| |
|
83 |
pod documentation and will print the corresponding usage |
| |
|
84 |
message. If no input file is specifed than standard input is |
| |
|
85 |
read. |
| |
|
86 |
|
| |
|
87 |
|
| |
|
88 |
__pod2usage__ invokes the ''pod2usage()'' function in |
| |
|
89 |
the __Pod::Usage__ module. Please see |
| |
|
90 |
``''pod2usage()'''' in Pod::Usage. |
| |
|
91 |
!!SEE ALSO |
| |
|
92 |
|
| |
|
93 |
|
| |
|
94 |
Pod::Usage, ''pod2text''(1) |
| |
|
95 |
!!AUTHOR |
| |
|
96 |
|
| |
|
97 |
|
| |
|
98 |
Brad Appleton |
| |
|
99 |
|
| |
|
100 |
|
| |
|
101 |
Based on code for ''pod2text''__(1)__ written by Tom |
| |
|
102 |
Christiansen __ |
| |
|
103 |
---- |
This page is a man page (or other imported legacy content). We are unable to automatically determine the license status of this page.
