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 b3982d039fa4ebe3741c6a90c8ebbdfa6edc14f7..a8a2c9f4dfaaee1880c76617ea27f1a9f8bb3c37 100644 (file)
--- a/doc/man/lttng-crash.1.txt
+++ b/doc/man/lttng-crash.1.txt
@@ -1,5 +1,6 @@
 lttng-crash(1)
 ==============
 lttng-crash(1)
 ==============

+:revdate: 2 April 2020

 
 
 NAME
 
 
 NAME


@@ -10,7 +11,7 @@ lttng-crash - Recover and view LTTng 2 trace buffers in the event of a crash
 SYNOPSIS
 --------
 [verse]
 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
 
 
 DESCRIPTION


@@ -22,9 +23,23 @@ 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).
 
 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 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
 -------
 
 OPTIONS
 -------


@@ -45,7 +60,8 @@ option:-e 'VIEWER', option:--viewer='VIEWER'::
     command arguments as well. The trace directory paths are passed to
     the 'VIEWER' command as its last arguments.
 +
     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
 
 
 Program information


@@ -78,4 +94,4 @@ man:lttng(1),
 man:lttng-sessiond(8),
 man:lttng-relayd(8),
 man:lttng-ust(3),
 man:lttng-sessiond(8),
 man:lttng-relayd(8),
 man:lttng-ust(3),

-man:babeltrace(1)
+man:babeltrace2(1)