X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=doc%2Fman%2Flttng-snapshot.1.txt;h=d60d6fcef0aaba6e24885dc546225b031fb6e5e8;hp=a749e1c02e99629945da9a76631459e1a65fd0f1;hb=b61776fb63d4bb14df77c0b5a15de28beed7ddfc;hpb=59b19c3c82a824b602b4e3cd70e1cb22448fcb9d diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt index a749e1c02..d60d6fcef 100644 --- 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