Commit | Line | Data |
---|---|---|
e70712b3 PP |
1 | [specialcharacters] |
2 | ||
3 | # LaTeX-like non-breaking space (disables subscript but we don't need it) | |
4 | ~=  | |
5 | ||
0659f3af PP |
6 | [macros] |
7 | ||
8 | # command-line option in another man page macro | |
9 | # | |
10 | # Usage: manopt:page(section):--option-name | |
11 | (?su)[\\]?(?P<name>manopt):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\):(?P<opt>--?[a-zA-Z0-9-]*)= | |
12 | ||
13 | # component class initialization parameter in another man page macro | |
14 | # | |
15 | # Usage: manparam:type.plugin.compcls:param-name | |
16 | (?su)[\\]?(?P<name>manparam):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))= | |
17 | ||
18 | # man macro | |
19 | # | |
20 | # Usage: man:page(section) | |
21 | (?su)[\\]?(?P<name>man):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\)= | |
22 | ||
23 | # no link option macro | |
24 | # | |
25 | # Usage: nlopt:--option-name | |
26 | (?su)[\\]?(?P<name>nlopt):(?P<opt>--?[a-zA-Z0-9-]*)= | |
27 | ||
28 | # command-line option macro | |
29 | # | |
30 | # Usage: opt:--option-name | |
31 | (?su)[\\]?(?P<name>opt):(?P<opt>--?[a-zA-Z0-9-]*)= | |
32 | ||
33 | # no link component class initialization parameter macro | |
34 | # | |
35 | # Usage: nlparam:param-name | |
36 | (?su)[\\]?(?P<name>nlparam):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))= | |
37 | ||
38 | # component class initialization parameter macro | |
39 | # | |
40 | # Usage: param:param-name | |
41 | (?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))= | |
42 | ||
e70712b3 PP |
43 | # no link query result object entry macro |
44 | # | |
45 | # Usage: nlqres:qres-name | |
46 | (?su)[\\]?(?P<name>nlqres):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))= | |
47 | ||
48 | # query result object entry macro | |
49 | # | |
50 | # Usage: qres:qres-name | |
51 | (?su)[\\]?(?P<name>qres):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))= | |
52 | ||
0659f3af PP |
53 | # component class specification macro |
54 | # | |
55 | # Usage: compcls:TYPE.PLUGIN.COMPCLS | |
56 | (?su)[\\]?(?P<name>compcls):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+)= | |
57 | ||
e70712b3 PP |
58 | # value object type |
59 | # | |
60 | # Usage: vtype:[TYPE] | |
61 | (?su)[\\]?(?P<name>vtype):\[(?P<type>[^\]]+)\]= | |
62 | ||
63 | # not macro (emphasis) | |
0659f3af PP |
64 | # |
65 | # Usage: :not: | |
66 | :not:=not | |
67 | ||
e70712b3 PP |
68 | # all macro (emphasis) |
69 | # | |
70 | # Usage: :all: | |
71 | :all:=all | |
72 | ||
0659f3af PP |
73 | # escstar macro |
74 | # | |
75 | # Usage: :escstar: | |
76 | :escstar:=escstar | |
77 | ||
78 | # esccomma macro | |
79 | # | |
80 | # Usage: :esccomma: | |
81 | :esccomma:=esccomma | |
82 | ||
83 | # escdot macro | |
84 | # | |
85 | # Usage: :escdot: | |
86 | :escdot:=escdot | |
87 | ||
88 | # bs macro | |
89 | # | |
90 | # Usage: :bs: | |
91 | :bs:=bs | |
92 | ||
e70712b3 | 93 | # macro expansions for DocBook backend (begin) |
0659f3af PP |
94 | ifdef::doctype-manpage[] |
95 | ifdef::backend-docbook[] | |
e70712b3 PP |
96 | |
97 | # man macro expansions | |
0659f3af PP |
98 | [man-inlinemacro] |
99 | <citerefentry> | |
100 | <refentrytitle>{target}</refentrytitle><manvolnum>{section}</manvolnum> | |
101 | </citerefentry> | |
0659f3af PP |
102 | |
103 | # no link option macro expansions | |
0659f3af PP |
104 | [nlopt-inlinemacro] |
105 | <literal>{opt}</literal> | |
0659f3af PP |
106 | |
107 | # command-line option macro expansions | |
0659f3af PP |
108 | [opt-inlinemacro] |
109 | <literal>{opt}</literal> | |
0659f3af PP |
110 | |
111 | # command-line option in another man page macro expansions | |
0659f3af PP |
112 | [manopt-inlinemacro] |
113 | <literal>{opt}</literal> | |
0659f3af PP |
114 | |
115 | # component class initialization parameter macro expansions | |
0659f3af PP |
116 | [param-inlinemacro] |
117 | <literal>{pname}</literal> | |
0659f3af PP |
118 | |
119 | # no link component class initialization parameter macro expansions | |
0659f3af PP |
120 | [nlparam-inlinemacro] |
121 | <literal>{pname}</literal> | |
e70712b3 PP |
122 | |
123 | # query result entry macro expansions | |
124 | [qres-inlinemacro] | |
125 | <literal>{pname}</literal> | |
126 | ||
127 | # no link query result entry macro expansions | |
128 | [nlqres-inlinemacro] | |
129 | <literal>{pname}</literal> | |
0659f3af PP |
130 | |
131 | # component class initialization parameter in another man page macro expansions | |
0659f3af PP |
132 | [manparam-inlinemacro] |
133 | <literal>{pname}</literal> | |
0659f3af PP |
134 | |
135 | # component class specification macro expansions | |
0659f3af PP |
136 | [compcls-inlinemacro] |
137 | <literal>{cctype}.{ccplug}.{ccname}</literal> | |
e70712b3 PP |
138 | |
139 | # value object type macro expansions | |
140 | [vtype-inlinemacro] | |
141 | [{type}] | |
0659f3af PP |
142 | |
143 | # not macro expansions | |
0659f3af PP |
144 | [not-inlinemacro] |
145 | NOT | |
e70712b3 PP |
146 | |
147 | # all macro expansions | |
148 | [all-inlinemacro] | |
149 | ALL | |
0659f3af PP |
150 | |
151 | # escstar macro expansions | |
0659f3af PP |
152 | [escstar-inlinemacro] |
153 | <literal>\e*</literal> | |
0659f3af PP |
154 | |
155 | # esccomma macro expansions | |
0659f3af PP |
156 | [esccomma-inlinemacro] |
157 | <literal>\e,</literal> | |
0659f3af PP |
158 | |
159 | # escdot macro expansions | |
0659f3af PP |
160 | [escdot-inlinemacro] |
161 | <literal>\e,</literal> | |
0659f3af PP |
162 | |
163 | # bs macro expansions | |
0659f3af PP |
164 | [bs-inlinemacro] |
165 | <literal>\e</literal> | |
0659f3af PP |
166 | |
167 | # configure XML man page header | |
0659f3af PP |
168 | [header] |
169 | template::[header-declarations] | |
170 | <refentry> | |
171 | <refentryinfo> | |
172 | <date>{revdate}</date> | |
173 | </refentryinfo> | |
174 | <refmeta> | |
175 | <refentrytitle>{mantitle}</refentrytitle> | |
176 | <manvolnum>{manvolnum}</manvolnum> | |
177 | <refmiscinfo class="source">Babeltrace</refmiscinfo> | |
178 | <refmiscinfo class="version">{babeltrace_version}</refmiscinfo> | |
e70712b3 | 179 | <refmiscinfo class="manual">Babeltrace 2 manual</refmiscinfo> |
0659f3af PP |
180 | </refmeta> |
181 | <refnamediv> | |
182 | <refname>{manname}</refname> | |
183 | <refpurpose>{manpurpose}</refpurpose> | |
184 | </refnamediv> | |
e70712b3 PP |
185 | |
186 | # macro expansions for DocBook backend (end) | |
0659f3af PP |
187 | endif::backend-docbook[] |
188 | endif::doctype-manpage[] |