From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 20:19:09 +0000 (-0400)
Subject: lttng-track(1): add usage examples
X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=4781283ce229c47e1831685b30851a7c3ae6cb9e

lttng-track(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I21a7906626a09b9964fc51dd083f1c2ea5b855c3
---

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index 195e07973..2a04eeedc 100644
--- a/doc/man/lttng-track.1.txt
+++ b/doc/man/lttng-track.1.txt
@@ -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.
 
@@ -294,6 +296,40 @@ 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-footer.txt[]