socket: add new Symlinks= option for socket units

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

diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index d645de45e10ae074a1c64412c9c29450d045edd1..f65704d67b68be3dd6d269cbe649ec47d5e43108 100644 (file)
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -571,7 +571,7 @@
 
                         <varlistentry>
                                 <term><varname>PipeSize=</varname></term>
 
                         <varlistentry>
                                 <term><varname>PipeSize=</varname></term>

-                                <listitem><para>Takes an size in
+                                <listitem><para>Takes a size in

                                 bytes. Controls the pipe buffer size
                                 of FIFOs configured in this socket
                                 unit. See
                                 bytes. Controls the pipe buffer size
                                 of FIFOs configured in this socket
                                 unit. See


@@ -730,6 +730,43 @@
                                 option.</para></listitem>
                         </varlistentry>
 
                                 option.</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>RemoveOnStop=</varname></term>
+                                <listitem><para>Takes a boolean
+                                argument. If enabled any file nodes
+                                created by this socket unit are
+                                removed when it is stopped. This
+                                applies to AF_UNIX sockets in the file
+                                system, POSIX message queues as well
+                                as FIFOs, as well as any symlinks to
+                                them configured with
+                                <varname>Symlinks=</varname>. Normally
+                                it should not be necessary to use this
+                                option, and is not recommended as
+                                services might continue to run after
+                                the socket unit has been terminated
+                                and it should still be possible to
+                                communicate with them via their file
+                                system node. Defaults to
+                                off.</para></listitem>
+                        </varlistentry>
+
+                        <varlistentry>
+                                <term><varname>Symlinks=</varname></term>
+                                <listitem><para>Takes a list of file
+                                system paths. The specified paths will
+                                be created as symlinks to the AF_UNIX
+                                socket path or FIFO path of this
+                                socket unit.  If this setting is used
+                                only one AF_UNIX socket in the file
+                                system or one FIFO may be configured
+                                for the socket unit. Use this option
+                                to manage one or more symlinked alias
+                                names for a socket, binding their
+                                lifecycle together. Defaults to the
+                                empty list.</para></listitem>
+                        </varlistentry>
+

                 </variablelist>
 
                 <para>Check
                 </variablelist>
 
                 <para>Check