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

lttng-save(1)
=============


NAME
----
lttng-save - Save LTTng tracing session configurations


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='PATH'] ['SESSION']


DESCRIPTION
-----------
The `lttng save` command saves the configurations of one or more
tracing sessions to files.

The `lttng save` command is used in conjunction with the
man:lttng-load(1) command to save and restore the complete
configurations of tracing sessions. This includes the enabled channels
and event rules, the context added to channels, the tracing activity,
and more. `lttng save` does not save tracing data, only the tracing
session parameters.

If 'SESSION' is omitted, all the existing tracing session configurations
are saved (equivalent to using the option:--all option). Otherwise,
'SESSION' is the name of an existing tracing session. `lttng list`
outputs all the existing tracing sessions (see man:lttng-list(1)).

The default output directory path is `$LTTNG_HOME/.lttng/sessions`
(`$LTTNG_HOME` defaults to `$HOME`). Each tracing session configuration
file is named `SESSION.lttng`, where `SESSION` is the original tracing
session name. The default output directory path can be overridden with
the option:--output-path option.

By default, existing tracing session configuration files are not
overwritten when saving; the command fails. The option:--force option
can be used to allow this.


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


option:-a, option:--all::
    Save all tracing session configurations (default).

option:-f, option:--force::
    Overwrite existing tracing session configuration files when
    saving.

option:-o 'PATH', option:--output-path='PATH'::
    Set output directory path to 'PATH'.


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


include::common-cmd-footer.txt[]


SEE ALSO
--------
man:lttng-load(1),
man:lttng(1)
Commit	Line	Data
	1	lttng-save(1)
	2	=============
	3
	4
	5	NAME
	6	----
	7	lttng-save - Save LTTng tracing session configurations
	8
	9
	10	SYNOPSIS
	11	--------
	12	[verse]
	13	lttng ['linkgenoptions:(GENERAL OPTIONS)'] save [option:--force] [option:--output-path='PATH'] ['SESSION']
	14
	15
	16	DESCRIPTION
	17	-----------
	18	The `lttng save` command saves the configurations of one or more
	19	tracing sessions to files.
	20
	21	The `lttng save` command is used in conjunction with the
	22	man:lttng-load(1) command to save and restore the complete
	23	configurations of tracing sessions. This includes the enabled channels
	24	and event rules, the context added to channels, the tracing activity,
	25	and more. `lttng save` does not save tracing data, only the tracing
	26	session parameters.
	27
	28	If 'SESSION' is omitted, all the existing tracing session configurations
	29	are saved (equivalent to using the option:--all option). Otherwise,
	30	'SESSION' is the name of an existing tracing session. `lttng list`
	31	outputs all the existing tracing sessions (see man:lttng-list(1)).
	32
	33	The default output directory path is `$LTTNG_HOME/.lttng/sessions`
	34	(`$LTTNG_HOME` defaults to `$HOME`). Each tracing session configuration
	35	file is named `SESSION.lttng`, where `SESSION` is the original tracing
	36	session name. The default output directory path can be overridden with
	37	the option:--output-path option.
	38
	39	By default, existing tracing session configuration files are not
	40	overwritten when saving; the command fails. The option:--force option
	41	can be used to allow this.
	42
	43
	44	include::common-cmd-options-head.txt[]
	45
	46
	47	option:-a, option:--all::
	48	Save all tracing session configurations (default).
	49
	50	option:-f, option:--force::
	51	Overwrite existing tracing session configuration files when
	52	saving.
	53
	54	option:-o 'PATH', option:--output-path='PATH'::
	55	Set output directory path to 'PATH'.
	56
	57
	58	include::common-cmd-help-options.txt[]
	59
	60
	61	include::common-cmd-footer.txt[]
	62
	63
	64	SEE ALSO
	65	--------
	66	man:lttng-load(1),
	67	man:lttng(1)