memfd: rename memfd.h to memfd-util.h to avoid any confusion with any libc provided...

[elogind.git] / man / sd_is_fifo.xml

diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml
index 2bc860c373adccc371a875abb8612952ee0086a9..17ecca833672be4c9c915eba1a9915ba14cf86cb 100644 (file)
--- a/man/sd_is_fifo.xml
+++ b/man/sd_is_fifo.xml
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="sd_is_fifo">
+<refentry id="sd_is_fifo"
+        xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>sd_is_fifo</title>
@@ -48,6 +49,7 @@
                 <refname>sd_is_socket_inet</refname>
                 <refname>sd_is_socket_unix</refname>
                 <refname>sd_is_mq</refname>
+                <refname>sd_is_special</refname>
                 <refpurpose>Check the type of a file descriptor</refpurpose>
         </refnamediv>
 
@@ -83,7 +85,7 @@
                                 <paramdef>int <parameter>fd</parameter></paramdef>
                                 <paramdef>int <parameter>type</parameter></paramdef>
                                 <paramdef>int <parameter>listening</parameter></paramdef>
-                                <paramdef>const char* <parameter>path</parameter></paramdef>
+                                <paramdef>const char *<parameter>path</parameter></paramdef>
                                 <paramdef>size_t <parameter>length</parameter></paramdef>
                         </funcprototype>
 
@@ -93,6 +95,12 @@
                                 <paramdef>const char *<parameter>path</parameter></paramdef>
                         </funcprototype>
 
+                        <funcprototype>
+                                <funcdef>int <function>sd_is_special</function></funcdef>
+                                <paramdef>int <parameter>fd</parameter></paramdef>
+                                <paramdef>const char *<parameter>path</parameter></paramdef>
+                        </funcprototype>
+
                 </funcsynopsis>
         </refsynopsisdiv>
 
@@ -153,6 +161,16 @@
                 <parameter>path</parameter> parameter is not
                 <constant>NULL</constant>, it is checked whether the
                 message queue is bound to the specified name.</para>
+
+                <para><function>sd_is_special()</function> may be
+                called to check whether the specified file descriptor
+                refers to a special file. If the
+                <parameter>path</parameter> parameter is not
+                <constant>NULL</constant>, it is checked whether the file
+                descriptor is bound to the specified file
+                name. Special files in this context are character
+                device nodes and files in <filename>/proc</filename>
+                or <filename>/sys</filename>.</para>
         </refsect1>
 
         <refsect1>
@@ -168,41 +186,12 @@
         <refsect1>
                 <title>Notes</title>
 
-                <para>These functions are provided by the reference
-                implementation of APIs for new-style daemons and
-                distributed with the systemd package. The algorithms
-                they implement are simple, and they can easily be
-                reimplemented in daemons if it is important to support
-                this interface without using the reference
-                implementation.</para>
+                <xi:include href="libsystemd-pkgconfig.xml" xpointer="pkgconfig-text"/>
 
                 <para>Internally, these function use a combination of
                 <filename>fstat()</filename> and
                 <filename>getsockname()</filename> to check the file
                 descriptor type and where it is bound to.</para>
-
-                <para>For details about the algorithms, check the
-                liberally licensed reference implementation sources:
-                <ulink url="http://cgit.freedesktop.org/systemd/systemd/plain/src/libsystemd-daemon/sd-daemon.c"/>
-                and <ulink
-                url="http://cgit.freedesktop.org/systemd/systemd/plain/src/systemd/sd-daemon.h"/></para>
-
-                <para><function>sd_is_fifo()</function> and the
-                related functions are implemented in the reference
-                implementation's <filename>sd-daemon.c</filename> and
-                <filename>sd-daemon.h</filename> files. These
-                interfaces are available as shared library, which can
-                be compiled and linked to with the
-                <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
-                implementation see
-                <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para>
-
-                <para>These functions continue to work as described,
-                even if -DDISABLE_SYSTEMD is set during
-                compilation.</para>
         </refsect1>
 
         <refsect1>