doc/man: add escwc macro and use it
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Thu, 24 Mar 2016 18:00:38 +0000 (14:00 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 24 Mar 2016 19:21:00 +0000 (15:21 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/README.md
doc/man/asciidoc.conf
doc/man/lttng-enable-event.1.txt

index 21513ba0dc5976e3dfebd56a05cf0c578371c0ac..316c4d58ca2aa751afd5261c3d85b6a62998179b 100644 (file)
@@ -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
 --------
 
index baa697839341fe5295f8db5315a75a5b8a1c252e..d6045fd2052b2770f7283461060f7f6b1177eb9e 100644 (file)
 # 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]
+<literal>\e*</literal>
+endif::backend-docbook[]
+
 # configure XML man page header
 ifdef::doctype-manpage[]
 ifdef::backend-docbook[]
index f8a630af5ea34a9af4238a490ff8261e7d4b1db5..f0755333c8f6ac510ae4b88d79211b4013a29c0b 100644 (file)
@@ -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).
This page took 0.03531 seconds and 4 git commands to generate.