From e6751d628bdc96c751517e9b6680d3a3a5cd8f2f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Sun, 13 Jul 2014 20:32:46 -0400 Subject: [PATCH] man: add systemd-coredump(8) and a bunch of links (cherry picked from commit 5146e7e8aec2d394c06771d4c9d0d03fc2cd911c) --- Makefile-man.am | 4 +- man/coredumpctl.xml | 2 + man/journalctl.xml | 1 + man/systemd-coredump.xml | 105 +++++++++++++++++++++++++++++++++++++++ man/systemd-journald.service.xml | 1 + sysctl.d/50-coredump.conf.in | 4 +- 6 files changed, 115 insertions(+), 2 deletions(-) create mode 100644 man/systemd-coredump.xml diff --git a/Makefile-man.am b/Makefile-man.am index 4238c21710..a02ef733aa 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -681,7 +681,8 @@ endif if ENABLE_COREDUMP MANPAGES += \ man/coredump.conf.5 \ - man/coredumpctl.1 + man/coredumpctl.1 \ + man/systemd-coredump.8 MANPAGES_ALIAS += \ # @@ -1595,6 +1596,7 @@ EXTRA_DIST += \ man/systemd-cat.xml \ man/systemd-cgls.xml \ man/systemd-cgtop.xml \ + man/systemd-coredump.xml \ man/systemd-cryptsetup-generator.xml \ man/systemd-cryptsetup@.service.xml \ man/systemd-debug-generator.xml \ diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 73d1b8435f..327ef6e859 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -210,6 +210,8 @@ See Also + systemd-coredump8, + coredump.conf5, systemd-journald.service8, gdb1 diff --git a/man/journalctl.xml b/man/journalctl.xml index 78fc6f6160..de7741c819 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -908,6 +908,7 @@ systemd1, systemd-journald.service8, systemctl1, + coredumpctl1, systemd.journal-fields7, journald.conf5 diff --git a/man/systemd-coredump.xml b/man/systemd-coredump.xml new file mode 100644 index 0000000000..b83b278620 --- /dev/null +++ b/man/systemd-coredump.xml @@ -0,0 +1,105 @@ + + + + + + + + + systemd-coredump + systemd + + + + Developer + Lennart + Poettering + lennart@poettering.net + + + + + + systemd-coredump + 8 + + + + systemd-coredump + Log and store core dumps + + + + /usr/lib/systemd/systemd-coredump + + + + Description + + systemd-coredump can be used as a helper + binary by the kernel when a user space program receives a fatal + signal and dumps core. For it to be used in this capacity, it must + be specified by the + kernel.core_pattern sysctl8 + setting. Systemd installs + /usr/lib/sysctl.d/50-coredump.conf which + configures kernel.core_pattern to invoke + systemd-coredump. This file may be masked or + overriden to use a different setting following normal + sysctl.d5 rules. + + The behaviour of a specific program upon reception of a + signal is governed by a few factors which are described in detail + in core5. + In particular, the coredump will only be processed when the + related resource limits are high enough. For programs started by + systemd those may be set using + LimitCore= (see + systemd.exec5). + + + systemd-coredump will log the coredump + including a backtrace if possible, and store the core (contents of + process' memory contents) in an external file on disk in + /var/lib/systemd/coredump, or directly in + the journal. This behaviour may be modified using + coredump.conf5. + + Apart from the + journalctl1 + log viewer, + coredumpctl1 + may be used to list and extract coredumps. + + + + See Also + + coredump.conf5, + coredumpctl1, + systemd-journald.service8, + core5, + sysctl.d5, + systemd-sysctl.service8. + + + diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 7ac73ed66d..eb16118afd 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -248,6 +248,7 @@ journald.conf5, systemd.journal-fields7, sd-journal3, + systemd-coredump8, setfacl1, pydoc systemd.journal. diff --git a/sysctl.d/50-coredump.conf.in b/sysctl.d/50-coredump.conf.in index d5795a37d5..d5f600ef45 100644 --- a/sysctl.d/50-coredump.conf.in +++ b/sysctl.d/50-coredump.conf.in @@ -5,6 +5,8 @@ # the Free Software Foundation; either version 2.1 of the License, or # (at your option) any later version. -# See sysctl.d(5) and core(5) for for details. +# See sysctl.d(5) for the description of the files in this directory, +# and systemd-coredump(8) and core(5) for the explanation of the +# setting below. kernel.core_pattern=|@rootlibexecdir@/systemd-coredump %p %u %g %s %t %e