doc/man: lttng(1) command pages: always include `common-footer.txt`

The end of an lttng(1) command manual page source now looks like this:

    include::common-lttng-cmd-help-options.txt[]

    include::common-lttng-cmd-after-options.txt[]

    include::common-footer.txt[]

`common-lttng-cmd-after-options.txt` contains the "EXIT STATUS",
"ENVIRONMENT", and "FILES" sections.

`common-footer.txt` begins with the "RESOURCES" section.

This will make it possible to insert an "EXAMPLES" section between
`common-lttng-cmd-after-options.txt` and `common-footer.txt`.

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
Change-Id: I1eee42d7386f4671d9825e9d3e131e54f868ee39

diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am
index 97aa59b665449036ab6be99d9f6c83b6b0a6ef24..037d84d9f572c225cafe109fe145bde7c83e383a 100644 (file)
--- a/doc/man/Makefile.am
+++ b/doc/man/Makefile.am
@@ -59,9 +59,9 @@ MAN_XML = $(patsubst $(srcdir)/%.txt,%.xml,$(MAN_TXT))
 # common AsciiDoc source files
 COMMON_TXT = \
        $(srcdir)/common-footer.txt \
 # common AsciiDoc source files
 COMMON_TXT = \
        $(srcdir)/common-footer.txt \

-       $(srcdir)/common-cmd-footer.txt \
-       $(srcdir)/common-cmd-options-head.txt \
-       $(srcdir)/common-cmd-help-options.txt \
+       $(srcdir)/common-lttng-cmd-after-options.txt \
+       $(srcdir)/common-lttng-cmd-options-head.txt \
+       $(srcdir)/common-lttng-cmd-help-options.txt \

        $(srcdir)/common-help-option.txt \
        $(srcdir)/common-intro.txt \
        $(srcdir)/common-daemon-cfg.txt
        $(srcdir)/common-help-option.txt \
        $(srcdir)/common-intro.txt \
        $(srcdir)/common-daemon-cfg.txt

diff --git a/doc/man/README.md b/doc/man/README.md
index c904d77a6d5d9696b29e8d5f6df76377f7f028a2..1b0233b8e9975c2b1658b0f54723bc2e522d1c6e 100644 (file)
--- a/doc/man/README.md
+++ b/doc/man/README.md
@@ -77,9 +77,10 @@ which is not so easy to do otherwise.
 Includes
 --------
 
 Includes
 --------
 

-  * `common-cmd-footer.txt`: common `lttng` command footer.
-  * `common-cmd-help-options.txt`: common program information section
-    of `lttng` command options.
+  * `common-lttng-cmd-after-options.txt`: common part after the options
+    section of an `lttng` command.
+  * `common-lttng-cmd-help-options.txt`: common program information
+    section of `lttng` command options.

   * `common-cmd-options-head.txt`: common `lttng` command head of
     options section.
   * `common-footer.txt`: common footer for all commands.
   * `common-cmd-options-head.txt`: common `lttng` command head of
     options section.
   * `common-footer.txt`: common footer for all commands.

