X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-untrack.1.txt;h=8d0fd1f60ae837a993dea87191e010a259bbe6fb;hb=508a802cc4850531d02cb097bb4ed2379a66052c;hp=b7da339df9c06b2204d0d23b3ed6a8bc9428bf67;hpb=ce19b9ed9bd9591bd0c4d1998780082a490991fd;p=lttng-tools.git diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index b7da339df..8d0fd1f60 100644 --- a/doc/man/lttng-untrack.1.txt +++ b/doc/man/lttng-untrack.1.txt @@ -1,5 +1,6 @@ lttng-untrack(1) ================ +:revdate: 14 March 2017 NAME @@ -19,11 +20,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 +33,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. @@ -41,9 +42,9 @@ Assume the maximum system PID is 7 for this example. Command: [role="term"] ------------- -lttng create ------------- +---- +$ lttng create +---- Initial whitelist: @@ -54,9 +55,9 @@ Initial whitelist: Command: [role="term"] -------------------------------------- -lttng untrack --userspace --pid --all -------------------------------------- +---- +$ lttng untrack --userspace --pid --all +---- Whitelist: @@ -67,12 +68,12 @@ Whitelist: Commands: [role="term"] ----------------------------------- -lttng enable-event --userspace ... -lttng start -# ... -lttng track --userspace --pid=3,5 ----------------------------------- +---- +$ lttng enable-event --userspace ... +$ lttng start +$ # ... +$ lttng track --userspace --pid=3,5 +---- Whitelist: @@ -83,9 +84,9 @@ Whitelist: Command: [role="term"] -------------------------------- -lttng track --userspace --pid=2 -------------------------------- +---- +$ lttng track --userspace --pid=2 +---- Whitelist: @@ -121,7 +122,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 @@ -136,5 +137,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-track(1), -linklttng:lttng(1) +man:lttng-track(1), +man:lttng(1)