doc/man: use double quotes when referring to internal section
[lttng-tools.git] / doc / man / lttng-track.1.txt
index d2768b12ccd2f6d59ca0a0fb9a5280f38b056d3a..5c328c6e0bd2f9f838c8e3748d0d4a53a56b228a 100644 (file)
@@ -1,6 +1,6 @@
 lttng-track(1)
 ==============
-:revdate: 1 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -111,6 +111,8 @@ $ lttng track --kernel --pid=2345
 $ lttng start
 ----
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
+
 Remove values from an inclusion set with the man:lttng-untrack(1)
 command.
 
@@ -171,7 +173,7 @@ Remove values from an inclusion set with the man:lttng-untrack(1)
 command.
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
 
 
 Tracing domain
@@ -288,10 +290,47 @@ option:-a, option:--all::
     the possible values to the selected inclusion sets.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Add the PIDs 1728 and 3775 to the Linux kernel process ID inclusion set of the current tracing session.
+====
+See the option:--pid option.
+
+[role="term"]
+----
+$ lttng track --kernel --pid=1728,3775
+----
+====
+
+.Add the ID of a specific user to the user space virtual user ID inclusion set of a specific tracing session.
+====
+See the option:--vuid and option:--session options.
+
+[role="term"]
+----
+$ lttng track --userspace --session=my-session --vuid=http
+----
+====
+
+.Add all the possible group IDs to the Linux kernel group ID inclusion set of the current tracing session.
+====
+See the option:--all and option:--gid options.
+
+[role="term"]
+----
+$ lttng track --kernel --all --gid
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
This page took 0.024786 seconds and 5 git commands to generate.