diff --git a/doc/man/common-cmd-footer.txt b/doc/man/common-cmd-footer.txt
deleted file mode 100644 (file)
index 86b4a81..0000000
--- a/doc/man/common-cmd-footer.txt
+++ /dev/null
@@ -1,85 +0,0 @@
-EXIT STATUS
------------
-*0*::
-    Success
-
-*1*::
-    Command error
-
-*2*::
-    Undefined command
-
-*3*::
-    Fatal error
-
-*4*::
-    Command warning (something went wrong during the command)
-
-
-ENVIRONMENT
------------
-`LTTNG_ABORT_ON_ERROR`::
-    Set to `1` to abort the process after the first error is
-    encountered.
-
-`LTTNG_HOME`::
-    Path to the LTTng home directory.
-+
-Defaults to `$HOME`.
-+
-Useful when the Unix user running the commands has a non-writable home
-directory.
-
-`LTTNG_MAN_BIN_PATH`::
-    Absolute path to the manual pager to use to read the LTTng
-    command-line help (with man:lttng-help(1) or with the
-    nloption:--help option) instead of `/usr/bin/man`.
-
-`LTTNG_SESSION_CONFIG_XSD_PATH`::
-    Path to the directory containing the `session.xsd` tracing session
-    configuration XML schema.
-
-`LTTNG_SESSIOND_PATH`::
-    Absolute path to the LTTng session daemon binary (see
-    man:lttng-sessiond(8)).
-+
-The genoption:--sessiond-path general option overrides this environment
-variable.
-+
-NOTE: The man:lttng-create(1) command can spawn an LTTng session daemon
-automatically if none is running. See man:lttng-sessiond(8) for the
-environment variables affecting the execution of the session daemon.
-
-
-FILES
------
-`$LTTNG_HOME/.lttngrc`::
-    Unix user's LTTng runtime configuration.
-+
-This is where LTTng stores the name of the Unix user's current tracing
-session between executions of man:lttng(1). man:lttng-create(1) and
-man:lttng-set-session(1) set the current tracing session.
-
-`$LTTNG_HOME/lttng-traces`::
-    Default output directory of LTTng traces in local and snapshot
-    modes.
-+
-Override this path with the nloption:--output option of the
-man:lttng-create(1) command.
-
-`$LTTNG_HOME/.lttng`::
-    Unix user's LTTng runtime and configuration directory.
-
-`$LTTNG_HOME/.lttng/sessions`::
-    Default directory containing the Unix user's saved tracing session
-    configurations (see man:lttng-save(1) and man:lttng-load(1)).
-
-+{system_sessions_dir}+::
-    Directory containing the system-wide saved tracing session
-    configurations (see man:lttng-save(1) and man:lttng-load(1)).
-
-NOTE: `$LTTNG_HOME` defaults to the value of the `HOME` environment
-variable.
-
-
-include::common-footer.txt[]

diff --git a/doc/man/common-cmd-help-options.txt b/doc/man/common-cmd-help-options.txt
deleted file mode 100644 (file)
index 0e85fdc..0000000
--- a/doc/man/common-cmd-help-options.txt
+++ /dev/null
@@ -1,3 +0,0 @@
-Program information
-~~~~~~~~~~~~~~~~~~~
-include::common-help-option.txt[]

diff --git a/doc/man/common-lttng-cmd-after-options.txt b/doc/man/common-lttng-cmd-after-options.txt
new file mode 100644 (file)
index 0000000..2122cee
--- /dev/null
+++ b/doc/man/common-lttng-cmd-after-options.txt
@@ -0,0 +1,83 @@
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Command error
+
+*2*::
+    Undefined command
+
+*3*::
+    Fatal error
+
+*4*::
+    Command warning (something went wrong during the command)
+
+
+ENVIRONMENT
+-----------
+`LTTNG_ABORT_ON_ERROR`::
+    Set to `1` to abort the process after the first error is
+    encountered.
+
+`LTTNG_HOME`::
+    Path to the LTTng home directory.
++
+Defaults to `$HOME`.
++
+Useful when the Unix user running the commands has a non-writable home
+directory.
+
+`LTTNG_MAN_BIN_PATH`::
+    Absolute path to the manual pager to use to read the LTTng
+    command-line help (with man:lttng-help(1) or with the
+    nloption:--help option) instead of `/usr/bin/man`.
+
+`LTTNG_SESSION_CONFIG_XSD_PATH`::
+    Path to the directory containing the `session.xsd` tracing session
+    configuration XML schema.
+
+`LTTNG_SESSIOND_PATH`::
+    Absolute path to the LTTng session daemon binary (see
+    man:lttng-sessiond(8)).
++
+The genoption:--sessiond-path general option overrides this environment
+variable.
++
+NOTE: The man:lttng-create(1) command can spawn an LTTng session daemon
+automatically if none is running. See man:lttng-sessiond(8) for the
+environment variables affecting the execution of the session daemon.
+
+
+FILES
+-----
+`$LTTNG_HOME/.lttngrc`::
+    Unix user's LTTng runtime configuration.
++
+This is where LTTng stores the name of the Unix user's current tracing
+session between executions of man:lttng(1). man:lttng-create(1) and
+man:lttng-set-session(1) set the current tracing session.
+
+`$LTTNG_HOME/lttng-traces`::
+    Default output directory of LTTng traces in local and snapshot
+    modes.
++
+Override this path with the nloption:--output option of the
+man:lttng-create(1) command.
+
+`$LTTNG_HOME/.lttng`::
+    Unix user's LTTng runtime and configuration directory.
+
+`$LTTNG_HOME/.lttng/sessions`::
+    Default directory containing the Unix user's saved tracing session
+    configurations (see man:lttng-save(1) and man:lttng-load(1)).
+
++{system_sessions_dir}+::
+    Directory containing the system-wide saved tracing session
+    configurations (see man:lttng-save(1) and man:lttng-load(1)).
+
+NOTE: `$LTTNG_HOME` defaults to the value of the `HOME` environment
+variable.
+

