X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.socket.xml;h=8394fa81aac5e7e65add6eaf7680de46aa624495;hp=71d1ab916d085cebed17a8910eca5eba558ca89f;hb=06b643e7f5a3b79005dd57497897ab7255fe3659;hpb=b200a92cdc47b204e2ed7fbdd1eaf15abfd019c6
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index 71d1ab916..8394fa81a 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -84,15 +84,15 @@
which configure resource control settings for the
processes of the socket.
- For each socket file a matching service file
+ For each socket file, a matching service file
must exist, describing the service to start on
incoming traffic on the socket (see
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
@@ -254,7 +254,7 @@
before the interface it is configured
on is up and running, and even
regardless of whether it will be up and
- running at any point. To deal with this
+ running at any point. To deal with this,
it is recommended to set the
FreeBind= option
described below.
@@ -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,53 @@
.
+
+ KeepAliveTimeSec=
+ Takes time (in seconds) as argument . The connection needs to remain
+ idle before TCP starts sending keepalive probes. This controls the TCP_KEEPIDLE
+ socket option (see
+ socket7
+ and the TCP
+ Keepalive HOWTO for details.)
+ Defaults value is 7200 seconds (2 hours).
+
+
+
+ KeepAliveIntervalSec=
+ Takes time (in seconds) as argument between individual keepalive probes,
+ if the socket option SO_KEEPALIVE has been set on this socket seconds as argument.
+ This controls the TCP_KEEPINTVL socket option (see
+ socket7
+ and the TCP
+ Keepalive HOWTO for details.)
+ Defaults value is 75 seconds.
+
+
+
+ KeepAliveProbes=
+ Takes integer as argument. It's the number of unacknowledged probes to
+ send before considering the connection dead and notifying the application layer.
+ This controls the TCP_KEEPCNT socket option (see
+ socket7
+ and the TCP
+ Keepalive HOWTO for details.)
+ Defaults value is 9.
+
+
+
+ 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
+ .
+
+
Priority=Takes an integer
@@ -480,16 +545,60 @@
for details.).
+
+ DeferAcceptSec=
+
+ Takes time (in
+ seconds) as argument. If set, the
+ listening process will be awakened
+ only when data arrives on the socket,
+ and not immediately when connection is
+ established. When this option is set,
+ the
+ TCP_DEFER_ACCEPT
+ socket option will be used (see
+ tcp7),
+ and the kernel will ignore initial ACK
+ packets without any data. The argument
+ specifies the approximate amount of
+ time the kernel should wait for
+ incoming data before falling back to
+ the normal behaviour of honouring
+ empty ACK packets. This option is
+ beneficial for protocols where the
+ client sends the data first (e.g.
+ HTTP, in contrast to SMTP), because
+ the server process will not be woken
+ up unnecessarily before it can take
+ any action.
+
+
+ If the client also uses the
+ TCP_DEFER_ACCEPT
+ option, the latency of the initial
+ connection may be reduced, because the
+ kernel will send data in the final
+ packet establishing the connection
+ (the third packet in the "three-way
+ handshake").
+
+ Disabled by default.
+
+
+
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 +677,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 +810,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).
+
@@ -720,11 +833,48 @@
Accept=no. It
defaults to the service that bears the
same name as the socket (with the
- suffix replaced). In most cases it
+ suffix replaced). In most cases, it
should not be necessary to use this
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