Docs: add lttng-crash(1) man page
authorJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 26 Mar 2015 21:37:07 +0000 (17:37 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Thu, 26 Mar 2015 22:08:25 +0000 (18:08 -0400)
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/Makefile.am
doc/man/lttng-crash.1 [new file with mode: 0644]

index d91a91a8822675664c865b8a5ab9a64225d530bd..4234fb804d3375058708d74b9fdde10947931ce3 100644 (file)
@@ -1,2 +1,2 @@
-dist_man1_MANS = lttng.1
+dist_man1_MANS = lttng.1 lttng-crash.1
 dist_man8_MANS = lttng-sessiond.8 lttng-relayd.8
diff --git a/doc/man/lttng-crash.1 b/doc/man/lttng-crash.1
new file mode 100644 (file)
index 0000000..4af93f3
--- /dev/null
@@ -0,0 +1,82 @@
+.TH "LTTNG-CRASH" "1" "March 26th, 2015" "" ""
+
+.SH "NAME"
+lttng-crash \(em LTTng Crash Trace Viewer
+
+.SH "SYNOPSIS"
+
+.PP
+lttng-crash [OPTIONS] FILE
+.SH "DESCRIPTION"
+
+.PP
+The LTTng project aims at providing highly efficient tracing tools for Linux.
+Its tracers help track down performance issues and debug problems involving
+multiple concurrent processes and threads. Tracing across multiple systems
+is also possible.
+
+The \fBlttng-crash\fP command line tool, part of the lttng-tools package, is used to
+view or recover trace buffers in the event of a crash.
+.SH "OPTIONS"
+
+.PP
+This program follows the usual GNU command line syntax with long options starting with
+two dashes. Below is a summary of the available options.
+.PP
+
+.TP
+.BR "\-h, \-\-help"
+Show summary of possible options and commands.
+.TP
+.BR "\-V, \-\-version"
+Show version.
+.TP
+.BR "\-v, \-\-verbose"
+Increase verbosity.
+Three levels of verbosity are available which are triggered by putting additional v to
+the option (\-vv or \-vvv)
+.TP
+.BR "\-e, \-\-viewer NAME"
+Specify viewer and/or options to use. This will completely override the default
+viewers therefore make sure to specify the full command. The trace directory paths are
+appended at the end to the arguments. (defaults: babeltrace)
+.TP
+.BR "\-x, \-\-extract PATH"
+Extract trace(s) to the specified path. Don't display the trace.
+
+.SH "SEE ALSO"
+.BR babeltrace(1),
+.BR lttng(1),
+.BR lttng-ust(3),
+.BR lttng-sessiond(8),
+.BR lttng-relayd(8),
+
+.SH "BUGS"
+
+.PP
+If you encounter any issues or usability problem, please report it on our
+mailing list <lttng-dev@lists.lttng.org> to help improve this project or
+at https://bugs.lttng.org which is a bug tracker.
+.PP
+
+.SH "CREDITS"
+
+.PP
+lttng is distributed under the GNU General Public License version 2. See the file
+COPYING for details.
+.PP
+A Web site is available at http://lttng.org for more information on the LTTng
+project.
+.PP
+You can also find our git tree at http://git.lttng.org.
+.PP
+Mailing lists for support and development: <lttng-dev@lists.lttng.org>.
+.PP
+You can find us on IRC server irc.oftc.net (OFTC) in #lttng.
+.PP
+.SH "AUTHORS"
+
+.PP
+lttng-crash was originally written by Mathieu Desnoyers. It is currently
+maintained by Jérémie Galarneau <jeremie.galarneau@efficios.com>.
+.PP
This page took 0.034039 seconds and 4 git commands to generate.