doc/man/lttng-save.1.txt

   1 lttng-save(1)
   2 =============
   3 :revdate: 12 May 2021
   4
   5
   6 NAME
   7 ----
   8 lttng-save - Save LTTng tracing session configurations
   9
  10
  11 SYNOPSIS
  12 --------
  13 [verse]
  14 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *save* [option:--force] [option:--output-path='DIR']
  15       [option:--all | 'SESSION']
  16
  17
  18 DESCRIPTION
  19 -----------
  20 The `lttng save` command saves to files the configurations of:
  21
  22 With the 'SESSION' argument::
  23         The tracing session named 'SESSION'.
  24
  25 Without the 'SESSION' argument::
  26     Implicit option:--all option: *all* the tracing sessions of the
  27     connected session daemon for your Unix user, or for all users if
  28     your Unix user is `root`, as listed in the output of `lttng list`
  29     (see man:lttng-list(1)).
  30 +
  31 See the ``Session daemon connection'' section of man:lttng(1) to learn
  32 how a user application connects to a session daemon.
  33
  34 See man:lttng-concepts(7) to learn more about tracing sessions.
  35
  36 Use the `save` command in conjunction with the man:lttng-load(1) command
  37 to save and restore the complete configurations of tracing sessions.
  38
  39 The `save` command does :not: save tracing data, only the tracing
  40 session parameters, including the channel and recording event rule
  41 configurations.
  42
  43 The default output directory path is `$LTTNG_HOME/.lttng/sessions`
  44 (`$LTTNG_HOME` defaults to `$HOME`). Override the default output
  45 directory path with the option:--output-path option. Each tracing
  46 session configuration file is named __SNAME__++.lttng++,
  47 where{nbsp}__SNAME__ is the original tracing session name.
  48
  49 By default, the `save` command does :not: overwrite existing tracing
  50 session configuration files: the command fails. Allow the `save` command
  51 to overwrite existing tracing session configuration files with the
  52 option:--force option.
  53
  54
  55 include::common-lttng-cmd-options-head.txt[]
  56
  57
  58 option:-a, option:--all::
  59     Save all the tracing session configurations of your Unix user, or of
  60     all users if your Unix user is `root`, as listed in the output of
  61     man:lttng-list(1), instead of the current tracing session or the
  62     tracing session named 'SESSION'.
  63
  64 option:-f, option:--force::
  65     Overwrite existing tracing session configuration files when
  66     saving.
  67
  68 option:-o 'DIR', option:--output-path='DIR'::
  69     Save tracing session configuration files to the directory 'DIR'
  70     instead of `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to
  71     `$HOME`).
  72
  73
  74 include::common-lttng-cmd-help-options.txt[]
  75
  76
  77 include::common-lttng-cmd-after-options.txt[]
  78
  79
  80 include::common-footer.txt[]
  81
  82
  83 SEE ALSO
  84 --------
  85 man:lttng(1),
  86 man:lttng-load(1),
  87 man:lttng-concepts(7)