Update the remaining manual pages for LTTng-tools 2.13

[lttng-tools.git] / doc / man / lttng-load.1.txt

diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt
index 253b86d3ccdc605e23dc80d9084dc44a824d6401..f5cc3e203c116ed6fb29cb751d5c58151913ceec 100644 (file)
--- a/doc/man/lttng-load.1.txt
+++ b/doc/man/lttng-load.1.txt
@@ -1,6 +1,6 @@
 lttng-load(1)
 =============
 lttng-load(1)
 =============

-:revdate: 28 November 2016
+:revdate: 30 April 2021

 
 
 NAME
 
 
 NAME


@@ -12,7 +12,7 @@ SYNOPSIS
 --------
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
 --------
 [verse]
 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']

-      [option:--override-url='URL'] ['SESSION' [option:--override-name='NAME']]
+      [option:--override-url='URL'] [option:--all | 'SESSION' [option:--override-name='NAME']]

 
 
 DESCRIPTION
 
 
 DESCRIPTION


@@ -20,54 +20,63 @@ DESCRIPTION
 The `lttng load` command loads the configurations of one or more
 tracing sessions from files.
 
 The `lttng load` command loads the configurations of one or more
 tracing sessions from files.
 

-The `lttng load` command is used in conjunction with the
-man:lttng-save(1) command to save and restore the complete
-configurations of tracing sessions. This includes the enabled channels
-and recording event rules, the context added to channels, the tracing
+See man:lttng-concepts(7) to learn more about tracing sessions.
+
+Use the `load` command in conjunction with the man:lttng-save(1) command
+to save and restore the complete configurations of tracing sessions. A
+tracing session configuration includes the enabled channels and
+recording event rules, the context fields to be recorded, the tracing

 activity, and more.
 
 activity, and more.
 

-Once one or more tracing session configurations are loaded, they appear
+Once LTTng loads one or more tracing session configurations, they appear

 exactly as they were saved from the user's point of view.
 
 exactly as they were saved from the user's point of view.
 

-The following directories are searched, non-recursively, in this order
-for configuration files:
+LTTng searches the following directories, non-recursively, in this order
+for tracing session configuration files:

 
 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
 . +{system_sessions_dir}+
 
 
 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
 . +{system_sessions_dir}+
 

-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.
+Override the input path with the option:--input-path='PATH' option. With
+this option, LTTng does :not: search the default directories above.
+'PATH' can be the path of one of:
+
+A directory::
+    With the 'SESSION' argument:::
+        LTTng searches for the tracing session configuration named
+        'SESSION' in all the files of the directory 'PATH' and loads it
+        if found.

 
 

-If the input path is a *directory*, then:
+    Without the 'SESSION' argument:::
+        The option:--all option is implicit: LTTng loads all the tracing
+        session configurations found in all the files in the directory
+        'PATH'.

 
 

-* 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.
+A file::
+    With the 'SESSION' argument:::
+        LTTng searches for the tracing session configuration named
+        'SESSION' in the file 'PATH' and loads it if found.

 
 

-If the input path is a *file*, then:
+    Without the 'SESSION' argument:::
+        The option:--all option is implicit: LTTng loads all the tracing
+        session configurations found in the file 'PATH'.

 
 

-* 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.
+Override the output URL of the loaded tracing session configurations
+with the option:--override-url option.

 
 

-Aspects of the loaded configurations can be overridden at load time
-using the option:--override-url and option:--override-name options.
+With the 'SESSION' argument, override the name of the loaded tracing
+session configuration with the option:--override-name option.

 
 

-By default, existing tracing sessions are not overwritten when loading:
-the command fails. The option:--force option can be used to allow this.
+By default, the `load` command does :not: overwrite existing tracing
+sessions: the command fails. Allow the `load` command to overwrite
+existing tracing sessions with the option:--force option.

 
 
 include::common-cmd-options-head.txt[]
 
 
 option:-a, option:--all::
 
 
 include::common-cmd-options-head.txt[]
 
 
 option:-a, option:--all::

-    Load all tracing session configurations (default).
+    Load all the tracing session configurations (default).

 
 option:-f, option:--force::
     Overwrite existing tracing sessions when loading.
 
 option:-f, option:--force::
     Overwrite existing tracing sessions when loading.


@@ -80,12 +89,9 @@ option:-i 'PATH', option:--input-path='PATH'::
 option:--override-name='NAME'::
     Override the name of the loaded tracing session configuration,
     'SESSION', with 'NAME'.
 option:--override-name='NAME'::
     Override the name of the loaded tracing session configuration,
     'SESSION', with 'NAME'.

-+
-You must specify a tracing session name to load ('SESSION') and :not:
-use the option:--all option when using this option.

 
 option:--override-url='URL'::
 
 option:--override-url='URL'::

-    Override the URL of the loaded tracing session configurations
+    Override the output URL of the loaded tracing session configurations

     with 'URL'.
 +
 This is the equivalent of the nloption:--set-url option of
     with 'URL'.
 +
 This is the equivalent of the nloption:--set-url option of


@@ -102,5 +108,6 @@ include::common-cmd-footer.txt[]
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------

-man:lttng-save(1),
-man:lttng(1)
+man:lttng(1),
+man:lttng-concepts(7),
+man:lttng-save(1)