lttng-disable-rotation(1): add usage examples
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Mon, 17 May 2021 18:09:54 +0000 (14:09 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Wed, 19 May 2021 15:22:43 +0000 (11:22 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I24f132858c12fa4e99b8a24baee9e8becf0d73f8

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

index 8b68ded7a324589084972b1930aa40ec88ee3bb5..c28d699d215545d23544e848875acdf347734443 100644 (file)
@@ -1,6 +1,6 @@
 lttng-disable-rotation(1)
 =========================
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -30,6 +30,8 @@ Without the option:--session option::
 See man:lttng-concepts(7) to learn more about the tracing session
 rotation and trace chunk concepts.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
+
 
 include::common-lttng-cmd-options-head.txt[]
 
@@ -58,6 +60,30 @@ include::common-lttng-cmd-help-options.txt[]
 include::common-lttng-cmd-after-options.txt[]
 
 
+[[examples]]
+EXAMPLES
+--------
+.Unset the size-based rotation schedule of the current tracing session.
+====
+See the option:--size option.
+
+[role="term"]
+----
+$ lttng disable-rotation --size
+----
+====
+
+.Unset 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
+----
+====
+
+
 include::common-footer.txt[]
 
 
This page took 0.02863 seconds and 4 git commands to generate.