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 # escbs macro
  47 #
  48 # Usage: :escbs:
  49 :escbs:=escbs
  50
  51 # man macro expansions
  52 ifdef::doctype-manpage[]
  53 ifdef::backend-docbook[]
  54 [man-inlinemacro]
  55 {0%{target}}
  56 {0#<citerefentry>}
  57 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  58 {0#</citerefentry>}
  59 endif::backend-docbook[]
  60 endif::doctype-manpage[]
  61
  62 # linkgenoptions macro expansions
  63 ifdef::doctype-manpage[]
  64 ifdef::backend-docbook[]
  65 [linkgenoptions-inlinemacro]
  66 {text}
  67 endif::backend-docbook[]
  68 endif::doctype-manpage[]
  69
  70 # option macro expansions
  71 ifdef::doctype-manpage[]
  72 ifdef::backend-docbook[]
  73 [option-inlinemacro]
  74 <literal>{opt}</literal>
  75 endif::backend-docbook[]
  76 endif::doctype-manpage[]
  77
  78 # no link option macro expansions
  79 ifdef::doctype-manpage[]
  80 ifdef::backend-docbook[]
  81 [nloption-inlinemacro]
  82 <literal>{opt}</literal>
  83 endif::backend-docbook[]
  84 endif::doctype-manpage[]
  85
  86 # lttng(1) general option macro expansions
  87 ifdef::doctype-manpage[]
  88 ifdef::backend-docbook[]
  89 [genoption-inlinemacro]
  90 <literal>{opt}</literal>
  91 endif::backend-docbook[]
  92 endif::doctype-manpage[]
  93
  94 # not macro expansions
  95 ifdef::doctype-manpage[]
  96 ifdef::backend-docbook[]
  97 [not-inlinemacro]
  98 NOT
  99 endif::backend-docbook[]
 100 endif::doctype-manpage[]
 101
 102 # escwc macro expansions
 103 ifdef::doctype-manpage[]
 104 ifdef::backend-docbook[]
 105 [escwc-inlinemacro]
 106 <literal>\e*</literal>
 107 endif::backend-docbook[]
 108 endif::doctype-manpage[]
 109
 110 # esccomma macro expansions
 111 ifdef::doctype-manpage[]
 112 ifdef::backend-docbook[]
 113 [esccomma-inlinemacro]
 114 <literal>\e,</literal>
 115 endif::backend-docbook[]
 116 endif::doctype-manpage[]
 117
 118 # escbs macro expansions
 119 ifdef::doctype-manpage[]
 120 ifdef::backend-docbook[]
 121 [escbs-inlinemacro]
 122 <literal>\e</literal>
 123 endif::backend-docbook[]
 124 endif::doctype-manpage[]
 125
 126 # configure XML man page header
 127 ifdef::doctype-manpage[]
 128 ifdef::backend-docbook[]
 129 [header]
 130 template::[header-declarations]
 131 <refentry>
 132     <refentryinfo>
 133         <date>{revdate}</date>
 134     </refentryinfo>
 135     <refmeta>
 136         <refentrytitle>{mantitle}</refentrytitle>
 137         <manvolnum>{manvolnum}</manvolnum>
 138         <refmiscinfo class="source">LTTng</refmiscinfo>
 139         <refmiscinfo class="version">{lttng_version}</refmiscinfo>
 140         <refmiscinfo class="manual">LTTng Manual</refmiscinfo>
 141     </refmeta>
 142     <refnamediv>
 143         <refname>{manname}</refname>
 144         <refpurpose>{manpurpose}</refpurpose>
 145     </refnamediv>
 146 endif::backend-docbook[]
 147 endif::doctype-manpage[]