X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=doc%2Fman%2Flttng-disable-rotation.1.txt;h=d719072e05aa395b2a335d4f2d269afb266f8d9c;hb=refs%2Fheads%2Fsow-2021-0002-rev1;hp=8b68ded7a324589084972b1930aa40ec88ee3bb5;hpb=55e0699466ecc7e7a52b3ca54a806f2faf9bb59e;p=lttng-tools.git diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt index 8b68ded7a..d719072e0 100644 --- a/doc/man/lttng-disable-rotation.1.txt +++ b/doc/man/lttng-disable-rotation.1.txt @@ -1,11 +1,11 @@ lttng-disable-rotation(1) ========================= -:revdate: 30 April 2021 +:revdate: 14 June 2021 NAME ---- -lttng-disable-rotation - Unset an LTTng tracing session rotation schedule +lttng-disable-rotation - Unset an LTTng recording session rotation schedule SYNOPSIS @@ -21,15 +21,17 @@ 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'. + The recording session named 'SESSION'. Without the option:--session option:: - The current tracing session (see man:lttng-concepts(7) to learn more - about the current tracing session). + 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 tracing 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[] @@ -48,8 +50,8 @@ option:--timer:: Recording target ~~~~~~~~~~~~~~~~ option:-s 'SESSION', option:--session='SESSION':: - Unset a rotation schedule for 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[] @@ -58,6 +60,30 @@ 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 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-footer.txt[]