From: David Goulet Date: Thu, 11 Jul 2013 20:46:14 +0000 (-0400) Subject: Update man page with snapshot command X-Git-Tag: v2.3.0-rc1~41 X-Git-Url: https://git.lttng.org/?a=commitdiff_plain;h=b872baea3c26766331255b40ca7f9a9ad31e4ea6;hp=8692d4e5805da0104c690972bb96b60b8cb52685;p=lttng-tools.git Update man page with snapshot command Signed-off-by: David Goulet --- diff --git a/doc/man/lttng.1 b/doc/man/lttng.1 index 72454f0d3..484b365b4 100644 --- a/doc/man/lttng.1 +++ b/doc/man/lttng.1 @@ -595,6 +595,66 @@ Will change the session name in the .lttngrc file. .IP +.IP "\fBsnapshot\fP ACTION" +.nf +Snapshot command for LTTng session. +.fi + +.B OPTIONS: + +.nf +\-h, \-\-help + Show summary of possible options and commands. +\-\-list-options + Simple listing of options +.fi + +.B ACTION: + +.nf +\fBadd-output\fP [-m ] [-s ] [-n ] | -C -D + +Setup and add an snapshot output for a session. Output are the destination +where the snapshot will be sent. Only one output is permitted. To change it, +you'll need to delete it and add back the new one. + +\fBdel-output\fP ID | NAME [-s ] + +Delete an output for a session using the ID. You can either specify the +output's ID that can be found with list-output or the name. + +\fBlist-output\fP [-s ] + +List the output of a session. Attributes of the output are printed. + +\fBrecord\fP [-m ] [-s ] [-n ] [ | -C -D ] + +Snapshot a session's buffer(s) for all domains. If an URL is specified, it is +used instead of a previously added output. Specifying only a name or/and a max +size will override the current output values. For instance, you can record a +snapshot with a custom maximum size or with a different name. + +$ lttng add-output -n mysnapshot file:///data/snapshot +[...] +$ lttng snapshot record -n new_name_snapshot + +The above will create a snapshot in /data/snapshot/new_name_snapshot* directory +rather then in mysnapshot*/ +.fi + +.B LONG OPTIONS + +.nf +\-s, \-\-session NAME Apply to session name. +\-n, \-\-name NAME Name of the snapshot's output. +\-m, \-\-max-size SIZE Maximum size in bytes of the snapshot. + The maxium size does not count the metadata file. +\-C, \-\-ctrl-url URL Set control path URL. (Must use -D also) +\-D, \-\-data-url URL Set data path URL. (Must use -C also) +.fi + +.IP + .IP "\fBstart\fP [NAME] [OPTIONS]" .nf Start tracing