man: document device units

[elogind.git] / man / systemd.socket.xml

diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index f187fe3bdf97e6319ad689b4b2fbac39518fdbd5..e15ea602f4b7c322065578b399299c5472c3e73b 100644 (file)
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -54,10 +54,11 @@
         <refsect1>
                 <title>Description</title>
 
-                <para>A unit configuration file whose name ends in .socket
-                encodes information about an IPC or network socket or
-                a file system FIFO controlled and supervised by systemd,
-                for socket-based activation.</para>
+                <para>A unit configuration file whose name ends in
+                <filename>.socket</filename> encodes information about
+                an IPC or network socket or a file system FIFO
+                controlled and supervised by systemd, for socket-based
+                activation.</para>
 
                 <para>This man page lists the configuration options
                 specific to this unit type. See
@@ -65,19 +66,21 @@
                 for the common options of all unit configuration
                 files. The common configuration items are configured
                 in the generic [Unit] and [Install] sections. The
-                service specific configuration options are configured
+                socket specific configuration options are configured
                 in the [Socket] section.</para>
 
                 <para>Additional options are listed in
                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para>
 
-                <para>For each socket file a matching service file (see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details)
-                must exist, describing the service to start on
-                incoming traffic on the socket. Depending on the
-                setting of <option>Accept=</option> (see below) this
-                must either be named like the socket unit, but with
-                the suffix replaced; or it must be a template file
-                named the same way. Example: a socket file
+                <para>For each socket file a matching service file
+                (see
+                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for details) must exist, describing the service to
+                start on incoming traffic on the socket. Depending on
+                the setting of <option>Accept=</option> (see below)
+                this must either be named like the socket unit, but
+                with the suffix replaced; or it must be a template
+                file named the same way. Example: a socket file
                 <filename>foo.socket</filename> needs a matching
                 service <filename>foo.service</filename> if
                 <option>Accept=false</option> is set. If
@@ -85,6 +88,10 @@
                 file <filename>foo@.service</filename> must exist from
                 which services are instantiated for each incoming
                 connection.</para>
+
+                <para>Socket units may be used to implement on-demand
+                starting of services as well as parallelized starting
+                of services.</para>
         </refsect1>
 
         <refsect1>
@@ -96,7 +103,7 @@
                 this section are shared with other unit types. These
                 options are documented in
                 <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
-                options specific to the [Socket] section of service
+                options specific to the [Socket] section of socket
                 units are the following:</para>
 
                 <variablelist>
@@ -406,10 +413,6 @@
                                 address. Defaults to <option>false</option>.</para></listitem>
                         </varlistentry>
 
-    <!--
-                { "TimeoutSec",             config_parse_usec,            &u->socket.timeout_usec,                         "Socket"  },
-                { "KillMode",               config_parse_kill_mode,       &u->socket.kill_mode,                            "Socket"  },
--->
                         <varlistentry>
                                 <term><varname>ExecStartPre=</varname></term>
                                 <term><varname>ExecStartPost=</varname></term>
@@ -438,7 +441,6 @@
                                 optional.</para></listitem>
                         </varlistentry>
 
-
                         <varlistentry>
                                 <term><varname>TimeoutSec=</varname></term>
                                 <listitem><para>Configures the time to
@@ -454,7 +456,7 @@
                                 will be terminated forcibly via
                                 SIGTERM, and after another delay of
                                 this time with SIGKILL. (See
-                                <option>KilleMode=</option> below.)
+                                <option>KillMode=</option> below.)
                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
@@ -462,11 +464,10 @@
                                 60s.</para></listitem>
                         </varlistentry>
 
-
                         <varlistentry>
                                 <term><varname>KillMode=</varname></term>
                                 <listitem><para>Specifies how
-                                processes of this service shall be
+                                processes of this socket unit shall be
                                 killed. One of
                                 <option>control-group</option>,
                                 <option>process-group</option>,
@@ -479,8 +480,6 @@
                                 <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                                 for details.</para></listitem>
                         </varlistentry>
-
-
                 </variablelist>
         </refsect1>