doc/man: lttng(1) command pages: always include `common-footer.txt`
[lttng-tools.git] / doc / man / lttng-disable-rotation.1.txt
index c0b89ad078651ec177796bbd6b1f1e1792865d63..8b68ded7a324589084972b1930aa40ec88ee3bb5 100644 (file)
@@ -1,33 +1,41 @@
 lttng-disable-rotation(1)
 =========================
+:revdate: 30 April 2021
 
 
 NAME
 ----
-lttng-disable-rotation - Unset a tracing session's rotation schedule
+lttng-disable-rotation - Unset an LTTng tracing session rotation schedule
 
 
 SYNOPSIS
 --------
 [verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* (option:--timer | option:--size)
-      [option:--session='SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* [option:--session='SESSION']
+      (option:--timer | option:--size | option:--timer option:--size)
 
 
 DESCRIPTION
 -----------
-The `lttng disable-rotation` command unsets a rotation schedule for the
-current tracing session, or for the tracing session named 'SESSION' if
-provided, previously set with the man:lttng-enable-rotation(1) command.
+The `lttng disable-rotation` command unsets a rotation schedule,
+previously set with the man:lttng-enable-rotation(1) command, for:
 
+With the option:--session='SESSION' option::
+    The tracing session named 'SESSION'.
 
-include::common-cmd-options-head.txt[]
+Without the option:--session option::
+    The current tracing session (see man:lttng-concepts(7) to learn more
+    about the current tracing session).
+
+See man:lttng-concepts(7) to learn more about the tracing session
+rotation and trace chunk concepts.
+
+
+include::common-lttng-cmd-options-head.txt[]
 
 
 Rotation schedule condition
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-One of:
-
 option:--size::
     Unset the rotation schedule previously set with the nloption:--size
     option of the man:lttng-enable-rotation(1) command.
@@ -37,20 +45,25 @@ option:--timer::
     option of the man:lttng-enable-rotation(1) command.
 
 
-Target
-~~~~~~
+Recording target
+~~~~~~~~~~~~~~~~
 option:-s 'SESSION', option:--session='SESSION'::
-    Unset a rotation schedule in the tracing session named 'SESSION'
+    Unset a rotation schedule for the tracing session named '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[]
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
+man:lttng(1),
 man:lttng-enable-rotation(1),
-man:lttng(1)
+man:lttng-rotate(1),
+man:lttng-concepts(7)
This page took 0.024135 seconds and 4 git commands to generate.