doc/man/asciidoc.conf

   1 [macros]
   2
   3 # man macro
   4 #
   5 # Inspired by linkgit macro:
   6 # <https://github.com/git/git/blob/master/Documentation/asciidoc.conf>
   7 #
   8 # Usage: man:command(manpage-section)
   9 (?su)[\\]?(?P<name>man):(?P<target>\S*?)\((?P<attrlist>.*?)\)=
  10
  11 # linkgenoptions macro
  12 #
  13 # Usage: linkgenoptions:(text)
  14 (?su)[\\]?(?P<name>linkgenoptions):\((?P<text>.*?)\)=
  15
  16 # no link option macro
  17 #
  18 # Usage: nloption:--option-name
  19 (?su)[\\]?(?P<name>nloption):(?P<opt>--?[a-zA-Z0-9-]*)=
  20
  21 # lttng(1) general option macro
  22 #
  23 # Usage: genoption:--option-name
  24 (?su)[\\]?(?P<name>genoption):(?P<opt>--?[a-zA-Z0-9-]*)=
  25
  26 # option macro
  27 #
  28 # Usage: option:--option-name
  29 (?su)[\\]?(?P<name>option):(?P<opt>--?[a-zA-Z0-9-]*)=
  30
  31 # not macro
  32 #
  33 # Usage: :not:
  34 :not:=not
  35
  36 # escwc macro
  37 #
  38 # Usage: :escwc:
  39 :escwc:=escwc
  40
  41 # esccomma macro
  42 #
  43 # Usage: :esccomma:
  44 :esccomma:=esccomma
  45
  46 # man macro expansions
  47 ifdef::doctype-manpage[]
  48 ifdef::backend-docbook[]
  49 [man-inlinemacro]
  50 {0%{target}}
  51 {0#<citerefentry>}
  52 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  53 {0#</citerefentry>}
  54 endif::backend-docbook[]
  55 endif::doctype-manpage[]
  56
  57 # linkgenoptions macro expansions
  58 ifdef::doctype-manpage[]
  59 ifdef::backend-docbook[]
  60 [linkgenoptions-inlinemacro]
  61 {text}
  62 endif::backend-docbook[]
  63 endif::doctype-manpage[]
  64
  65 # option macro expansions
  66 ifdef::doctype-manpage[]
  67 ifdef::backend-docbook[]
  68 [option-inlinemacro]
  69 <literal>{opt}</literal>
  70 endif::backend-docbook[]
  71 endif::doctype-manpage[]
  72
  73 # no link option macro expansions
  74 ifdef::doctype-manpage[]
  75 ifdef::backend-docbook[]
  76 [nloption-inlinemacro]
  77 <literal>{opt}</literal>
  78 endif::backend-docbook[]
  79 endif::doctype-manpage[]
  80
  81 # lttng(1) general option macro expansions
  82 ifdef::doctype-manpage[]
  83 ifdef::backend-docbook[]
  84 [genoption-inlinemacro]
  85 <literal>{opt}</literal>
  86 endif::backend-docbook[]
  87 endif::doctype-manpage[]
  88
  89 # not macro expansions
  90 ifdef::doctype-manpage[]
  91 ifdef::backend-docbook[]
  92 [not-inlinemacro]
  93 NOT
  94 endif::backend-docbook[]
  95 endif::doctype-manpage[]
  96
  97 # escwc macro expansions
  98 ifdef::doctype-manpage[]
  99 ifdef::backend-docbook[]
 100 [escwc-inlinemacro]
 101 <literal>\e*</literal>
 102 endif::backend-docbook[]
 103 endif::doctype-manpage[]
 104
 105 # esccomma macro expansions
 106 ifdef::doctype-manpage[]
 107 ifdef::backend-docbook[]
 108 [esccomma-inlinemacro]
 109 <literal>\e,</literal>
 110 endif::backend-docbook[]
 111 endif::doctype-manpage[]
 112
 113 # configure XML man page header
 114 ifdef::doctype-manpage[]
 115 ifdef::backend-docbook[]
 116 [header]
 117 template::[header-declarations]
 118 <refentry>
 119 <refmeta>
 120 <refentrytitle>{mantitle}</refentrytitle>
 121 <manvolnum>{manvolnum}</manvolnum>
 122 <refmiscinfo class="source">LTTng</refmiscinfo>
 123 <refmiscinfo class="version">{lttng_version}</refmiscinfo>
 124 <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
 125 </refmeta>
 126 <refnamediv>
 127   <refname>{manname}</refname>
 128   <refpurpose>{manpurpose}</refpurpose>
 129 </refnamediv>
 130 endif::backend-docbook[]
 131 endif::doctype-manpage[]