doc/man/lttng-load.1.txt

   1 lttng-load(1)
   2 =============
   3
   4
   5 NAME
   6 ----
   7 lttng-load - Load LTTng tracing session configurations
   8
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH']
  14       [option:--override-url='URL'] ['SESSION' [option:--override-name='NAME']]
  15
  16
  17 DESCRIPTION
  18 -----------
  19 The `lttng load` command loads the configurations of one or more
  20 tracing sessions from files.
  21
  22 The `lttng load` command is used in conjunction with the
  23 man:lttng-save(1) command to save and restore the complete
  24 configurations of tracing sessions. This includes the enabled channels
  25 and event rules, the context added to channels, the tracing activity,
  26 and more.
  27
  28 Once one or more tracing session configurations are loaded, they appear
  29 exactly as they were saved from the user's point of view.
  30
  31 The following directories are searched, non-recursively, in this order
  32 for configuration files:
  33
  34 . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`)
  35 . +{system_sessions_dir}+
  36
  37 The input path can be overridden with the option:--input-path option.
  38 When this option is specified, the default directories are :not:
  39 searched for configuration files. When it's not specified, _both_
  40 default directories are searched for configuration files.
  41
  42 If the input path is a *directory*, then:
  43
  44 * If 'SESSION' is specified, the tracing session configuration named
  45   'SESSION' is searched for in all the files of this directory and
  46   loaded if found.
  47 * If 'SESSION' is not specified, the option:--all option is implicit:
  48   all the tracing session configurations found in all the files in this
  49   directory are loaded.
  50
  51 If the input path is a *file*, then:
  52
  53 * If 'SESSION' is specified, the tracing session configuration named
  54   'SESSION' is searched for in this file and loaded if found.
  55 * If 'SESSION' is not specified, the option:--all option is implicit:
  56   all the tracing session configurations found in this file are loaded.
  57
  58 Aspects of the loaded configurations can be overridden at load time
  59 using the option:--override-url and option:--override-name options.
  60
  61 By default, existing tracing sessions are not overwritten when loading:
  62 the command fails. The option:--force option can be used to allow this.
  63
  64
  65 include::common-cmd-options-head.txt[]
  66
  67
  68 option:-a, option:--all::
  69     Load all tracing session configurations (default).
  70
  71 option:-f, option:--force::
  72     Overwrite existing tracing sessions when loading.
  73
  74 option:-i 'PATH', option:--input-path='PATH'::
  75     Load tracing session configurations from 'PATH', either a directory
  76     or a file, instead of loading them from the default search
  77     directories.
  78
  79 option:--override-name='NAME'::
  80     Override the name of the loaded tracing session configuration,
  81     'SESSION', with 'NAME'.
  82 +
  83 You must specify a tracing session name to load ('SESSION') and :not:
  84 use the option:--all option when using this option.
  85
  86 option:--override-url='URL'::
  87     Override the URL of the loaded tracing session configurations
  88     with 'URL'.
  89 +
  90 This is the equivalent of the nloption:--set-url option of
  91 man:lttng-create(1). The validity of the URL override depends on the
  92 type of tracing session configurations to load. This option applies to
  93 _all_ the loaded tracing session configurations.
  94
  95
  96 include::common-cmd-help-options.txt[]
  97
  98
  99 include::common-cmd-footer.txt[]
 100
 101
 102 SEE ALSO
 103 --------
 104 man:lttng-save(1),
 105 man:lttng(1)