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

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

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index 7dcfa00a1ed78387eb1259b978b3dfc3e6bd2a53..ac4bebfd756355b9c9a7f80857de162a42128b45 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -46,7 +46,7 @@ is sent to the registered snapshot outputs.
 
 The tracing session should be created in _snapshot mode_ to make sure
 taking snapshots is allowed. This is done at tracing session creation
 
 The tracing session should be created in _snapshot mode_ to make sure
 taking snapshots is allowed. This is done at tracing session creation

-time using the linklttng:lttng-create(1) command.
+time using the man:lttng-create(1) command.

 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same
 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same


@@ -63,7 +63,7 @@ As of this version, only one snapshot output is allowed.
 A snapshot output can be added using the `add-output` action. The
 output destination URL is set using either the 'URL' positional
 argument, or both the option:--ctrl-url and option:--data-url options.
 A snapshot output can be added using the `add-output` action. The
 output destination URL is set using either the 'URL' positional
 argument, or both the option:--ctrl-url and option:--data-url options.

-See linklttng:lttng-create(1) to learn more about the URL format.
+See man:lttng-create(1) to learn more about the URL format.

 
 A name can be assigned to an output when adding it using the
 option:--name option. This name is part of the names of the
 
 A name can be assigned to an output when adding it using the
 option:--name option. This name is part of the names of the


@@ -85,9 +85,10 @@ Taking a snapshot
 ~~~~~~~~~~~~~~~~~
 Taking a snapshot of the current tracing session is as easy as:
 
 ~~~~~~~~~~~~~~~~~
 Taking a snapshot of the current tracing session is as easy as:
 

----------------------
-lttng snapshot record
----------------------
+[role="term"]
+----
+$ lttng snapshot record
+----

 
 This writes the snapshot files to the configured output. It is possible
 to use a custom, unregistered output at record time using the same
 
 This writes the snapshot files to the configured output. It is possible
 to use a custom, unregistered output at record time using the same


@@ -95,10 +96,10 @@ options supported by the `add-output` action.
 
 NOTE: Before taking a snapshot on a system with a high event throughput,
 it is recommended to first run `lttng stop` (see
 
 NOTE: Before taking a snapshot on a system with a high event throughput,
 it is recommended to first run `lttng stop` (see

-linklttng:lttng-stop(1)). Otherwise, the snapshot could contain "holes",
+man:lttng-stop(1)). Otherwise, the snapshot could contain "holes",

 the result of the tracers overwriting unconsumed trace packets during
 the record operation. After the snapshot is recorded, the tracers can be
 the result of the tracers overwriting unconsumed trace packets during
 the record operation. After the snapshot is recorded, the tracers can be

-started again with `lttng start` (see linklttng:lttng-start(1)).
+started again with `lttng start` (see man:lttng-start(1)).

 
 
 include::common-cmd-options-head.txt[]
 
 
 include::common-cmd-options-head.txt[]


@@ -106,7 +107,7 @@ include::common-cmd-options-head.txt[]
 
 Target
 ~~~~~~
 
 Target
 ~~~~~~

-option:-s, option:--session='SESSION'::
+option:-s 'SESSION', option:--session='SESSION'::

     Take a snapshot of the sub-buffers of the channels contained in
     the tracing session named 'SESSION' instead of the current
     tracing session.
     Take a snapshot of the sub-buffers of the channels contained in
     the tracing session named 'SESSION' instead of the current
     tracing session.


@@ -114,20 +115,20 @@ option:-s, option:--session='SESSION'::
 
 Snapshot output
 ~~~~~~~~~~~~~~~
 
 Snapshot output
 ~~~~~~~~~~~~~~~

-option:-C, option:--ctrl-url='URL'::
+option:-C 'URL', option:--ctrl-url='URL'::

     Set control path URL to 'URL' (must use option:--data-url option
     also).
 
     Set control path URL to 'URL' (must use option:--data-url option
     also).
 

-option:-D, option:--data-url='URL'::
+option:-D 'URL', option:--data-url='URL'::

     Set data path URL to 'URL' (must use option:--ctrl-url option
     also).
 
     Set data path URL to 'URL' (must use option:--ctrl-url option
     also).
 

-option:-m, option:--max-size='SIZE'::
+option:-m 'SIZE', option:--max-size='SIZE'::

     Limit the total size of all the snapshot files written when
     recording a snapshot to 'SIZE' bytes. The `k` (kiB), `M` (MiB),
     and `G` (GiB) suffixes are supported.
 
     Limit the total size of all the snapshot files written when
     recording a snapshot to 'SIZE' bytes. The `k` (kiB), `M` (MiB),
     and `G` (GiB) suffixes are supported.
 

-option:-n, option:--name='NAME'::
+option:-n 'NAME', option:--name='NAME'::

     Assign the name 'NAME' to the snapshot output.
 
 
     Assign the name 'NAME' to the snapshot output.
 
 


@@ -139,4 +140,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------

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