d036e09a880102997cd9940921fa129e42abeaf0
[lttng-tools.git] / doc / man / asciidoc.conf
1 [macros]
2
3 # man macro
4 #
5 # Inspired by linkgit macro:
6 # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
7 #
8 # Usage: man:command(manpage-section)
9 (?su)[\\]?(?P<name>man):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
10
11 # linkgenoptions macro
12 #
13 # Usage: linkgenoptions:(text)
14 (?su)[\\]?(?P<name>linkgenoptions):\((?P<text>.*?)\)=
15
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
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 # escwc macro
37 #
38 # Usage: :escwc:
39 :escwc:=escwc
40
41 # man macro expansions
42 ifdef::backend-docbook[]
43 [man-inlinemacro]
44 {0%{target}}
45 {0#<citerefentry>}
46 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
47 {0#</citerefentry>}
48 endif::backend-docbook[]
49
50 # linkgenoptions macro expansions
51 ifdef::backend-docbook[]
52 [linkgenoptions-inlinemacro]
53 {text}
54 endif::backend-docbook[]
55
56 # option macro expansions
57 ifdef::backend-docbook[]
58 [option-inlinemacro]
59 <literal>{opt}</literal>
60 endif::backend-docbook[]
61
62 # no link option macro expansions
63 ifdef::backend-docbook[]
64 [nloption-inlinemacro]
65 <literal>{opt}</literal>
66 endif::backend-docbook[]
67
68 # lttng(1) general option macro expansions
69 ifdef::backend-docbook[]
70 [genoption-inlinemacro]
71 <literal>{opt}</literal>
72 endif::backend-docbook[]
73
74 # not macro expansions
75 ifdef::backend-docbook[]
76 [not-inlinemacro]
77 NOT
78 endif::backend-docbook[]
79
80 # escwc macro expansions
81 ifdef::backend-docbook[]
82 [escwc-inlinemacro]
83 <literal>\e*</literal>
84 endif::backend-docbook[]
85
86 # configure XML man page header
87 ifdef::doctype-manpage[]
88 ifdef::backend-docbook[]
89 [header]
90 template::[header-declarations]
91 <refentry>
92 <refmeta>
93 <refentrytitle>{mantitle}</refentrytitle>
94 <manvolnum>{manvolnum}</manvolnum>
95 <refmiscinfo class="source">LTTng</refmiscinfo>
96 <refmiscinfo class="version">{lttng_version}</refmiscinfo>
97 <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
98 </refmeta>
99 <refnamediv>
100 <refname>{manname}</refname>
101 <refpurpose>{manpurpose}</refpurpose>
102 </refnamediv>
103 endif::backend-docbook[]
104 endif::doctype-manpage[]
This page took 0.045184 seconds and 3 git commands to generate.