lttng-load(1): fix synopsis and style
[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]
fe559816 13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
62482ec6 14 [option:--override-url='URL'] ['SESSION' [option:--override-name='NAME']]
44f5039e
PP
15
16
17DESCRIPTION
18-----------
19The `lttng load` command loads the configurations of one or more
20tracing sessions from files.
21
22The `lttng load` command is used in conjunction with the
7c1a4458 23man:lttng-save(1) command to save and restore the complete
44f5039e
PP
24configurations of tracing sessions. This includes the enabled channels
25and event rules, the context added to channels, the tracing activity,
26and more.
27
28Once one or more tracing session configurations are loaded, they appear
29exactly as they were saved from the user's point of view.
30
7a0f38c7
PP
31The following directories are searched, non-recursively, in this order
32for configuration files:
33
34. `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
35. +{system_sessions_dir}+
36
37The input path can be overridden with the option:--input-path option.
38When this option is specified, the default directories are :not:
39searched for configuration files. When it's not specified, _both_
40default directories are searched for configuration files.
44f5039e 41
9014e3a8
PP
42If 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
51If 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
54c28cda
JG
58Aspects of the loaded configurations can be overridden at load time
59using the option:--override-url and option:--override-name options.
e1f481f6 60
9014e3a8 61By default, existing tracing sessions are not overwritten when loading:
44f5039e
PP
62the command fails. The option:--force option can be used to allow this.
63
64
65include::common-cmd-options-head.txt[]
66
67
68option:-a, option:--all::
69 Load all tracing session configurations (default).
70
71option:-f, option:--force::
72 Overwrite existing tracing sessions when loading.
73
74option:-i, option:--input-path='PATH'::
7a0f38c7
PP
75 Load tracing session configurations from 'PATH', either a directory
76 or a file, instead of loading them from the default search
77 directories.
44f5039e 78
54c28cda 79option:--override-name='NAME'::
62482ec6
PP
80 Override the name of the loaded tracing session configuration,
81 'SESSION', with 'NAME'.
82+
83You must specify a tracing session name to load ('SESSION') and :not:
84use the option:--all option when using this option.
85
86option:--override-url='URL'::
87 Override the URL of the loaded tracing session configurations
88 with 'URL'.
89+
90This is the equivalent of the nloption:--set-url option of
91man:lttng-create(1). The validity of the URL override depends on the
92type of tracing session configurations to load. This option applies to
93_all_ the loaded tracing session configurations.
94
44f5039e
PP
95
96include::common-cmd-help-options.txt[]
97
98
99include::common-cmd-footer.txt[]
100
101
102SEE ALSO
103--------
7c1a4458
PP
104man:lttng-save(1),
105man:lttng(1)
This page took 0.039172 seconds and 4 git commands to generate.