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