X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.socket.xml;h=ef5b28c771984330cc4bf5b3f4aab7c10859a6aa;hp=e25b5a00fda1096d3081cc86daf74fb8f6428876;hb=271b032a053f9d4a1be271bb052276ae27fe36c6;hpb=b439c6ee04967fa988d232e0765f972cb27b1877
diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml
index e25b5a00f..ef5b28c77 100644
--- a/man/systemd.socket.xml
+++ b/man/systemd.socket.xml
@@ -70,7 +70,13 @@
in the [Socket] section.
Additional options are listed in
- systemd.exec5.
+ systemd.exec5,
+ which define the execution environment the
+ ,
+ ,
+ and
+ commands are executed
+ in.
For each socket file a matching service file
(see
@@ -89,9 +95,35 @@
which services are instantiated for each incoming
connection.
+ Unless DefaultDependencies=
+ is set to , socket units will
+ implicitly have dependencies of type
+ Requires= and
+ After= on
+ sysinit.target as well as
+ dependencies of type Conflicts= and
+ Before= on
+ shutdown.target. These ensure
+ that socket units pull in basic system
+ initialization, and are terminated cleanly prior to
+ system shutdown. Only sockets involved with early
+ boot or late system shutdown should disable this
+ option.
+
Socket units may be used to implement on-demand
starting of services, as well as parallelized starting
of services.
+
+ Note that the daemon software configured for
+ socket activation with socket units needs to be able
+ to accept sockets from systemd, either via systemd's
+ native socket passing interface (see
+ sd_listen_fds3
+ for details) or via the traditional
+ inetd8-style
+ socket passing (i.e. sockets passed in via STDIN and
+ STDOUT, using StandardInput=socket
+ in the service file).
@@ -124,7 +156,7 @@
family.
If the address starts with an
- ampersand (@) it is read as abstract
+ at symbol (@) it is read as abstract
namespace socket in the AF_UNIX
family. The @ is replaced with a NUL
character before binding. For details
@@ -186,6 +218,51 @@
directive above.
+
+ ListenSpecial=
+ Specifies a special
+ file in the file system to listen
+ on. This expects an absolute file
+ system path as argument. Behaviour
+ otherwise is very similar to the
+ ListenFIFO=
+ directive above. Use this to open
+ character device nodes as well as
+ special files in
+ /proc and
+ /sys.
+
+
+
+ ListenNetlink=
+ Specifies a Netlink
+ family to create a socket for to
+ listen on. This expects a short string
+ referring to the AF_NETLINK family
+ name (such as audit
+ or kobject-uevent)
+ as argument, optionally suffixed by a
+ whitespace followed by a multicast
+ group integer. Behaviour otherwise is
+ very similar to the
+ ListenDatagram=
+ directive above.
+
+
+
+ ListenMessageQueue=
+ Specifies a POSIX
+ message queue name to listen on. This
+ expects a valid message queue name
+ (i.e. beginning with /). Behaviour
+ otherwise is very similar to the
+ ListenFIFO=
+ directive above. On Linux message
+ queue descriptors are actually file
+ descriptors and can be inherited
+ between processes.
+
+
BindIPv6Only=Takes a one of
@@ -245,8 +322,10 @@
directories are automatically created
if needed. This option specifies the
file system access mode used when
- creating these directories. Defaults
- to 0755.
+ creating these directories. Takes an
+ access mode in octal
+ notation. Defaults to
+ 0755.
@@ -255,7 +334,8 @@
system socket of FIFO, this option
specifies the file system access mode
used when creating the file
- node. Defaults to
+ node. Takes an access mode in octal
+ notation. Defaults to
0666.
@@ -396,6 +476,19 @@
for details.
+
+ MessageQueueMaxMessages=,
+ MessageQueueMessageSize=
+ These two settings
+ take integer values and control the
+ mq_maxmsg resp. mq_msgsize field when
+ creating the message queue. Note that
+ either none or both of these variables
+ need to be set. See
+ mq_setattr3
+ for details.
+
+
FreeBind=Takes a boolean
@@ -413,19 +506,62 @@
address. Defaults to .
+
+ Transparent=
+ Takes a boolean
+ value. Controls the IP_TRANSPARENT
+ socket option. Defaults to
+ .
+
+
+
+ Broadcast=
+ Takes a boolean
+ value. This controls the SO_BROADCAST
+ socket option, which allows broadcast
+ datagrams to be sent from this
+ socket. Defaults to
+ .
+
+
+
+ PassCredentials=
+ Takes a boolean
+ value. This controls the SO_PASSCRED
+ socket option, which allows UNIX sockets to
+ receive the credentials of the sending
+ process in an ancillary message.
+ Defaults to
+ .
+
+
+
+ TCPCongestion=
+ Takes a string
+ value. Controls the TCP congestion
+ algorithm used by this socket. Should
+ be one of "westwood", "veno", "cubic",
+ "lp" or any other available algorithm
+ supported by the IP stack. This
+ setting applies only to stream
+ sockets.
+
+
ExecStartPre=ExecStartPost=
- Takes a command line,
- which is executed before (resp. after)
- the listening sockets/FIFOs are created and
+ Takes one or more
+ command lines, which are executed
+ before (resp. after) the listening
+ sockets/FIFOs are created and
bound. The first token of the command
line must be an absolute file name,
then followed by arguments for the
- process. If specified more than once,
- all commands are executed one after
- the other, fully serialized. The use of
- these settings is optional.
+ process. Multiple command lines may be
+ specified following the same scheme as
+ used for
+ ExecStartPre= of
+ service unit files.
@@ -434,10 +570,11 @@
Additional commands
that are executed before (resp. after)
the listening sockets/FIFOs are closed
- and removed. If specified more than
- once, all commands are executed one
- after the other, fully serialized. The use of
- these settings is optional.
+ and removed. Multiple command lines
+ may be specified following the same
+ scheme as used for
+ ExecStartPre= of
+ service unit files.
@@ -460,7 +597,7 @@
a time span value such as "5min
20s". Pass 0 to disable the timeout
logic. Defaults to
- 60s.
+ 90s.
@@ -469,7 +606,6 @@
processes of this socket unit shall be
killed. One of
,
- ,
,
.
@@ -479,13 +615,44 @@
systemd.service5
for details.
+
+
+ KillSignal=
+ Specifies which signal
+ to use when killing a process of this
+ socket. Defaults to SIGTERM.
+
+
+
+
+ SendSIGKILL=
+ 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".
+
+
+
+
+ Service=
+ Specifies the service
+ unit name to activate on incoming
+ traffic. This defaults to the service
+ that bears the same name as the socket
+ (ignoring the different suffixes). In
+ most cases it should not be necessary
+ to use this option.
+
+
See Also
- systemd8,
+ systemd1,
systemctl8,
systemd.unit5,
systemd.exec5,