Commit 71e6c1cf authored by Lennart Poettering's avatar Lennart Poettering

man: document that sd-daemon.[ch] is now available as shared library

parent 5375410b
...@@ -129,17 +129,20 @@ ...@@ -129,17 +129,20 @@
resp. <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> resp. <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para>
<para>These APIs are implemented in the reference <para>These APIs are implemented in the reference
implementation's drop-in implementation's <filename>sd-daemon.c</filename> and
<filename>sd-daemon.c</filename> and <filename>sd-daemon.h</filename> files. These
<filename>sd-daemon.h</filename> files. It is interfaces are available as shared library, which can
recommended that applications consuming these APIs copy be compiled and linked to with the
the implementation into their source tree, either <literal>libsystemd-daemon</literal>
verbatim or in excerpts. These interfaces are <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
currently not available in a dynamic library.</para> file. Alternatively, applications consuming these APIs
may copy the implementation into their source tree,
either verbatim or in excerpts.</para>
<para>The functions directly related to new-style <para>The functions directly related to new-style
daemons become NOPs when -DDISABLE_SYSTEMD is set daemons become NOPs when -DDISABLE_SYSTEMD is set
during compilation. In addition, if during compilation and the reference implementation is
used as drop-in files. In addition, if
<filename>sd-daemon.c</filename> is compiled on <filename>sd-daemon.c</filename> is compiled on
non-Linux systems they become NOPs.</para> non-Linux systems they become NOPs.</para>
</refsect1> </refsect1>
......
...@@ -98,17 +98,23 @@ ...@@ -98,17 +98,23 @@
url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para>
<para><function>sd_booted()</function> is implemented <para><function>sd_booted()</function> is implemented
in the reference implementation's drop-in in the reference implementation's
<filename>sd-daemon.c</filename> and <filename>sd-daemon.c</filename> and
<filename>sd-daemon.h</filename> files. It is <filename>sd-daemon.h</filename> files. These
recommended that applications consuming these APIs interfaces are available as shared library, which can
copy the implementation into their source tree. For be compiled and linked to with the
more details about the reference implementation see <literal>libsystemd-daemon</literal>
<citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file. Alternatively, applications consuming these APIs
<para>If -DDISABLE_SYSTEMD is set during compilation may copy the implementation into their source
this function will always return 0 and otherwise tree. For more details about the reference
become a NOP.</para> implementation see
<citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<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
otherwise become a NOP.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
...@@ -178,7 +178,7 @@ ...@@ -178,7 +178,7 @@
<filename>getsockname()</filename> to check the file <filename>getsockname()</filename> to check the file
descriptor type and where it is bound to.</para> descriptor type and where it is bound to.</para>
<para>For details about the algorithm check the <para>For details about the algorithms check the
liberally licensed reference implementation sources: liberally licensed reference implementation sources:
<ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/>
resp. <ulink resp. <ulink
...@@ -186,13 +186,17 @@ ...@@ -186,13 +186,17 @@
<para><function>sd_is_fifo()</function> and the <para><function>sd_is_fifo()</function> and the
related functions are implemented in the reference related functions are implemented in the reference
implementation's drop-in implementation's <filename>sd-daemon.c</filename> and
<filename>sd-daemon.c</filename> and <filename>sd-daemon.h</filename> files. These
<filename>sd-daemon.h</filename> files. It is interfaces are available as shared library, which can
recommended that applications consuming these APIs be compiled and linked to with the
copy the implementation into their source tree. For <literal>libsystemd-daemon</literal>
more details about the reference implementation see <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
<citerefentry><refentrytitle>sd_daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> 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>7</manvolnum></citerefentry>.</para>
<para>These functions continue to work as described, <para>These functions continue to work as described,
even if -DDISABLE_SYSTEMD is set during even if -DDISABLE_SYSTEMD is set during
......
...@@ -145,17 +145,23 @@ ...@@ -145,17 +145,23 @@
url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para> url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.h"/></para>
<para><function>sd_listen_fds()</function> is <para><function>sd_listen_fds()</function> is
implemented in the reference implementation's drop-in implemented in the reference implementation's
<filename>sd-daemon.c</filename> and <filename>sd-daemon.c</filename> and
<filename>sd-daemon.h</filename> files. It is <filename>sd-daemon.h</filename> files. These
recommended that applications consuming these APIs interfaces are available as shared library, which can
copy the implementation into their source tree. For be compiled and linked to with the
more details about the reference implementation see <literal>libsystemd-daemon</literal>
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file. Alternatively, applications consuming these APIs
<para>If -DDISABLE_SYSTEMD is set during compilation may copy the implementation into their source
this function will always return 0 and otherwise tree. For more details about the reference
become a NOP.</para> implementation see
<citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<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
otherwise become a NOP.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
...@@ -206,7 +206,7 @@ ...@@ -206,7 +206,7 @@
datagram is accompanied by the process credentials of datagram is accompanied by the process credentials of
the sending daemon, using SCM_CREDENTIALS.</para> the sending daemon, using SCM_CREDENTIALS.</para>
<para>For details about the algorithm check the <para>For details about the algorithms check the
liberally licensed reference implementation sources: liberally licensed reference implementation sources:
<ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/> <ulink url="http://cgit.freedesktop.org/systemd/tree/src/sd-daemon.c"/>
resp. <ulink resp. <ulink
...@@ -214,17 +214,22 @@ ...@@ -214,17 +214,22 @@
<para><function>sd_notify()</function> and <para><function>sd_notify()</function> and
<function>sd_notifyf()</function> are implemented in <function>sd_notifyf()</function> are implemented in
the reference implementation's drop-in the reference implementation's
<filename>sd-daemon.c</filename> and <filename>sd-daemon.c</filename> and
<filename>sd-daemon.h</filename> files. It is <filename>sd-daemon.h</filename> files. These
recommended that applications consuming these APIs interfaces are available as shared library, which can
copy the implementation into their source tree. For be compiled and linked to with the
<literal>libsystemd-daemon</literal>
<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 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 <para>If the reference implementation is used as
this function will always return 0 and otherwise drop-in files and -DDISABLE_SYSTEMD is set during
become a NOP.</para> compilation these functions will always return 0 and
otherwise become a NOP.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
...@@ -134,17 +134,23 @@ ...@@ -134,17 +134,23 @@
url="http://cgit.freedesktop.org/systemd/tree/src/sd-readahead.h"/></para> url="http://cgit.freedesktop.org/systemd/tree/src/sd-readahead.h"/></para>
<para><function>sd_readahead()</function> is <para><function>sd_readahead()</function> is
implemented in the reference implementation's drop-in implemented in the reference implementation's
<filename>sd-readahead.c</filename> and <filename>sd-readahead.c</filename> and
<filename>sd-readahead.h</filename> files. It is <filename>sd-readahead.h</filename> files. These
recommended that applications consuming this API copy interfaces are available as shared library, which can
the implementation into their source tree. For more be compiled and linked to with the
details about the reference implementation see <literal>libsystemd-daemon</literal>
<citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> <citerefentry><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>
file. Alternatively, applications consuming this API
<para>If -DDISABLE_SYSTEMD is set during compilation may copy the implementation into their source
this function will always return 0 and otherwise tree. For more details about the reference
become a NOP.</para> implementation see
<citerefentry><refentrytitle>sd-readahead</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para>
<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
otherwise become a NOP.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment