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