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 # no link option macro
  12 #
  13 # Usage: nloption:--option-name
  14 (?su)[\\]?(?P<name>nloption):(?P<opt>--?[a-zA-Z0-9-]*)=
  15
  16 # lttng(1) general option macro
  17 #
  18 # Usage: genoption:--option-name
  19 (?su)[\\]?(?P<name>genoption):(?P<opt>--?[a-zA-Z0-9-]*)=
  20
  21 # option macro
  22 #
  23 # Usage: option:--option-name
  24 (?su)[\\]?(?P<name>option):(?P<opt>--?[a-zA-Z0-9-]*)=
  25
  26 # not macro
  27 #
  28 # Usage: :not:
  29 :not:=not
  30
  31 # linklttng macro expansions
  32 ifdef::backend-docbook[]
  33 [linklttng-inlinemacro]
  34 {0%{target}}
  35 {0#<citerefentry>}
  36 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  37 {0#</citerefentry>}
  38 endif::backend-docbook[]
  39
  40 # option macro expansions
  41 ifdef::backend-docbook[]
  42 [option-inlinemacro]
  43 <literal>{opt}</literal>
  44 endif::backend-docbook[]
  45
  46 # no link option macro expansions
  47 ifdef::backend-docbook[]
  48 [nloption-inlinemacro]
  49 <literal>{opt}</literal>
  50 endif::backend-docbook[]
  51
  52 # lttng(1) general option macro expansions
  53 ifdef::backend-docbook[]
  54 [genoption-inlinemacro]
  55 <literal>{opt}</literal>
  56 endif::backend-docbook[]
  57
  58 # not macro expansions
  59 ifdef::backend-docbook[]
  60 [not-inlinemacro]
  61 NOT
  62 endif::backend-docbook[]
  63
  64 # configure XML man page header
  65 ifdef::doctype-manpage[]
  66 ifdef::backend-docbook[]
  67 [header]
  68 template::[header-declarations]
  69 <refentry>
  70 <refmeta>
  71 <refentrytitle>{mantitle}</refentrytitle>
  72 <manvolnum>{manvolnum}</manvolnum>
  73 <refmiscinfo class="source">LTTng</refmiscinfo>
  74 <refmiscinfo class="version">{lttng_version}</refmiscinfo>
  75 <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
  76 </refmeta>
  77 <refnamediv>
  78   <refname>{manname}</refname>
  79   <refpurpose>{manpurpose}</refpurpose>
  80 </refnamediv>
  81 endif::backend-docbook[]
  82 endif::doctype-manpage[]