doc/man: add links between man pages about session rotation

[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 816473a555ed8f1059badeba0355b3c9deaa42c3..9d5b313a8e4ac230fea1a8da15437be530eba1ef 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -45,13 +45,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
 ~~~~~~~~~~~~~~~~
@@ -86,9 +92,9 @@ Taking a snapshot
 Taking a snapshot of the current tracing session is as easy as:
 
 [role="term"]
----------------------
-lttng snapshot record
----------------------
+----
+$ 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