Update manual pages for 2.0.0-rc1

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

diff --git a/doc/man/bt-asciidoc.conf b/doc/man/bt-asciidoc.conf
index c7611d08192806606f0150c25a9cdbf6a20f5395..b9f768f39baf9ce08757145d80b58d5f9d2bdafb 100644 (file)
--- a/doc/man/bt-asciidoc.conf
+++ b/doc/man/bt-asciidoc.conf
@@ -1,3 +1,8 @@
+[specialcharacters]
+
+# LaTeX-like non-breaking space (disables subscript but we don't need it)
+~= 
+
 [macros]
 
 # command-line option in another man page macro
@@ -35,16 +40,36 @@
 # Usage: param:param-name
 (?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
 
+# no link query result object entry macro
+#
+# Usage: nlqres:qres-name
+(?su)[\\]?(?P<name>nlqres):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
+
+# query result object entry macro
+#
+# Usage: qres:qres-name
+(?su)[\\]?(?P<name>qres):(?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
+# value object type
+#
+# Usage: vtype:[TYPE]
+(?su)[\\]?(?P<name>vtype):\[(?P<type>[^\]]+)\]=
+
+# not macro (emphasis)
 #
 # Usage: :not:
 :not:=not
 
+# all macro (emphasis)
+#
+# Usage: :all:
+:all:=all
+
 # escstar macro
 #
 # Usage: :escstar:
@@ -65,115 +90,81 @@
 # Usage: :bs:
 :bs:=bs
 
-# man macro expansions
+# macro expansions for DocBook backend (begin)
 ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
+
+# man macro expansions
 [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[]
+
+# query result entry macro expansions
+[qres-inlinemacro]
+<literal>{pname}</literal>
+
+# no link query result entry macro expansions
+[nlqres-inlinemacro]
+<literal>{pname}</literal>
 
 # 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[]
+
+# value object type macro expansions
+[vtype-inlinemacro]
+[{type}]
 
 # not macro expansions
-ifdef::doctype-manpage[]
-ifdef::backend-docbook[]
 [not-inlinemacro]
 NOT
-endif::backend-docbook[]
-endif::doctype-manpage[]
+
+# all macro expansions
+[all-inlinemacro]
+ALL
 
 # 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>
@@ -185,11 +176,13 @@ template::[header-declarations]
     <manvolnum>{manvolnum}</manvolnum>
     <refmiscinfo class="source">Babeltrace</refmiscinfo>
     <refmiscinfo class="version">{babeltrace_version}</refmiscinfo>
-    <refmiscinfo class="manual">Babeltrace manual</refmiscinfo>
+    <refmiscinfo class="manual">Babeltrace&nbsp;2 manual</refmiscinfo>
   </refmeta>
   <refnamediv>
     <refname>{manname}</refname>
     <refpurpose>{manpurpose}</refpurpose>
   </refnamediv>
+
+# macro expansions for DocBook backend (end)
 endif::backend-docbook[]
 endif::doctype-manpage[]