lttng-enable-rotation(1): add usage examples
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 17 May 2021 18:12:16 +0000 (14:12 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 27 May 2021 21:31:35 +0000 (17:31 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I56eafd9e52cd37f48849ddfb82d007c9fb3f3767

doc/man/lttng-enable-rotation.1.txt

index e9571ca5be4d9f7e20afcf9908063bdc442ed339..2071848e184c8e0acd894bc15fe1f903bfc91c8a 100644 (file)
@@ -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.
 
@@ -114,6 +116,30 @@ 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-footer.txt[]
 
 
This page took 0.028093 seconds and 4 git commands to generate.