From 6dfde7acf1405adbb7adb2adc6969c4eb3c0990a Mon Sep 17 00:00:00 2001
From: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Date: Tue, 5 Apr 2016 21:00:10 -0400
Subject: man: also mention systemd-coredump@.service and
 systemd-coredump.socket

Added in 3c171f0b1e.
---
 man/systemd-coredump.xml | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'man/systemd-coredump.xml')

diff --git a/man/systemd-coredump.xml b/man/systemd-coredump.xml
index aa352448b2..51dc27e8d3 100644
--- a/man/systemd-coredump.xml
+++ b/man/systemd-coredump.xml
@@ -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>
-- 
cgit v1.2.3-54-g00ecf