doc/man: use linkgenoptions macro

[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 4d88bdb1b6d37480287c796d1ba92c97942f7db6..f8a630af5ea34a9af4238a490ff8261e7d4b1db5 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -12,7 +12,7 @@ SYNOPSIS
 Create or enable Linux kernel event rules:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *enable-event* option:--kernel
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel
       [option:--probe='SOURCE' | option:--function='SOURCE' | option:--syscall]
       [option:--filter='EXPR'] [option:--session='SESSION']
       [option:--channel='CHANNEL'] 'EVENT'[,'EVENT']...
@@ -20,13 +20,13 @@ Create or enable Linux kernel event rules:
 Create or enable an "all" Linux kernel event rule:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *enable-event* option:--kernel option:--all [option:--syscall]
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event* option:--kernel option:--all [option:--syscall]
       [option:--filter='EXPR'] [option:--session='SESSION'] [option:--channel='CHANNEL']
 
 Create or enable application event rules:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *enable-event*
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *enable-event*
       (option:--userspace | option:--jul | option:--log4j | option:--python)
       [option:--filter='EXPR'] [option:--exclude='EVENT'[,'EVENT']...]
       [option:--loglevel='LOGLEVEL' | option:--loglevel-only='LOGLEVEL']
@@ -106,6 +106,7 @@ a _don't care_.
 
 For example, consider the following commands:
 
+[role="term"]
 ----------------------------------------------------------------
 lttng enable-event --userspace hello:world
 lttng enable-event --userspace hello:world --loglevel=TRACE_INFO
@@ -180,6 +181,10 @@ when creating a new event rule. If the filter expression evaluates
 to true when executed against the dynamic values of an event's fields
 when tracing, the filtering condition passes.
 
+NOTE: Make sure to **single-quote** the filter expression when running
+the command from a shell, as filter expressions typically include
+characters having a special meaning for most shells.
+
 The filter expression syntax is very similar to C language conditional
 expressions (expressions that can be evaluated by an `if` statement).