doc/man: create lttng-load(1) and update/fix content
[lttng-tools.git] / doc / man / lttng-load.1.txt
1 lttng-load(1)
2 =============
3
4
5 NAME
6 ----
7 lttng-load - Load LTTng tracing session configurations
8
9
10 SYNOPSIS
11 --------
12 [verse]
13 *lttng* ['GENERAL OPTIONS'] *load* [option:--force] [option:--input-path='PATH'] ['SESSION']
14
15
16 DESCRIPTION
17 -----------
18 The `lttng load` command loads the configurations of one or more
19 tracing sessions from files.
20
21 The `lttng load` command is used in conjunction with the
22 linklttng:lttng-save(1) command to save and restore the complete
23 configurations of tracing sessions. This includes the enabled channels
24 and event rules, the context added to channels, the tracing activity,
25 and more.
26
27 Once one or more tracing session configurations are loaded, they appear
28 exactly as they were saved from the user's point of view.
29
30 The default input path is `$LTTNG_HOME/.lttng/sessions`
31 (`$LTTNG_HOME` defaults to `$HOME`). The input path can be
32 overridden with the option:--input-path option.
33
34 If the input path is a directory, then if 'SESSION' is specified, the
35 tracing session configuration named 'SESSION' is searched in all the
36 files of this directory and loaded if found. If 'SESSION' is not
37 specified, the option:--all option is implicit: all the tracing session
38 configurations found in all the files in this directory are loaded.
39
40 If the input path is a file, then if 'SESSION' is specified, the tracing
41 session configuration named 'SESSION' is searched in this file and
42 loaded if found. If 'SESSION' is not specified, the option:--all option
43 is implicit: all the tracing session configurations found in this file
44 are loaded.
45
46 By default, existing tracing sessions are not overwritten when loading;
47 the command fails. The option:--force option can be used to allow this.
48
49
50 include::common-cmd-options-head.txt[]
51
52
53 option:-a, option:--all::
54 Load all tracing session configurations (default).
55
56 option:-f, option:--force::
57 Overwrite existing tracing sessions when loading.
58
59 option:-i, option:--input-path='PATH'::
60 Set input path to 'PATH', either a directory or a file, in which
61 tracing session configurations are searched for.
62
63
64 include::common-cmd-help-options.txt[]
65
66
67 include::common-cmd-footer.txt[]
68
69
70 SEE ALSO
71 --------
72 linklttng:lttng-save(1),
73 linklttng:lttng(1)
This page took 0.043372 seconds and 4 git commands to generate.