lttng-rotate(1): add usage examples

[lttng-tools.git] / doc / man / lttng-rotate.1.txt

diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt
index 29ff3a0d7dc06b0796e5632500f16f3068647c11..2a73f8bcfa685d858fd5574faebb1dd16b650acd 100644 (file)
--- a/doc/man/lttng-rotate.1.txt
+++ b/doc/man/lttng-rotate.1.txt
@@ -1,6 +1,6 @@
 lttng-rotate(1)
 ===============
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -62,6 +62,8 @@ directly cause discarded event records or packets.
 A `rotate-session` trigger action can also rotate a tracing session (see
 man:lttng-add-trigger(1)).
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 [IMPORTANT]
 ====
 You may only use the `rotate` command when:
@@ -93,6 +95,36 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Rotate the current tracing session.
+====
+[role="term"]
+----
+$ lttng rotate
+----
+====
+
+.Rotate a specific tracing session.
+====
+[role="term"]
+----
+$ lttng rotate my-session
+----
+====
+
+.Rotate the current tracing session without waiting for completion.
+====
+See the option:--no-wait option.
+
+[role="term"]
+----
+$ lttng rotate --no-wait
+----
+====
+
+
 include::common-footer.txt[]