X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Fsystemd.socket.xml;h=0a2d86996be29c9001416b1e861dcee67f68a7a0;hp=9db39b1de9d0921359d4d75860124d4ed97f2316;hb=05cc726731c5cec952722f1c14acb08e3d4d5e98;hpb=16dad32e437fdf2ffca03cc60a083d84bd31886f diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 9db39b1de..0a2d86996 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -48,7 +48,7 @@ - systemd.socket + socket.socket @@ -75,7 +75,7 @@ , , and - commands are executed + commands are executed in, and in systemd.kill5 which define the way the processes are @@ -143,29 +143,31 @@ options specific to the [Socket] section of socket units are the following: - + ListenStream= ListenDatagram= ListenSequentialPacket= Specifies an address to listen on for a stream - (SOCK_STREAM), datagram (SOCK_DGRAM), + (SOCK_STREAM), datagram (SOCK_DGRAM), or sequential packet - (SOCK_SEQPACKET) socket, respectively. The address + (SOCK_SEQPACKET) socket, respectively. The address can be written in various formats: If the address starts with a - slash (/), it is read as file system - socket in the AF_UNIX socket + slash (/), it is read as file system + socket in the AF_UNIX socket family. - If the address starts with an - 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 - see + If the address starts with an 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 see unix7. If the address string is a @@ -193,31 +195,36 @@ setting (see below). - Note that SOCK_SEQPACKET + Note that SOCK_SEQPACKET (i.e. ListenSequentialPacket=) - is only available for AF_UNIX - sockets. SOCK_STREAM + is only available for AF_UNIX + sockets. SOCK_STREAM (i.e. ListenStream=) when used for IP sockets refers to TCP - sockets, SOCK_DGRAM + sockets, SOCK_DGRAM (i.e. ListenDatagram=) to UDP. These options may be specified more than once in which case incoming - traffic on any of the sockets will trigger - service activation, and all listed - sockets will be passed to the service, - regardless whether there is incoming - traffic on them or not. - - If an IP address is used here, it - is often desirable to listen on it + traffic on any of the sockets will + trigger service activation, and all + listed sockets will be passed to the + service, regardless whether there is + incoming traffic on them or not. If + the empty string is assigned to any of + these options, the list of addresses + to listen on is reset, all prior uses + of any of these options will have no + effect. + + If an IP address is used here, + it is often desirable to listen on it before the interface it is configured on is up and running, and even regardless whether it will be up and - running ever at all. To deal with this it is - recommended to set the + running ever at all. To deal with this + it is recommended to set the FreeBind= option described below. @@ -253,7 +260,7 @@ Specifies a Netlink family to create a socket for to listen on. This expects a short string - referring to the AF_NETLINK family + referring to the AF_NETLINK family name (such as audit or kobject-uevent) as argument, optionally suffixed by a @@ -336,7 +343,7 @@ DirectoryMode= If listening on a file - system socket of FIFO, the parent + system socket or FIFO, the parent directories are automatically created if needed. This option specifies the file system access mode used when @@ -349,7 +356,7 @@ SocketMode= If listening on a file - system socket of FIFO, this option + system socket or FIFO, this option specifies the file system access mode used when creating the file node. Takes an access mode in octal @@ -369,17 +376,30 @@ and only one service unit is spawned for all connections (also see above). This value is ignored for - datagram sockets and FIFOs where - a single service unit unconditionally + datagram sockets and FIFOs where a + single service unit unconditionally handles all incoming traffic. Defaults to . For performance reasons, it is recommended to write new daemons only in a way that is suitable for - . This - option is mostly useful to allow - daemons designed for usage with - inetd8, + . A + daemon listening on an AF_UNIX socket + may, but does not need to, call + close2 + on the received socket before + exiting. However, it must not unlink + the socket from a file system. It + should not invoke + shutdown2 + on sockets it got with + Accept=false, but + it may do so for sockets it got with + Accept=true set. + Setting Accept=true + is mostly useful to allow daemons + designed for usage with + inetd8 to work unmodified with systemd socket activation. @@ -394,8 +414,8 @@ are coming in, they will be refused until at least one existing connection is terminated. This setting has no - effect for sockets configured with - or datagram + effect on sockets configured with + or datagram sockets. Defaults to 64. @@ -484,12 +504,32 @@ for details. + + SmackLabel= + SmackLabelIPIn= + SmackLabelIPOut= + Takes a string + value. Controls the extended + attributes + security.SMACK64, + security.SMACK64IPIN + and + security.SMACK64IPOUT, + respectively, i.e. the security label + of the FIFO, or the security label for + the incoming or outgoing connections + of the socket, respectively. See + Smack.txt + for details. + + PipeSize= Takes an integer value. Controls the pipe buffer size of FIFOs configured in this socket - unit. See + unit. See fcntl2 for details. @@ -546,7 +586,7 @@ PassCredentials= Takes a boolean value. This controls the SO_PASSCRED - socket option, which allows AF_UNIX sockets to + socket option, which allows AF_UNIX sockets to receive the credentials of the sending process in an ancillary message. Defaults to @@ -557,10 +597,10 @@ PassSecurity= Takes a boolean value. This controls the SO_PASSSEC - socket option, which allows AF_UNIX + socket option, which allows AF_UNIX sockets to receive the security context of the sending process in an - ancillary message. Defaults to + ancillary message. Defaults to . @@ -584,7 +624,7 @@ before or after the listening sockets/FIFOs are created and bound, respectively. The first token of the command - line must be an absolute file name, + line must be an absolute filename, then followed by arguments for the process. Multiple command lines may be specified following the same scheme as @@ -619,8 +659,8 @@ will be considered failed and be shut down again. All commands still running, will be terminated forcibly via - SIGTERM, and after another delay of - this time with SIGKILL. (See + 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 @@ -658,7 +698,16 @@ systemd.unit5, systemd.exec5, systemd.kill5, - systemd.service5 + systemd.service5, + systemd.directives7 + + + + For more extensive descriptions see the "systemd for Developers" series: + Socket Activation, + Socket Activation, part II, + Converting inetd Services, + Socket Activated Internet Services and OS Containers.