X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-track.1.txt;h=de8e7ec9d484591a9450f4156d9c24cc2bc8002d;hp=9e0d2263ff62594a53ca95c646e858713f3d1f37;hb=03c5529d5cb12b279866d2c3245712a639284ce8;hpb=d4f093aa457acf5492c099f40badcc8379c95fe9 diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt index 9e0d2263f..de8e7ec9d 100644 --- a/doc/man/lttng-track.1.txt +++ b/doc/man/lttng-track.1.txt @@ -10,7 +10,7 @@ lttng-track - Add one or more entries to an LTTng resource tracker SYNOPSIS -------- [verse] -*lttng* ['GENERAL OPTIONS'] *track* (option:--kernel | option:--userspace) +*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *track* (option:--kernel | option:--userspace) [option:--session='SESSION'] (option:--pid='PID'[,'PID']... | option:--all option:--pid) @@ -21,10 +21,10 @@ resource tracker. A resource tracker is a _whitelist_ of resources. Tracked resources are allowed to emit events, provided those events are targeted by enabled -event rules (see linklttng:lttng-enable-event(1)). +event rules (see man:lttng-enable-event(1)). Tracker entries can be removed from the whitelist with -linklttng:lttng-untrack(1). +man:lttng-untrack(1). As of this version, the only available tracker is the *PID tracker*. The process ID (PID) tracker follows one or more process IDs; only the @@ -36,11 +36,11 @@ With the PID tracker, it is possible, for example, to record all system calls called by a given process: [role="term"] -------------------------------------------- -lttng enable-event --kernel --all --syscall -lttng track --kernel --pid=2345 -lttng start -------------------------------------------- +---- +# lttng enable-event --kernel --all --syscall +# lttng track --kernel --pid=2345 +# lttng start +---- If all the PIDs are tracked (i.e. `lttng track --pid --all`, which is the default state of all domains when creating a tracing session), then @@ -62,9 +62,9 @@ Initial whitelist: Command: [role="term"] ------------------------------------ -lttng track --userspace --pid=3,6,7 ------------------------------------ +---- +$ lttng track --userspace --pid=3,6,7 +---- Whitelist: @@ -75,9 +75,9 @@ Whitelist: Command: [role="term"] ---------------------------------- -lttng untrack --userspace --pid=7 ---------------------------------- +---- +$ lttng untrack --userspace --pid=7 +---- Whitelist: @@ -88,9 +88,9 @@ Whitelist: Command: [role="term"] ---------------------------------- -lttng track --userspace --pid=1,5 ---------------------------------- +---- +$ lttng track --userspace --pid=1,5 +---- Whitelist: @@ -102,7 +102,7 @@ It should be noted that the PID tracker tracks the numeric process IDs. Should a process with a given ID exit and another process be given this ID, then the latter would also be allowed to emit events. -See the linklttng:lttng-untrack(1) for more details about removing +See the man:lttng-untrack(1) for more details about removing entries. @@ -122,7 +122,7 @@ option:-u, option:--userspace:: Target ~~~~~~ -option:-s, option:--session='SESSION':: +option:-s 'SESSION', option:--session='SESSION':: Track resources in the tracing session named 'SESSION' instead of the current tracing session. @@ -133,7 +133,7 @@ option:-a, option:--all:: Used in conjunction with an empty option:--pid option: track _all_ process IDs (add all entries to the whitelist). -option:-p, option:--pid[='PID'[,'PID']...]:: +option:-p ['PID'[,'PID']...], option:--pid[='PID'[,'PID']...]:: Track process IDs 'PID' (add them to the current whitelist). + The 'PID' argument must be omitted when also using the option:--all @@ -148,5 +148,5 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -linklttng:lttng-untrack(1), -linklttng:lttng(1) +man:lttng-untrack(1), +man:lttng(1)