diff options
Diffstat (limited to 'man/sd_listen_fds.xml')
| -rw-r--r-- | man/sd_listen_fds.xml | 21 |
1 files changed, 10 insertions, 11 deletions
diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 9c8fdbccaf..240300dcb0 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -70,7 +70,7 @@ activation logic.</para> <para>If the <parameter>unset_environment</parameter> - parameter is non-zero + parameter is non-zero, <function>sd_listen_fds()</function> will unset the <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname> environment variables before returning (regardless @@ -83,16 +83,16 @@ <para>If a daemon receives more than one file descriptor, they will be passed in the same order as configured in the systemd socket definition - file. Nonetheless it is recommended to verify the + file. Nonetheless, it is recommended to verify the correct socket types before using them. To simplify - this checking the functions + this checking, the functions <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_is_socket</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_is_socket_inet</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_is_socket_unix</refentrytitle><manvolnum>3</manvolnum></citerefentry> - are provided. In order to maximize flexibility it is + are provided. In order to maximize flexibility, it is recommended to make these checks as loose as possible - without allowing incorrect setups. i.e. often the + without allowing incorrect setups. i.e. often, the actual port number a socket is bound to matters little for the service to work, hence it should not be verified. On the other hand, whether a socket is a @@ -112,7 +112,7 @@ <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname> was not set or was not correctly set for this daemon and hence no file descriptors were received, 0 is - returned. Otherwise the number of file descriptors + returned. Otherwise, the number of file descriptors passed is returned. The application may find them starting with file descriptor SD_LISTEN_FDS_START, i.e. file descriptor 3.</para> @@ -132,11 +132,11 @@ <para>Internally, this function checks whether the <varname>$LISTEN_PID</varname> environment variable equals the daemon PID. If not, it returns - immediately. Otherwise it parses the number passed in + immediately. Otherwise, it parses the number passed in the <varname>$LISTEN_FDS</varname> environment variable, then sets the FD_CLOEXEC flag for the parsed number of file descriptors starting from - SD_LISTEN_FDS_START. Finally it returns the parsed + SD_LISTEN_FDS_START. Finally, it returns the parsed number.</para> <para>For details about the algorithm check the @@ -151,8 +151,7 @@ <filename>sd-daemon.h</filename> files. These interfaces are available as shared library, which can be compiled and linked to with the - <literal>libsystemd-daemon</literal> - <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <constant>libsystemd-daemon</constant> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> file. Alternatively, applications consuming these APIs may copy the implementation into their source tree. For more details about the reference @@ -161,7 +160,7 @@ <para>If the reference implementation is used as drop-in files and -DDISABLE_SYSTEMD is set during - compilation this function will always return 0 and + compilation, this function will always return 0 and otherwise become a NOP.</para> </refsect1> |