X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Fasciidoc.conf;h=6fc2d5e09f4bbf7c6d513d278103fca4d517b259;hp=3f8cac41e36c365c3f0306eb776f4c854a8be7b1;hb=11613178f13a68334d5163e5983fc4ef09911718;hpb=f95ec87d0f3f4a6c8119e95394bbb5b3aed3a651 diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf index 3f8cac41e..6fc2d5e09 100644 --- a/doc/man/asciidoc.conf +++ b/doc/man/asciidoc.conf @@ -1,12 +1,27 @@ [macros] -# linklttng macro +# man macro # # Inspired by linkgit macro: # # -# Usage: linklttng:command(manpage-section) -(?su)[\\]?(?Plinklttng):(?P\S*?)\((?P.*?)\)= +# 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 # @@ -18,26 +33,95 @@ # Usage: :not: :not:=not -# linklttng macro expansions +# escwc macro +# +# Usage: :escwc: +:escwc:=escwc + +# esccomma macro +# +# Usage: :esccomma: +:esccomma:=esccomma + +# escbs macro +# +# Usage: :escbs: +:escbs:=escbs + +# man macro expansions +ifdef::doctype-manpage[] ifdef::backend-docbook[] -[linklttng-inlinemacro] +[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[] + +# esccomma macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[esccomma-inlinemacro] +\e, +endif::backend-docbook[] +endif::doctype-manpage[] + +# escbs macro expansions +ifdef::doctype-manpage[] +ifdef::backend-docbook[] +[escbs-inlinemacro] +\e +endif::backend-docbook[] +endif::doctype-manpage[] # configure XML man page header ifdef::doctype-manpage[]