Fix: build: libcommon fd-tracker dependency is not available
[lttng-tools.git] / doc / man / asciidoc.conf
CommitLineData
c4ee4984
PP
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
f69e7997
PP
41# esccomma macro
42#
43# Usage: :esccomma:
44:esccomma:=esccomma
45
11613178
PP
46# escbs macro
47#
48# Usage: :escbs:
49:escbs:=escbs
50
c4ee4984
PP
51# man macro expansions
52ifdef::doctype-manpage[]
53ifdef::backend-docbook[]
54[man-inlinemacro]
55{0%{target}}
56{0#<citerefentry>}
57{0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
58{0#</citerefentry>}
59endif::backend-docbook[]
60endif::doctype-manpage[]
61
62# linkgenoptions macro expansions
63ifdef::doctype-manpage[]
64ifdef::backend-docbook[]
65[linkgenoptions-inlinemacro]
66{text}
67endif::backend-docbook[]
68endif::doctype-manpage[]
69
70# option macro expansions
71ifdef::doctype-manpage[]
72ifdef::backend-docbook[]
73[option-inlinemacro]
74<literal>{opt}</literal>
75endif::backend-docbook[]
76endif::doctype-manpage[]
77
78# no link option macro expansions
79ifdef::doctype-manpage[]
80ifdef::backend-docbook[]
81[nloption-inlinemacro]
82<literal>{opt}</literal>
83endif::backend-docbook[]
84endif::doctype-manpage[]
85
86# lttng(1) general option macro expansions
87ifdef::doctype-manpage[]
88ifdef::backend-docbook[]
89[genoption-inlinemacro]
90<literal>{opt}</literal>
91endif::backend-docbook[]
92endif::doctype-manpage[]
93
94# not macro expansions
95ifdef::doctype-manpage[]
96ifdef::backend-docbook[]
97[not-inlinemacro]
98NOT
99endif::backend-docbook[]
100endif::doctype-manpage[]
101
102# escwc macro expansions
103ifdef::doctype-manpage[]
104ifdef::backend-docbook[]
105[escwc-inlinemacro]
106<literal>\e*</literal>
107endif::backend-docbook[]
108endif::doctype-manpage[]
109
f69e7997
PP
110# esccomma macro expansions
111ifdef::doctype-manpage[]
112ifdef::backend-docbook[]
113[esccomma-inlinemacro]
114<literal>\e,</literal>
115endif::backend-docbook[]
116endif::doctype-manpage[]
117
11613178
PP
118# escbs macro expansions
119ifdef::doctype-manpage[]
120ifdef::backend-docbook[]
121[escbs-inlinemacro]
122<literal>\e</literal>
123endif::backend-docbook[]
124endif::doctype-manpage[]
125
c4ee4984
PP
126# configure XML man page header
127ifdef::doctype-manpage[]
128ifdef::backend-docbook[]
129[header]
130template::[header-declarations]
131<refentry>
4605890e
PP
132 <refentryinfo>
133 <date>{revdate}</date>
134 </refentryinfo>
135 <refmeta>
136 <refentrytitle>{mantitle}</refentrytitle>
137 <manvolnum>{manvolnum}</manvolnum>
138 <refmiscinfo class="source">LTTng</refmiscinfo>
139 <refmiscinfo class="version">{lttng_version}</refmiscinfo>
140 <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
141 </refmeta>
142 <refnamediv>
143 <refname>{manname}</refname>
144 <refpurpose>{manpurpose}</refpurpose>
145 </refnamediv>
c4ee4984
PP
146endif::backend-docbook[]
147endif::doctype-manpage[]
This page took 0.035393 seconds and 4 git commands to generate.