lttng-load(1): add usage examples

[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 f5cc3e203c116ed6fb29cb751d5c58151913ceec..bebe1230607d362216f2a95534e5605135dc380b 100644 (file)
--- a/doc/man/lttng-load.1.txt
+++ b/doc/man/lttng-load.1.txt
@@ -1,6 +1,6 @@
 lttng-load(1)
 =============
-:revdate: 30 April 2021
+:revdate: 17 May 2021
 
 
 NAME
@@ -71,8 +71,10 @@ 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.
 
+See the <<examples,EXAMPLES>> section below for usage examples.
 
-include::common-cmd-options-head.txt[]
+
+include::common-lttng-cmd-options-head.txt[]
 
 
 option:-a, option:--all::
@@ -100,14 +102,68 @@ type of tracing session configurations to load. This option applies to
 _all_ the loaded tracing session configurations.
 
 
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+[[examples]]
+EXAMPLES
+--------
+.Load all the tracing session configurations from the default search directories.
+====
+[role="term"]
+----
+$ lttng load
+----
+====
+
+.Load all the tracing session configurations from a specific directory.
+====
+See the option:--input-path option.
+
+[role="term"]
+----
+$ lttng load --input-path=/path/to/sessions
+----
+====
+
+.Load a specific tracing session configuration from the default search directories.
+====
+[role="term"]
+----
+$ lttng load my-session
+----
+====
+
+.Allow LTTng to overwrite existing tracing sessions when loading.
+====
+See the option:--force option.
+
+[role="term"]
+----
+$ lttng load --force
+----
+====
+
+.Load a specific tracing session configuration from a specific file, overriding its name.
+====
+See the option:--input-path and option:--override-name options.
+
+[role="term"]
+----
+$ lttng load my-session --input-path=/path/to/sessions.lttng \
+             --override-name=new-test
+----
+====
 
 
-include::common-cmd-footer.txt[]
+include::common-footer.txt[]
 
 
 SEE ALSO
 --------
 man:lttng(1),
-man:lttng-concepts(7),
-man:lttng-save(1)
+man:lttng-save(1),
+man:lttng-concepts(7)