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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
Description: A one-line description of what the program does.
Include: #include <this>
Min: 0
Max: -1
Show-Pid: 0
Usage: FILE [FILE ...]
[prefix]
The text in this section is shown in the command usage
before the options description.
[options]
The list of options this program accepts. Format is:
-S --long TYPE[=VALUE] VARIABLE =default
One line help text =default-text
TYPE is one of: FLAG, COUNTER, INTEGER, UINTEGER, STRING, STRINGLIST,
FUNCTION, or SEPARATOR.
Examples:
-q --quiet FLAG=0 opt_verbose
Eliminate all program output except errors
-v --verbose COUNTER=1 opt_verbose
Generate more program output
--count INTEGER opt_count =1
How many items to process =only the first
-x STRINGLIST opt_extensions
Add an extension name
[suffix]
The text in this section is shown in the command usage
after the options description.
[description]
Long drawn out discussion of the program.
[return value]
What the program or function returns if successful.
[errors]
Exceptions, return codes, exit stati, and errno settings.
[examples]
Give some example uses of the program.
[environment]
@table @env
@item NAME
What setting @env{$NAME} does.
@end table
[files]
All files used by the program.
@table @file
@item filename
@end table
[see also]
Other man pages to check out, like man(1), man(7), makewhatis(8), or
catman(8).
[notes]
Miscellaneous commentary.
[caveats]
Things to take special care with; sometimes called [warnings].
[diagnostics]
All possible messages the program can print out--and
what they mean.
[bugs]
Things that are broken or just don't work quite right.
[restrictions]
Bugs you don't plan to fix :-)
[author]
Who wrote it (or AUTHORS if multiple)
[history]
Programs derived from other sources sometimes have this, or
you might keep a modification log here.
|
