shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-11-06 08:26:52 +03:00
Code
b26c39ad2c
systemd/man/sd-bus.xml

112 lines
7.3 KiB
XML
Raw Normal View History

man: drop mode line in file headers This is already included in .dir-locals, so we don't need it in the files themselves.
2018-07-03 00:15:39 +03:00
<?xml version='1.0'?>
man: use same header for all files The "include" files had type "book" for some raeason. I don't think this is meaningful. Let's just use the same everywhere. $ perl -i -0pe 's^..DOCTYPE (book|refentry) PUBLIC "-//OASIS//DTD DocBook XML V4.[25]//EN"\s+"http^<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"\n "http^gms' man/*.xml
2019-03-14 16:40:58 +03:00
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
man: standarize on one-line license header No need to waste space, and uniformity is good. $ perl -i -0pe 's|\n+<!--\s*SPDX-License-Identifier: LGPL-2.1..\s*-->|\n<!-- SPDX-License-Identifier: LGPL-2.1+ -->|gms' man/*.xml
2019-03-14 16:29:37 +03:00
<!-- SPDX-License-Identifier: LGPL-2.1+ -->
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
<refentry id="sd-bus" xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>sd-bus</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>sd-bus</refentrytitle>
<manvolnum>3</manvolnum>
</refmeta>
<refnamediv>
<refname>sd-bus</refname>
man: document sd_bus_track objects And while ware at it, also drop some references to kdbus, and stop claiming sd-bus wasn't stable yet. Also order man page references in the main sd-bus man page alphabetically.
2016-08-15 15:59:59 +03:00
<refpurpose>A lightweight D-Bus IPC client library</refpurpose>
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>#include &lt;systemd/sd-bus.h&gt;</funcsynopsisinfo>
</funcsynopsis>
<cmdsynopsis>
<command>pkg-config --cflags --libs libsystemd</command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
man: document sd_bus_track objects And while ware at it, also drop some references to kdbus, and stop claiming sd-bus wasn't stable yet. Also order man page references in the main sd-bus man page alphabetically.
2016-08-15 15:59:59 +03:00
<para><filename>sd-bus.h</filename> provides an implementation of a D-Bus IPC client. See
man: use https:// in URLs
2017-02-21 18:28:04 +03:00
<ulink url="https://www.freedesktop.org/software/dbus/" />
man: document sd_bus_track objects And while ware at it, also drop some references to kdbus, and stop claiming sd-bus wasn't stable yet. Also order man page references in the main sd-bus man page alphabetically.
2016-08-15 15:59:59 +03:00
for more information about D-Bus IPC.
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
</para>
<para>See
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<literallayout><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: document sd_bus_add_{object,fallback}_vtable The interface provided by those two functions is huge, so this text could probably be made two or three times as long if all details were described. But I think it's a good start.
2019-04-21 23:39:30 +03:00
<citerefentry><refentrytitle>sd_bus_add_object_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: document sd_bus_attach_event()
2018-10-06 21:31:17 +03:00
<citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add missing link in sd-bus(3) Follow-up for 576af73f4a01e0fec9f376ead40fcce558aeebe8.
2018-11-09 22:48:50 +03:00
<citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_get_n_queued_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_append_string_memfd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_append_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_copy(3)
2018-07-08 14:51:18 +03:00
<citerefentry><refentrytitle>sd_bus_message_copy</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_get_signature(3)
2018-08-23 16:31:21 +03:00
<citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_get_type(3) sd_bus_message{get_type,is_signal,is_method_call,is_method_error} get one man page. sd_bus_message_{set,get}_{destination,path,interface,member,sender} are put in the second one.
2018-07-27 15:58:41 +03:00
<citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_new(3)
2018-07-27 10:03:04 +03:00
<citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_new_call(3)
2018-07-26 21:00:36 +03:00
<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_new_error(3)
2018-07-08 13:49:32 +03:00
<citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_new_signal(3)
2018-07-25 00:23:29 +03:00
<citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_read_array(3)
2018-08-11 11:16:17 +03:00
<citerefentry><refentrytitle>sd_bus_message_read_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_rewind(3)
2018-08-02 11:38:51 +03:00
<citerefentry><refentrytitle>sd_bus_message_rewind</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_set_expect_reply(3)
2018-08-01 18:27:31 +03:00
<citerefentry><refentrytitle>sd_bus_message_set_expect_reply</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_skip(3)
2018-08-11 10:35:26 +03:00
<citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_message_verify_type(3)
2018-07-27 17:33:02 +03:00
<citerefentry><refentrytitle>sd_bus_message_verify_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_negotiate_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_reply_method_error(3)
2018-07-08 15:11:13 +03:00
<citerefentry><refentrytitle>sd_bus_reply_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_set_description(3)
2018-07-08 16:09:23 +03:00
<citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry>
sd-bus: make "close+flush-on-exit" optional when using sd-event with sd-bus This adds a new pair of API calls sd_bus_set_close_on_exit() and sd_bus_get_close_on_exit(). They control whether an sd_bus object attached to a an sd-event loop shall automatically be flushed/closed when the event loop goes down. Usually that's a good thing, except for very few cases where the bus connection is longer living than the event loop it is attached on. Specifically, this is the case for nspawn, where we run the event loop only while the container is up, but afterwards still want to be able to use the bus connection.
2018-10-06 19:43:28 +03:00
<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>
man: add sd_bus_slot_set_description(3)
2018-08-02 00:56:36 +03:00
<citerefentry><refentrytitle>sd_bus_slot_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: add sd_bus_slot_set_userdata(3)
2018-08-02 00:41:49 +03:00
<citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
sd-bus(3): synchronize the list with reality Use <literallayout> to keep each reference on a separate line. With all the pages jumbled together into a paragraph, it is quite hard to find anything in that list. Also add the missing pages to the list. And remove the nonexistent ones — not much point in advertisting pages that haven't been written yet.
2018-07-07 19:38:06 +03:00
<citerefentry><refentrytitle>sd_bus_track_add_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>
</literallayout>
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
for more information about the functions available.</para>
</refsect1>
<xi:include href="libsystemd-pkgconfig.xml" />
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
man: document sd_bus_track objects And while ware at it, also drop some references to kdbus, and stop claiming sd-bus wasn't stable yet. Also order man page references in the main sd-bus man page alphabetically.
2016-08-15 15:59:59 +03:00
<citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
<citerefentry project='man-pages'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
man: document sd_bus_track objects And while ware at it, also drop some references to kdbus, and stop claiming sd-bus wasn't stable yet. Also order man page references in the main sd-bus man page alphabetically.
2016-08-15 15:59:59 +03:00
<citerefentry project='man-pages'><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry>
man: add stub sd-bus(3) We have 126 broken links to sd-bus.html, it's nice to fix that. Current version is mostly a stub, with a long list of links to other pages. I think that's fine, especially that sd-bus might evolve quite a bit before it is made public. Not all of linked pages are written. Still missing: sd_bus_can_send sd_bus_get_name_creds sd_bus_get_owner_creds sd_bus_message_can_send sd_bus_message_get_creds sd_bus_message_set_allow_interactive_authorization sd_bus_send sd_bus_set_address sd_bus_set_description sd_bus_start sd_event_set_prepare sd-device systemd.busname
2016-01-26 04:20:58 +03:00
</para>
</refsect1>
</refentry>
Copy Permalink