log: introduce a macro to format message id

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

diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index d3762cd63d9312d9d76c9c5aabc5607a3f3e5703..7885b0748a70e00b2a2f5e3bff082183adaf1b1a 100644 (file)
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -44,7 +44,7 @@
 
         <refnamediv>
                 <refname>systemd.socket</refname>
 
         <refnamediv>
                 <refname>systemd.socket</refname>

-                <refpurpose>systemd socket configuration files</refpurpose>
+                <refpurpose>Socket unit configuration</refpurpose>

         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>


@@ -76,7 +76,10 @@
                 <option>ExecStartPost=</option>,
                 <option>ExecStopPre=</option> and
                 <option>ExecStoptPost=</option> commands are executed
                 <option>ExecStartPost=</option>,
                 <option>ExecStopPre=</option> and
                 <option>ExecStoptPost=</option> commands are executed

-                in.</para>
+                in, and in
+                <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                which define the way the processes are
+                terminated.</para>

 
                 <para>For each socket file a matching service file
                 (see
 
                 <para>For each socket file a matching service file
                 (see


@@ -134,7 +137,9 @@
                 supervises. A number of options that may be used in
                 this section are shared with other unit types. These
                 options are documented in
                 supervises. A number of options that may be used in
                 this section are shared with other unit types. These
                 options are documented in

-                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The
+                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                and
+                <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The

                 options specific to the [Socket] section of socket
                 units are the following:</para>
 
                 options specific to the [Socket] section of socket
                 units are the following:</para>
 


@@ -165,8 +170,13 @@
 
                                 <para>If the address string is a
                                 single number it is read as port
 
                                 <para>If the address string is a
                                 single number it is read as port

-                                number to listen on for both IPv4 and
-                                IPv6.</para>
+                                number to listen on via
+                                IPv6. Depending on the value of
+                                <varname>BindIPv6Only=</varname> (see below) this
+                                might result in the service being
+                                available via both IPv6 and IPv4 (default) or
+                                just via IPv6.
+                                </para>

 
                                 <para>If the address string is a
                                 string in the format v.w.x.y:z it is
 
                                 <para>If the address string is a
                                 string in the format v.w.x.y:z it is


@@ -176,7 +186,12 @@
 
                                 <para>If the address string is a
                                 string in the format [x]:y it is read
 
                                 <para>If the address string is a
                                 string in the format [x]:y it is read

-                                as IPv6 address x on a port y.</para>
+                                as IPv6 address x on a port y. Note
+                                that this might make the service
+                                available via IPv4, too, depending on
+                                the <varname>BindIPv6Only=</varname>
+                                setting (see below).
+                                </para>

 
                                 <para>Note that SOCK_SEQPACKET
                                 (i.e. <varname>ListenSequentialPacket=</varname>)
 
                                 <para>Note that SOCK_SEQPACKET
                                 (i.e. <varname>ListenSequentialPacket=</varname>)


@@ -212,7 +227,7 @@
                                 <listitem><para>Specifies a file
                                 system FIFO to listen on. This expects
                                 an absolute file system path as
                                 <listitem><para>Specifies a file
                                 system FIFO to listen on. This expects
                                 an absolute file system path as

-                                argument. Behaviour otherwise is very
+                                argument. Behavior otherwise is very

                                 similar to the
                                 <varname>ListenDatagram=</varname>
                                 directive above.</para></listitem>
                                 similar to the
                                 <varname>ListenDatagram=</varname>
                                 directive above.</para></listitem>


@@ -223,7 +238,7 @@
                                 <listitem><para>Specifies a special
                                 file in the file system to listen
                                 on. This expects an absolute file
                                 <listitem><para>Specifies a special
                                 file in the file system to listen
                                 on. This expects an absolute file

-                                system path as argument. Behaviour
+                                system path as argument. Behavior

                                 otherwise is very similar to the
                                 <varname>ListenFIFO=</varname>
                                 directive above. Use this to open
                                 otherwise is very similar to the
                                 <varname>ListenFIFO=</varname>
                                 directive above. Use this to open


@@ -243,7 +258,7 @@
                                 or <varname>kobject-uevent</varname>)
                                 as argument, optionally suffixed by a
                                 whitespace followed by a multicast
                                 or <varname>kobject-uevent</varname>)
                                 as argument, optionally suffixed by a
                                 whitespace followed by a multicast

