X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-rotation.1.txt;h=b088c94f2a626b6b49bec614cb0b631449088bad;hb=da39b67ce2828bfc63a02db969048bfe1abd4ca0;hp=5c79abba3da4efb68f784c8c0e2339a9bc918467;hpb=eb027cfc9ad54c48c468f60fc34be14d804eb7a2;p=lttng-tools.git diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index 5c79abba3..b088c94f2 100644 --- a/doc/man/lttng-disable-rotation.1.txt +++ b/doc/man/lttng-disable-rotation.1.txt @@ -1,10 +1,11 @@ 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 @@ -16,12 +17,23 @@ SYNOPSIS 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 @@ -35,20 +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[] + + +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-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)