c82fbf4559b796737ab5a8ebee0cd7c7e62206f9
[lttng-tools.git] / doc / man / lttng-load.1.txt
1 lttng-load(1)
2 =============
3
4
5 NAME
6 ----
7 lttng-load - Load LTTng tracing session configurations
8
9
10 SYNOPSIS
11 --------
12 [verse]
13 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
14 [option:--override-url='URL'] [option:--override-name='NAME'] ['SESSION']
15
16
17 DESCRIPTION
18 -----------
19 The `lttng load` command loads the configurations of one or more
20 tracing sessions from files.
21
22 The `lttng load` command is used in conjunction with the
23 man:lttng-save(1) command to save and restore the complete
24 configurations of tracing sessions. This includes the enabled channels
25 and event rules, the context added to channels, the tracing activity,
26 and more.
27
28 Once one or more tracing session configurations are loaded, they appear
29 exactly as they were saved from the user's point of view.
30
31 The following directories are searched, non-recursively, in this order
32 for configuration files:
33
34 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
35 . +{system_sessions_dir}+
36
37 The input path can be overridden with the option:--input-path option.
38 When this option is specified, the default directories are :not:
39 searched for configuration files. When it's not specified, _both_
40 default directories are searched for configuration files.
41
42 If the input path is a *directory*, then:
43
44 * If 'SESSION' is specified, the tracing session configuration named
45 'SESSION' is searched for in all the files of this directory and
46 loaded if found.
47 * If 'SESSION' is not specified, the option:--all option is implicit:
48 all the tracing session configurations found in all the files in this
49 directory are loaded.
50
51 If the input path is a *file*, then:
52
53 * If 'SESSION' is specified, the tracing session configuration named
54 'SESSION' is searched for in this file and loaded if found.
55 * If 'SESSION' is not specified, the option:--all option is implicit:
56 all the tracing session configurations found in this file are loaded.
57
58 Aspects of the loaded configurations can be overridden at load time
59 using the option:--override-url and option:--override-name options.
60
61 By default, existing tracing sessions are not overwritten when loading:
62 the command fails. The option:--force option can be used to allow this.
63
64
65 include::common-cmd-options-head.txt[]
66
67
68 option:-a, option:--all::
69 Load all tracing session configurations (default).
70
71 option:-f, option:--force::
72 Overwrite existing tracing sessions when loading.
73
74 option:-i, option:--input-path='PATH'::
75 Load tracing session configurations from 'PATH', either a directory
76 or a file, instead of loading them from the default search
77 directories.
78
79 option:--override-url::
80 Provides the equivalent of the option:--set-url option
81 of the man:lttng-create(1) command. The validity of the url override is
82 dependent of the type of session(s) to be loaded. Refer to
83 man:lttng-create(1) for the accepted URL format. This option applies
84 to all sessions loaded.
85
86 option:--override-name='NAME'::
87 Set the session name to NAME. This option is invalid in combination with
88 the --all option.
89
90 include::common-cmd-help-options.txt[]
91
92
93 include::common-cmd-footer.txt[]
94
95
96 SEE ALSO
97 --------
98 man:lttng-save(1),
99 man:lttng(1)
This page took 0.054304 seconds and 4 git commands to generate.