| 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 | # no link option macro |
| 12 | # |
| 13 | # Usage: nloption:--option-name |
| 14 | (?su)[\\]?(?P<name>nloption):(?P<opt>--?[a-zA-Z0-9-]*)= |
| 15 | |
| 16 | # option macro |
| 17 | # |
| 18 | # Usage: option:--option-name |
| 19 | (?su)[\\]?(?P<name>option):(?P<opt>--?[a-zA-Z0-9-]*)= |
| 20 | |
| 21 | # not macro |
| 22 | # |
| 23 | # Usage: :not: |
| 24 | :not:=not |
| 25 | |
| 26 | # man macro expansions |
| 27 | ifdef::doctype-manpage[] |
| 28 | ifdef::backend-docbook[] |
| 29 | [man-inlinemacro] |
| 30 | {0%{target}} |
| 31 | {0#<citerefentry>} |
| 32 | {0#<refentrytitle>{target}</refentrytitle><manvolnum>{0}</manvolnum>} |
| 33 | {0#</citerefentry>} |
| 34 | endif::backend-docbook[] |
| 35 | endif::doctype-manpage[] |
| 36 | |
| 37 | # option macro expansions |
| 38 | ifdef::doctype-manpage[] |
| 39 | ifdef::backend-docbook[] |
| 40 | [option-inlinemacro] |
| 41 | <literal>{opt}</literal> |
| 42 | endif::backend-docbook[] |
| 43 | endif::doctype-manpage[] |
| 44 | |
| 45 | # no link option macro expansions |
| 46 | ifdef::doctype-manpage[] |
| 47 | ifdef::backend-docbook[] |
| 48 | [nloption-inlinemacro] |
| 49 | <literal>{opt}</literal> |
| 50 | endif::backend-docbook[] |
| 51 | endif::doctype-manpage[] |
| 52 | |
| 53 | # not macro expansions |
| 54 | ifdef::doctype-manpage[] |
| 55 | ifdef::backend-docbook[] |
| 56 | [not-inlinemacro] |
| 57 | NOT |
| 58 | endif::backend-docbook[] |
| 59 | endif::doctype-manpage[] |
| 60 | |
| 61 | # configure XML man page header |
| 62 | ifdef::doctype-manpage[] |
| 63 | ifdef::backend-docbook[] |
| 64 | [header] |
| 65 | template::[header-declarations] |
| 66 | <refentry> |
| 67 | <refmeta> |
| 68 | <refentrytitle>{mantitle}</refentrytitle> |
| 69 | <manvolnum>{manvolnum}</manvolnum> |
| 70 | <refmiscinfo class="source">LTTng</refmiscinfo> |
| 71 | <refmiscinfo class="version">{lttng_version}</refmiscinfo> |
| 72 | <refmiscinfo class="manual">LTTng Manual</refmiscinfo> |
| 73 | </refmeta> |
| 74 | <refnamediv> |
| 75 | <refname>{manname}</refname> |
| 76 | <refpurpose>{manpurpose}</refpurpose> |
| 77 | </refnamediv> |
| 78 | endif::backend-docbook[] |
| 79 | endif::doctype-manpage[] |