X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-untrack.1.txt;h=3fb02558db45df4e00f3fd78cd77c408a5cecc0d;hb=adc4b5c84ab187cafb8b5368bdfd4b6be5b1faf5;hp=8226e1ada3db8932ee5293b89905660c40dc2cf1;hpb=882443a6d87be3c1d3d862794c87882d7bcde1bc;p=lttng-tools.git diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index 8226e1ada..3fb02558d 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -10,7 +10,7 @@ lttng-untrack - Remove one or more entries from an LTTng resource tracker SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *untrack* (option:--kernel | option:--userspace) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *untrack* (option:--kernel | option:--userspace) [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid) @@ -19,11 +19,11 @@ 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. +See man: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 +man: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. @@ -32,7 +32,7 @@ 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 +(see man:lttng-create(1)), remove all the entries from the PID tracker whitelist, start tracing, and then manually track PIDs while tracing is active. @@ -40,9 +40,10 @@ Assume the maximum system PID is 7 for this example. Command: ------------- -lttng create ------------- +[role="term"] +---- +$ lttng create +---- Initial whitelist: @@ -52,9 +53,10 @@ Initial whitelist: Command: -------------------------------------- -lttng untrack --userspace --pid --all -------------------------------------- +[role="term"] +---- +$ lttng untrack --userspace --pid --all +---- Whitelist: @@ -64,12 +66,13 @@ Whitelist: Commands: ----------------------------------- -lttng enable-event --userspace ... -lttng start -... -lttng track --userspace --pid=3,5 ----------------------------------- +[role="term"] +---- +$ lttng enable-event --userspace ... +$ lttng start +$ # ... +$ lttng track --userspace --pid=3,5 +---- Whitelist: @@ -79,9 +82,10 @@ Whitelist: Command: -------------------------------- -lttng track --userspace --pid=2 -------------------------------- +[role="term"] +---- +$ lttng track --userspace --pid=2 +---- Whitelist: @@ -117,7 +121,7 @@ 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']...]:: +option:-p ['PID'[,'PID']...], 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 @@ -132,5 +136,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-track(1), -linklttng:lttng(1) +man:lttng-track(1), +man:lttng(1)