diff --git a/doc/man/common-lttng-cmd-help-options.txt b/doc/man/common-lttng-cmd-help-options.txt
new file mode 100644 (file)
index 0000000..0e85fdc
--- /dev/null
+++ b/doc/man/common-lttng-cmd-help-options.txt
@@ -0,0 +1,3 @@
+Program information
+~~~~~~~~~~~~~~~~~~~
+include::common-help-option.txt[]

diff --git a/doc/man/common-lttng-cmd-options-head.txt b/doc/man/common-lttng-cmd-options-head.txt
new file mode 100644 (file)
index 0000000..c910e71
--- /dev/null
+++ b/doc/man/common-lttng-cmd-options-head.txt
@@ -0,0 +1,3 @@
+OPTIONS
+-------
+See man:lttng(1) for 'linkgenoptions:(GENERAL OPTIONS)'.

diff --git a/doc/man/common-lttng-cmd-opts-head.txt b/doc/man/common-lttng-cmd-opts-head.txt
new file mode 100644 (file)
index 0000000..c910e71
--- /dev/null
+++ b/doc/man/common-lttng-cmd-opts-head.txt
@@ -0,0 +1,3 @@
+OPTIONS
+-------
+See man:lttng(1) for 'linkgenoptions:(GENERAL OPTIONS)'.

diff --git a/doc/man/lttng-add-context.1.txt b/doc/man/lttng-add-context.1.txt
index b1d11e931d70c4c1c7a721fad947d7e8995c336f..ad83445b5c97ca45af5239271ead76742fff0d06 100644 (file)
--- a/doc/man/lttng-add-context.1.txt
+++ b/doc/man/lttng-add-context.1.txt
@@ -107,7 +107,7 @@ to be recorded to the event records of a given channel once its tracing
 session has been started (see man:lttng-start(1)) at least once.
 
 
 session has been started (see man:lttng-start(1)) at least once.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -158,10 +158,13 @@ option:-t 'TYPE', option:--type='TYPE'::
 Repeat this option to add more than one context field.
 
 
 Repeat this option to add more than one context field.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-add-trigger.1.txt b/doc/man/lttng-add-trigger.1.txt
index aee2380b352b2d4e9e3120ee8c49382627096b67..0b7363e8190a061930c5e0f4c07278bf289870d4 100644 (file)
--- a/doc/man/lttng-add-trigger.1.txt
+++ b/doc/man/lttng-add-trigger.1.txt
@@ -300,10 +300,13 @@ option:--action='ACTTYPE'::
 See the <<action-spec,Action specifier>> section above to learn more.
 
 
 See the <<action-spec,Action specifier>> section above to learn more.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-clear.1.txt b/doc/man/lttng-clear.1.txt
index f60a55b96d3896655a96e96405d9b46cd62e5b7a..4fb52671aca669ce5cd79e07e9cb89c993a25066 100644 (file)
--- a/doc/man/lttng-clear.1.txt
+++ b/doc/man/lttng-clear.1.txt
@@ -55,7 +55,7 @@ sends tracing data over the network for the selected tracing session(s)
 to an LTTng relay daemon configured as such, the `clear` command fails.
 
 
 to an LTTng relay daemon configured as such, the `clear` command fails.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Recording target
 
 
 Recording target


@@ -67,10 +67,13 @@ option:-a, option:--all::
     tracing session named 'SESSION'.
 
 
     tracing session named 'SESSION'.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-create.1.txt b/doc/man/lttng-create.1.txt
index f3420a0100f9e068a05234954ddc1d7f981a8356..5b5f7b62eebecd3f2545a543acf58c731063548b 100644 (file)
--- a/doc/man/lttng-create.1.txt
+++ b/doc/man/lttng-create.1.txt
@@ -234,7 +234,7 @@ This path is relative to the base output directory of the LTTng relay
 daemon (see the nloption:--output option of man:lttng-relayd(8)).
 
 
 daemon (see the nloption:--output option of man:lttng-relayd(8)).
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Mode selection
 
 
 Mode selection


