From 1153307429aaf4fad932e72d13b44befce51c7be Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=A9mie=20Galarneau?= Date: Fri, 18 Mar 2016 12:04:18 -0400 Subject: [PATCH] Add an lttng-metadata man page MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérémie Galarneau --- doc/man/Makefile.am | 3 +- doc/man/lttng-metadata.1.txt | 62 ++++++++++++++++++++++++++++++++++++ doc/man/lttng.1.txt | 3 ++ 3 files changed, 67 insertions(+), 1 deletion(-) create mode 100644 doc/man/lttng-metadata.1.txt diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index bb0772fb3..f3afa448f 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -30,7 +30,8 @@ MAN1_NAMES = \ lttng-snapshot \ lttng-enable-event \ lttng-disable-event \ - lttng-crash + lttng-crash \ + lttng-metadata MAN3_NAMES = MAN8_NAMES = lttng-sessiond lttng-relayd MAN1_NO_ASCIIDOC_NAMES = diff --git a/doc/man/lttng-metadata.1.txt b/doc/man/lttng-metadata.1.txt new file mode 100644 index 000000000..a146c9324 --- /dev/null +++ b/doc/man/lttng-metadata.1.txt @@ -0,0 +1,62 @@ +lttng-metadata(1) +================= + + +NAME +---- +lttng-metadata - Manage an LTTng tracing session's metadata generation + + +SYNOPSIS +-------- +[verse] +*lttng* ['GENERAL OPTIONS'] *metadata regenerate* [option:--session='SESSION'] + + +DESCRIPTION +----------- +The `lttng metadata` command manages a tracing session's metadata +generation options. + +As of this version, only the `regenerate` command's action is available. +Regenerating a tracing session's metadata can be used to +resample the offset between the system's monotonic clock and +the wall-clock time. + +This command is meant to be used to resample the wall-clock time +following a major +link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] +correction. As such, a system booting with an incorrect wall time can be +traced before its wall time is NTP-corrected. Regenerating the tracing +session's metadata ensures that trace viewers can accurately determine +the events time relative to Unix Epoch. + + +include::common-cmd-options-head.txt[] + + +option:-s, option:--session='SESSION':: + Manage the metadata generation of the tracing session named 'SESSION' + instead of the current tracing session. + + +include::common-cmd-help-options.txt[] + + +LIMITATIONS +----------- +The `lttng metadata regenerate` command can only be used on kernel and +user space tracing sessions (using per-user buffering), in non-live +mode. + +See linklttng:lttng-enable-channel(1) for more information about +buffering schemes and linklttng:lttng-create(1) for more information +about the different tracing session modes. + + +include::common-cmd-footer.txt[] + + +SEE ALSO +-------- +linklttng:lttng(1) diff --git a/doc/man/lttng.1.txt b/doc/man/lttng.1.txt index a737e11f3..902d8a7e6 100644 --- a/doc/man/lttng.1.txt +++ b/doc/man/lttng.1.txt @@ -150,6 +150,9 @@ linklttng:lttng-create(1):: linklttng:lttng-destroy(1):: Tear down tracing sessions. +linklttng:lttng-metadata(1):: + Manage an LTTng tracing session's metadata generation. + linklttng:lttng-save(1):: Save tracing session configurations. -- 2.34.1