From: Philippe Proulx Date: Thu, 24 Mar 2016 18:00:38 +0000 (-0400) Subject: doc/man: add escwc macro and use it X-Git-Tag: v2.9.0-rc1~311 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=bca82bfe61d7b17cd46891072a5bb0b2680a285d doc/man: add escwc macro and use it Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- diff --git a/doc/man/README.md b/doc/man/README.md index 21513ba0d..316c4d58c 100644 --- a/doc/man/README.md +++ b/doc/man/README.md @@ -69,6 +69,12 @@ Usage example: `genoption:--group`, `genoption:--sessiond-path` The `:not:` macro is used to emphasize on _not_. +### escwc + +The `:escwc:` macro is used to output `\*` literally in the man page, +which is not so easy to do otherwise. + + Includes -------- diff --git a/doc/man/asciidoc.conf b/doc/man/asciidoc.conf index baa697839..d6045fd20 100644 --- a/doc/man/asciidoc.conf +++ b/doc/man/asciidoc.conf @@ -33,6 +33,11 @@ # Usage: :not: :not:=not +# escwc macro +# +# Usage: :escwc: +:escwc:=escwc + # linklttng macro expansions ifdef::backend-docbook[] [linklttng-inlinemacro] @@ -72,6 +77,12 @@ ifdef::backend-docbook[] NOT endif::backend-docbook[] +# escwc macro expansions +ifdef::backend-docbook[] +[escwc-inlinemacro] +\e* +endif::backend-docbook[] + # configure XML man page header ifdef::doctype-manpage[] ifdef::backend-docbook[] diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt index f8a630af5..f0755333c 100644 --- a/doc/man/lttng-enable-event.1.txt +++ b/doc/man/lttng-enable-event.1.txt @@ -234,7 +234,7 @@ expression evaluates to false (the event is discarded). C integer and floating point number constants are supported, as well as literal strings between double quotes (`"`). Literal strings can contain a wildcard character (`*`) at the end to match more than one string. -This wildcard can be escaped using `\\*`. +This wildcard can be escaped using :escwc:. LTTng-UST enumeration fields can be compared to integer values (fields or constants).