doc/man: lttng(1): update and standardize content
[lttng-tools.git] / doc / man / lttng-crash.1
1 .TH "LTTNG-CRASH" "1" "March 26th, 2015" "" ""
2
3 .SH "NAME"
4 lttng-crash \- LTTng Crash Trace Viewer
5
6 .SH "SYNOPSIS"
7
8 .PP
9 lttng-crash [OPTIONS] FILE
10 .SH "DESCRIPTION"
11
12 .PP
13 The LTTng project aims at providing highly efficient tracing tools for Linux.
14 Its tracers help track down performance issues and debug problems involving
15 multiple concurrent processes and threads. Tracing across multiple systems
16 is also possible.
17
18 The \fBlttng-crash\fP command line tool, part of the lttng-tools package, is used to
19 view or recover trace buffers in the event of a crash.
20 .SH "OPTIONS"
21
22 .PP
23 This program follows the usual GNU command line syntax with long options starting with
24 two dashes. Below is a summary of the available options.
25 .PP
26
27 .TP
28 .BR "\-h, \-\-help"
29 Show summary of possible options and commands.
30 .TP
31 .BR "\-V, \-\-version"
32 Show version.
33 .TP
34 .BR "\-v, \-\-verbose"
35 Increase verbosity.
36 Three levels of verbosity are available which are triggered by putting additional v to
37 the option (\-vv or \-vvv)
38 .TP
39 .BR "\-e, \-\-viewer NAME"
40 Specify viewer and/or options to use. This will completely override the default
41 viewers therefore make sure to specify the full command. The trace directory paths are
42 appended at the end to the arguments. (defaults: babeltrace)
43 .TP
44 .BR "\-x, \-\-extract PATH"
45 Extract trace(s) to the specified path. Don't display the trace.
46
47 .SH "SEE ALSO"
48 .BR babeltrace(1),
49 .BR lttng(1),
50 .BR lttng-ust(3),
51 .BR lttng-sessiond(8),
52 .BR lttng-relayd(8),
53
54 .SH "BUGS"
55
56 .PP
57 If you encounter any issues or usability problem, please report it on our
58 mailing list <lttng-dev@lists.lttng.org> to help improve this project or
59 at https://bugs.lttng.org which is a bug tracker.
60 .PP
61
62 .SH "CREDITS"
63
64 .PP
65 lttng is distributed under the GNU General Public License version 2. See the file
66 COPYING for details.
67 .PP
68 A Web site is available at http://lttng.org for more information on the LTTng
69 project.
70 .PP
71 You can also find our git tree at http://git.lttng.org.
72 .PP
73 Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
74 .PP
75 You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
76 .PP
77 .SH "AUTHORS"
78
79 .PP
80 lttng-crash was originally written by Mathieu Desnoyers. It is currently
81 maintained by Jérémie Galarneau <jeremie.galarneau@efficios.com>.
82 .PP
This page took 0.030241 seconds and 4 git commands to generate.