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