Update manual pages for 2.0.0-rc1

[babeltrace.git] / doc / man / bt-asciidoc.conf

[specialcharacters]

# LaTeX-like non-breaking space (disables subscript but we don't need it)
~= 

[macros]

# command-line option in another man page macro
#
# Usage: manopt:page(section):--option-name
(?su)[\\]?(?P<name>manopt):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\):(?P<opt>--?[a-zA-Z0-9-]*)=

# component class initialization parameter in another man page macro
#
# Usage: manparam:type.plugin.compcls:param-name
(?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_:.-]+(?<![:.]))=

# man macro
#
# Usage: man:page(section)
(?su)[\\]?(?P<name>man):(?P<target>[a-zA-Z0-9_.-]+)\((?P<section>[a-zA-Z0-9]+)\)=

# no link option macro
#
# Usage: nlopt:--option-name
(?su)[\\]?(?P<name>nlopt):(?P<opt>--?[a-zA-Z0-9-]*)=

# command-line option macro
#
# Usage: opt:--option-name
(?su)[\\]?(?P<name>opt):(?P<opt>--?[a-zA-Z0-9-]*)=

# no link component class initialization parameter macro
#
# Usage: nlparam:param-name
(?su)[\\]?(?P<name>nlparam):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=

# component class initialization parameter macro
#
# Usage: param:param-name
(?su)[\\]?(?P<name>param):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=

# no link query result object entry macro
#
# Usage: nlqres:qres-name
(?su)[\\]?(?P<name>nlqres):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=

# query result object entry macro
#
# Usage: qres:qres-name
(?su)[\\]?(?P<name>qres):(?P<pname>[a-zA-Z0-9_:.-]+(?<![:.]))=

# component class specification macro
#
# Usage: compcls:TYPE.PLUGIN.COMPCLS
(?su)[\\]?(?P<name>compcls):(?P<cctype>[a-zA-Z0-9_-]+)\.(?P<ccplug>[a-zA-Z0-9_-]+)\.(?P<ccname>[a-zA-Z0-9_-]+)=

# value object type
#
# Usage: vtype:[TYPE]
(?su)[\\]?(?P<name>vtype):\[(?P<type>[^\]]+)\]=

# not macro (emphasis)
#
# Usage: :not:
:not:=not

# all macro (emphasis)
#
# Usage: :all:
:all:=all

# escstar macro
#
# Usage: :escstar:
:escstar:=escstar

# esccomma macro
#
# Usage: :esccomma:
:esccomma:=esccomma

# escdot macro
#
# Usage: :escdot:
:escdot:=escdot

# bs macro
#
# Usage: :bs:
:bs:=bs

# macro expansions for DocBook backend (begin)
ifdef::doctype-manpage[]
ifdef::backend-docbook[]

# man macro expansions
[man-inlinemacro]
<citerefentry>
<refentrytitle>{target}</refentrytitle><manvolnum>{section}</manvolnum>
</citerefentry>

# no link option macro expansions
[nlopt-inlinemacro]
<literal>{opt}</literal>

# command-line option macro expansions
[opt-inlinemacro]
<literal>{opt}</literal>

# command-line option in another man page macro expansions
[manopt-inlinemacro]
<literal>{opt}</literal>

# component class initialization parameter macro expansions
[param-inlinemacro]
<literal>{pname}</literal>

# no link component class initialization parameter macro expansions
[nlparam-inlinemacro]
<literal>{pname}</literal>

# query result entry macro expansions
[qres-inlinemacro]
<literal>{pname}</literal>

# no link query result entry macro expansions
[nlqres-inlinemacro]
<literal>{pname}</literal>

# component class initialization parameter in another man page macro expansions
[manparam-inlinemacro]
<literal>{pname}</literal>

# component class specification macro expansions
[compcls-inlinemacro]
<literal>{cctype}.{ccplug}.{ccname}</literal>

# value object type macro expansions
[vtype-inlinemacro]
[{type}]

# not macro expansions
[not-inlinemacro]
NOT

# all macro expansions
[all-inlinemacro]
ALL

# escstar macro expansions
[escstar-inlinemacro]
<literal>\e*</literal>

# esccomma macro expansions
[esccomma-inlinemacro]
<literal>\e,</literal>

# escdot macro expansions
[escdot-inlinemacro]
<literal>\e,</literal>

# bs macro expansions
[bs-inlinemacro]
<literal>\e</literal>

# configure XML man page header
[header]
template::[header-declarations]
<refentry>
  <refentryinfo>
    <date>{revdate}</date>
  </refentryinfo>
  <refmeta>
    <refentrytitle>{mantitle}</refentrytitle>
    <manvolnum>{manvolnum}</manvolnum>
    <refmiscinfo class="source">Babeltrace</refmiscinfo>
    <refmiscinfo class="version">{babeltrace_version}</refmiscinfo>
    <refmiscinfo class="manual">Babeltrace&nbsp;2 manual</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>{manname}</refname>
    <refpurpose>{manpurpose}</refpurpose>
  </refnamediv>

# macro expansions for DocBook backend (end)
endif::backend-docbook[]
endif::doctype-manpage[]