doc: lttng-stop(1): replace tabs with spaces
[lttng-tools.git] / doc / man / lttng-stop.1.txt
CommitLineData
fb58d659
PP
1lttng-stop(1)
2=============
3
4
5NAME
6----
7lttng-stop - Stop LTTng tracers
8
9
10SYNOPSIS
11--------
12[verse]
ce19b9ed 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait] ['SESSION']
fb58d659
PP
14
15
16DESCRIPTION
17-----------
18The `lttng stop` command stops the various LTTng tracers for a given
19active tracing session.
20
5de63f6d 21Stopping the LTTng tracers has the effect that all enabled event rules
fb58d659
PP
22within enabled channels cannot make event sources _emit_ trace events
23anymore.
24
25A tracing session with no running tracers is said to be _inactive_.
26Inactive tracing sessions can be set active using the
7c1a4458 27man:lttng-start(1) command.
fb58d659
PP
28
29If 'SESSION' is omitted, the LTTng tracers are stopped for the current
7c1a4458 30tracing session (see man:lttng-create(1) for more information
fb58d659
PP
31about the current tracing session). Otherwise, they are stopped for the
32existing tracing session named 'SESSION'. `lttng list`
7c1a4458 33outputs all the existing tracing sessions (see man:lttng-list(1)).
fb58d659
PP
34
35By default, the `lttng stop` command ensures that the tracing session's
36trace data is valid before returning to the prompt. With the
37option:--no-wait option, the command finishes immediately, hence a local
38trace might not be valid when the command is done. In this case, there
39is no way to know when the trace becomes valid.
40
41
42include::common-cmd-options-head.txt[]
43
44
45option:-n, option:--no-wait::
5dd0d9a5
PP
46 Do not ensure that the chosen tracing session's trace data is valid
47 before returning to the prompt.
fb58d659
PP
48
49
50include::common-cmd-help-options.txt[]
51
52
53include::common-cmd-footer.txt[]
54
55
56SEE ALSO
57--------
7c1a4458
PP
58man:lttng-start(1),
59man:lttng(1)
This page took 0.035741 seconds and 4 git commands to generate.