3 # command-line option in another man page macro
5 # Usage: manopt:page(section):--option-name
6 (?su)[\\]?(?P<name>manopt):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\):(?P<opt>--?[a-zA-Z0-9-]*)=
8 # component class initialization parameter in another man page macro
10 # Usage: manparam:type.plugin.compcls:param-name
11 (?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_:.-]+(?<![:.]))=
15 # Usage: man:page(section)
16 (?su)[\\]?(?P<name>man):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\)=
18 # no link option macro
20 # Usage: nlopt:--option-name
21 (?su)[\\]?(?P<name>nlopt):(?P<opt>--?[a-zA-Z0-9-]*)=
23 # command-line option macro
25 # Usage: opt:--option-name
26 (?su)[\\]?(?P<name>opt):(?P<opt>--?[a-zA-Z0-9-]*)=
28 # no link component class initialization parameter macro
30 # Usage: nlparam:param-name
31 (?su)[\\]?(?P<name>nlparam):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
33 # component class initialization parameter macro
35 # Usage: param:param-name
36 (?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
38 # component class specification macro
40 # Usage: compcls:TYPE.PLUGIN.COMPCLS
41 (?su)[\\]?(?P<name>compcls):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+)=
68 # man macro expansions
69 ifdef::doctype-manpage[]
70 ifdef::backend-docbook[]
73 <refentrytitle>{target}</refentrytitle><manvolnum>{section}</manvolnum>
75 endif::backend-docbook[]
76 endif::doctype-manpage[]
78 # no link option macro expansions
79 ifdef::doctype-manpage[]
80 ifdef::backend-docbook[]
82 <literal>{opt}</literal>
83 endif::backend-docbook[]
84 endif::doctype-manpage[]
86 # command-line option macro expansions
87 ifdef::doctype-manpage[]
88 ifdef::backend-docbook[]
90 <literal>{opt}</literal>
91 endif::backend-docbook[]
92 endif::doctype-manpage[]
94 # command-line option in another man page macro expansions
95 ifdef::doctype-manpage[]
96 ifdef::backend-docbook[]
98 <literal>{opt}</literal>
99 endif::backend-docbook[]
100 endif::doctype-manpage[]
102 # component class initialization parameter macro expansions
103 ifdef::doctype-manpage[]
104 ifdef::backend-docbook[]
106 <literal>{pname}</literal>
107 endif::backend-docbook[]
108 endif::doctype-manpage[]
110 # no link component class initialization parameter macro expansions
111 ifdef::doctype-manpage[]
112 ifdef::backend-docbook[]
113 [nlparam-inlinemacro]
114 <literal>{pname}</literal>
115 endif::backend-docbook[]
116 endif::doctype-manpage[]
118 # component class initialization parameter in another man page macro expansions
119 ifdef::doctype-manpage[]
120 ifdef::backend-docbook[]
121 [manparam-inlinemacro]
122 <literal>{pname}</literal>
123 endif::backend-docbook[]
124 endif::doctype-manpage[]
126 # component class specification macro expansions
127 ifdef::doctype-manpage[]
128 ifdef::backend-docbook[]
129 [compcls-inlinemacro]
130 <literal>{cctype}.{ccplug}.{ccname}</literal>
131 endif::backend-docbook[]
132 endif::doctype-manpage[]
134 # not macro expansions
135 ifdef::doctype-manpage[]
136 ifdef::backend-docbook[]
139 endif::backend-docbook[]
140 endif::doctype-manpage[]
142 # escstar macro expansions
143 ifdef::doctype-manpage[]
144 ifdef::backend-docbook[]
145 [escstar-inlinemacro]
146 <literal>\e*</literal>
147 endif::backend-docbook[]
148 endif::doctype-manpage[]
150 # esccomma macro expansions
151 ifdef::doctype-manpage[]
152 ifdef::backend-docbook[]
153 [esccomma-inlinemacro]
154 <literal>\e,</literal>
155 endif::backend-docbook[]
156 endif::doctype-manpage[]
158 # escdot macro expansions
159 ifdef::doctype-manpage[]
160 ifdef::backend-docbook[]
162 <literal>\e,</literal>
163 endif::backend-docbook[]
164 endif::doctype-manpage[]
166 # bs macro expansions
167 ifdef::doctype-manpage[]
168 ifdef::backend-docbook[]
170 <literal>\e</literal>
171 endif::backend-docbook[]
172 endif::doctype-manpage[]
174 # configure XML man page header
175 ifdef::doctype-manpage[]
176 ifdef::backend-docbook[]
178 template::[header-declarations]
181 <date>{revdate}</date>
184 <refentrytitle>{mantitle}</refentrytitle>
185 <manvolnum>{manvolnum}</manvolnum>
186 <refmiscinfo class="source">Babeltrace</refmiscinfo>
187 <refmiscinfo class="version">{babeltrace_version}</refmiscinfo>
188 <refmiscinfo class="manual">Babeltrace manual</refmiscinfo>
191 <refname>{manname}</refname>
192 <refpurpose>{manpurpose}</refpurpose>
194 endif::backend-docbook[]
195 endif::doctype-manpage[]