Docs: remove invalid short option -U and move option descriptions
[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--------
dbcf3dd3 12Regenerate the metadata of a session:
eded6438
JD
13
14[verse]
15*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate metadata* [option:--session='SESSION']
16
dbcf3dd3
JD
17Regenerate the state dump of a session:
18
19[verse]
20*lttng* ['linkgenoptions:(GENERAL OPTIONS)'] *regenerate statedump* [option:--session='SESSION']
21
eded6438
JD
22DESCRIPTION
23-----------
dbcf3dd3
JD
24The `lttng regenerate` command regenerates specific data of a tracing session.
25
26As of this version, the `metadata` and `statedump` actions are
27available.
28
29
30Regenerating a tracing session's metadata
31~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
32The `lttng regenerate metadata` action can be used to resample the offset
33between the system's monotonic clock and the wall-clock time.
34
35This action is meant to be used to resample the wall-clock time following a
36major link:https://en.wikipedia.org/wiki/Network_Time_Protocol[NTP] correction.
37As such, a system booting with an incorrect wall time can be traced before its
38wall time is NTP-corrected. Regenerating the tracing session's metadata ensures
39that trace viewers can accurately determine the events time relative to Unix
40Epoch.
eded6438 41
eded6438 42
dbcf3dd3
JD
43Regenerating a tracing session's state dump
44~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45The `lttng regenerate statedump` action can be used to collect up-to-date state
46dump information during the tracing session. This is particularly useful in
47snapshot (see man:lttng-snapshot(1)) or trace file rotation (see
48man:lttng-enable-channel(1)) modes where the state dump information may be
49lost.
eded6438
JD
50
51
52include::common-cmd-options-head.txt[]
53
54
55option:-s, option:--session='SESSION'::
dbcf3dd3 56 Regenerate the data of the tracing session named 'SESSION'
eded6438
JD
57 instead of the current tracing session.
58
59
60include::common-cmd-help-options.txt[]
61
62
63LIMITATIONS
64-----------
65The `lttng regenerate metadata` command can only be used on kernel and
66user space tracing sessions (using per-user buffering), in non-live
67mode.
68
69See man:lttng-enable-channel(1) for more information about
70buffering schemes and man:lttng-create(1) for more information
71about the different tracing session modes.
72
73
74include::common-cmd-footer.txt[]
75
76
77SEE ALSO
78--------
79man:lttng(1)
This page took 0.025272 seconds and 4 git commands to generate.