Rename "tracing session" -> "recording session"

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

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index 01e82b1b4368bbab722f9ebfb4478722885c6e76..9a485950c414b154927728a85beedfd3718fd702 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -1,6 +1,6 @@
 lttng-untrack(1)
 ================
-:revdate: 1 May 2021
+:revdate: 14 June 2021
 
 
 NAME
@@ -40,25 +40,27 @@ The `lttng untrack` command disallows one or more processes to record
 LTTng events based on their attributes within:
 
 With the option:--session='SESSION' option::
-    The tracing session named 'SESSION'.
+    The recording session named 'SESSION'.
 
 Without the option:--session option::
-    The current tracing session (see man:lttng-concepts(7) to learn more
-    about the current tracing session).
+    The current recording session (see man:lttng-concepts(7) to learn
+    more about the current recording session).
 
-See man:lttng-concepts(7) to learn more about tracing sessions and
+See man:lttng-concepts(7) to learn more about recording sessions and
 recording event rules.
 
 The `untrack` command removes values from _inclusion sets_ of process
 attributes. See man:lttng-track(1) to learn more about inclusion sets.
 
+See the ``<<examples,EXAMPLES>>'' section below for usage examples.
 
-Example
-~~~~~~~
-A common operation is to create a tracing session (see
-man:lttng-create(1)), remove all the entries from the PID tracker
-inclusion set, start tracing, and then manually track PIDs while the
-tracing session is active.
+
+Inclusion set example
+~~~~~~~~~~~~~~~~~~~~~
+A common operation is to create a recording session (see
+man:lttng-create(1)), remove all the entries from the Linux kernel
+process ID inclusion set, start recording, and then manually add PIDs
+while the recording session is active.
 
 Assume the maximum system PID is 7 for this example.
 
@@ -79,7 +81,7 @@ Initial inclusion set:
 +
 [role="term"]
 ----
-$ lttng untrack --kernel --pid --all
+$ lttng untrack --kernel --all --pid
 ----
 +
 Inclusion set:
@@ -118,7 +120,7 @@ Inclusion set:
 -------------------------------
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
 
 
 Tracing domain
@@ -135,15 +137,15 @@ option:-u, option:--userspace::
 Recording target
 ~~~~~~~~~~~~~~~~
 option:-s 'SESSION', option:--session='SESSION'::
-    Remove values from one or more inclusion sets of the tracing session
-    named 'SESSION' instead of the current tracing session.
+    Remove values from one or more inclusion sets of the recording
+    session named 'SESSION' instead of the current recording session.
 
 
 Inclusion set selection
 ~~~~~~~~~~~~~~~~~~~~~~~
 option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]::
     For each 'PID' argument, remove 'PID' from the process ID inclusion
-    set of the selected tracing session and domain.
+    set of the selected recording session and domain.
 +
 'PID' is the process ID attribute of a process as seen from the root
 PID namespace (see man:pid_namespaces(7)).
@@ -152,14 +154,14 @@ Only available with option:--kernel option.
 
 option:--vpid[='VPID'[,'VPID']...]::
     For each 'VPID' argument, remove 'VPID' from the virtual process ID
-    inclusion set of the selected tracing session and domain.
+    inclusion set of the selected recording session and domain.
 +
 'VPID' is the virtual process ID attribute of a process as seen from
 the PID namespace of the process (see man:pid_namespaces(7)).
 
 option:--uid[='USER'[,'USER']...]::
     For each 'USER' argument, remove 'USER' from the user ID inclusion
-    set of the selected tracing session and domain.
+    set of the selected recording session and domain.
 +
 'USER' is either:
 +
@@ -177,7 +179,7 @@ Only available with option:--kernel option.
 
 option:--vuid[='VUSER'[,'VUSER']...]::
     For each 'VUSER' argument, remove 'VUSER' from the virtual user ID
-    inclusion set of the selected tracing session and domain.
+    inclusion set of the selected recording session and domain.
 +
 'VUSER' is either:
 +
@@ -194,7 +196,7 @@ set.
 
 option:--gid[='GROUP'[,'GROUP']...]::
     For each 'GROUP' argument, remove 'GROUP' from the group ID
-    inclusion set of the selected tracing session and domain.
+    inclusion set of the selected recording session and domain.
 +
 'GROUP' is either:
 +
@@ -212,7 +214,7 @@ Only available with option:--kernel option.
 
 option:--vgid[='VGROUP'[,'VGROUP']...]::
     For each 'VGROUP' argument, remove 'VGROUP' from the virtual group
-    ID inclusion set of the selected tracing session and domain.
+    ID inclusion set of the selected recording session and domain.
 +
 'VGROUP' is either:
 +
@@ -236,14 +238,52 @@ option:-a, option:--all::
     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
+--------
+.Remove the PIDs 1728 and 3775 from the Linux kernel process ID inclusion set of the current recording session.
+====
+See the option:--pid option.
+
+[role="term"]
+----
+$ lttng untrack --kernel --pid=1728,3775
+----
+====
+
+.Remove the IDs of a specific groups from the user space virtual group ID inclusion set of a specific recording session.
+====
+See the option:--vgid and option:--session options.
+
+[role="term"]
+----
+$ lttng untrack --userspace --session=my-session \
+                --vgid=docker,mysql
+----
+====
+
+.Remove all the user IDs from the Linux kernel user ID inclusion set of the current recording session.
+====
+See the option:--all and option:--uid options.
+
+[role="term"]
+----
+$ lttng untrack --kernel --all --uid
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-track(1)
+man:lttng-track(1),
+man:lttng-concepts(7)