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