tools/lib/traceevent/Documentation/asciidoc.conf

   1 ## linktep: macro
   2 #
   3 # Usage: linktep:command[manpage-section]
   4 #
   5 # Note, {0} is the manpage section, while {target} is the command.
   6 #
   7 # Show TEP link as: <command>(<section>); if section is defined, else just show
   8 # the command.
   9
  10 [macros]
  11 (?su)[\\]?(?P<name>linktep):(?P<target>\S*?)\[(?P<attrlist>.*?)\]=
  12
  13 [attributes]
  14 asterisk=&#42;
  15 plus=&#43;
  16 caret=&#94;
  17 startsb=&#91;
  18 endsb=&#93;
  19 tilde=&#126;
  20
  21 ifdef::backend-docbook[]
  22 [linktep-inlinemacro]
  23 {0%{target}}
  24 {0#<citerefentry>}
  25 {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>}
  26 {0#</citerefentry>}
  27 endif::backend-docbook[]
  28
  29 ifdef::backend-docbook[]
  30 ifndef::tep-asciidoc-no-roff[]
  31 # "unbreak" docbook-xsl v1.68 for manpages. v1.69 works with or without this.
  32 # v1.72 breaks with this because it replaces dots not in roff requests.
  33 [listingblock]
  34 <example><title>{title}</title>
  35 <literallayout>
  36 ifdef::doctype-manpage[]
  37 &#10;.ft C&#10;
  38 endif::doctype-manpage[]
  39 |
  40 ifdef::doctype-manpage[]
  41 &#10;.ft&#10;
  42 endif::doctype-manpage[]
  43 </literallayout>
  44 {title#}</example>
  45 endif::tep-asciidoc-no-roff[]
  46
  47 ifdef::tep-asciidoc-no-roff[]
  48 ifdef::doctype-manpage[]
  49 # The following two small workarounds insert a simple paragraph after screen
  50 [listingblock]
  51 <example><title>{title}</title>
  52 <literallayout>
  53 |
  54 </literallayout><simpara></simpara>
  55 {title#}</example>
  56
  57 [verseblock]
  58 <formalpara{id? id="{id}"}><title>{title}</title><para>
  59 {title%}<literallayout{id? id="{id}"}>
  60 {title#}<literallayout>
  61 |
  62 </literallayout>
  63 {title#}</para></formalpara>
  64 {title%}<simpara></simpara>
  65 endif::doctype-manpage[]
  66 endif::tep-asciidoc-no-roff[]
  67 endif::backend-docbook[]
  68
  69 ifdef::doctype-manpage[]
  70 ifdef::backend-docbook[]
  71 [header]
  72 template::[header-declarations]
  73 <refentry>
  74 <refmeta>
  75 <refentrytitle>{mantitle}</refentrytitle>
  76 <manvolnum>{manvolnum}</manvolnum>
  77 <refmiscinfo class="source">libtraceevent</refmiscinfo>
  78 <refmiscinfo class="version">{libtraceevent_version}</refmiscinfo>
  79 <refmiscinfo class="manual">libtraceevent Manual</refmiscinfo>
  80 </refmeta>
  81 <refnamediv>
  82   <refname>{manname1}</refname>
  83   <refname>{manname2}</refname>
  84   <refname>{manname3}</refname>
  85   <refname>{manname4}</refname>
  86   <refname>{manname5}</refname>
  87   <refname>{manname6}</refname>
  88   <refname>{manname7}</refname>
  89   <refname>{manname8}</refname>
  90   <refname>{manname9}</refname>
  91   <refname>{manname10}</refname>
  92   <refname>{manname11}</refname>
  93   <refname>{manname12}</refname>
  94   <refname>{manname13}</refname>
  95   <refname>{manname14}</refname>
  96   <refname>{manname15}</refname>
  97   <refname>{manname16}</refname>
  98   <refname>{manname17}</refname>
  99   <refname>{manname18}</refname>
 100   <refname>{manname19}</refname>
 101   <refname>{manname20}</refname>
 102   <refname>{manname21}</refname>
 103   <refname>{manname22}</refname>
 104   <refname>{manname23}</refname>
 105   <refname>{manname24}</refname>
 106   <refname>{manname25}</refname>
 107   <refname>{manname26}</refname>
 108   <refname>{manname27}</refname>
 109   <refname>{manname28}</refname>
 110   <refname>{manname29}</refname>
 111   <refname>{manname30}</refname>
 112   <refpurpose>{manpurpose}</refpurpose>
 113 </refnamediv>
 114 endif::backend-docbook[]
 115 endif::doctype-manpage[]
 116
 117 ifdef::backend-xhtml11[]
 118 [linktep-inlinemacro]
 119 <a href="{target}.html">{target}{0?({0})}</a>
 120 endif::backend-xhtml11[]