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