From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 20:01:05 +0000 (-0400)
Subject: lttng-snapshot(1): add usage examples
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f0197e11ff416d52799a8c83810e244b6efb100a;p=lttng-tools.git

lttng-snapshot(1): add usage examples

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I686f3c8a0e82952a5b673780eef830dea888044d
---

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index a65156f9c..b81adbc9d 100644
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -1,6 +1,6 @@
 lttng-snapshot(1)
 =================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -69,6 +69,8 @@ to use the `snapshot` command.
 A `snapshot-session` trigger action can also take a tracing session
 snapshot (see man:lttng-add-trigger(1)).
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 If you want, instead, to keep all the trace data, but divide it into
 archived chunks which are then, like snapshots, ready to be processed,
 see the tracing session rotation feature in man:lttng-concepts(7). Trace
@@ -190,6 +192,62 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Take a snapshot of the current tracing session, sending the trace files to its snapshot output.
+====
+[role="term"]
+----
+$ lttng snapshot record
+----
+====
+
+.Take a snapshot of a specific tracing session, giving it a custom name.
+====
+See the option:--session and option:--name options.
+
+[role="term"]
+----
+$ lttng snapshot record --session=my-session --name=SNAP
+----
+====
+
+.Take a snapshot of the current tracing session, sending the trace files to a custom location.
+====
+See the ``Output directory'' section of man:lttng-relayd(8) to
+understand where the relay daemon to connect to (`3.96.87.215`) writes
+the received traces.
+
+[role="term"]
+----
+$ lttng snapshot record net://3.96.87.215
+----
+====
+
+.Replace the snapshot output of a specific tracing session with a local file system path.
+====
+See the option:--session option.
+
+[role="term"]
+----
+$ lttng snapshot del-output --session=monk 1
+$ lttng snapshot add-output --session=monk \
+                 file:///path/to/snapshots
+----
+====
+
+.Take a snapshot of the current tracing session, making sure its size is not over 4{nbsp}MiB.
+====
+See the option:--max-size option.
+
+[role="term"]
+----
+$ lttng snapshot record --max-size=4M
+----
+====
+
+
 include::common-footer.txt[]