doc/man: update rotation man pages to follow API's terminology
[lttng-tools.git] / doc / man / lttng-disable-rotation.1.txt
CommitLineData
980bb5fd
PP
1lttng-disable-rotation(1)
2=========================
3
4
5NAME
6----
31099add 7lttng-disable-rotation - Unset a tracing session's rotation schedule
980bb5fd
PP
8
9
10SYNOPSIS
11--------
12[verse]
13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *disable-rotation* (option:--timer | option:--size)
14 [option:--session='SESSION']
15
16
17DESCRIPTION
18-----------
31099add
PP
19The `lttng disable-rotation` command unsets a rotation schedule for the
20current tracing session, or for the tracing session named 'SESSION' if
21provided, previously set with the man:lttng-enable-rotation(1) command.
980bb5fd
PP
22
23
24include::common-cmd-options-head.txt[]
25
26
31099add
PP
27Rotation schedule condition
28~~~~~~~~~~~~~~~~~~~~~~~~~~~
980bb5fd
PP
29One of:
30
31option:--size::
31099add
PP
32 Unset the rotation schedule previously set with the nloption:--size
33 option of the man:lttng-enable-rotation(1) command.
980bb5fd
PP
34
35option:--timer::
31099add
PP
36 Unset the rotation schedule previously set with the nloption:--timer
37 option of the man:lttng-enable-rotation(1) command.
980bb5fd
PP
38
39
40Target
41~~~~~~
42option:-s 'SESSION', option:--session='SESSION'::
31099add
PP
43 Unset a rotation schedule in the tracing session named 'SESSION'
44 instead of the current tracing session.
980bb5fd
PP
45
46
47include::common-cmd-help-options.txt[]
48
49
50[[limitations]]
51LIMITATIONS
52-----------
53The `lttng enable-rotation` command only works when:
54
55* The tracing session is created in normal mode or in network streaming
56 mode (see man:lttng-create(1)).
57
58* No channel was created with a configured trace file count or size
59 limit (see the nloption:--tracefile-size and
60 nloption:--tracefile-count options in man:lttng-enable-channel(1)).
61
62For a given tracing session, LTTng only performs an automatic rotation
63when no other rotation is currently happening.
64
65
66include::common-cmd-footer.txt[]
67
68
69SEE ALSO
70--------
71man:lttng-enable-rotation(1),
72man:lttng(1)
This page took 0.025075 seconds and 4 git commands to generate.