Docs: remove invalid short option -U and move option descriptions
[lttng-tools.git] / doc / man / lttng-load.1.txt
index 1435defbdd70144067cb77467627e92f63254371..c82fbf4559b796737ab5a8ebee0cd7c7e62206f9 100644 (file)
@@ -10,7 +10,8 @@ lttng-load - Load LTTng tracing session configurations
 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
@@ -38,19 +39,26 @@ 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.
 
-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.
+If the input path is a *directory*, then:
 
-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.
+* 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.
 
-By default, existing tracing sessions are not overwritten when loading;
+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.
 
 
@@ -68,6 +76,16 @@ option:-i, option:--input-path='PATH'::
     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[]
 
This page took 0.023839 seconds and 4 git commands to generate.