[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* [option::--all | option::--glob 'SESSION' | '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[]

option:-a, option:--all::
    Start all sessions.

option:-g, option:--glob::
    Interpret SESSION as a globbing pattern.

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
----
====

.Start all sessions.
====
See the option::--all option.

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

.Start all sessions with the suffix foo.
====
See the option::--glob option.

[role="term"]
----
$ lttng start --glob '*foo'
----
====


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 [option::--all \| option::--glob 'SESSION' \| '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	option:-a, option:--all::
	48	Start all sessions.
	49
	50	option:-g, option:--glob::
	51	Interpret SESSION as a globbing pattern.
	52
	53	include::common-lttng-cmd-after-options.txt[]
	54
	55
	56	[[examples]]
	57	EXAMPLES
	58	--------
	59	.Start the current recording session.
	60	====
	61	[role="term"]
	62	----
	63	$ lttng start
	64	----
	65	====
	66
	67	.Start a specific recording session.
	68	====
	69	[role="term"]
	70	----
	71	$ lttng start my-session
	72	----
	73	====
	74
	75	.Start all sessions.
	76	====
	77	See the option::--all option.
	78
	79	[role="term"]
	80	----
	81	$ lttng start --all
	82	----
	83	====
	84
	85	.Start all sessions with the suffix foo.
	86	====
	87	See the option::--glob option.
	88
	89	[role="term"]
	90	----
	91	$ lttng start --glob '*foo'
	92	----
	93	====
	94
	95
	96	include::common-footer.txt[]
	97
	98
	99	SEE ALSO
	100	--------
	101	man:lttng(1),
	102	man:lttng-add-trigger(1),
	103	man:lttng-create(1),
	104	man:lttng-enable-event(1),
	105	man:lttng-stop(1),
	106	man:lttng-concepts(7)