From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Mon, 17 May 2021 19:49:59 +0000 (-0400)
Subject: lttng-save(1): add usage examples
X-Git-Tag: v2.13.0-rc3~101
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=6d234d4e218a6eae32a1bbd463a6fcbb549337e3;p=lttng-tools.git

lttng-save(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: I73d4cd169c37d0dbb99ad965d04acc9eaf8a1856
---

diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt
index ae2b9424a..b9c334592 100644
--- a/doc/man/lttng-save.1.txt
+++ b/doc/man/lttng-save.1.txt
@@ -1,6 +1,6 @@
 lttng-save(1)
 =============
-:revdate: 12 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -51,6 +51,8 @@ session configuration files: the command fails. Allow the `save` command
 to overwrite existing tracing session configuration files with the
 option:--force option.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -77,6 +79,38 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Save all the tracing session configurations to the default output directory.
+====
+[role="term"]
+----
+$ lttng save
+----
+====
+
+.Save a specific tracing session configuration to a specific output directory.
+====
+See the option:--output-path option.
+
+[role="term"]
+----
+$ lttng save my-session --output-path=/path/to/sessions
+----
+====
+
+.Allow LTTng to overwrite existing tracing session configuration files when saving.
+====
+See the option:--force option.
+
+[role="term"]
+----
+$ lttng save --force
+----
+====
+
+
 include::common-footer.txt[]