From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Sat, 14 Nov 2015 05:09:18 +0000 (-0500)
Subject: doc/man: create lttng-untrack(1) and update/fix content
X-Git-Tag: v2.8.0-rc1~39
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=882443a6d87be3c1d3d862794c87882d7bcde1bc;p=lttng-tools.git

doc/man: create lttng-untrack(1) and update/fix content

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

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index ea307aed8..0a10e8653 100644
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -23,7 +23,8 @@ MAN1_NAMES = \
 	lttng-add-context \
 	lttng-list \
 	lttng-calibrate \
-	lttng-track
+	lttng-track \
+	lttng-untrack
 MAN3_NAMES =
 MAN8_NAMES =
 MAN1_NO_ASCIIDOC_NAMES = lttng-crash
diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
new file mode 100644
index 000000000..8226e1ada
--- /dev/null
+++ b/doc/man/lttng-untrack.1.txt
@@ -0,0 +1,136 @@
+lttng-untrack(1)
+================
+
+
+NAME
+----
+lttng-untrack - Remove one or more entries from an LTTng resource tracker
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng* ['GENERAL OPTIONS'] *untrack* (option:--kernel | option:--userspace)
+      [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid)
+
+
+DESCRIPTION
+-----------
+The `lttng untrack` commands removes one or more entries from a
+resource tracker.
+
+See linklttng:lttng-track(1) to learn more about LTTng trackers.
+
+The untrack command removes specific resources from a tracker. The
+resources to remove must have been precedently added by
+linklttng:lttng-track(1). It is also possible to remove all the
+resources from the whitelist using the option:--all option.
+
+As of this version, the only available tracker is the PID tracker.
+
+
+Example
+~~~~~~~
+One common operation is to create a tracing session
+(see linklttng:lttng-create(1)), remove all the entries from the PID
+tracker whitelist, start tracing, and then manually track PIDs
+while tracing is active.
+
+Assume the maximum system PID is 7 for this example.
+
+Command:
+
+------------
+lttng create
+------------
+
+Initial whitelist:
+
+-------------------------------
+[0] [1] [2] [3] [4] [5] [6] [7]
+-------------------------------
+
+Command:
+
+-------------------------------------
+lttng untrack --userspace --pid --all
+-------------------------------------
+
+Whitelist:
+
+-------------------------------
+[ ] [ ] [ ] [ ] [ ] [ ] [ ] [ ]
+-------------------------------
+
+Commands:
+
+----------------------------------
+lttng enable-event --userspace ...
+lttng start
+...
+lttng track --userspace --pid=3,5
+----------------------------------
+
+Whitelist:
+
+-------------------------------
+[ ] [ ] [ ] [3] [ ] [5] [ ] [ ]
+-------------------------------
+
+Command:
+
+-------------------------------
+lttng track --userspace --pid=2
+-------------------------------
+
+Whitelist:
+
+-------------------------------
+[ ] [ ] [2] [3] [ ] [5] [ ] [ ]
+-------------------------------
+
+
+include::common-cmd-options-head.txt[]
+
+
+Domain
+~~~~~~
+One of:
+
+option:-k, option:--kernel::
+    Untrack resources tracked in the Linux kernel domain.
+
+option:-u, option:--userspace::
+    Untrack resources tracked in the user space domain.
+
+
+Target
+~~~~~~
+option:-s, option:--session='SESSION'::
+    Untrack resources in the tracing session named 'SESSION' instead of
+    the current tracing session.
+
+
+Untracking
+~~~~~~~~~~
+option:-a, option:--all::
+    Used in conjunction with an empty option:--pid option: untrack _all_
+    process IDs (clear the whitelist).
+
+option:-p, option:--pid[='PID'[,'PID']...]::
+    Untrack process IDs 'PID' (remove them from the current whitelist).
++
+The 'PID' argument must be omitted when also using the option:--all
+option.
+
+
+include::common-cmd-help-options.txt[]
+
+
+include::common-cmd-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng-track(1),
+linklttng:lttng(1)