-                                group integer. Behaviour otherwise is
+                                group integer. Behavior otherwise is

                                 very similar to the
                                 <varname>ListenDatagram=</varname>
                                 directive above.</para></listitem>
                                 very similar to the
                                 <varname>ListenDatagram=</varname>
                                 directive above.</para></listitem>


@@ -254,7 +269,7 @@
                                 <listitem><para>Specifies a POSIX
                                 message queue name to listen on. This
                                 expects a valid message queue name
                                 <listitem><para>Specifies a POSIX
                                 message queue name to listen on. This
                                 expects a valid message queue name

-                                (i.e. beginning with /). Behaviour
+                                (i.e. beginning with /). Behavior

                                 otherwise is very similar to the
                                 <varname>ListenFIFO=</varname>
                                 directive above. On Linux message
                                 otherwise is very similar to the
                                 <varname>ListenFIFO=</varname>
                                 directive above. On Linux message


@@ -281,7 +296,10 @@
                                 default, surprise!) the system wide
                                 default setting is used, as controlled
                                 by
                                 default, surprise!) the system wide
                                 default setting is used, as controlled
                                 by

-                                <filename>/proc/sys/net/ipv6/bindv6only</filename>.</para>
+                                <filename>/proc/sys/net/ipv6/bindv6only</filename>,
+                                which in turn defaults to the
+                                equivalent of
+                                <option>both</option>.</para>

                                 </listitem>
                         </varlistentry>
 
                                 </listitem>
                         </varlistentry>
 


@@ -603,7 +621,7 @@
                                 will be terminated forcibly via
                                 SIGTERM, and after another delay of
                                 this time with SIGKILL. (See
                                 will be terminated forcibly via
                                 SIGTERM, and after another delay of
                                 this time with SIGKILL. (See

-                                <option>KillMode=</option> below.)
+                                <option>KillMode=</option> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.)

                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout
                                 Takes a unit-less value in seconds, or
                                 a time span value such as "5min
                                 20s". Pass 0 to disable the timeout


@@ -611,41 +629,6 @@
                                 90s.</para></listitem>
                         </varlistentry>
 
                                 90s.</para></listitem>
                         </varlistentry>
 

-                        <varlistentry>
-                                <term><varname>KillMode=</varname></term>
-                                <listitem><para>Specifies how
-                                processes of this socket unit shall be
-                                killed. One of
-                                <option>control-group</option>,
-                                <option>process</option>,
-                                <option>none</option>.</para>
-
-                                <para>This option is mostly equivalent
-                                to the <option>KillMode=</option>
-                                option of service files. See
-                                <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
-                                for details.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><varname>KillSignal=</varname></term>
-                                <listitem><para>Specifies which signal
-                                to use when killing a process of this
-                                socket. Defaults to SIGTERM.
-                                </para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><varname>SendSIGKILL=</varname></term>
-                                <listitem><para>Specifies whether to
-                                send SIGKILL to remaining processes
-                                after a timeout, if the normal
-                                shutdown procedure left processes of
-                                the socket around. Takes a boolean
-                                value. Defaults to "yes".
-                                </para></listitem>
-                        </varlistentry>
-

                         <varlistentry>
                                 <term><varname>Service=</varname></term>
                                 <listitem><para>Specifies the service
                         <varlistentry>
                                 <term><varname>Service=</varname></term>
                                 <listitem><para>Specifies the service


@@ -658,6 +641,13 @@
                         </varlistentry>
 
                 </variablelist>
                         </varlistentry>
 
                 </variablelist>

+
+                <para>Check
+                <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                and
+                <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                for more settings.</para>
+

         </refsect1>
 
         <refsect1>
         </refsect1>
 
         <refsect1>


@@ -667,6 +657,7 @@
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

+                          <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>
                           <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                   </para>
         </refsect1>