Add an lttng-metadata man page
[lttng-tools.git] / doc / man / lttng-metadata.1.txt
1 lttng-metadata(1)
2 =================
3
4
5 NAME
6 ----
7 lttng-metadata - Manage an LTTng tracing session's metadata generation
8
9
10 SYNOPSIS
11 --------
12 [verse]
13 *lttng* ['GENERAL OPTIONS'] *metadata regenerate* [option:--session='SESSION']
14
15
16 DESCRIPTION
17 -----------
18 The `lttng metadata` command manages a tracing session's metadata
19 generation options.
20
21 As of this version, only the `regenerate` command's action is available.
22 Regenerating a tracing session's metadata can be used to
23 resample the offset between the system's monotonic clock and
24 the wall-clock time.
25
26 This command is meant to be used to resample the wall-clock time
27 following a major
28 link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP]
29 correction. As such, a system booting with an incorrect wall time can be
30 traced before its wall time is NTP-corrected. Regenerating the tracing
31 session's metadata ensures that trace viewers can accurately determine
32 the events time relative to Unix Epoch.
33
34
35 include::common-cmd-options-head.txt[]
36
37
38 option:-s, option:--session='SESSION'::
39 Manage the metadata generation of the tracing session named 'SESSION'
40 instead of the current tracing session.
41
42
43 include::common-cmd-help-options.txt[]
44
45
46 LIMITATIONS
47 -----------
48 The `lttng metadata regenerate` command can only be used on kernel and
49 user space tracing sessions (using per-user buffering), in non-live
50 mode.
51
52 See linklttng:lttng-enable-channel(1) for more information about
53 buffering schemes and linklttng:lttng-create(1) for more information
54 about the different tracing session modes.
55
56
57 include::common-cmd-footer.txt[]
58
59
60 SEE ALSO
61 --------
62 linklttng:lttng(1)
This page took 0.043139 seconds and 4 git commands to generate.