X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd.socket.xml;h=170d010f601625c04679276c6062f8c3a9a803b3;hb=9528592ff8d7ff361da430285deba8196e8984d5;hp=f495fe3666117e137c66139a5f1440b3db6d81d6;hpb=73e231abde39f22097df50542c745e01de879836;p=elogind.git
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index f495fe366..170d010f6 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -90,9 +90,9 @@
systemd.service5
for more information about .service files). The name
of the .service unit is by default the same as the
- name of the .socket unit, but can be altered with
+ name of the .socket unit, but can be altered with the
option described below.
- Depending on the setting of
+ Depending on the setting of the
option described below, this .service unit must either
be named like the .socket unit, but with the suffix
replaced, unless overridden with
@@ -135,7 +135,7 @@
Socket units may be used to implement on-demand
starting of services, as well as parallelized starting
of services. See the blog stories linked at the end
- for introduction.
+ for an introduction.
Note that the daemon software configured for
socket activation with socket units needs to be able
@@ -188,7 +188,7 @@
replaced with a
NUL character
before binding. For details, see
- unix7.
+ unix7.
If the address string is a
single number, it is read as port
@@ -372,16 +372,21 @@
- DirectoryMode=
- If listening on a file
- system socket or FIFO, the parent
- directories are automatically created
- if needed. This option specifies the
- file system access mode used when
- creating these directories. Takes an
- access mode in octal
- notation. Defaults to
- 0755.
+ SocketUser=
+ SocketGroup=
+
+ Takes a UNIX
+ user/group name. When specified,
+ all AF_UNIX sockets and FIFO nodes in
+ the file system are owned by the
+ specified user and group. If unset
+ (the default), the nodes are owned by
+ the root user/group (if run in system
+ context) or the invoking user/group
+ (if run in user context). If only a
+ user is specified but no group, then
+ the group is derived from the user's
+ default group.
@@ -395,6 +400,19 @@
0666.
+
+ DirectoryMode=
+ If listening on a file
+ system socket or FIFO, the parent
+ directories are automatically created
+ if needed. This option specifies the
+ file system access mode used when
+ creating these directories. Takes an
+ access mode in octal
+ notation. Defaults to
+ 0755.
+
+
Accept=Takes a boolean
@@ -469,6 +487,32 @@
.
+
+ NoDelay=
+ Takes a boolean
+ argument. TCP Nagle's algorithm works by combining a number of
+ small outgoing messages, and sending them all at once.
+ This controls the TCP_NODELAY socket option (see
+ tcp7
+ Defaults to
+ .
+
+
+
+ FastOpen=
+ Takes a boolean
+ argument. It works by using a TFO cookie (a TCP option) in the initial
+ SYN packet to authenticate a previously connected client. If successful,
+ it may start sending data to the client before the receipt of the final
+ ACK packet of the three way handshake is received, skipping a round trip
+ and lowering the latency in the start of transmission of data.
+ This controls the TCP_FASTOPEN socket option (see
+ the TCP
+ Fast Open: expediting web services for details.)
+ Defaults to
+ .
+
+
Priority=Takes an integer
@@ -484,12 +528,15 @@
ReceiveBuffer=SendBuffer=Takes an integer
- argument controlling the receive
- or send buffer sizes of this
- socket, respectively. This controls the SO_RCVBUF
- and SO_SNDBUF socket options (see
+ argument controlling the receive or
+ send buffer sizes of this socket,
+ respectively. This controls the
+ SO_RCVBUF and SO_SNDBUF socket options
+ (see
socket7
- for details.).
+ for details.). The usual suffixes K,
+ M, G are supported and are understood
+ to the base of 1024.
@@ -568,12 +615,14 @@
PipeSize=
- Takes an integer
- value. Controls the pipe buffer size
+ Takes a size in
+ bytes. Controls the pipe buffer size
of FIFOs configured in this socket
unit. See
fcntl2
- for details.
+ for details. The usual suffixes K, M,
+ G are supported and are understood to
+ the base of 1024.
@@ -699,16 +748,18 @@
finish. If a command does not exit
within the configured time, the socket
will be considered failed and be shut
- down again. All commands still running,
+ down again. All commands still running
will be terminated forcibly via
SIGTERM, and after another delay of
this time with SIGKILL. (See
in systemd.kill5.)
Takes a unit-less value in seconds, or
a time span value such as "5min
- 20s". Pass 0 to disable the timeout
- logic. Defaults to TimeoutStartSec= from the
- manager configuration file.
+ 20s". Pass 0 to disable the timeout
+ logic. Defaults to DefaultTimeoutStartSec= from the
+ manager configuration file
+ (see systemd-systemd.conf5).
+
@@ -725,6 +776,43 @@
option.
+
+ RemoveOnStop=
+ 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, FIFOs,
+ as well as any symlinks to
+ them configured with
+ Symlinks=. 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.
+
+
+
+ Symlinks=
+ 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.
+
+
Check