doc/man/bt-asciidoc.conf

   1 [macros]
   2
   3 # command-line option in another man page macro
   4 #
   5 # Usage: manopt:page(section):--option-name
   6 (?su)[\\]?(?P<name>manopt):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\):(?P<opt>--?[a-zA-Z0-9-]*)=
   7
   8 # component class initialization parameter in another man page macro
   9 #
  10 # Usage: manparam:type.plugin.compcls:param-name
  11 (?su)[\\]?(?P<name>manparam):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
  12
  13 # man macro
  14 #
  15 # Usage: man:page(section)
  16 (?su)[\\]?(?P<name>man):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\)=
  17
  18 # no link option macro
  19 #
  20 # Usage: nlopt:--option-name
  21 (?su)[\\]?(?P<name>nlopt):(?P<opt>--?[a-zA-Z0-9-]*)=
  22
  23 # command-line option macro
  24 #
  25 # Usage: opt:--option-name
  26 (?su)[\\]?(?P<name>opt):(?P<opt>--?[a-zA-Z0-9-]*)=
  27
  28 # no link component class initialization parameter macro
  29 #
  30 # Usage: nlparam:param-name
  31 (?su)[\\]?(?P<name>nlparam):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
  32
  33 # component class initialization parameter macro
  34 #
  35 # Usage: param:param-name
  36 (?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=
  37
  38 # component class specification macro
  39 #
  40 # Usage: compcls:TYPE.PLUGIN.COMPCLS
  41 (?su)[\\]?(?P<name>compcls):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+)=
  42
  43 # not macro
  44 #
  45 # Usage: :not:
  46 :not:=not
  47
  48 # escstar macro
  49 #
  50 # Usage: :escstar:
  51 :escstar:=escstar
  52
  53 # esccomma macro
  54 #
  55 # Usage: :esccomma:
  56 :esccomma:=esccomma
  57
  58 # escdot macro
  59 #
  60 # Usage: :escdot:
  61 :escdot:=escdot
  62
  63 # bs macro
  64 #
  65 # Usage: :bs:
  66 :bs:=bs
  67
  68 # man macro expansions
  69 ifdef::doctype-manpage[]
  70 ifdef::backend-docbook[]
  71 [man-inlinemacro]
  72 <citerefentry>
  73 <refentrytitle>{target}</refentrytitle><manvolnum>{section}</manvolnum>
  74 </citerefentry>
  75 endif::backend-docbook[]
  76 endif::doctype-manpage[]
  77
  78 # no link option macro expansions
  79 ifdef::doctype-manpage[]
  80 ifdef::backend-docbook[]
  81 [nlopt-inlinemacro]
  82 <literal>{opt}</literal>
  83 endif::backend-docbook[]
  84 endif::doctype-manpage[]
  85
  86 # command-line option macro expansions
  87 ifdef::doctype-manpage[]
  88 ifdef::backend-docbook[]
  89 [opt-inlinemacro]
  90 <literal>{opt}</literal>
  91 endif::backend-docbook[]
  92 endif::doctype-manpage[]
  93
  94 # command-line option in another man page macro expansions
  95 ifdef::doctype-manpage[]
  96 ifdef::backend-docbook[]
  97 [manopt-inlinemacro]
  98 <literal>{opt}</literal>
  99 endif::backend-docbook[]
 100 endif::doctype-manpage[]
 101
 102 # component class initialization parameter macro expansions
 103 ifdef::doctype-manpage[]
 104 ifdef::backend-docbook[]
 105 [param-inlinemacro]
 106 <literal>{pname}</literal>
 107 endif::backend-docbook[]
 108 endif::doctype-manpage[]
 109
 110 # no link component class initialization parameter macro expansions
 111 ifdef::doctype-manpage[]
 112 ifdef::backend-docbook[]
 113 [nlparam-inlinemacro]
 114 <literal>{pname}</literal>
 115 endif::backend-docbook[]
 116 endif::doctype-manpage[]
 117
 118 # component class initialization parameter in another man page macro expansions
 119 ifdef::doctype-manpage[]
 120 ifdef::backend-docbook[]
 121 [manparam-inlinemacro]
 122 <literal>{pname}</literal>
 123 endif::backend-docbook[]
 124 endif::doctype-manpage[]
 125
 126 # component class specification macro expansions
 127 ifdef::doctype-manpage[]
 128 ifdef::backend-docbook[]
 129 [compcls-inlinemacro]
 130 <literal>{cctype}.{ccplug}.{ccname}</literal>
 131 endif::backend-docbook[]
 132 endif::doctype-manpage[]
 133
 134 # not macro expansions
 135 ifdef::doctype-manpage[]
 136 ifdef::backend-docbook[]
 137 [not-inlinemacro]
 138 NOT
 139 endif::backend-docbook[]
 140 endif::doctype-manpage[]
 141
 142 # escstar macro expansions
 143 ifdef::doctype-manpage[]
 144 ifdef::backend-docbook[]
 145 [escstar-inlinemacro]
 146 <literal>\e*</literal>
 147 endif::backend-docbook[]
 148 endif::doctype-manpage[]
 149
 150 # esccomma macro expansions
 151 ifdef::doctype-manpage[]
 152 ifdef::backend-docbook[]
 153 [esccomma-inlinemacro]
 154 <literal>\e,</literal>
 155 endif::backend-docbook[]
 156 endif::doctype-manpage[]
 157
 158 # escdot macro expansions
 159 ifdef::doctype-manpage[]
 160 ifdef::backend-docbook[]
 161 [escdot-inlinemacro]
 162 <literal>\e,</literal>
 163 endif::backend-docbook[]
 164 endif::doctype-manpage[]
 165
 166 # bs macro expansions
 167 ifdef::doctype-manpage[]
 168 ifdef::backend-docbook[]
 169 [bs-inlinemacro]
 170 <literal>\e</literal>
 171 endif::backend-docbook[]
 172 endif::doctype-manpage[]
 173
 174 # configure XML man page header
 175 ifdef::doctype-manpage[]
 176 ifdef::backend-docbook[]
 177 [header]
 178 template::[header-declarations]
 179 <refentry>
 180   <refentryinfo>
 181     <date>{revdate}</date>
 182   </refentryinfo>
 183   <refmeta>
 184     <refentrytitle>{mantitle}</refentrytitle>
 185     <manvolnum>{manvolnum}</manvolnum>
 186     <refmiscinfo class="source">Babeltrace</refmiscinfo>
 187     <refmiscinfo class="version">{babeltrace_version}</refmiscinfo>
 188     <refmiscinfo class="manual">Babeltrace manual</refmiscinfo>
 189   </refmeta>
 190   <refnamediv>
 191     <refname>{manname}</refname>
 192     <refpurpose>{manpurpose}</refpurpose>
 193   </refnamediv>
 194 endif::backend-docbook[]
 195 endif::doctype-manpage[]