X-Git-Url: http://git.efficios.com/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-untrack.1.txt;h=3fb02558db45df4e00f3fd78cd77c408a5cecc0d;hp=b57150633d6a66937a289baddfe0563f0d982c8c;hb=437afa719f5e777dac77827298c443f450e0903e;hpb=d4f093aa457acf5492c099f40badcc8379c95fe9 diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt index b57150633..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. @@ -41,9 +41,9 @@ Assume the maximum system PID is 7 for this example. Command: [role="term"] ------------- -lttng create ------------- +---- +$ lttng create +---- Initial whitelist: @@ -54,9 +54,9 @@ Initial whitelist: Command: [role="term"] -------------------------------------- -lttng untrack --userspace --pid --all -------------------------------------- +---- +$ lttng untrack --userspace --pid --all +---- Whitelist: @@ -67,12 +67,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 +83,9 @@ Whitelist: Command: [role="term"] -------------------------------- -lttng track --userspace --pid=2 -------------------------------- +---- +$ lttng track --userspace --pid=2 +---- Whitelist: @@ -121,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 @@ -136,5 +136,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-track(1), -linklttng:lttng(1) +man:lttng-track(1), +man:lttng(1)