doc/man: use specific revision date for each manual page

[lttng-tools.git] / doc / man / asciidoc.conf

diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf
index 3410dd2a3faedeaf9729f78d5a3aa9261fcc856b..a961db21a845522963495004712327787d5e52c9 100644 (file)
--- a/doc/man/asciidoc.conf
+++ b/doc/man/asciidoc.conf
@@ -1,12 +1,17 @@
 [macros]
 
-# linklttng macro
+# man macro
 #
 # Inspired by linkgit macro:
 # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
 #
-# Usage: linklttng:command(manpage-section)
-(?su)[\\]?(?P<name>linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
+# Usage: man:command(manpage-section)
+(?su)[\\]?(?P<name>man):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
+
+# linkgenoptions macro
+#
+# Usage: linkgenoptions:(text)
+(?su)[\\]?(?P<name>linkgenoptions):\((?P<text>.*?)\)=
 
 # no link option macro
 #
@@ -28,38 +33,95 @@
 # Usage: :not:
 :not:=not
 
-# linklttng macro expansions
+# escwc macro
+#
+# Usage: :escwc:
+:escwc:=escwc
+
+# esccomma macro
+#
+# Usage: :esccomma:
+:esccomma:=esccomma
+
+# escbs macro
+#
+# Usage: :escbs:
+:escbs:=escbs
+
+# man macro expansions
+ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
-[linklttng-inlinemacro]
+[man-inlinemacro]
 {0%{target}}
 {0#<citerefentry>}
 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
 {0#</citerefentry>}
 endif::backend-docbook[]
+endif::doctype-manpage[]
+
+# linkgenoptions macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[linkgenoptions-inlinemacro]
+{text}
+endif::backend-docbook[]
+endif::doctype-manpage[]
 
 # option macro expansions
+ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
 [option-inlinemacro]
 <literal>{opt}</literal>
 endif::backend-docbook[]
+endif::doctype-manpage[]
 
 # no link option macro expansions
+ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
 [nloption-inlinemacro]
 <literal>{opt}</literal>
 endif::backend-docbook[]
+endif::doctype-manpage[]
 
 # lttng(1) general option macro expansions
+ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
 [genoption-inlinemacro]
 <literal>{opt}</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[]
+
+# escwc macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[escwc-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[]
+
+# escbs macro expansions
+ifdef::doctype-manpage[]
+ifdef::backend-docbook[]
+[escbs-inlinemacro]
+<literal>\e</literal>
+endif::backend-docbook[]
+endif::doctype-manpage[]
 
 # configure XML man page header
 ifdef::doctype-manpage[]
@@ -67,16 +129,19 @@ ifdef::backend-docbook[]
 [header]
 template::[header-declarations]
 <refentry>
-<refmeta>
-<refentrytitle>{mantitle}</refentrytitle>
-<manvolnum>{manvolnum}</manvolnum>
-<refmiscinfo class="source">LTTng</refmiscinfo>
-<refmiscinfo class="version">{lttng_version}</refmiscinfo>
-<refmiscinfo class="manual">LTTng Manual</refmiscinfo>
-</refmeta>
-<refnamediv>
-  <refname>{manname}</refname>
-  <refpurpose>{manpurpose}</refpurpose>
-</refnamediv>
+    <refentryinfo>
+        <date>{revdate}</date>
+    </refentryinfo>
+    <refmeta>
+        <refentrytitle>{mantitle}</refentrytitle>
+        <manvolnum>{manvolnum}</manvolnum>
+        <refmiscinfo class="source">LTTng</refmiscinfo>
+        <refmiscinfo class="version">{lttng_version}</refmiscinfo>
+        <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
+    </refmeta>
+    <refnamediv>
+        <refname>{manname}</refname>
+        <refpurpose>{manpurpose}</refpurpose>
+    </refnamediv>
 endif::backend-docbook[]
 endif::doctype-manpage[]