X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=doc%2Fman%2Flttng-load.1.txt;h=f5cc3e203c116ed6fb29cb751d5c58151913ceec;hb=26f0c7794376456fcb5b13d4eae91c0ccf0dfe66;hp=10f893e5370daf0b0623584258053ea241d89672;hpb=e1f481f68598431b2b9eca264a2ec0c7f5aea686;p=lttng-tools.git diff --git a/doc/man/lttng-load.1.txt b/doc/man/lttng-load.1.txt index 10f893e53..f5cc3e203 100644 --- a/doc/man/lttng-load.1.txt +++ b/doc/man/lttng-load.1.txt @@ -1,5 +1,6 @@ lttng-load(1) ============= +:revdate: 30 April 2021 NAME @@ -11,7 +12,7 @@ SYNOPSIS -------- [verse] *lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *load* [option:--force] [option:--input-path='PATH'] - [option:--override-url='URL'] [option:--override-name='NAME'] ['SESSION'] + [option:--override-url='URL'] [option:--all | 'SESSION' [option:--override-name='NAME']] DESCRIPTION @@ -19,75 +20,85 @@ DESCRIPTION The `lttng load` command loads the configurations of one or more tracing sessions from files. -The `lttng load` command is used in conjunction with the -man:lttng-save(1) command to save and restore the complete -configurations of tracing sessions. This includes the enabled channels -and event rules, the context added to channels, the tracing activity, -and more. +See man:lttng-concepts(7) to learn more about tracing sessions. -Once one or more tracing session configurations are loaded, they appear +Use the `load` command in conjunction with the man:lttng-save(1) command +to save and restore the complete configurations of tracing sessions. A +tracing session configuration includes the enabled channels and +recording event rules, the context fields to be recorded, the tracing +activity, and more. + +Once LTTng loads one or more tracing session configurations, they appear exactly as they were saved from the user's point of view. -The following directories are searched, non-recursively, in this order -for configuration files: +LTTng searches the following directories, non-recursively, in this order +for tracing session configuration files: . `$LTTNG_HOME/.lttng/sessions` (`$LTTNG_HOME` defaults to `$HOME`) . +{system_sessions_dir}+ -The input path can be overridden with the option:--input-path option. -When this option is specified, the default directories are :not: -searched for configuration files. When it's not specified, _both_ -default directories are searched for configuration files. - -If the input path is a *directory*, then: +Override the input path with the option:--input-path='PATH' option. With +this option, LTTng does :not: search the default directories above. +'PATH' can be the path of one of: -* If 'SESSION' is specified, the tracing session configuration named - 'SESSION' is searched for in all the files of this directory and - loaded if found. -* If 'SESSION' is not specified, the option:--all option is implicit: - all the tracing session configurations found in all the files in this - directory are loaded. +A directory:: + With the 'SESSION' argument::: + LTTng searches for the tracing session configuration named + 'SESSION' in all the files of the directory 'PATH' and loads it + if found. -If the input path is a *file*, then: + Without the 'SESSION' argument::: + The option:--all option is implicit: LTTng loads all the tracing + session configurations found in all the files in the directory + 'PATH'. -* If 'SESSION' is specified, the tracing session configuration named - 'SESSION' is searched for in this file and loaded if found. -* If 'SESSION' is not specified, the option:--all option is implicit: - all the tracing session configurations found in this file are loaded. +A file:: + With the 'SESSION' argument::: + LTTng searches for the tracing session configuration named + 'SESSION' in the file 'PATH' and loads it if found. -Aspects of the loaded configurations can be overridden at load time. + Without the 'SESSION' argument::: + The option:--all option is implicit: LTTng loads all the tracing + session configurations found in the file 'PATH'. -option:--override-url:: - Provides the equivalent of the option:--set-url option - of the (1)lttng-create command. The validity of the url override is - dependant on the type of session(s) to be loaded. Refer to (1)lttng-create for - the accepted URL format. +Override the output URL of the loaded tracing session configurations +with the option:--override-url option. -option:--override-name:: - Set the session name to NAME. This option is invalid in combination with - the --all option. +With the 'SESSION' argument, override the name of the loaded tracing +session configuration with the option:--override-name option. -By default, existing tracing sessions are not overwritten when loading: -the command fails. The option:--force option can be used to allow this. +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. include::common-cmd-options-head.txt[] option:-a, option:--all:: - Load all tracing session configurations (default). + Load all the tracing session configurations (default). option:-f, option:--force:: Overwrite existing tracing sessions when loading. -option:-i, option:--input-path='PATH':: +option:-i 'PATH', option:--input-path='PATH':: Load tracing session configurations from 'PATH', either a directory or a file, instead of loading them from the default search directories. -option:-U, option:--override-url='URL':: - Load tracing session configurations and apply an url override - while loading. Applies to all sessions loaded. +option:--override-name='NAME':: + Override the name of the loaded tracing session configuration, + 'SESSION', with 'NAME'. + +option:--override-url='URL':: + Override the output URL of the loaded tracing session configurations + with 'URL'. ++ +This is the equivalent of the nloption:--set-url option of +man:lttng-create(1). The validity of the URL override depends on the +type of tracing session configurations to load. This option applies to +_all_ the loaded tracing session configurations. + include::common-cmd-help-options.txt[] @@ -97,5 +108,6 @@ include::common-cmd-footer.txt[] SEE ALSO -------- -man:lttng-save(1), -man:lttng(1) +man:lttng(1), +man:lttng-concepts(7), +man:lttng-save(1)