@@ -359,10 +359,13 @@ Snapshot mode (option:--snapshot option):::
     after creating the tracing session.
 
 
     after creating the tracing session.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-destroy.1.txt b/doc/man/lttng-destroy.1.txt
index bed0a0053e90eb8a735c59eb39829c1fc2ef115b..9792924778ad8dd98f369120d772fa74b98f6190 100644 (file)
--- a/doc/man/lttng-destroy.1.txt
+++ b/doc/man/lttng-destroy.1.txt
@@ -65,7 +65,7 @@ command exits. In other words, it's safe to read them, modify them, move
 them, or remove then.
 
 
 them, or remove then.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-a, option:--all::
 
 
 option:-a, option:--all::


@@ -79,10 +79,13 @@ option:-n, option:--no-wait::
     destroy is valid before exiting.
 
 
     destroy is valid before exiting.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-disable-channel.1.txt b/doc/man/lttng-disable-channel.1.txt
index 9492a390391ab69ac856f115d2d30a1f4688ef56..7f86d6d189c230a884edac478b49e4bd9e95e8d0 100644 (file)
--- a/doc/man/lttng-disable-channel.1.txt
+++ b/doc/man/lttng-disable-channel.1.txt
@@ -37,7 +37,7 @@ channel once its tracing session has ben started (see
 man:lttng-start(1)) at least once.
 
 
 man:lttng-start(1)) at least once.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -58,10 +58,13 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
     instead of the current tracing session.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-disable-event.1.txt b/doc/man/lttng-disable-event.1.txt
index 7ace9d1b4c9ff97814db813e331c493d433f41f6..2f09d3873c71a591ec5879ba5a27daa1e38c86ef 100644 (file)
--- a/doc/man/lttng-disable-event.1.txt
+++ b/doc/man/lttng-disable-event.1.txt
@@ -70,7 +70,7 @@ activity (started or stopped) of its tracing session (see
 man:lttng-start(1) and man:lttng-stop(1)).
 
 
 man:lttng-start(1) and man:lttng-stop(1)).
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -147,10 +147,13 @@ option:-a, option:--all-events::
     condition.
 
 
     condition.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-disable-rotation.1.txt b/doc/man/lttng-disable-rotation.1.txt
index 0fc53afebc6bcc1af10774ff985d997ccc69b1aa..8b68ded7a324589084972b1930aa40ec88ee3bb5 100644 (file)
--- a/doc/man/lttng-disable-rotation.1.txt
+++ b/doc/man/lttng-disable-rotation.1.txt
@@ -31,7 +31,7 @@ See man:lttng-concepts(7) to learn more about the tracing session
 rotation and trace chunk concepts.
 
 
 rotation and trace chunk concepts.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Rotation schedule condition
 
 
 Rotation schedule condition


@@ -52,10 +52,13 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
     instead of the current tracing session.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-enable-channel.1.txt b/doc/man/lttng-enable-channel.1.txt
index 4da752f347451706b5c44a8e57a8564213c75d5f..c16051dfaf446509ba149089a519b7cfcf64e8a2 100644 (file)
--- a/doc/man/lttng-enable-channel.1.txt
+++ b/doc/man/lttng-enable-channel.1.txt
@@ -89,7 +89,7 @@ operations with the `enable-channel` command:
 ====
 
 
 ====
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -345,10 +345,13 @@ option:--kernel and option:--buffers-global options:::
     +{default_metadata_switch_timer}+
 
 
     +{default_metadata_switch_timer}+
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-enable-event.1.txt b/doc/man/lttng-enable-event.1.txt
index 439099b7fb0d2872b4bb2c7afef9a14f34deb4ff..526266fe145cf2ee46db1fe94ca7a01388e6b748 100644 (file)
--- a/doc/man/lttng-enable-event.1.txt
+++ b/doc/man/lttng-enable-event.1.txt
@@ -618,7 +618,7 @@ create it. In particular, with the option:--filter='EXPR' option, 'EXPR'
 must be the exact same string as the one you used on creation.
 
 
 must be the exact same string as the one you used on creation.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -845,10 +845,13 @@ option:-f 'EXPR', option:--filter='EXPR'::
     event payload and current context fields, is _true_.
 
 
     event payload and current context fields, is _true_.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-enable-rotation.1.txt b/doc/man/lttng-enable-rotation.1.txt
