Update the remaining manual pages for LTTng-tools 2.13
[lttng-tools.git] / doc / man / lttng-load.1.txt
1 lttng-load(1)
2 =============
3 :revdate: 30 April 2021
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'] [option:--all | '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 See man:lttng-concepts(7) to learn more about tracing sessions.
24
25 Use the `load` command in conjunction with the man:lttng-save(1) command
26 to save and restore the complete configurations of tracing sessions. A
27 tracing session configuration includes the enabled channels and
28 recording event rules, the context fields to be recorded, the tracing
29 activity, and more.
30
31 Once LTTng loads one or more tracing session configurations, they appear
32 exactly as they were saved from the user's point of view.
33
34 LTTng searches the following directories, non-recursively, in this order
35 for tracing session configuration files:
36
37 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
38 . +{system_sessions_dir}+
39
40 Override the input path with the option:--input-path='PATH' option. With
41 this option, LTTng does :not: search the default directories above.
42 'PATH' can be the path of one of:
43
44 A directory::
45 With the 'SESSION' argument:::
46 LTTng searches for the tracing session configuration named
47 'SESSION' in all the files of the directory 'PATH' and loads it
48 if found.
49
50 Without the 'SESSION' argument:::
51 The option:--all option is implicit: LTTng loads all the tracing
52 session configurations found in all the files in the directory
53 'PATH'.
54
55 A file::
56 With the 'SESSION' argument:::
57 LTTng searches for the tracing session configuration named
58 'SESSION' in the file 'PATH' and loads it if found.
59
60 Without the 'SESSION' argument:::
61 The option:--all option is implicit: LTTng loads all the tracing
62 session configurations found in the file 'PATH'.
63
64 Override the output URL of the loaded tracing session configurations
65 with the option:--override-url option.
66
67 With the 'SESSION' argument, override the name of the loaded tracing
68 session configuration with the option:--override-name option.
69
70 By default, the `load` command does :not: overwrite existing tracing
71 sessions: the command fails. Allow the `load` command to overwrite
72 existing tracing sessions with the option:--force option.
73
74
75 include::common-cmd-options-head.txt[]
76
77
78 option:-a, option:--all::
79 Load all the tracing session configurations (default).
80
81 option:-f, option:--force::
82 Overwrite existing tracing sessions when loading.
83
84 option:-i 'PATH', option:--input-path='PATH'::
85 Load tracing session configurations from 'PATH', either a directory
86 or a file, instead of loading them from the default search
87 directories.
88
89 option:--override-name='NAME'::
90 Override the name of the loaded tracing session configuration,
91 'SESSION', with 'NAME'.
92
93 option:--override-url='URL'::
94 Override the output URL of the loaded tracing session configurations
95 with 'URL'.
96 +
97 This is the equivalent of the nloption:--set-url option of
98 man:lttng-create(1). The validity of the URL override depends on the
99 type of tracing session configurations to load. This option applies to
100 _all_ the loaded tracing session configurations.
101
102
103 include::common-cmd-help-options.txt[]
104
105
106 include::common-cmd-footer.txt[]
107
108
109 SEE ALSO
110 --------
111 man:lttng(1),
112 man:lttng-concepts(7),
113 man:lttng-save(1)
This page took 0.035408 seconds and 6 git commands to generate.