lttng-crash(1): document the command's positional argument

[lttng-tools.git] / doc / man / lttng-crash.1.txt

diff --git a/doc/man/lttng-crash.1.txt b/doc/man/lttng-crash.1.txt
index 7427af94f5db14b0b6270153180ec6843b6e7b3c..a8a2c9f4dfaaee1880c76617ea27f1a9f8bb3c37 100644 (file)
--- a/doc/man/lttng-crash.1.txt
+++ b/doc/man/lttng-crash.1.txt
@@ -1,5 +1,6 @@
 lttng-crash(1)
 ==============
+:revdate: 2 April 2020
 
 
 NAME
@@ -10,25 +11,39 @@ 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]
+*lttng-crash* [option:--extract='PATH' | option:--viewer='VIEWER'] [option:-v | option:-vv | option:-vvv] 'SHMDIR'
 
 
 DESCRIPTION
 -----------
-The http://lttng.org/[_Linux Trace Toolkit: next generation_] is an open
+The https://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
+The `lttng-crash` command-line tool is used to recover and view
 LTTng trace buffers in the event of a system crash.
 
+`lttng-crash` reads files within the directory 'SHMDIR' and does one
+of:
+
+Without the option:--extract option::
+    Launches a trace reader (see the option:--viewer option) to view the
+    recovered traces.
+
+With the option:--extract option::
+    Extracts them as uncorrupted LTTng traces on the file system.
+
+'SHMDIR' is the directory specified as the argument of the
+nloption:--shm-path option of the man:lttng-create(1) command used to
+create the tracing session for which to recover the traces.
+
 
 OPTIONS
 -------
-option:-x, option:--extract='PATH'::
+option:-x 'PATH', option:--extract='PATH'::
     Extract recovered traces to path 'PATH'; do not execute the trace
     viewer.
 
@@ -39,13 +54,14 @@ 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'::
+option:-e 'VIEWER', 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`.
+Without this option, `lttng crash` uses man:babeltrace2(1) if it's
+available. Otherwise, it tries to use man:babeltrace(1).
 
 
 Program information
@@ -78,4 +94,4 @@ man:lttng(1),
 man:lttng-sessiond(8),
 man:lttng-relayd(8),
 man:lttng-ust(3),
-man:babeltrace(1)
+man:babeltrace2(1)