X-Git-Url: http://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-rotation.1.txt;h=c28d699d215545d23544e848875acdf347734443;hb=80950c2ceefe543d324833a7fc045ec94494ded6;hp=d69975ff703e1129a60e1bdd63eaff3b29c642a7;hpb=31099add7a58b2a671f9324aa023a4dc5ae000f1;p=lttng-tools.git diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index d69975ff7..c28d699d2 100644 --- a/doc/man/lttng-disable-rotation.1.txt +++ b/doc/man/lttng-disable-rotation.1.txt @@ -1,33 +1,43 @@ lttng-disable-rotation(1) ========================= +:revdate: 17 May 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. + +See the <> section below for usage examples. + + +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,36 +47,49 @@ 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[] -[[limitations]] -LIMITATIONS ------------ -The `lttng enable-rotation` command only works when: +include::common-lttng-cmd-after-options.txt[] -* The tracing session is created in normal mode or in network streaming - mode (see man:lttng-create(1)). -* No channel was created with a configured trace file count or size - limit (see the nloption:--tracefile-size and - nloption:--tracefile-count options in man:lttng-enable-channel(1)). +[[examples]] +EXAMPLES +-------- +.Unset the size-based rotation schedule of the current tracing session. +==== +See the option:--size option. -For a given tracing session, LTTng only performs an automatic rotation -when no other rotation is currently happening. +[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-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)