blob: be8af9553c9f018243760b81cccaf833e5dbac12 (
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
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
[+: -*- Mode: nroff -*-
AutoGen5 template mdoc
## agman-cmd.tpl -- Template for command line mdoc pages
##
## Time-stamp: "2011-11-18 07:48:29 bkorb"
##
## This file is part of AutoOpts, a companion to AutoGen.
## AutoOpts is free software.
## AutoOpts is Copyright (c) 1992-2012 by Bruce Korb - all rights reserved
##
## AutoOpts is available under any one of two licenses. The license
## in use must be one of these two and the choice is under the control
## of the user of the license.
##
## The GNU Lesser General Public License, version 3 or later
## See the files "COPYING.lgplv3" and "COPYING.gplv3"
##
## The Modified Berkeley Software Distribution License
## See the file "COPYING.mbsd"
##
## These files have the following md5sums:
##
## 43b91e8ca915626ed3818ffb1b71248b COPYING.gplv3
## 06a1a2e4760c90ea5e1dad8dfaac4d39 COPYING.lgplv3
## 66a5cedaf62c4b2637025f049f9b826f COPYING.mbsd
# Produce a man page for section 1, 5 or 8 commands.
# Which is selected via: -DMAN_SECTION=n
# passed to the autogen invocation. "n" may have a suffix, if desired.
#
:+][+:
(define head-line (lambda() (string-append
".Dd " (shell "date '+%B %e %Y' | sed 's/ */ /g'")
"\n.Dt " UP-PROG-NAME " " man-sect " " section-name
"\n.Os " (shell "uname -sr") "\n") ))
(define man-page #f)
:+][+:
INCLUDE "cmd-doc.tlib"
:+]
.Sh NAME
.Nm [+: prog-name :+]
.Nd [+: prog-title :+]
[+: INVOKE build-doc :+][+:
(out-move (string-append (get "prog-name") "."
man-sect)) :+][+:#
.\" = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
.\" S Y N O P S I S
.\" = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = :+][+:
DEFINE mk-synopsis :+][+:
(out-push-new file-name) \:+]
.Sh SYNOPSIS
.Nm[+:
IF (. use-flags) :+][+:
IF (exist? "long-opts") :+]
.\" Mixture of short (flag) options and long options
.Op Fl flags
.Op Fl flag Ar value
.Op Fl \-option-name Ar value
[+: ELSE no long options: :+]
.Op Fl flags
.Op Fl flag Ar value
[+: ENDIF
:+][+:
ELIF (exist? "long-opts")
:+]
.Op Fl \-option-name
.Op Fl \-option-name Ar value
[+:
ELIF (not (exist? "argument")) :+]
.Op Ar option\-name Ar value
.Pp
All arguments are named options.
[+:
ENDIF :+][+:
IF (exist? "argument") :+][+:
argument :+][+:
IF (exist? "reorder-args") :+]
.Pp
Operands and options may be intermixed. They will be reordered.
[+: ENDIF :+][+:
ELIF (or (exist? "long-opts") use-flags)
:+]
.Pp
All arguments must be options.
[+:
ENDIF :+]
.Pp
[+:
FOR explain "\n.Pp\n" :+][+:
explain :+][+:
ENDFOR :+][+:
(out-pop) :+][+:
ENDDEF mk-synopsis
agmdoc-cmd.tpl ends here :+]
|
