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