doc/man: convert lttng-crash(1) to AsciiDoc
authorPhilippe Proulx <eeppeliteloop@gmail.com>
Sat, 5 Mar 2016 03:19:13 +0000 (22:19 -0500)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 18 Mar 2016 01:53:02 +0000 (21:53 -0400)
Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
doc/man/Makefile.am
doc/man/lttng-crash.1 [deleted file]
doc/man/lttng-crash.1.txt [new file with mode: 0644]

index 73e9e239bf00ff996917a14ca2912f769ef0022e..98d37caa3c9ce56195b2ca8287fa015d50a59341 100644 (file)
@@ -29,10 +29,11 @@ MAN1_NAMES = \
        lttng-help \
        lttng-snapshot \
        lttng-enable-event \
-       lttng-disable-event
+       lttng-disable-event \
+       lttng-crash
 MAN3_NAMES =
 MAN8_NAMES = lttng-sessiond
-MAN1_NO_ASCIIDOC_NAMES = lttng-crash
+MAN1_NO_ASCIIDOC_NAMES =
 MAN3_NO_ASCIIDOC_NAMES =
 MAN8_NO_ASCIIDOC_NAMES = lttng-relayd
 
diff --git a/doc/man/lttng-crash.1 b/doc/man/lttng-crash.1
deleted file mode 100644 (file)
index 8097108..0000000
+++ /dev/null
@@ -1,82 +0,0 @@
-.TH "LTTNG-CRASH" "1" "March 26th, 2015" "" ""
-
-.SH "NAME"
-lttng-crash \- 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
diff --git a/doc/man/lttng-crash.1.txt b/doc/man/lttng-crash.1.txt
new file mode 100644 (file)
index 0000000..1d74deb
--- /dev/null
@@ -0,0 +1,81 @@
+lttng-crash(1)
+==============
+
+
+NAME
+----
+lttng-crash - Recover and view LTTng 2 trace buffers in the event of a crash
+
+
+SYNOPSIS
+--------
+[verse]
+*lttng-crash* [option:--extract='PATH' | option:--viewer='VIEWER'] [option:-v | option:-vv | option:-vvv]
+
+
+DESCRIPTION
+-----------
+The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
+source software package used for correlated tracing of the Linux kernel,
+user applications, and user libraries.
+
+LTTng consists of Linux kernel modules (for Linux kernel tracing) and
+dynamically loaded libraries (for user application and library tracing).
+
+The _`lttng-crash`_ command-line tool is used to recover and view
+LTTng trace buffers in the event of a system crash.
+
+
+OPTIONS
+-------
+option:-x, option:--extract='PATH'::
+    Extract recovered traces to path 'PATH'; do not execute the trace
+    viewer.
+
+option:-v, option:--verbose::
+    Increase verbosity.
++
+Three levels of verbosity are available, which are triggered by
+appending additional `v` letters to the option
+(that is, `-vv` and `-vvv`).
+
+option:-e, option:--viewer='VIEWER'::
+    Use trace viewer 'VIEWER' to view the trace buffers. 'VIEWER' is the
+    absolute path to the viewer command to use, and it can contain
+    command arguments as well. The trace directory paths are passed to
+    the 'VIEWER' command as its last arguments.
++
+Default: `babeltrace`.
+
+
+Program information
+~~~~~~~~~~~~~~~~~~~
+option:-h, option:--help::
+    Show help.
+
+option:-V, option:--version::
+    Show version.
+
+
+EXIT STATUS
+-----------
+*0*::
+    Success
+
+*1*::
+    Error
+
+*3*::
+    Fatal error
+
+
+include::common-footer.txt[]
+
+
+SEE ALSO
+--------
+linklttng:lttng(1),
+linklttng:lttng-sessiond(8),
+linklttng:lttng-relayd(8),
+linklttng:lttng-ust(3),
+linklttng:babeltrace(1)
This page took 0.037082 seconds and 4 git commands to generate.