Add modern Babeltrace man pages

[babeltrace.git] / doc / man / bt-asciidoc.conf

diff --git a/doc/man/bt-asciidoc.conf b/doc/man/bt-asciidoc.conf
new file mode 100644 (file)
index 0000000..c7611d0
--- /dev/null
+++ b/doc/man/bt-asciidoc.conf
@@ -0,0 +1,195 @@
+[macros]
+
+# command-line option in another man page macro
+#
+# Usage: manopt:page(section):--option-name
+(?su)[\\]?(?P<name>manopt):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\):(?P<opt>--?[a-zA-Z0-9-]*)=
+
+# component class initialization parameter in another man page macro
+#
+# Usage: manparam:type.plugin.compcls:param-name
+(?su)[\\]?(?P<name>manparam):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
+
+# man macro
+#
+# Usage: man:page(section)
+(?su)[\\]?(?P<name>man):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\)=
+
+# no link option macro
+#
+# Usage: nlopt:--option-name
+(?su)[\\]?(?P<name>nlopt):(?P<opt>--?[a-zA-Z0-9-]*)=
+
+# command-line option macro
+#
+# Usage: opt:--option-name
+(?su)[\\]?(?P<name>opt):(?P<opt>--?[a-zA-Z0-9-]*)=
+
+# no link component class initialization parameter macro
+#
+# Usage: nlparam:param-name
+(?su)[\\]?(?P<name>nlparam):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
+
+# component class initialization parameter macro
+#
+# Usage: param:param-name
+(?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
+
+# component class specification macro
+#
+# Usage: compcls:TYPE.PLUGIN.COMPCLS
+(?su)[\\]?(?P<name>compcls):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+)=
+
+# not macro
+#
+# Usage: :not:
+:not:=not
+
+# escstar macro
+#
+# Usage: :escstar:
+:escstar:=escstar
+
+# esccomma macro
+#
+# Usage: :esccomma:
+:esccomma:=esccomma
+
+# escdot macro
+#
+# Usage: :escdot:
+:escdot:=escdot
+
+# bs macro
+#
+# Usage: :bs:
+:bs:=bs
+
+# man macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[man-inlinemacro]
+<citerefentry>
+<refentrytitle>{target}</refentrytitle><manvolnum>{section}</manvolnum>
+</citerefentry>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# no link option macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[nlopt-inlinemacro]
+<literal>{opt}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# command-line option macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[opt-inlinemacro]
+<literal>{opt}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# command-line option in another man page macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[manopt-inlinemacro]
+<literal>{opt}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# component class initialization parameter macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[param-inlinemacro]
+<literal>{pname}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# no link component class initialization parameter macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[nlparam-inlinemacro]
+<literal>{pname}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# component class initialization parameter in another man page macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[manparam-inlinemacro]
+<literal>{pname}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# component class specification macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[compcls-inlinemacro]
+<literal>{cctype}.{ccplug}.{ccname}</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# not macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[not-inlinemacro]
+NOT
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# escstar macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[escstar-inlinemacro]
+<literal>\e*</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# esccomma macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[esccomma-inlinemacro]
+<literal>\e,</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# escdot macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[escdot-inlinemacro]
+<literal>\e,</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# bs macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[bs-inlinemacro]
+<literal>\e</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# configure XML man page header
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[header]
+template::[header-declarations]
+<refentry>
+  <refentryinfo>
+    <date>{revdate}</date>
+  </refentryinfo>
+  <refmeta>
+    <refentrytitle>{mantitle}</refentrytitle>
+    <manvolnum>{manvolnum}</manvolnum>
+    <refmiscinfo class="source">Babeltrace</refmiscinfo>
+    <refmiscinfo class="version">{babeltrace_version}</refmiscinfo>
+    <refmiscinfo class="manual">Babeltrace manual</refmiscinfo>
+  </refmeta>
+  <refnamediv>
+    <refname>{manname}</refname>
+    <refpurpose>{manpurpose}</refpurpose>
+  </refnamediv>
+endif::backend-docbook[]
+endif::doctype-manpage[]