SYNOPSIS
--------
[verse]
-*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH'] ['SESSION']
+*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
+ [option:--override-url='URL'] [option:--override-name='NAME'] ['SESSION']
DESCRIPTION
Once one or more tracing session configurations are loaded, they appear
exactly as they were saved from the user's point of view.
-The default input path is `$LTTNG_HOME/.lttng/sessions`
-(`$LTTNG_HOME` defaults to `$HOME`). The input path can be
-overridden with the option:--input-path option.
+The following directories are searched, non-recursively, in this order
+for configuration files:
-If the input path is a directory, then if 'SESSION' is specified, the
-tracing session configuration named 'SESSION' is searched in all the
-files of this directory and loaded if found. If 'SESSION' is not
-specified, the option:--all option is implicit: all the tracing session
-configurations found in all the files in this directory are loaded.
+. `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
+. +{system_sessions_dir}+
-If the input path is a file, then if 'SESSION' is specified, the tracing
-session configuration named 'SESSION' is searched in this file and
-loaded if found. If 'SESSION' is not specified, the option:--all option
-is implicit: all the tracing session configurations found in this file
-are loaded.
+The input path can be overridden with the option:--input-path option.
+When this option is specified, the default directories are :not:
+searched for configuration files. When it's not specified, _both_
+default directories are searched for configuration files.
-By default, existing tracing sessions are not overwritten when loading;
+If the input path is a *directory*, then:
+
+* If 'SESSION' is specified, the tracing session configuration named
+ 'SESSION' is searched for in all the files of this directory and
+ loaded if found.
+* If 'SESSION' is not specified, the option:--all option is implicit:
+ all the tracing session configurations found in all the files in this
+ directory are loaded.
+
+If the input path is a *file*, then:
+
+* If 'SESSION' is specified, the tracing session configuration named
+ 'SESSION' is searched for in this file and loaded if found.
+* If 'SESSION' is not specified, the option:--all option is implicit:
+ all the tracing session configurations found in this file are loaded.
+
+Aspects of the loaded configurations can be overridden at load time
+using the option:--override-url and option:--override-name options.
+
+By default, existing tracing sessions are not overwritten when loading:
the command fails. The option:--force option can be used to allow this.
Overwrite existing tracing sessions when loading.
option:-i, option:--input-path='PATH'::
- Set input path to 'PATH', either a directory or a file, in which
- tracing session configurations are searched for.
-
+ Load tracing session configurations from 'PATH', either a directory
+ or a file, instead of loading them from the default search
+ directories.
+
+option:--override-url::
+ Provides the equivalent of the option:--set-url option
+ of the man:lttng-create(1) command. The validity of the url override is
+ dependent of the type of session(s) to be loaded. Refer to
+ man:lttng-create(1) for the accepted URL format. This option applies
+ to all sessions loaded.
+
+option:--override-name='NAME'::
+ Set the session name to NAME. This option is invalid in combination with
+ the --all option.
include::common-cmd-help-options.txt[]