sd-bus: Add sd_bus_set_exec docs

This commit is contained in:
Daan De Meyer 2020-04-11 21:57:36 +02:00
parent 59a77060e0
commit 3415b0cc8a
2 changed files with 17 additions and 5 deletions

View file

@ -342,7 +342,7 @@ manpages = [
'sd_bus_request_name_async'], 'sd_bus_request_name_async'],
''], ''],
['sd_bus_send', '3', [], ''], ['sd_bus_send', '3', [], ''],
['sd_bus_set_address', '3', ['sd_bus_get_address'], ''], ['sd_bus_set_address', '3', ['sd_bus_get_address', 'sd_bus_set_exec'], ''],
['sd_bus_set_close_on_exit', '3', ['sd_bus_get_close_on_exit'], ''], ['sd_bus_set_close_on_exit', '3', ['sd_bus_get_close_on_exit'], ''],
['sd_bus_set_connected_signal', '3', ['sd_bus_get_connected_signal'], ''], ['sd_bus_set_connected_signal', '3', ['sd_bus_get_connected_signal'], ''],
['sd_bus_set_description', ['sd_bus_set_description',

View file

@ -19,6 +19,7 @@
<refnamediv> <refnamediv>
<refname>sd_bus_set_address</refname> <refname>sd_bus_set_address</refname>
<refname>sd_bus_get_address</refname> <refname>sd_bus_get_address</refname>
<refname>sd_bus_set_exec</refname>
<refpurpose>Set or query the address of the bus connection</refpurpose> <refpurpose>Set or query the address of the bus connection</refpurpose>
</refnamediv> </refnamediv>
@ -39,6 +40,12 @@
<paramdef>const char **<parameter>address</parameter></paramdef> <paramdef>const char **<parameter>address</parameter></paramdef>
</funcprototype> </funcprototype>
<funcprototype>
<funcdef>int <function>sd_bus_set_exec</function></funcdef>
<paramdef>sd_bus *<parameter>bus</parameter></paramdef>
<paramdef>const char *<parameter>path</parameter></paramdef>
<paramdef>char *const *<parameter>argv</parameter></paramdef>
</funcprototype>
</funcsynopsis> </funcsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -104,6 +111,11 @@
automatically by automatically by
<citerefentry><refentrytitle>sd_bus_open</refentrytitle><manvolnum>3</manvolnum></citerefentry> and <citerefentry><refentrytitle>sd_bus_open</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
similar calls, based on environment variables or built-in defaults.</para> similar calls, based on environment variables or built-in defaults.</para>
<para><function>sd_bus_set_exec</function> is a shorthand function for setting a
<literal>unixexec</literal> address that spawns the given executable with the given arguments.
If <parameter>argv</parameter> is <constant>NULL</constant>, the given executable is spawned
without any extra arguments.</para>
</refsect1> </refsect1>
<refsect1> <refsect1>