lttng-enable-rotation(1): add usage examples

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

diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt
index d8ec88e75e4f28469a0201e35ace732f5d73d732..2071848e184c8e0acd894bc15fe1f903bfc91c8a 100644 (file)
--- a/doc/man/lttng-enable-rotation.1.txt
+++ b/doc/man/lttng-enable-rotation.1.txt
@@ -1,6 +1,6 @@
 lttng-enable-rotation(1)
 ========================
-:revdate: 3 May 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -60,6 +60,8 @@ You may combine the option:--timer and option:--size options.
 See the man:lttng-concepts(7) to learn how LTTng names a trace chunk
 archive directory.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 Unset a tracing session rotation schedule with the
 man:lttng-disable-rotation(1) command.
 
@@ -80,7 +82,7 @@ when it's not currently performing a rotation.
 ====
 
 
-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]
 
 
 Rotation schedule condition
@@ -108,16 +110,43 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Set the size-based rotation schedule of the current tracing session.
+====
+See the option:--size option.
+
+[role="term"]
+----
+$ lttng disable-rotation --size=256M
+----
+====
+
+.Set the periodic rotation schedule of a specific tracing session.
+====
+See the option:--timer and option:--session options.
+
+[role="term"]
+----
+$ lttng disable-rotation --session=my-session --timer=5m
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
 man:lttng-create(1),
 man:lttng-disable-rotation(1),
-man:lttng-rotate(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)