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