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

lttng-start(1)
==============
:revdate: 14 June 2021


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


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


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

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

Without the 'SESSION' argument::
    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 must be inactive (stopped). A recording
session is inactive on creation (see man:lttng-create(1)).

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

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

Stop an active recording 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 recording session.
====
[role="term"]
----
$ lttng start
----
====

.Start a specific recording 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)
Commit	Line	Data
	1	lttng-start(1)
	2	==============
	3	:revdate: 14 June 2021
	4
	5
	6	NAME
	7	----
	8	lttng-start - Start an LTTng recording session
	9
	10
	11	SYNOPSIS
	12	--------
	13	[verse]
	14	lttng ['linkgenoptions:(GENERAL OPTIONS)'] start ['SESSION']
	15
	16
	17	DESCRIPTION
	18	-----------
	19	The `lttng start` command starts a recording session, that is, it
	20	activates the LTTng tracers for:
	21
	22	With the 'SESSION' argument::
	23	The recording session named 'SESSION'.
	24
	25	Without the 'SESSION' argument::
	26	The current recording session (see man:lttng-concepts(7) to learn
	27	more about the current recording session).
	28
	29	See man:lttng-concepts(7) to learn more about recording sessions.
	30
	31	The selected recording session must be inactive (stopped). A recording
	32	session is inactive on creation (see man:lttng-create(1)).
	33
	34	A `start-session` trigger action can also start a recording session
	35	(see man:lttng-add-trigger(1)).
	36
	37	See the ``<<examples,EXAMPLES>>'' section below for usage examples.
	38
	39	Stop an active recording session with the man:lttng-stop(1) command.
	40
	41
	42	include::common-lttng-cmd-options-head.txt[]
	43
	44
	45	include::common-lttng-cmd-help-options.txt[]
	46
	47
	48	include::common-lttng-cmd-after-options.txt[]
	49
	50
	51	[[examples]]
	52	EXAMPLES
	53	--------
	54	.Start the current recording session.
	55	====
	56	[role="term"]
	57	----
	58	$ lttng start
	59	----
	60	====
	61
	62	.Start a specific recording session.
	63	====
	64	[role="term"]
	65	----
	66	$ lttng start my-session
	67	----
	68	====
	69
	70
	71	include::common-footer.txt[]
	72
	73
	74	SEE ALSO
	75	--------
	76	man:lttng(1),
	77	man:lttng-add-trigger(1),
	78	man:lttng-create(1),
	79	man:lttng-enable-event(1),
	80	man:lttng-stop(1),
	81	man:lttng-concepts(7)