Commit | Line | Data |
---|---|---|
b3903b3a PP |
1 | lttng-save(1) |
2 | ============= | |
42a43108 | 3 | :revdate: 12 May 2021 |
b3903b3a PP |
4 | |
5 | ||
6 | NAME | |
7 | ---- | |
8 | lttng-save - Save LTTng tracing session configurations | |
9 | ||
10 | ||
11 | SYNOPSIS | |
12 | -------- | |
13 | [verse] | |
42a43108 PP |
14 | *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='DIR'] |
15 | [option:--all | 'SESSION'] | |
b3903b3a PP |
16 | |
17 | ||
18 | DESCRIPTION | |
19 | ----------- | |
26f0c779 | 20 | The `lttng save` command saves to files the configurations of: |
b3903b3a | 21 | |
26f0c779 PP |
22 | With the 'SESSION' argument:: |
23 | The tracing session named 'SESSION'. | |
b3903b3a | 24 | |
26f0c779 | 25 | Without the 'SESSION' argument:: |
42a43108 PP |
26 | Implicit option:--all option: *all* the tracing sessions of the |
27 | connected session daemon for your Unix user, or for all users if | |
28 | your Unix user is `root`, as listed in the output of `lttng list` | |
29 | (see man:lttng-list(1)). | |
26f0c779 PP |
30 | + |
31 | See the ``Session daemon connection'' section of man:lttng(1) to learn | |
32 | how a user application connects to a session daemon. | |
33 | ||
34 | See man:lttng-concepts(7) to learn more about tracing sessions. | |
35 | ||
36 | Use the `save` command in conjunction with the man:lttng-load(1) command | |
37 | to save and restore the complete configurations of tracing sessions. | |
38 | ||
39 | The `save` command does :not: save tracing data, only the tracing | |
40 | session parameters, including the channel and recording event rule | |
41 | configurations. | |
b3903b3a PP |
42 | |
43 | The default output directory path is `$LTTNG_HOME/.lttng/sessions` | |
26f0c779 PP |
44 | (`$LTTNG_HOME` defaults to `$HOME`). Override the default output |
45 | directory path with the option:--output-path option. Each tracing | |
46 | session configuration file is named __SNAME__++.lttng++, | |
47 | where{nbsp}__SNAME__ is the original tracing session name. | |
b3903b3a | 48 | |
26f0c779 PP |
49 | By default, the `save` command does :not: overwrite existing tracing |
50 | session configuration files: the command fails. Allow the `save` command | |
51 | to overwrite existing tracing session configuration files with the | |
52 | option:--force option. | |
b3903b3a PP |
53 | |
54 | ||
f5511eea | 55 | include::common-lttng-cmd-options-head.txt[] |
b3903b3a PP |
56 | |
57 | ||
58 | option:-a, option:--all:: | |
26f0c779 PP |
59 | Save all the tracing session configurations of your Unix user, or of |
60 | all users if your Unix user is `root`, as listed in the output of | |
61 | man:lttng-list(1), instead of the current tracing session or the | |
62 | tracing session named 'SESSION'. | |
b3903b3a PP |
63 | |
64 | option:-f, option:--force:: | |
65 | Overwrite existing tracing session configuration files when | |
66 | saving. | |
67 | ||
26f0c779 PP |
68 | option:-o 'DIR', option:--output-path='DIR':: |
69 | Save tracing session configuration files to the directory 'DIR' | |
70 | instead of `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to | |
71 | `$HOME`). | |
b3903b3a PP |
72 | |
73 | ||
f5511eea | 74 | include::common-lttng-cmd-help-options.txt[] |
b3903b3a PP |
75 | |
76 | ||
f5511eea PP |
77 | include::common-lttng-cmd-after-options.txt[] |
78 | ||
79 | ||
80 | include::common-footer.txt[] | |
b3903b3a PP |
81 | |
82 | ||
83 | SEE ALSO | |
84 | -------- | |
26f0c779 | 85 | man:lttng(1), |
af1c4164 PP |
86 | man:lttng-load(1), |
87 | man:lttng-concepts(7) |