X-Git-Url: http://git.ipfire.org/?a=blobdiff_plain;f=man%2Fcoredumpctl.xml;h=5419bc151aab1e4f7dd992ef8d250df463c257ce;hb=5057d73ba1bb016c9325d0a7fdb84519d3443622;hp=0f1afe77c38af14a8727c879717ca1bb37f812dd;hpb=5a6d44ed77f46c18aa2315e645de7302b88c34c8;p=thirdparty%2Fsystemd.git diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 0f1afe77c38..5419bc151aa 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -1,25 +1,7 @@ - - - + @@ -27,15 +9,6 @@ coredumpctl systemd - - - - Developer - Zbigniew - Jędrzejewski-Szmek - zbyszek@in.waw.pl - - @@ -45,7 +18,7 @@ coredumpctl - Retrieve coredumps from the journal + Retrieve and process saved core dumps and metadata @@ -60,9 +33,10 @@ Description - coredumpctl may be used to - retrieve coredumps from - systemd-journald8. + coredumpctl is a tool that can be used to retrieve and process core + dumps and metadata which were saved by + systemd-coredump8. + @@ -71,18 +45,45 @@ The following options are understood: + + + + - Do not print column headers. - + Do not print column headers. + + - Show information of a single coredump only, - instead of listing all known coredumps. + Show information of a single core dump only, instead of listing + all known core dumps. + + + + + + + Only print entries which are since the specified date. + + + + + + + Only print entries which are until the specified date. + + + + + + + Reverse output so that the newest entries are displayed first. + @@ -90,7 +91,7 @@ FIELD Print all possible data values the specified - field takes in matching coredump entries of the + field takes in matching core dump entries of the journal. @@ -102,6 +103,15 @@ + + DEBUGGER + + Use the given debugger for the debug + command. If not given and $SYSTEMD_DEBUGGER is unset, then + gdb1 + will be used. + + DIR DIR @@ -110,11 +120,19 @@ - - - + + + + Suppresses informational messages about lack + of access to journal files and possible in-flight coredumps. + + + + + + Commands The following commands are understood: @@ -122,32 +140,96 @@ list - List coredumps captured in the journal + List core dumps captured in the journal matching specified characteristics. If no command is - specified, this is the implied default. + specified, this is the implied default. + + The output is designed to be human readable and contains list contains + a table with the following columns: + + + TIME + The timestamp of the crash, as reported by the kernel. + + + + + PID + The identifier of the process that crashed. + + + + + UID + GID + The user and group identifiers of the process that crashed. + + + + + SIGNAL + The signal that caused the process to crash, when applicable. + + + + + COREFILE + Information whether the coredump was stored, and whether + it is still accessible: none means the core was + not stored, - means that it was not available (for + example because the process was not terminated by a signal), + present means that the core file is accessible by the + current user, journal means that the core was stored + in the journal, truncated is the + same as one of the previous two, but the core was too large and was not + stored in its entirety, error means that the core file + cannot be accessed, most likely because of insufficient permissions, and + missing means that the core was stored in a file, but + this file has since been removed. + + + + EXE + The full path to the executable. For backtraces of scripts + this is the name of the interpreter. + + + + It's worth noting that different restrictions apply to + data saved in the journal and core dump files saved in + /var/lib/systemd/coredump, see overview in + systemd-coredump8. + Thus it may very well happen that a particular core dump is still listed + in the journal while its corresponding core dump file has already been + removed. info - Show detailed information about coredumps + Show detailed information about the last core dump + or core dumps matching specified characteristics captured in the journal. dump - Extract the last coredump matching specified - characteristics. The coredump will be written on standard + Extract the last core dump matching specified + characteristics. The core dump will be written on standard output, unless an output file is specified with . - gdb - - Invoke the GNU debugger on the last coredump - matching specified characteristics. + debug + + Invoke a debugger on the last core dump + matching specified characteristics. By default, + gdb1 + will be used. This may be changed using the + option or the $SYSTEMD_DEBUGGER environment + variable. @@ -187,9 +269,10 @@ MATCH - General journalctl predicates (see - journalctl1). - Must contain an equal sign. + General journalctl match filter, must contain an equals + sign (=). See + journalctl1. + @@ -197,24 +280,36 @@ Exit status On success, 0 is returned; otherwise, a non-zero failure - code is returned. Not finding any matching coredumps is treated as + code is returned. Not finding any matching core dumps is treated as failure. + + Environment + + + + $SYSTEMD_DEBUGGER + Use the given debugger for the debug + command. See the option. + + + + Examples - List all the coredumps of a program named foo + List all the core dumps of a program named foo # coredumpctl list foo - Invoke gdb on the last coredump + Invoke gdb on the last core dump - # coredumpctl gdb + # coredumpctl debug @@ -225,7 +320,7 @@ - Extract the last coredump of /usr/bin/bar to a file named + <title>Extract the last core dump of /usr/bin/bar to a file named <filename noindex="true">bar.coredump</filename> # coredumpctl -o bar.coredump dump /usr/bin/bar