index f965ed973e3bb2b1d06c4ef302520a4935b066c1..e9571ca5be4d9f7e20afcf9908063bdc442ed339 100644 (file)
--- a/doc/man/lttng-enable-rotation.1.txt
+++ b/doc/man/lttng-enable-rotation.1.txt
@@ -80,7 +80,7 @@ when it's not currently performing a rotation.
 ====
 
 
 ====
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Rotation schedule condition
 
 
 Rotation schedule condition


@@ -108,10 +108,13 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
     instead of the current tracing session.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-help.1.txt b/doc/man/lttng-help.1.txt
index 3b1d7b50e91d2b464dceedf50d422ebfc248d439..a371a944bc0cb3f155c27fc69b83d6ce74b8e940 100644 (file)
--- a/doc/man/lttng-help.1.txt
+++ b/doc/man/lttng-help.1.txt
@@ -34,13 +34,16 @@ manual page of the command. Override the manual pager path with the
 `LTTNG_MAN_BIN_PATH` environment variable.
 
 
 `LTTNG_MAN_BIN_PATH` environment variable.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-list-triggers.1.txt b/doc/man/lttng-list-triggers.1.txt
index 7d99869f2afc7efcddb936d233aa609f63c3c4ec..f5e469145e8dec39eed88943abd66c21da839a07 100644 (file)
--- a/doc/man/lttng-list-triggers.1.txt
+++ b/doc/man/lttng-list-triggers.1.txt
@@ -23,11 +23,16 @@ properties.
 See man:lttng-concepts(7) to learn more about triggers.
 
 
 See man:lttng-concepts(7) to learn more about triggers.
 
 

-OPTIONS
--------
-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 

-include::common-cmd-footer.txt[]
+
+include::common-lttng-cmd-help-options.txt[]
+
+
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-list.1.txt b/doc/man/lttng-list.1.txt
index 319ec50524887b7f73ac96792609dab78630e823..749d66e3f55d1133cd7f080f1b7f322b2017e694 100644 (file)
--- a/doc/man/lttng-list.1.txt
+++ b/doc/man/lttng-list.1.txt
@@ -92,7 +92,7 @@ session (see man:lttng-concept(7) to learn more) with the
 man:lttng-status(1) command.
 
 
 man:lttng-status(1) command.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -153,10 +153,13 @@ option:--syscall::
     system calls.
 
 
     system calls.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt
index 545bc362890f4caf7486098d8062fdad2791977f..0a6626b96762cbc1b568d0bdcdbdefa80fdca9e8 100644 (file)
--- a/doc/man/lttng-load.1.txt
+++ b/doc/man/lttng-load.1.txt
@@ -72,7 +72,7 @@ sessions: the command fails. Allow the `load` command to overwrite
 existing tracing sessions with the option:--force option.
 
 
 existing tracing sessions with the option:--force option.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-a, option:--all::
 
 
 option:-a, option:--all::


@@ -100,10 +100,13 @@ type of tracing session configurations to load. This option applies to
 _all_ the loaded tracing session configurations.
 
 
 _all_ the loaded tracing session configurations.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt
index 6911f9fb80922e42d7ed80d2d7a616763154b7e2..e2dfde62375146c2ec5cdd47c1cdb29f77a3b74b 100644 (file)
--- a/doc/man/lttng-metadata.1.txt
+++ b/doc/man/lttng-metadata.1.txt
@@ -20,7 +20,7 @@ WARNING: This command is **deprecated**; it's been replaced with
 `lttng regenerate metadata` (see man:lttng-regenerate(1)).
 
 
 `lttng regenerate metadata` (see man:lttng-regenerate(1)).
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-s 'SESSION', option:--session='SESSION'::
 
 
 option:-s 'SESSION', option:--session='SESSION'::


@@ -30,10 +30,13 @@ option:-s 'SESSION', option:--session='SESSION'::
     session).
 
 
     session).
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-regenerate.1.txt b/doc/man/lttng-regenerate.1.txt
index d3f645fc6d9e381066679a9723767a491d0e3e67..cd8f4d7764b4f64dcc303519b46809f6c87c2189 100644 (file)
--- a/doc/man/lttng-regenerate.1.txt
+++ b/doc/man/lttng-regenerate.1.txt
@@ -85,7 +85,7 @@ man:lttng-concepts(7)): in both cases, the state dump information may be
 lost.
 
 
 lost.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-s 'SESSION', option:--session='SESSION'::
 
 
 option:-s 'SESSION', option:--session='SESSION'::


