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