From: Philippe Proulx Date: Fri, 3 Apr 2020 20:14:05 +0000 (-0400) Subject: lttng-crash(1): document the command's positional argument X-Git-Tag: v2.13.0-rc1~669 X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=commitdiff_plain;h=6f7058c201395648796691f05e69ce285a185f08;ds=sidebyside lttng-crash(1): document the command's positional argument Signed-off-by: Philippe Proulx Change-Id: I919329f2e072b14ad94181e98e49cb8840991225 Signed-off-by: Jérémie Galarneau --- diff --git a/doc/man/lttng-crash.1.txt b/doc/man/lttng-crash.1.txt index f67a88135..a8a2c9f4d 100644 --- a/doc/man/lttng-crash.1.txt +++ b/doc/man/lttng-crash.1.txt @@ -11,7 +11,7 @@ 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 @@ -23,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). -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 -------