doc/man/asciidoc.conf

   1 [macros]
   2
   3 # linklttng macro
   4 #
   5 # Inspired by linkgit macro:
   6 # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
   7 #
   8 # Usage: linklttng:command(manpage-section)
   9 (?su)[\\]?(?P<name>linklttng):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
  10
  11 # option macro
  12 #
  13 # Usage: option:--option-name
  14 (?su)[\\]?(?P<name>option):(?P<opt>--?[a-zA-Z0-9-]*)=
  15
  16 # not macro
  17 #
  18 # Usage: :not:
  19 :not:=not
  20
  21 # linklttng macro expansions
  22 ifdef::backend-docbook[]
  23 [linklttng-inlinemacro]
  24 {0%{target}}
  25 {0#<citerefentry>}
  26 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  27 {0#</citerefentry>}
  28 endif::backend-docbook[]
  29
  30 # option macro expansions
  31 ifdef::backend-docbook[]
  32 [option-inlinemacro]
  33 <literal>{opt}</literal>
  34 endif::backend-docbook[]
  35
  36 # not macro expansions
  37 ifdef::backend-docbook[]
  38 [not-inlinemacro]
  39 NOT
  40 endif::backend-docbook[]
  41
  42 # configure XML man page header
  43 ifdef::doctype-manpage[]
  44 ifdef::backend-docbook[]
  45 [header]
  46 template::[header-declarations]
  47 <refentry>
  48 <refmeta>
  49 <refentrytitle>{mantitle}</refentrytitle>
  50 <manvolnum>{manvolnum}</manvolnum>
  51 <refmiscinfo class="source">LTTng</refmiscinfo>
  52 <refmiscinfo class="version">{lttng_version}</refmiscinfo>
  53 <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
  54 </refmeta>
  55 <refnamediv>
  56   <refname>{manname}</refname>
  57   <refpurpose>{manpurpose}</refpurpose>
  58 </refnamediv>
  59 endif::backend-docbook[]
  60 endif::doctype-manpage[]