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
|
include(manual.h)dnl
HEADER(program name)
SECTION(NAME)
BOLD(program) - one sentence explanation
SECTION(SYNOPSIS)
CODE(BOLD(program [options] arguments))
SECTION(DESCRIPTION)
Describe what the program is good for in one or two paragraphs here.
PARA
Here is how to split paragraphs.
PARA
Examples of type styles: BOLD(bold), ITALIC(italic), CODE(code).
SECTION(OPTIONS)
List all options here in alphabetical order.
It's ok to copy and paste from the program help text or the manual.
OPTIONS_BEGIN
OPTION_PAIR(-d,flag) Enable debugging for this sub-system.
OPTION_ITEM(-h) Display version information.
OPTION_ITEM(-v) Show help text.
OPTIONS_END
SECTION(ENVIRONMENT VARIABLES)
List any environment variables used or set in this section.
SECTION(EXIT STATUS)
On success, returns zero. On failure, returns non-zero.
SECTION(EXAMPLES)
Give 1-3 short examples of how to use the program:
To access a single remote file using BOLD(vi):
LONGCODE_BEGIN
parrot_run vi /anonftp/ftp.gnu.org/pub/README
LONGCODE_END
You can also run an entire shell inside of Parrot, like this:
LONGCODE_BEGIN
parrot_run bash
cd /anonftp/ftp.gnu.org/pub
ls -la
cat README
LONGCODE_END
SECTION(COPYRIGHT)
COPYRIGHT_BOILERPLATE
SECTION(SEE ALSO)
LIST_BEGIN
LIST_ITEM LINK(The Cooperative Computing Tools,"http://www.nd.edu/~ccl/software/manuals")
LIST_ITEM LINK(Parrot User Manual,"http://www.nd.edu/~ccl/software/manuals/parrot.html")
LIST_ITEM MANPAGE(parrot_run,1)
LIST_ITEM MANPAGE(makeflow,1)
LIST_END
FOOTER
|
