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

   1 lttng-disable-rotation(1)
   2 =========================
   3 :revdate: 14 June 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-disable-rotation - Unset an LTTng recording session rotation schedule
   9
  10
  11 SYNOPSIS
  12 --------
  13 [verse]
  14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* [option:--session='SESSION']
  15       (option:--timer | option:--size | option:--timer option:--size)
  16
  17
  18 DESCRIPTION
  19 -----------
  20 The `lttng disable-rotation` command unsets a rotation schedule,
  21 previously set with the man:lttng-enable-rotation(1) command, for:
  22
  23 With the option:--session='SESSION' option::
  24     The recording session named 'SESSION'.
  25
  26 Without the option:--session option::
  27     The current recording session (see man:lttng-concepts(7) to learn
  28     more about the current recording session).
  29
  30 See man:lttng-concepts(7) to learn more about the recording session
  31 rotation and trace chunk concepts.
  32
  33 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
  34
  35
  36 include::common-lttng-cmd-options-head.txt[]
  37
  38
  39 Rotation schedule condition
  40 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  41 option:--size::
  42     Unset the rotation schedule previously set with the nloption:--size
  43     option of the man:lttng-enable-rotation(1) command.
  44
  45 option:--timer::
  46     Unset the rotation schedule previously set with the nloption:--timer
  47     option of the man:lttng-enable-rotation(1) command.
  48
  49
  50 Recording target
  51 ~~~~~~~~~~~~~~~~
  52 option:-s 'SESSION', option:--session='SESSION'::
  53     Unset a rotation schedule for the recording session named 'SESSION'
  54     instead of the current recording session.
  55
  56
  57 include::common-lttng-cmd-help-options.txt[]
  58
  59
  60 include::common-lttng-cmd-after-options.txt[]
  61
  62
  63 [[examples]]
  64 EXAMPLES
  65 --------
  66 .Unset the size-based rotation schedule of the current recording session.
  67 ====
  68 See the option:--size option.
  69
  70 [role="term"]
  71 ----
  72 $ lttng disable-rotation --size
  73 ----
  74 ====
  75
  76 .Unset the periodic rotation schedule of a specific recording session.
  77 ====
  78 See the option:--timer and option:--session options.
  79
  80 [role="term"]
  81 ----
  82 $ lttng disable-rotation --session=my-session --timer
  83 ----
  84 ====
  85
  86
  87 include::common-footer.txt[]
  88
  89
  90 SEE ALSO
  91 --------
  92 man:lttng(1),
  93 man:lttng-enable-rotation(1),
  94 man:lttng-rotate(1),
  95 man:lttng-concepts(7)