chiark / gitweb /
build-sys: drop AM_GNU_GETTEXT as it fights with IT_PROG_INTLTOOL
[elogind.git] / man / sd_listen_fds.xml
index 4164a991d93bcbcafd97bf74055154153fbada40..128d859b97631136817e0c81ba769ef9dad81435 100644 (file)
                 <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
                 <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
-                recommened to make these checks as loose as possible
+                recommended to make these checks as loose as possible
                 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
                 datagram or stream socket matters a lot for the most
                 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
                 datagram or stream socket matters a lot for the most
-                common program logics and should hence be
-                checked.</para>
+                common program logics and should be checked.</para>
 
                 <para>This function call will set the FD_CLOEXEC flag
                 for all passed file descriptors to avoid further
 
                 <para>This function call will set the FD_CLOEXEC flag
                 for all passed file descriptors to avoid further
                 <para>On failure, this call returns a negative
                 errno-style error code. If
                 <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname>
                 <para>On failure, this call returns a negative
                 errno-style error code. If
                 <varname>$LISTEN_FDS</varname>/<varname>$LISTEN_PID</varname>
-                was not set or not correctly set for this daemon and
-                hence no file descriptors received 0 is
+                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
+                passed is returned. The application may find them
                 starting with file descriptor SD_LISTEN_FDS_START,
                 i.e. file descriptor 3.</para>
         </refsect1>
                 starting with file descriptor SD_LISTEN_FDS_START,
                 i.e. file descriptor 3.</para>
         </refsect1>
                 recommended that applications consuming these APIs
                 copy the implementation into their source tree. For
                 more details about the reference implementation see
                 recommended that applications consuming these APIs
                 copy the implementation into their source tree. For
                 more details about the reference implementation see
-                <citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para>
+                <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para>
 
                 <para>If -DDISABLE_SYSTEMD is set during compilation
                 this function will always return 0 and otherwise
                 become a NOP.</para>
         </refsect1>
 
 
                 <para>If -DDISABLE_SYSTEMD is set during compilation
                 this function will always return 0 and otherwise
                 become a NOP.</para>
         </refsect1>
 
+        <refsect1>
+                <title>Environment</title>
+
+                <variablelist>
+                        <varlistentry>
+                                <term><varname>$LISTEN_PID</varname></term>
+                                <term><varname>$LISTEN_FDS</varname></term>
+
+                                <listitem><para>Set by the init system
+                                for supervised processes that use
+                                socket-based activation. This
+                                environment variable specifies the
+                                data
+                                <function>sd_listen_fds()</function>
+                                parses. See above for
+                                details.</para></listitem>
+                        </varlistentry>
+                </variablelist>
+        </refsect1>
+
         <refsect1>
                 <title>See Also</title>
 
         <refsect1>
                 <title>See Also</title>