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