[lttng-dev] [PATCH lttng-tools] Docs: Add load and save sections to the lttng.1 man page

[David Goulet]

Merged with minor modifications.

David

On 13 May (12:14:10), Jérémie Galarneau wrote:
> Signed-off-by: Jérémie Galarneau <jeremie.galarneau at efficios.com>
> ---
>  doc/man/lttng.1 | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 60 insertions(+)
> 
> diff --git a/doc/man/lttng.1 b/doc/man/lttng.1
> index 9f95a8a..d49a5b2 100644
> --- a/doc/man/lttng.1
> +++ b/doc/man/lttng.1
> @@ -736,6 +736,60 @@ List available domain(s)
>  .PP
>  
>  .PP
> +\fBload\fP [OPTIONS] [NAME]
> +.RS
> +Load tracing session configuration
> +
> +If NAME is omitted, all session configurations found in both the user's session
> +configuration directory and the system session configuration directory will be
> +loaded.
> +
> +.B OPTIONS:
> +
> +.TP
> +.BR "\-h, \-\-help"
> +Show summary of possible options and commands.
> +.TP
> +.BR "\-a, \-\-all"
> +Load all session configurations (default).
> +.TP
> +.BR "\-i, \-\-input-path PATH"
> +Specify the input path for session configurations.
> +.TP
> +.BR "\-f, -\-force"
> +Overwrite current session configuration(s) if a session of the same name already
> +exists.
> +.RE
> +.PP
> +
> +.PP
> +\fBsave\fP [OPTIONS] [SESSION]
> +.RS
> +Save tracing session configuration
> +
> +If SESSION is omitted, all session configurations will be saved to
> +individual \fB.lttng\fP files under the user's session configuration directory.
> +The default session configuration file naming scheme is \fBSESSION.lttng\fP.
> +
> +.B OPTIONS:
> +
> +.TP
> +.BR "\-h, \-\-help"
> +Show summary of possible options and commands.
> +.TP
> +.BR "\-a, \-\-all"
> +Save all session configurations (default).
> +.TP
> +.BR "\-o, \-\-output-path PATH"
> +Specify the output path for session configurations (defaults to
> +~/.lttng/sessions/).
> +.TP
> +.BR "\-f, -\-force"
> +Overwrite session configuration files if names clash.
> +.RE
> +.PP
> +
> +.PP
>  \fBset-session\fP NAME [OPTIONS]
>  .RS
>  Set current session name
> @@ -980,6 +1034,12 @@ Allows one to specify the full session daemon binary path to lttng command line
>  tool. You can also use \-\-sessiond-path option having the same effect.
>  .PP
>  
> +.PP
> +.IP "LTTNG_SESSION_CONFIG_XSD_PATH"
> +Set the path in which the \fBsession.xsd\fP session configuration schema may be
> +found.
> +.PP
> +
>  .SH "SEE ALSO"
>  .BR babeltrace(1),
>  .BR lttng-ust(3),
> -- 
> 1.9.2
> 
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 603 bytes
Desc: Digital signature
URL: <http://lists.lttng.org/pipermail/lttng-dev/attachments/20140513/771f9b91/attachment.sig>