ec8741b079fa908e5354768203dde55c07c2f5f7
[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'] ['SESSION']
14
15
16 DESCRIPTION
17 -----------
18 The `lttng load` command loads the configurations of one or more
19 tracing sessions from files.
20
21 The `lttng load` command is used in conjunction with the
22 man:lttng-save(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.
26
27 Once one or more tracing session configurations are loaded, they appear
28 exactly as they were saved from the user's point of view.
29
30 The following directories are searched, non-recursively, in this order
31 for configuration files:
32
33 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
34 . +{system_sessions_dir}+
35
36 The input path can be overridden with the option:--input-path option.
37 When this option is specified, the default directories are :not:
38 searched for configuration files. When it's not specified, _both_
39 default directories are searched for configuration files.
40
41 If the input path is a *directory*, then:
42
43 * If 'SESSION' is specified, the tracing session configuration named
44 'SESSION' is searched for in all the files of this directory and
45 loaded if found.
46 * If 'SESSION' is not specified, the option:--all option is implicit:
47 all the tracing session configurations found in all the files in this
48 directory are loaded.
49
50 If the input path is a *file*, then:
51
52 * If 'SESSION' is specified, the tracing session configuration named
53 'SESSION' is searched for in this file and loaded if found.
54 * If 'SESSION' is not specified, the option:--all option is implicit:
55 all the tracing session configurations found in this file are loaded.
56
57 By default, existing tracing sessions are not overwritten when loading:
58 the command fails. The option:--force option can be used to allow this.
59
60
61 include::common-cmd-options-head.txt[]
62
63
64 option:-a, option:--all::
65 Load all tracing session configurations (default).
66
67 option:-f, option:--force::
68 Overwrite existing tracing sessions when loading.
69
70 option:-i, option:--input-path='PATH'::
71 Load tracing session configurations from 'PATH', either a directory
72 or a file, instead of loading them from the default search
73 directories.
74
75
76 include::common-cmd-help-options.txt[]
77
78
79 include::common-cmd-footer.txt[]
80
81
82 SEE ALSO
83 --------
84 man:lttng-save(1),
85 man:lttng(1)
This page took 0.063437 seconds and 3 git commands to generate.