| 1 | lttng-crash(1) |
| 2 | ============== |
| 3 | :revdate: 8 April 2021 |
| 4 | |
| 5 | |
| 6 | NAME |
| 7 | ---- |
| 8 | lttng-crash - Recover and read LTTng trace buffers in the event of a crash |
| 9 | |
| 10 | |
| 11 | SYNOPSIS |
| 12 | -------- |
| 13 | [verse] |
| 14 | *lttng-crash* [option:--extract='DIR' | option:--viewer='READER'] [option:-verbose]... 'SHMDIR' |
| 15 | |
| 16 | |
| 17 | DESCRIPTION |
| 18 | ----------- |
| 19 | include::common-intro.txt[] |
| 20 | |
| 21 | The `lttng-crash` command-line tool recovers LTTng trace buffers in the |
| 22 | event of a system crash. |
| 23 | |
| 24 | `lttng-crash` reads files within the directory 'SHMDIR' and does one |
| 25 | of: |
| 26 | |
| 27 | Without the option:--extract option:: |
| 28 | Launches a trace reader (see the option:--viewer option) to view the |
| 29 | recovered traces. |
| 30 | |
| 31 | With the option:--extract='DIR' option:: |
| 32 | Extracts the files as uncorrupted LTTng traces to the 'DIR' |
| 33 | directory. |
| 34 | |
| 35 | 'SHMDIR' is the directory specified as the argument of the |
| 36 | nloption:--shm-path option of the man:lttng-create(1) command used to |
| 37 | create the tracing session for which to recover the traces. |
| 38 | |
| 39 | |
| 40 | OPTIONS |
| 41 | ------- |
| 42 | option:-x 'DIR', option:--extract='DIR':: |
| 43 | Extract recovered traces to the directory 'DIR'; do :not: execute |
| 44 | any trace reader. |
| 45 | |
| 46 | option:-v, option:--verbose:: |
| 47 | Increase verbosity. |
| 48 | + |
| 49 | Specify this option up to three times to get more levels of verbosity. |
| 50 | |
| 51 | option:-e 'READER', option:--viewer='READER':: |
| 52 | Use the trace reader 'READER' to read the trace buffers. |
| 53 | + |
| 54 | 'READER' is the absolute path to the reader command to use, and it can |
| 55 | contain command arguments as well. `lttng-crash` passes the trace |
| 56 | directory paths to the 'READER' command as its last arguments. |
| 57 | + |
| 58 | Without this option, `lttng crash` uses man:babeltrace2(1) if it's |
| 59 | available. Otherwise, it tries to use man:babeltrace(1). |
| 60 | |
| 61 | |
| 62 | Program information |
| 63 | ~~~~~~~~~~~~~~~~~~~ |
| 64 | include::common-help-option.txt[] |
| 65 | |
| 66 | option:-V, option:--version:: |
| 67 | Show version and quit. |
| 68 | |
| 69 | |
| 70 | EXIT STATUS |
| 71 | ----------- |
| 72 | *0*:: |
| 73 | Success |
| 74 | |
| 75 | *1*:: |
| 76 | Error |
| 77 | |
| 78 | *3*:: |
| 79 | Fatal error |
| 80 | |
| 81 | |
| 82 | include::common-footer.txt[] |
| 83 | |
| 84 | |
| 85 | SEE ALSO |
| 86 | -------- |
| 87 | man:babeltrace2(1), |
| 88 | man:lttng(1), |
| 89 | man:lttng-create(1), |
| 90 | man:lttng-relayd(8), |
| 91 | man:lttng-sessiond(8), |
| 92 | man:lttng-ust(3) |