man: also mention systemd-coredump@.service and systemd-coredump.socket

Added in 3c171f0b1e.
This commit is contained in:
Zbigniew Jędrzejewski-Szmek 2016-04-05 21:00:10 -04:00
parent 8e170d2909
commit 6dfde7acf1
2 changed files with 22 additions and 1 deletions

View file

@ -1849,11 +1849,21 @@ MANPAGES += \
man/coredumpctl.1 \
man/systemd-coredump.8
MANPAGES_ALIAS += \
man/coredump.conf.d.5
man/coredump.conf.d.5 \
man/systemd-coredump.socket.8 \
man/systemd-coredump@.service.8
man/coredump.conf.d.5: man/coredump.conf.5
man/systemd-coredump.socket.8: man/systemd-coredump.8
man/systemd-coredump@.service.8: man/systemd-coredump.8
man/coredump.conf.d.html: man/coredump.conf.html
$(html-alias)
man/systemd-coredump.socket.html: man/systemd-coredump.html
$(html-alias)
man/systemd-coredump@.service.html: man/systemd-coredump.html
$(html-alias)
endif
if ENABLE_EFI

View file

@ -45,11 +45,15 @@
<refnamediv>
<refname>systemd-coredump</refname>
<refname>systemd-coredump.socket</refname>
<refname>systemd-coredump@.service</refname>
<refpurpose>Log and store core dumps</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>/usr/lib/systemd/systemd-coredump</filename></para>
<para><filename>systemd-coredump@.service</filename></para>
<para><filename>systemd-coredump.socket</filename></para>
</refsynopsisdiv>
<refsect1>
@ -85,6 +89,13 @@
backtrace if possible, and store the core (contents of process' memory contents) in an external
file on disk in <filename>/var/lib/systemd/coredump</filename>.</para>
<para>When the kernel invokes <command>systemd-coredump</command> to handle a coredump,
it will connect to the socket created by the <filename>systemd-coredump.socket</filename>
unit, which in turn will spawn a <filename>systemd-coredump@.service</filename> instance
to process the coredump. Hence <filename>systemd-coredump.socket</filename>
and <filename>systemd-coredump@.service</filename> are helper units which do the actual
processing of coredumps and are subject to normal service management.</para>
<para>The log entry and a backtrace are stored in the journal, and can be viewed with
<citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
<citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>