]>
Commit | Line | Data |
---|---|---|
3802a3d3 | 1 | <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*--> |
5146e7e8 | 2 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
12b42c76 | 3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
5146e7e8 ZJS |
4 | |
5 | <!-- | |
6 | This file is part of systemd. | |
7 | ||
8 | Copyright 2014 Zbigniew Jędrzejewski-Szmek | |
9 | ||
10 | systemd is free software; you can redistribute it and/or modify it | |
11 | under the terms of the GNU Lesser General Public License as published by | |
12 | the Free Software Foundation; either version 2.1 of the License, or | |
13 | (at your option) any later version. | |
14 | ||
15 | systemd is distributed in the hope that it will be useful, but | |
16 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
18 | Lesser General Public License for more details. | |
19 | ||
20 | You should have received a copy of the GNU Lesser General Public License | |
21 | along with systemd; If not, see <http://www.gnu.org/licenses/>. | |
22 | --> | |
23 | ||
24 | <refentry id="systemd-coredump" conditional='ENABLE_COREDUMP' | |
25 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
26 | ||
27 | <refentryinfo> | |
28 | <title>systemd-coredump</title> | |
29 | <productname>systemd</productname> | |
30 | ||
31 | <authorgroup> | |
32 | <author> | |
33 | <contrib>Developer</contrib> | |
34 | <firstname>Lennart</firstname> | |
35 | <surname>Poettering</surname> | |
36 | <email>lennart@poettering.net</email> | |
37 | </author> | |
38 | </authorgroup> | |
39 | </refentryinfo> | |
40 | ||
41 | <refmeta> | |
42 | <refentrytitle>systemd-coredump</refentrytitle> | |
43 | <manvolnum>8</manvolnum> | |
44 | </refmeta> | |
45 | ||
46 | <refnamediv> | |
47 | <refname>systemd-coredump</refname> | |
48 | <refpurpose>Log and store core dumps</refpurpose> | |
49 | </refnamediv> | |
50 | ||
51 | <refsynopsisdiv> | |
12b42c76 | 52 | <para><filename>/usr/lib/systemd/systemd-coredump</filename></para> |
5146e7e8 ZJS |
53 | </refsynopsisdiv> |
54 | ||
55 | <refsect1> | |
56 | <title>Description</title> | |
57 | ||
58 | <para><command>systemd-coredump</command> can be used as a helper | |
59 | binary by the kernel when a user space program receives a fatal | |
60 | signal and dumps core. For it to be used in this capacity, it must | |
61 | be specified by the | |
62 | <varname>kernel.core_pattern</varname> <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> | |
63 | setting. Systemd installs | |
64 | <filename>/usr/lib/sysctl.d/50-coredump.conf</filename> which | |
65 | configures <varname>kernel.core_pattern</varname> to invoke | |
66 | <command>systemd-coredump</command>. This file may be masked or | |
ff9b60f3 | 67 | overridden to use a different setting following normal |
5146e7e8 ZJS |
68 | <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> rules.</para> |
69 | ||
dd2b607b | 70 | <para>The behavior of a specific program upon reception of a |
5146e7e8 ZJS |
71 | signal is governed by a few factors which are described in detail |
72 | in <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>. | |
73 | In particular, the coredump will only be processed when the | |
74 | related resource limits are high enough. For programs started by | |
75 | <command>systemd</command> those may be set using | |
76 | <varname>LimitCore=</varname> (see | |
77 | <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>). | |
78 | </para> | |
79 | ||
80 | <para><command>systemd-coredump</command> will log the coredump | |
81 | including a backtrace if possible, and store the core (contents of | |
82 | process' memory contents) in an external file on disk in | |
83 | <filename>/var/lib/systemd/coredump</filename>, or directly in | |
dd2b607b | 84 | the journal. This behavior may be modified using |
5146e7e8 ZJS |
85 | <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> |
86 | ||
87 | <para>Apart from the | |
88 | <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
89 | log viewer, | |
90 | <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> | |
91 | may be used to list and extract coredumps.</para> | |
92 | </refsect1> | |
93 | ||
94 | <refsect1> | |
95 | <title>See Also</title> | |
96 | <para> | |
97 | <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
98 | <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, | |
99 | <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, | |
100 | <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
101 | <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, | |
102 | <citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. | |
103 | </para> | |
104 | </refsect1> | |
105 | </refentry> |