doc/man: use specific revision date for each manual page
[lttng-tools.git] / doc / man / lttng-load.1.txt
1 lttng-load(1)
2 =============
3 :revdate: 28 November 2016
4
5
6 NAME
7 ----
8 lttng-load - Load LTTng tracing session configurations
9
10
11 SYNOPSIS
12 --------
13 [verse]
14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
15 [option:--override-url='URL'] ['SESSION' [option:--override-name='NAME']]
16
17
18 DESCRIPTION
19 -----------
20 The `lttng load` command loads the configurations of one or more
21 tracing sessions from files.
22
23 The `lttng load` command is used in conjunction with the
24 man:lttng-save(1) command to save and restore the complete
25 configurations of tracing sessions. This includes the enabled channels
26 and event rules, the context added to channels, the tracing activity,
27 and more.
28
29 Once one or more tracing session configurations are loaded, they appear
30 exactly as they were saved from the user's point of view.
31
32 The following directories are searched, non-recursively, in this order
33 for configuration files:
34
35 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
36 . +{system_sessions_dir}+
37
38 The input path can be overridden with the option:--input-path option.
39 When this option is specified, the default directories are :not:
40 searched for configuration files. When it's not specified, _both_
41 default directories are searched for configuration files.
42
43 If the input path is a *directory*, then:
44
45 * If 'SESSION' is specified, the tracing session configuration named
46 'SESSION' is searched for in all the files of this directory and
47 loaded if found.
48 * If 'SESSION' is not specified, the option:--all option is implicit:
49 all the tracing session configurations found in all the files in this
50 directory are loaded.
51
52 If the input path is a *file*, then:
53
54 * If 'SESSION' is specified, the tracing session configuration named
55 'SESSION' is searched for in this file and loaded if found.
56 * If 'SESSION' is not specified, the option:--all option is implicit:
57 all the tracing session configurations found in this file are loaded.
58
59 Aspects of the loaded configurations can be overridden at load time
60 using the option:--override-url and option:--override-name options.
61
62 By default, existing tracing sessions are not overwritten when loading:
63 the command fails. The option:--force option can be used to allow this.
64
65
66 include::common-cmd-options-head.txt[]
67
68
69 option:-a, option:--all::
70 Load all tracing session configurations (default).
71
72 option:-f, option:--force::
73 Overwrite existing tracing sessions when loading.
74
75 option:-i 'PATH', option:--input-path='PATH'::
76 Load tracing session configurations from 'PATH', either a directory
77 or a file, instead of loading them from the default search
78 directories.
79
80 option:--override-name='NAME'::
81 Override the name of the loaded tracing session configuration,
82 'SESSION', with 'NAME'.
83 +
84 You must specify a tracing session name to load ('SESSION') and :not:
85 use the option:--all option when using this option.
86
87 option:--override-url='URL'::
88 Override the URL of the loaded tracing session configurations
89 with 'URL'.
90 +
91 This is the equivalent of the nloption:--set-url option of
92 man:lttng-create(1). The validity of the URL override depends on the
93 type of tracing session configurations to load. This option applies to
94 _all_ the loaded tracing session configurations.
95
96
97 include::common-cmd-help-options.txt[]
98
99
100 include::common-cmd-footer.txt[]
101
102
103 SEE ALSO
104 --------
105 man:lttng-save(1),
106 man:lttng(1)
This page took 0.044256 seconds and 4 git commands to generate.