lttng-enable-channel(1): reword --blocking-timeout, document in description

[lttng-tools.git] / doc / man / lttng-enable-event.1.txt

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index afdbd6747e336fe4a42ae14c311d57011aeb7f57..b6141b25847a873b4c87a6c997161895c23f8688 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -107,10 +107,10 @@ a _don't care_.
 For example, consider the following commands:
 
 [role="term"]
 For example, consider the following commands:
 
 [role="term"]

-----------------------------------------------------------------
-lttng enable-event --userspace hello:world
-lttng enable-event --userspace hello:world --loglevel=TRACE_INFO
-----------------------------------------------------------------
+----
+$ lttng enable-event --userspace hello:world
+$ lttng enable-event --userspace hello:world --loglevel=TRACE_INFO
+----

 
 Here, two event rules are created. The first one has a single condition:
 the tracepoint name must match `hello:world`. The second one has two
 
 Here, two event rules are created. The first one has a single condition:
 the tracepoint name must match `hello:world`. The second one has two


@@ -133,8 +133,9 @@ The available conditions for the Linux kernel domain are:
   (option:--probe or option:--function option's argument) which must
   match event source's equivalent.
 +
   (option:--probe or option:--function option's argument) which must
   match event source's equivalent.
 +

-Wildcard using the `*` character are supported _at the end_ of
-tracepoint and system call names.
+You can use `*` characters at any place in the tracepoint or system
+call name as wildcards to match zero or more characters. To use a
+literal `*` character, use :escwc:.

 
 * Filter expression (option:--filter option) executed against the
   dynamic values of event fields at execution time that must evaluate
 
 * Filter expression (option:--filter option) executed against the
   dynamic values of event fields at execution time that must evaluate


@@ -146,10 +147,11 @@ The available conditions for the application domains are:
 * Tracepoint name ('EVENT' with option:--tracepoint option) which must
   match event source's equivalent.
 +
 * Tracepoint name ('EVENT' with option:--tracepoint option) which must
   match event source's equivalent.
 +

-Wildcard using the `*` character are supported _at the end_ of
-tracepoint names. When creating an event rule with a tracepoint name
-containing a wildcard, specific tracepoint names can be excluded from
-the match using the option:--exclude option.
+You can use `*` characters at any place in the tracepoint name as
+wildcards to match zero or more characters. To use a literal `*`
+character, use :escwc:. When you create an event rule with a tracepoint
+name containing a wildcard, you can exclude specific tracepoint names
+from the match with the option:--exclude option.

 
 * Filter expression (option:--filter option) executed against the
   dynamic values of event fields at execution time that must evaluate
 
 * Filter expression (option:--filter option) executed against the
   dynamic values of event fields at execution time that must evaluate


@@ -232,9 +234,9 @@ When a comparison includes a non existent event field, the whole filter
 expression evaluates to false (the event is discarded).
 
 C integer and floating point number constants are supported, as well as
 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 :escwc:.
+literal strings between double quotes (`"`). You can use `*` characters
+at any place in a literal string as wildcards to match zero or more
+characters. To use a literal `*` character, use :escwc:.

 
 LTTng-UST enumeration fields can be compared to integer values (fields
 or constants).
 
 LTTng-UST enumeration fields can be compared to integer values (fields
 or constants).


@@ -258,6 +260,10 @@ $ctx.procname == "lttng*" && (!flag || poel < 34)
 $app.my_provider:my_context == 17.34e9 || some_enum >= 14
 ---------------------------------------------------------
 
 $app.my_provider:my_context == 17.34e9 || some_enum >= 14
 ---------------------------------------------------------
 

+-------------------
+filename != "*.log"
+-------------------
+

 
 [[log-levels]]
 Log levels
 
 [[log-levels]]
 Log levels


@@ -353,11 +359,11 @@ option:-u, option:--userspace::
 
 Target
 ~~~~~~
 
 Target
 ~~~~~~

-option:-c, option:--channel='CHANNEL'::
+option:-c 'CHANNEL', option:--channel='CHANNEL'::

     Create or enable event rules in the channel named 'CHANNEL' instead
     of the default channel name `channel0`.
 
     Create or enable event rules in the channel named 'CHANNEL' instead
     of the default channel name `channel0`.
 

-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::

     Create or enable event rules in the tracing session named 'SESSION'
     instead of the current tracing session.
 
     Create or enable event rules in the tracing session named 'SESSION'
     instead of the current tracing session.
 


@@ -409,13 +415,15 @@ option:--loglevel-only='LOGLEVEL'::
 
 Filtering and exclusion
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Filtering and exclusion
 ~~~~~~~~~~~~~~~~~~~~~~~

-option:-x, option:--exclude='EVENT'[,'EVENT']...::
+option:-x 'EVENT'[,'EVENT']..., option:--exclude='EVENT'[,'EVENT']...::

     Exclude events named 'EVENT' from the event rule. This option
     Exclude events named 'EVENT' from the event rule. This option

-    can be used when the command's 'EVENT' argument contains a wildcard
-    (`*`) to exclude specific names. Only available with application
-    domains.
+    can be used when the command's 'EVENT' argument contains at least
+    one wildcard star (`*`) to exclude specific names. 'EVENT' can also
+    contain wildcard stars. To use a
+    literal `,` character, use :esccomma:.
+    Only available with the option:--userspace domain.

 
 

-option:-f, option:--filter='EXPR'::
+option:-f 'EXPR', option:--filter='EXPR'::

     Add filter expression condition to the event rule. Expression 'EXPR'
     must evaluate to true when executed against the dynamic values of
     event fields. See the <<filter-syntax,Filter expression syntax>>
     Add filter expression condition to the event rule. Expression 'EXPR'
     must evaluate to true when executed against the dynamic values of
     event fields. See the <<filter-syntax,Filter expression syntax>>