lttng: Add remove-trigger command

[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 2d2b6c68fd5d5167c2b00a8485c12f0dd8769de0..d60d6fcef0aaba6e24885dc546225b031fb6e5e8 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -1,5 +1,6 @@
 lttng-snapshot(1)
 =================
+:revdate: 9 November 2018
 
 
 NAME
@@ -12,25 +13,25 @@ SYNOPSIS
 Add a snapshot output:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *snapshot add-output* [option:--max-size='SIZE']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot add-output* [option:--max-size='SIZE']
       [option:--name='NAME'] [option:--session='SESSION']
       (option:--ctrl-url='URL' option:--data-url='URL' | 'URL')
 
 Remove a snapshot output:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *snapshot del-output* [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot del-output* [option:--session='SESSION']
       ('ID' | 'NAME')
 
 List current snapshot outputs:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *snapshot list-output* [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot list-output* [option:--session='SESSION']
 
 Take a snapshot:
 
 [verse]
-*lttng* ['GENERAL OPTIONS'] *snapshot record* [option:--max-size='SIZE']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *snapshot record* [option:--max-size='SIZE']
       [option:--name='NAME'] [option:--session='SESSION']
       (option:--ctrl-url='URL' option:--data-url='URL' | 'URL')
 
@@ -45,13 +46,19 @@ of a given tracing session. When a snapshot is taken, the memory dump
 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
-time using the linklttng:lttng-create(1) command.
+that taking snapshots is allowed. This is done at tracing session
+creation time using the man:lttng-create(1) command's
+nloption:--snapshot option.
 
 Note that, when a snapshot is taken, the sub-buffers are not cleared.
 This means that different recorded snapshots may contain the same
 events.
 
+If you want, instead, to keep all the trace data, but divide it into
+archived chunks which are then free to process (just like snapshots),
+see the lttng-rotate(1) and lttng-enable-rotation(1) commands. Trace
+chunk archives do not overlap like snapshots can.
+
 
 Snapshot outputs
 ~~~~~~~~~~~~~~~~
@@ -63,7 +70,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.
-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
@@ -85,9 +92,10 @@ Taking a snapshot
 ~~~~~~~~~~~~~~~~~
 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
@@ -95,10 +103,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
-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
-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[]
@@ -106,7 +114,7 @@ include::common-cmd-options-head.txt[]
 
 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.
@@ -114,20 +122,20 @@ option:-s, option:--session='SESSION'::
 
 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).
 
-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).
 
-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.
 
-option:-n, option:--name='NAME'::
+option:-n 'NAME', option:--name='NAME'::
     Assign the name 'NAME' to the snapshot output.
 
 
@@ -139,4 +147,4 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
-linklttng:lttng(1)
+man:lttng(1)