doc/man: use propagated default values in man pages
[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 40
9014e3a8
PP
41If 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
50If 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
57By default, existing tracing sessions are not overwritten when loading:
44f5039e
PP
58the command fails. The option:--force option can be used to allow this.
59
60
61include::common-cmd-options-head.txt[]
62
63
64option:-a, option:--all::
65 Load all tracing session configurations (default).
66
67option:-f, option:--force::
68 Overwrite existing tracing sessions when loading.
69
70option:-i, option:--input-path='PATH'::
7a0f38c7
PP
71 Load tracing session configurations from 'PATH', either a directory
72 or a file, instead of loading them from the default search
73 directories.
44f5039e
PP
74
75
76include::common-cmd-help-options.txt[]
77
78
79include::common-cmd-footer.txt[]
80
81
82SEE ALSO
83--------
7c1a4458
PP
84man:lttng-save(1),
85man:lttng(1)
This page took 0.026387 seconds and 4 git commands to generate.