man: lttng-load fix up
[lttng-tools.git] / doc / man / lttng-load.1.txt
... / ...
CommitLineData
1lttng-load(1)
2=============
3
4
5NAME
6----
7lttng-load - Load LTTng tracing session configurations
8
9
10SYNOPSIS
11--------
12[verse]
13*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
14 [option:--override-url='URL'] ['SESSION']
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
23man:lttng-save(1) command to save and restore the complete
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
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.
41
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
58Aspects of the loaded configurations can be overridden at load time.
59
60option:--override-url::
61 Provides the equivalent of the option:--set-url option
62 of the (1)lttng-create command. The validity of the url override is
63 dependant on the type of session(s) to be loaded. Refer to (1)lttng-create for
64 the accepted URL format.
65
66By default, existing tracing sessions are not overwritten when loading:
67the command fails. The option:--force option can be used to allow this.
68
69
70include::common-cmd-options-head.txt[]
71
72
73option:-a, option:--all::
74 Load all tracing session configurations (default).
75
76option:-f, option:--force::
77 Overwrite existing tracing sessions when loading.
78
79option:-i, option:--input-path='PATH'::
80 Load tracing session configurations from 'PATH', either a directory
81 or a file, instead of loading them from the default search
82 directories.
83
84option:-U, option:--override-url='URL'::
85 Load tracing session configurations and apply an url override
86 while loading. Applies to all sessions loaded.
87
88include::common-cmd-help-options.txt[]
89
90
91include::common-cmd-footer.txt[]
92
93
94SEE ALSO
95--------
96man:lttng-save(1),
97man:lttng(1)
This page took 0.022303 seconds and 4 git commands to generate.