lttng-save(1): add usage examples

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

lttng-save(1)
=============
:revdate: 17 May 2021


NAME
----
lttng-save - Save LTTng tracing session configurations


SYNOPSIS
--------
[verse]
*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='DIR']
      [option:--all | 'SESSION']


DESCRIPTION
-----------
The `lttng save` command saves to files the configurations of:

With the 'SESSION' argument::
	The tracing session named 'SESSION'.

Without the 'SESSION' argument::
    Implicit option:--all option: *all* the tracing sessions of the
    connected session daemon for your Unix user, or for all users if
    your Unix user is `root`, as listed in the output of `lttng list`
    (see man:lttng-list(1)).
+
See the ``Session daemon connection'' section of man:lttng(1) to learn
how a user application connects to a session daemon.

See man:lttng-concepts(7) to learn more about tracing sessions.

Use the `save` command in conjunction with the man:lttng-load(1) command
to save and restore the complete configurations of tracing sessions.

The `save` command does :not: save tracing data, only the tracing
session parameters, including the channel and recording event rule
configurations.

The default output directory path is `$LTTNG_HOME/.lttng/sessions`
(`$LTTNG_HOME` defaults to `$HOME`). Override the default output
directory path with the option:--output-path option. Each tracing
session configuration file is named __SNAME__++.lttng++,
where{nbsp}__SNAME__ is the original tracing session name.

By default, the `save` command does :not: overwrite existing tracing
session configuration files: the command fails. Allow the `save` command
to overwrite existing tracing session configuration files with the
option:--force option.

See the <<examples,EXAMPLES>> section below for usage examples.


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


option:-a, option:--all::
    Save all the tracing session configurations of your Unix user, or of
    all users if your Unix user is `root`, as listed in the output of
    man:lttng-list(1), instead of the current tracing session or the
    tracing session named 'SESSION'.

option:-f, option:--force::
    Overwrite existing tracing session configuration files when
    saving.

option:-o 'DIR', option:--output-path='DIR'::
    Save tracing session configuration files to the directory 'DIR'
    instead of `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to
    `$HOME`).


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


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


[[examples]]
EXAMPLES
--------
.Save all the tracing session configurations to the default output directory.
====
[role="term"]
----
$ lttng save
----
====

.Save a specific tracing session configuration to a specific output directory.
====
See the option:--output-path option.

[role="term"]
----
$ lttng save my-session --output-path=/path/to/sessions
----
====

.Allow LTTng to overwrite existing tracing session configuration files when saving.
====
See the option:--force option.

[role="term"]
----
$ lttng save --force
----
====


include::common-footer.txt[]


SEE ALSO
--------
man:lttng(1),
man:lttng-load(1),
man:lttng-concepts(7)