sessiond: notification: add support for async commands

[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 e4a02033a99394008c11bb4a339a5860e77c96d2..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
@@ -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 man: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
 ~~~~~~~~~~~~~~~~
@@ -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
@@ -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.