X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-rotation.1.txt;h=d719072e05aa395b2a335d4f2d269afb266f8d9c;hb=e971184584781f70bbbfc52bbede8b9abf0436e5;hp=c0b89ad078651ec177796bbd6b1f1e1792865d63;hpb=b471a013601dd021cd3d9b81aa02d048e223a132;p=lttng-tools.git diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index c0b89ad07..d719072e0 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: 14 June 2021 NAME ---- -lttng-disable-rotation - Unset a tracing session's rotation schedule +lttng-disable-rotation - Unset an LTTng recording 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 recording session named 'SESSION'. -include::common-cmd-options-head.txt[] +Without the option:--session option:: + The current recording session (see man:lttng-concepts(7) to learn + more about the current recording session). + +See man:lttng-concepts(7) to learn more about the recording 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,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' - instead of the current tracing session. + Unset a rotation schedule for the recording session named 'SESSION' + instead of the current recording session. + + +include::common-lttng-cmd-help-options.txt[] + + +include::common-lttng-cmd-after-options.txt[] -include::common-cmd-help-options.txt[] +[[examples]] +EXAMPLES +-------- +.Unset the size-based rotation schedule of the current recording session. +==== +See the option:--size option. + +[role="term"] +---- +$ lttng disable-rotation --size +---- +==== + +.Unset the periodic rotation schedule of a specific recording 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)