// SPDX-FileCopyrightText: 2015-2025 Philippe Proulx <pproulx@efficios.com>
//
// SPDX-License-Identifier: CC-BY-SA-4.0

lttng-stop(1)
=============
:revdate: 1 April 2025


NAME
----
lttng-stop - Stop one or more LTTng recording sessions


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *stop* [option:--no-wait]
      [option:--all | option:--glob='PATTERN' | 'SESSION']


DESCRIPTION
-----------
The `lttng stop` command stops one or more recording sessions, that is,
it deactivates the LTTng tracers for:

With the 'SESSION' argument::
    The recording session named 'SESSION'.

With the option:--glob='PATTERN' option::
    The recording sessions of which the globbing pattern
    'PATTERN' matches the name.

With the option:--all option::
    *All* the recording sessions of the connected session daemon for
    your Unix user, or for all users if your Unix user is `root`, as
    listed in the output of `lttng list` (see man:lttng-list(1)).
+
See the ``Session daemon connection'' section of man:lttng(1) to learn
how a user application connects to a session daemon.

Otherwise::
    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 recording sessions.

The selected recording session(s) must be active (started; see
man:lttng-start(1)). A recording session is inactive on creation (see
man:lttng-create(1)).

A `stop-session` trigger action can also stop a recording session (see
man:lttng-add-trigger(1)).

Start one or more inactive recording sessions with the
man:lttng-start(1) command.

By default, the `stop` command ensures that the trace data of the
selected recording session(s) is valid before it exits. Make the command
exit immediately with the option:--no-wait option. In this case,
however, the traces(s) might not be valid when the command exits, and
there's no way to know when it/they becomes valid.

See the ``<<examples,EXAMPLES>>'' section below for usage examples.


include::common-lttng-cmd-options-head.txt[]


option:-a, option:--all::
    Stop all the recording sessions of your Unix user, or of all
    users if your Unix user is `root`, as listed in the output of
    man:lttng-list(1).

option:-g 'PATTERN', option:--glob='PATTERN'::
    Stop the recording sessions of which the
    globbing pattern 'PATTERN' matches the name.
+
In 'PATTERN', the `*` character means ``match anything''. To match
a literal `*` character, use :escwc:.

option:-n, option:--no-wait::
    Do :not: ensure that the trace data of the selected recording
    session(s) is valid before exiting.


include::common-lttng-cmd-help-options.txt[]


include::common-lttng-cmd-after-options.txt[]


[[examples]]
EXAMPLES
--------
.Stop the current recording session.
====
[role="term"]
----
$ lttng stop
----
====

.Stop a specific recording session.
====
[role="term"]
----
$ lttng stop my-session
----
====

.Stop the current recording session without waiting for completion.
====
See the option:--no-wait option.

[role="term"]
----
$ lttng stop --no-wait
----
====

.Stop all the recording sessions.
====
See the option:--all option.

[role="term"]
----
$ lttng stop --all
----
====

.Stop all the recording sessions of which the name starts with `bar`.
====
See the option:--glob option.

[role="term"]
----
$ lttng stop --glob='bar*'
----
====


include::common-footer.txt[]


SEE ALSO
--------
man:lttng(1),
man:lttng-add-trigger(1),
man:lttng-create(1),
man:lttng-enable-event(1),
man:lttng-rotate(1),
man:lttng-start(1),
man:lttng-concepts(7)
