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

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

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index b7da339df9c06b2204d0d23b3ed6a8bc9428bf67..3fb02558db45df4e00f3fd78cd77c408a5cecc0d 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -19,11 +19,11 @@ DESCRIPTION
 The `lttng untrack` commands removes one or more entries from a
 resource tracker.
 
 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
 
 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.
 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
 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.
 
 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"]
 Command:
 
 [role="term"]

-------------
-lttng create
-------------
+----
+$ lttng create
+----

 
 Initial whitelist:
 
 
 Initial whitelist:
 


@@ -54,9 +54,9 @@ Initial whitelist:
 Command:
 
 [role="term"]
 Command:
 
 [role="term"]

--------------------------------------
-lttng untrack --userspace --pid --all
--------------------------------------
+----
+$ lttng untrack --userspace --pid --all
+----

 
 Whitelist:
 
 
 Whitelist:
 


@@ -67,12 +67,12 @@ Whitelist:
 Commands:
 
 [role="term"]
 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:
 
 
 Whitelist:
 


@@ -83,9 +83,9 @@ Whitelist:
 Command:
 
 [role="term"]
 Command:
 
 [role="term"]

--------------------------------
-lttng track --userspace --pid=2
--------------------------------
+----
+$ lttng track --userspace --pid=2
+----

 
 Whitelist:
 
 
 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).
 
     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
     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
 --------
 
 SEE ALSO
 --------

-linklttng:lttng-track(1),
-linklttng:lttng(1)
+man:lttng-track(1),
+man:lttng(1)