lttng-start(1): add usage examples

[lttng-tools.git] / doc / man / lttng-start.1.txt

lttng-start(1)
==============
:revdate: 17 May 2021


NAME
----
lttng-start - Start an LTTng tracing session


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *start* ['SESSION']


DESCRIPTION
-----------
The `lttng start` command starts a tracing session, that is, it
activates the LTTng tracers for:

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

Without the 'SESSION' argument::
    The current tracing session (see man:lttng-concepts(7) to learn more
    about the current tracing session).

See man:lttng-concepts(7) to learn more about tracing sessions.

The selected tracing session must be inactive (stopped). A tracing
session is inactive on creation (see man:lttng-create(1)).

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

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

Stop an active tracing session with the man:lttng-stop(1) command.


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


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


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


[[examples]]
EXAMPLES
--------
.Start the current tracing session.
====
[role="term"]
----
$ lttng start
----
====

.Start a specific tracing session.
====
[role="term"]
----
$ lttng start my-session
----
====


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-stop(1),
man:lttng-concepts(7)