b5dd8daea73980e05a324ef6b0252f0533d01741
[lttng-tools.git] / doc / man / lttng-save.1.txt
1 lttng-save(1)
2 =============
3 :revdate: 14 June 2021
4
5
6 NAME
7 ----
8 lttng-save - Save LTTng recording session configurations
9
10
11 SYNOPSIS
12 --------
13 [verse]
14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='DIR']
15 [option:--all | 'SESSION']
16
17
18 DESCRIPTION
19 -----------
20 The `lttng save` command saves to files the configurations of:
21
22 With the 'SESSION' argument::
23 The recording session named 'SESSION'.
24
25 Without the 'SESSION' argument::
26 Implicit option:--all option: *all* the recording 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)).
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 recording 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 recording sessions.
38
39 The `save` command does :not: save tracing data, only the recording
40 session parameters, including the channel and recording event rule
41 configurations.
42
43 The default output directory path is `$LTTNG_HOME/.lttng/sessions`
44 (`$LTTNG_HOME` defaults to `$HOME`). Override the default output
45 directory path with the option:--output-path option. Each recording
46 session configuration file is named __SNAME__++.lttng++,
47 where{nbsp}__SNAME__ is the original recording session name.
48
49 By default, the `save` command does :not: overwrite existing recording
50 session configuration files: the command fails. Allow the `save` command
51 to overwrite existing recording session configuration files with the
52 option:--force option.
53
54 See the ``<<examples,EXAMPLES>>'' section below for usage examples.
55
56
57 include::common-lttng-cmd-options-head.txt[]
58
59
60 option:-a, option:--all::
61 Save all the recording session configurations of your Unix user, or
62 of all users if your Unix user is `root`, as listed in the output of
63 man:lttng-list(1), instead of the current recording session or the
64 recording session named 'SESSION'.
65
66 option:-f, option:--force::
67 Overwrite existing recording session configuration files when
68 saving.
69
70 option:-o 'DIR', option:--output-path='DIR'::
71 Save recording session configuration files to the directory 'DIR'
72 instead of `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to
73 `$HOME`).
74
75
76 include::common-lttng-cmd-help-options.txt[]
77
78
79 include::common-lttng-cmd-after-options.txt[]
80
81
82 [[examples]]
83 EXAMPLES
84 --------
85 .Save all the recording session configurations to the default output directory.
86 ====
87 [role="term"]
88 ----
89 $ lttng save
90 ----
91 ====
92
93 .Save a specific recording session configuration to a specific output directory.
94 ====
95 See the option:--output-path option.
96
97 [role="term"]
98 ----
99 $ lttng save my-session --output-path=/path/to/sessions
100 ----
101 ====
102
103 .Allow LTTng to overwrite existing recording session configuration files when saving.
104 ====
105 See the option:--force option.
106
107 [role="term"]
108 ----
109 $ lttng save --force
110 ----
111 ====
112
113
114 include::common-footer.txt[]
115
116
117 SEE ALSO
118 --------
119 man:lttng(1),
120 man:lttng-load(1),
121 man:lttng-concepts(7)
This page took 0.035093 seconds and 5 git commands to generate.