Commit | Line | Data |
---|---|---|
f95ec87d PP |
1 | [macros] |
2 | ||
3 | # linklttng macro | |
4 | # | |
5 | # Inspired by linkgit macro: | |
6 | # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf> | |
7 | # | |
8 | # Usage: linklttng:command(manpage-section) | |
9 | (?su)[\\]?(?P<name>linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)= | |
10 | ||
f5d2e3f5 PP |
11 | # linkgenoptions macro |
12 | # | |
13 | # Usage: linkgenoptions:(text) | |
14 | (?su)[\\]?(?P<name>linkgenoptions):\((?P<text>.*?)\)= | |
15 | ||
1cdba677 PP |
16 | # no link option macro |
17 | # | |
18 | # Usage: nloption:--option-name | |
19 | (?su)[\\]?(?P<name>nloption):(?P<opt>--?[a-zA-Z0-9-]*)= | |
20 | ||
21 | # lttng(1) general option macro | |
22 | # | |
23 | # Usage: genoption:--option-name | |
24 | (?su)[\\]?(?P<name>genoption):(?P<opt>--?[a-zA-Z0-9-]*)= | |
25 | ||
f95ec87d PP |
26 | # option macro |
27 | # | |
28 | # Usage: option:--option-name | |
29 | (?su)[\\]?(?P<name>option):(?P<opt>--?[a-zA-Z0-9-]*)= | |
30 | ||
31 | # not macro | |
32 | # | |
33 | # Usage: :not: | |
34 | :not:=not | |
35 | ||
36 | # linklttng macro expansions | |
37 | ifdef::backend-docbook[] | |
38 | [linklttng-inlinemacro] | |
39 | {0%{target}} | |
40 | {0#<citerefentry>} | |
41 | {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} | |
42 | {0#</citerefentry>} | |
43 | endif::backend-docbook[] | |
44 | ||
f5d2e3f5 PP |
45 | # linkgenoptions macro expansions |
46 | ifdef::backend-docbook[] | |
47 | [linkgenoptions-inlinemacro] | |
48 | {text} | |
49 | endif::backend-docbook[] | |
50 | ||
f95ec87d PP |
51 | # option macro expansions |
52 | ifdef::backend-docbook[] | |
53 | [option-inlinemacro] | |
54 | <literal>{opt}</literal> | |
55 | endif::backend-docbook[] | |
56 | ||
1cdba677 PP |
57 | # no link option macro expansions |
58 | ifdef::backend-docbook[] | |
59 | [nloption-inlinemacro] | |
60 | <literal>{opt}</literal> | |
61 | endif::backend-docbook[] | |
62 | ||
63 | # lttng(1) general option macro expansions | |
64 | ifdef::backend-docbook[] | |
65 | [genoption-inlinemacro] | |
66 | <literal>{opt}</literal> | |
67 | endif::backend-docbook[] | |
68 | ||
f95ec87d PP |
69 | # not macro expansions |
70 | ifdef::backend-docbook[] | |
71 | [not-inlinemacro] | |
72 | NOT | |
73 | endif::backend-docbook[] | |
74 | ||
75 | # configure XML man page header | |
76 | ifdef::doctype-manpage[] | |
77 | ifdef::backend-docbook[] | |
78 | [header] | |
79 | template::[header-declarations] | |
80 | <refentry> | |
81 | <refmeta> | |
82 | <refentrytitle>{mantitle}</refentrytitle> | |
83 | <manvolnum>{manvolnum}</manvolnum> | |
84 | <refmiscinfo class="source">LTTng</refmiscinfo> | |
85 | <refmiscinfo class="version">{lttng_version}</refmiscinfo> | |
86 | <refmiscinfo class="manual">LTTng Manual</refmiscinfo> | |
87 | </refmeta> | |
88 | <refnamediv> | |
89 | <refname>{manname}</refname> | |
90 | <refpurpose>{manpurpose}</refpurpose> | |
91 | </refnamediv> | |
92 | endif::backend-docbook[] | |
93 | endif::doctype-manpage[] |