Commit | Line | Data |
---|---|---|
f95ec87d PP |
1 | [macros] |
2 | ||
74354842 | 3 | # man macro |
f95ec87d PP |
4 | # |
5 | # Inspired by linkgit macro: | |
6 | # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf> | |
7 | # | |
74354842 PP |
8 | # Usage: man:command(manpage-section) |
9 | (?su)[\\]?(?P<name>man):(?P<target>\S*?)\((?P<attrlist>.*?)\)= | |
f95ec87d | 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 | ||
249b9265 PP |
36 | # escwc macro |
37 | # | |
38 | # Usage: :escwc: | |
39 | :escwc:=escwc | |
40 | ||
74354842 | 41 | # man macro expansions |
d6cb610c | 42 | ifdef::doctype-manpage[] |
f95ec87d | 43 | ifdef::backend-docbook[] |
74354842 | 44 | [man-inlinemacro] |
f95ec87d PP |
45 | {0%{target}} |
46 | {0#<citerefentry>} | |
47 | {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} | |
48 | {0#</citerefentry>} | |
49 | endif::backend-docbook[] | |
d6cb610c | 50 | endif::doctype-manpage[] |
f95ec87d | 51 | |
f5d2e3f5 | 52 | # linkgenoptions macro expansions |
d6cb610c | 53 | ifdef::doctype-manpage[] |
f5d2e3f5 PP |
54 | ifdef::backend-docbook[] |
55 | [linkgenoptions-inlinemacro] | |
56 | {text} | |
57 | endif::backend-docbook[] | |
d6cb610c | 58 | endif::doctype-manpage[] |
f5d2e3f5 | 59 | |
f95ec87d | 60 | # option macro expansions |
d6cb610c | 61 | ifdef::doctype-manpage[] |
f95ec87d PP |
62 | ifdef::backend-docbook[] |
63 | [option-inlinemacro] | |
64 | <literal>{opt}</literal> | |
65 | endif::backend-docbook[] | |
d6cb610c | 66 | endif::doctype-manpage[] |
f95ec87d | 67 | |
1cdba677 | 68 | # no link option macro expansions |
d6cb610c | 69 | ifdef::doctype-manpage[] |
1cdba677 PP |
70 | ifdef::backend-docbook[] |
71 | [nloption-inlinemacro] | |
72 | <literal>{opt}</literal> | |
73 | endif::backend-docbook[] | |
d6cb610c | 74 | endif::doctype-manpage[] |
1cdba677 PP |
75 | |
76 | # lttng(1) general option macro expansions | |
d6cb610c | 77 | ifdef::doctype-manpage[] |
1cdba677 PP |
78 | ifdef::backend-docbook[] |
79 | [genoption-inlinemacro] | |
80 | <literal>{opt}</literal> | |
81 | endif::backend-docbook[] | |
d6cb610c | 82 | endif::doctype-manpage[] |
1cdba677 | 83 | |
f95ec87d | 84 | # not macro expansions |
d6cb610c | 85 | ifdef::doctype-manpage[] |
f95ec87d PP |
86 | ifdef::backend-docbook[] |
87 | [not-inlinemacro] | |
88 | NOT | |
89 | endif::backend-docbook[] | |
d6cb610c | 90 | endif::doctype-manpage[] |
f95ec87d | 91 | |
249b9265 | 92 | # escwc macro expansions |
d6cb610c | 93 | ifdef::doctype-manpage[] |
249b9265 PP |
94 | ifdef::backend-docbook[] |
95 | [escwc-inlinemacro] | |
96 | <literal>\e*</literal> | |
97 | endif::backend-docbook[] | |
d6cb610c | 98 | endif::doctype-manpage[] |
249b9265 | 99 | |
f95ec87d PP |
100 | # configure XML man page header |
101 | ifdef::doctype-manpage[] | |
102 | ifdef::backend-docbook[] | |
103 | [header] | |
104 | template::[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> | |
117 | endif::backend-docbook[] | |
118 | endif::doctype-manpage[] | |
daa968e3 PP |
119 | |
120 | [attributes] | |
7f2d4233 | 121 | # default values |
daa968e3 PP |
122 | default_agent_tcp_port="@DEFAULT_AGENT_TCP_PORT@" |
123 | default_app_socket_rw_timeout="@DEFAULT_APP_SOCKET_RW_TIMEOUT@" | |
124 | default_channel_subbuf_size="@DEFAULT_CHANNEL_SUBBUF_SIZE@" | |
125 | default_channel_tracefile_count="@DEFAULT_CHANNEL_TRACEFILE_COUNT@" | |
126 | default_channel_tracefile_size="@DEFAULT_CHANNEL_TRACEFILE_SIZE@" | |
127 | default_kernel_channel_live_timer="@DEFAULT_KERNEL_CHANNEL_LIVE_TIMER@" | |
128 | default_kernel_channel_read_timer="@DEFAULT_KERNEL_CHANNEL_READ_TIMER@" | |
129 | default_kernel_channel_subbuf_num="@DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM@" | |
130 | default_kernel_channel_subbuf_size="@DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE@" | |
131 | default_kernel_channel_switch_timer="@DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER@" | |
132 | default_lttng_live_timer="@DEFAULT_LTTNG_LIVE_TIMER@" | |
133 | default_metadata_cache_size="@DEFAULT_METADATA_CACHE_SIZE@" | |
134 | default_metadata_read_timer="@DEFAULT_METADATA_READ_TIMER@" | |
135 | default_metadata_subbuf_num="@DEFAULT_METADATA_SUBBUF_NUM@" | |
136 | default_metadata_subbuf_size="@DEFAULT_METADATA_SUBBUF_SIZE@" | |
137 | default_metadata_switch_timer="@DEFAULT_METADATA_SWITCH_TIMER@" | |
138 | default_network_control_port="@DEFAULT_NETWORK_CONTROL_PORT@" | |
139 | default_network_data_port="@DEFAULT_NETWORK_DATA_PORT@" | |
140 | default_network_viewer_port="@DEFAULT_NETWORK_VIEWER_PORT@" | |
141 | default_ust_pid_channel_live_timer="@DEFAULT_UST_PID_CHANNEL_LIVE_TIMER@" | |
142 | default_ust_pid_channel_read_timer="@DEFAULT_UST_PID_CHANNEL_READ_TIMER@" | |
143 | default_ust_pid_channel_subbuf_num="@DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM@" | |
144 | default_ust_pid_channel_subbuf_size="@DEFAULT_UST_PID_CHANNEL_SUBBUF_SIZE@" | |
145 | default_ust_pid_channel_switch_timer="@DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER@" | |
146 | default_ust_uid_channel_live_timer="@DEFAULT_UST_UID_CHANNEL_LIVE_TIMER@" | |
147 | default_ust_uid_channel_read_timer="@DEFAULT_UST_UID_CHANNEL_READ_TIMER@" | |
148 | default_ust_uid_channel_subbuf_num="@DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM@" | |
149 | default_ust_uid_channel_subbuf_size="@DEFAULT_UST_UID_CHANNEL_SUBBUF_SIZE@" | |
150 | default_ust_uid_channel_switch_timer="@DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER@" | |
151 | default_agent_bind_address="@DEFAULT_AGENT_BIND_ADDRESS@" | |
152 | default_network_control_bind_address="@DEFAULT_NETWORK_CONTROL_BIND_ADDRESS@" | |
153 | default_network_data_bind_address="@DEFAULT_NETWORK_DATA_BIND_ADDRESS@" | |
154 | default_network_viewer_bind_address="@DEFAULT_NETWORK_VIEWER_BIND_ADDRESS@" | |
491685e4 PP |
155 | lttng_version="@PACKAGE_VERSION@" |
156 | system_sessions_dir="@CONFDIR@/lttng/sessions" | |
157 | system_sessions_auto_dir="@CONFDIR@/lttng/sessions/auto" | |
158 | system_lttng_conf="@CONFDIR@/lttng/lttng.conf" | |
7f2d4233 PP |
159 | |
160 | # command short descriptions | |
161 | cmd_descr_add_context="@CMD_DESCR_ADD_CONTEXT@" | |
162 | cmd_descr_calibrate="@CMD_DESCR_CALIBRATE@" | |
163 | cmd_descr_create="@CMD_DESCR_CREATE@" | |
164 | cmd_descr_destroy="@CMD_DESCR_DESTROY@" | |
165 | cmd_descr_disable_channel="@CMD_DESCR_DISABLE_CHANNEL@" | |
166 | cmd_descr_disable_event="@CMD_DESCR_DISABLE_EVENT@" | |
167 | cmd_descr_enable_channel="@CMD_DESCR_ENABLE_CHANNEL@" | |
168 | cmd_descr_enable_event="@CMD_DESCR_ENABLE_EVENT@" | |
169 | cmd_descr_help="@CMD_DESCR_HELP@" | |
170 | cmd_descr_list="@CMD_DESCR_LIST@" | |
171 | cmd_descr_load="@CMD_DESCR_LOAD@" | |
172 | cmd_descr_metadata="@CMD_DESCR_METADATA@" | |
173 | cmd_descr_save="@CMD_DESCR_SAVE@" | |
174 | cmd_descr_set_session="@CMD_DESCR_SET_SESSION@" | |
175 | cmd_descr_snapshot="@CMD_DESCR_SNAPSHOT@" | |
176 | cmd_descr_start="@CMD_DESCR_START@" | |
177 | cmd_descr_status="@CMD_DESCR_STATUS@" | |
178 | cmd_descr_stop="@CMD_DESCR_STOP@" | |
179 | cmd_descr_track="@CMD_DESCR_TRACK@" | |
180 | cmd_descr_untrack="@CMD_DESCR_UNTRACK@" | |
181 | cmd_descr_version="@CMD_DESCR_VERSION@" | |
182 | cmd_descr_view="@CMD_DESCR_VIEW@" |