@@ -93,10 +93,13 @@ option:-s 'SESSION', option:--session='SESSION'::
     instead of the current tracing session.
 
 
     instead of the current tracing session.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-remove-trigger.1.txt b/doc/man/lttng-remove-trigger.1.txt
index faf67b2f86d70bede1e18733b3a65965e2a27b1c..016b5271ac0139e1bb47899715c4ba5b05f7b3fe 100644 (file)
--- a/doc/man/lttng-remove-trigger.1.txt
+++ b/doc/man/lttng-remove-trigger.1.txt
@@ -39,10 +39,13 @@ option:--owner-uid='UID'::
 You may only use this option if your Unix user is `root`.
 
 
 You may only use this option if your Unix user is `root`.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-rotate.1.txt b/doc/man/lttng-rotate.1.txt
index 50cb3102b3d2a35ae0335572e31477eb858680e8..29ff3a0d7dc06b0796e5632500f16f3068647c11 100644 (file)
--- a/doc/man/lttng-rotate.1.txt
+++ b/doc/man/lttng-rotate.1.txt
@@ -79,7 +79,7 @@ You may only use the `rotate` command when:
 ====
 
 
 ====
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-n, option:--no-wait::
 
 
 option:-n, option:--no-wait::


@@ -87,10 +87,13 @@ option:-n, option:--no-wait::
     completed before exiting.
 
 
     completed before exiting.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-save.1.txt b/doc/man/lttng-save.1.txt
index 36ef1d673f77edacf0653caa80da652b230e4597..a15a9940818dfd55b20b26c09ca76e51dc049c54 100644 (file)
--- a/doc/man/lttng-save.1.txt
+++ b/doc/man/lttng-save.1.txt
@@ -50,7 +50,7 @@ to overwrite existing tracing session configuration files with the
 option:--force option.
 
 
 option:--force option.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-a, option:--all::
 
 
 option:-a, option:--all::


@@ -69,10 +69,13 @@ option:-o 'DIR', option:--output-path='DIR'::
     `$HOME`).
 
 
     `$HOME`).
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-set-session.1.txt b/doc/man/lttng-set-session.1.txt
index 10f710abe940b24018dd84dd6706ad09d826cee7..21663ddc3095b218ee32bb48db3cc6f1ab245472 100644 (file)
--- a/doc/man/lttng-set-session.1.txt
+++ b/doc/man/lttng-set-session.1.txt
@@ -29,13 +29,16 @@ your Unix user is `root`, within the connected session daemon with the
 man:lttng-list(1) command.
 
 
 man:lttng-list(1) command.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-snapshot.1.txt b/doc/man/lttng-snapshot.1.txt
index 27c1e3d9c41821a9f97068bc3ac368da68b8160d..a65156f9c89c58a43b4e4d224ede10bd6484a2ac 100644 (file)
--- a/doc/man/lttng-snapshot.1.txt
+++ b/doc/man/lttng-snapshot.1.txt
@@ -145,7 +145,7 @@ Set the maximum total size of all the snapshot trace files LTTng writes
 with the option:--max-size option.
 
 
 with the option:--max-size option.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Recording target
 
 
 Recording target


@@ -184,10 +184,13 @@ option:-n 'NAME', option:--name='NAME'::
     Assign the name 'NAME' to the snapshot output.
 
 
     Assign the name 'NAME' to the snapshot output.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-start.1.txt b/doc/man/lttng-start.1.txt
index 9cc721de75eecfb8d2ed769498d4e892ff37c7b0..de90fa05a9bd4a413448cf6d6fe9e0d9c5c1beec 100644 (file)
--- a/doc/man/lttng-start.1.txt
+++ b/doc/man/lttng-start.1.txt
@@ -37,13 +37,16 @@ A `start-session` trigger action can also start a tracing session
 Stop an active tracing session with the man:lttng-stop(1) command.
 
 
 Stop an active tracing session with the man:lttng-stop(1) command.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-status.1.txt b/doc/man/lttng-status.1.txt
