doc/man: add typical `$` and `#` prompts to command lines

[lttng-tools.git] / doc / man / lttng-track.1.txt

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index 899a6c4eadd9b2ef0da5b242a0c32d519f7f0a7f..de8e7ec9d484591a9450f4156d9c24cc2bc8002d 100644 (file)
--- 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
@@ -35,11 +35,12 @@ events (equivalent of `lttng track --pid --all` for all domains).
 With the PID tracker, it is possible, for example, to record all system
 calls called by a given process:
 
--------------------------------------------
-lttng enable-event --kernel --all --syscall
-lttng track --kernel --pid=2345
-lttng start
--------------------------------------------
+[role="term"]
+----
+# 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
@@ -60,9 +61,10 @@ Initial whitelist:
 
 Command:
 
------------------------------------
-lttng track --userspace --pid=3,6,7
------------------------------------
+[role="term"]
+----
+$ lttng track --userspace --pid=3,6,7
+----
 
 Whitelist:
 
@@ -72,9 +74,10 @@ Whitelist:
 
 Command:
 
----------------------------------
-lttng untrack --userspace --pid=7
----------------------------------
+[role="term"]
+----
+$ lttng untrack --userspace --pid=7
+----
 
 Whitelist:
 
@@ -84,9 +87,10 @@ Whitelist:
 
 Command:
 
----------------------------------
-lttng track --userspace --pid=1,5
----------------------------------
+[role="term"]
+----
+$ lttng track --userspace --pid=1,5
+----
 
 Whitelist:
 
@@ -98,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.
 
 
@@ -118,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.
 
@@ -129,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
@@ -144,5 +148,5 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng-untrack(1),
-linklttng:lttng(1)
+man:lttng-untrack(1),
+man:lttng(1)