X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Fasciidoc.conf;fp=doc%2Fman%2Fasciidoc.conf;h=70bd7d68a7c061fb4ee4c0efe2b33f8db48f7e4f;hb=d41e8aa2ff8a13c173a51c0abab45d16c1f86598;hp=0000000000000000000000000000000000000000;hpb=eb30334cd31f0e196ce3c07fd7feb87deffb3843;p=lttng-tools.git diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf new file mode 100644 index 000000000..70bd7d68a --- /dev/null +++ b/doc/man/asciidoc.conf @@ -0,0 +1,118 @@ +[macros] + +# man macro +# +# Inspired by linkgit macro: +# +# +# Usage: man:command(manpage-section) +(?su)[\\]?(?Pman):(?P\S*?)\((?P.*?)\)= + +# linkgenoptions macro +# +# Usage: linkgenoptions:(text) +(?su)[\\]?(?Plinkgenoptions):\((?P.*?)\)= + +# no link option macro +# +# Usage: nloption:--option-name +(?su)[\\]?(?Pnloption):(?P--?[a-zA-Z0-9-]*)= + +# lttng(1) general option macro +# +# Usage: genoption:--option-name +(?su)[\\]?(?Pgenoption):(?P--?[a-zA-Z0-9-]*)= + +# option macro +# +# Usage: option:--option-name +(?su)[\\]?(?Poption):(?P--?[a-zA-Z0-9-]*)= + +# not macro +# +# Usage: :not: +:not:=not + +# escwc macro +# +# Usage: :escwc: +:escwc:=escwc + +# man macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[man-inlinemacro] +{0%{target}} +{0#} +{0#{target}{0}} +{0#} +endif::backend-docbook[] +endif::doctype-manpage[] + +# linkgenoptions macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[linkgenoptions-inlinemacro] +{text} +endif::backend-docbook[] +endif::doctype-manpage[] + +# option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[option-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# no link option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[nloption-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# lttng(1) general option macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[genoption-inlinemacro] +{opt} +endif::backend-docbook[] +endif::doctype-manpage[] + +# not macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[not-inlinemacro] +NOT +endif::backend-docbook[] +endif::doctype-manpage[] + +# escwc macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[escwc-inlinemacro] +\e* +endif::backend-docbook[] +endif::doctype-manpage[] + +# configure XML man page header +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[header] +template::[header-declarations] + + +{mantitle} +{manvolnum} +LTTng +{lttng_version} +LTTng Manual + + + {manname} + {manpurpose} + +endif::backend-docbook[] +endif::doctype-manpage[]