1435defbdd70144067cb77467627e92f63254371
[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 if 'SESSION' is specified, the
42 tracing session configuration named 'SESSION' is searched in all the
43 files of this directory and loaded if found. If 'SESSION' is not
44 specified, the option:--all option is implicit: all the tracing session
45 configurations found in all the files in this directory are loaded.
46
47 If the input path is a file, then if 'SESSION' is specified, the tracing
48 session configuration named 'SESSION' is searched in this file and
49 loaded if found. If 'SESSION' is not specified, the option:--all option
50 is implicit: all the tracing session configurations found in this file
51 are loaded.
52
53 By default, existing tracing sessions are not overwritten when loading;
54 the command fails. The option:--force option can be used to allow this.
55
56
57 include::common-cmd-options-head.txt[]
58
59
60 option:-a, option:--all::
61 Load all tracing session configurations (default).
62
63 option:-f, option:--force::
64 Overwrite existing tracing sessions when loading.
65
66 option:-i, option:--input-path='PATH'::
67 Load tracing session configurations from 'PATH', either a directory
68 or a file, instead of loading them from the default search
69 directories.
70
71
72 include::common-cmd-help-options.txt[]
73
74
75 include::common-cmd-footer.txt[]
76
77
78 SEE ALSO
79 --------
80 man:lttng-save(1),
81 man:lttng(1)
This page took 0.043817 seconds and 4 git commands to generate.