index 5f136f1aa606d37e2f46ca2533d6a37ed944c00b..c0d96da0d605949638dd4b8fccb34fa18b62f35d 100644 (file)
--- a/doc/man/lttng-status.1.txt
+++ b/doc/man/lttng-status.1.txt
@@ -28,13 +28,16 @@ This command is equivalent to:
 where `CURSESSION` is the name of the current tracing session.
 
 
 where `CURSESSION` is the name of the current tracing session.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-stop.1.txt b/doc/man/lttng-stop.1.txt
index 4715872fe7efbf10044706d43daa73782ddde494..9b1907c61127910802766bfda37707df476641ed 100644 (file)
--- a/doc/man/lttng-stop.1.txt
+++ b/doc/man/lttng-stop.1.txt
@@ -53,7 +53,7 @@ the tracing session with man:lttng-destroy(1) or perform a rotation with
 man:lttng-rotate(1) to archive it.
 
 
 man:lttng-rotate(1) to archive it.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-n, option:--no-wait::
 
 
 option:-n, option:--no-wait::


@@ -61,10 +61,13 @@ option:-n, option:--no-wait::
     is valid before exiting.
 
 
     is valid before exiting.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-track.1.txt b/doc/man/lttng-track.1.txt
index d2768b12ccd2f6d59ca0a0fb9a5280f38b056d3a..195e07973c5c07153f71866427a7007ba68afa76 100644 (file)
--- a/doc/man/lttng-track.1.txt
+++ b/doc/man/lttng-track.1.txt
@@ -171,7 +171,7 @@ Remove values from an inclusion set with the man:lttng-untrack(1)
 command.
 
 
 command.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -288,10 +288,13 @@ option:-a, option:--all::
     the possible values to the selected inclusion sets.
 
 
     the possible values to the selected inclusion sets.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-untrack.1.txt b/doc/man/lttng-untrack.1.txt
index d00b8921443d012e6b48edc49ecca00343f4efd2..363d8d718f765cce980ba51d49557773a7e36d23 100644 (file)
--- a/doc/man/lttng-untrack.1.txt
+++ b/doc/man/lttng-untrack.1.txt
@@ -118,7 +118,7 @@ Inclusion set:
 -------------------------------
 
 
 -------------------------------
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 Tracing domain
 
 
 Tracing domain


@@ -236,10 +236,13 @@ option:-a, option:--all::
     selected inclusion sets.
 
 
     selected inclusion sets.
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-version.1.txt b/doc/man/lttng-version.1.txt
index 5cc7b3c54a899635130e470f059caf4be95e0842..35750d014d151bd1560b05746067ecf1114f495c 100644 (file)
--- a/doc/man/lttng-version.1.txt
+++ b/doc/man/lttng-version.1.txt
@@ -29,13 +29,16 @@ The output of the `version` command shows:
 * The license information.
 
 
 * The license information.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng-view.1.txt b/doc/man/lttng-view.1.txt
index afb39fe0a349869683fefd0632015459eb915091..15465c9db42e50e98ef315848bc4dcd108e43b8e 100644 (file)
--- a/doc/man/lttng-view.1.txt
+++ b/doc/man/lttng-view.1.txt
@@ -39,7 +39,7 @@ if it's not available, man:babeltrace(1). Override which trace reader to
 launch with the option:--viewer option.
 
 
 launch with the option:--viewer option.
 
 

-include::common-cmd-options-head.txt[]
+include::common-lttng-cmd-options-head.txt[]

 
 
 option:-t 'DIR', option:--trace-path='DIR'::
 
 
 option:-t 'DIR', option:--trace-path='DIR'::


@@ -57,10 +57,13 @@ Without this option, the `view` command uses man:babeltrace2(1) if it's
 available. Otherwise, it tries to use man:babeltrace(1).
 
 
 available. Otherwise, it tries to use man:babeltrace(1).
 
 

-include::common-cmd-help-options.txt[]
+include::common-lttng-cmd-help-options.txt[]

 
 
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO

diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt
index 1b5d5ee31c996a699ad4024c176f81e5520e3b4f..0f8f24b9c553bdb53760e6e093af0f7a4aae3c64 100644 (file)
--- a/doc/man/lttng.1.txt
+++ b/doc/man/lttng.1.txt
@@ -245,7 +245,10 @@ Miscellaneous
 |===
 
 
 |===
 
 

-include::common-cmd-footer.txt[]
+include::common-lttng-cmd-after-options.txt[]
+
+
+include::common-footer.txt[]

 
 
 SEE ALSO
 
 
 SEE ALSO