diff options
author | Lennart Poettering <lennart@poettering.net> | 2024-11-05 14:07:31 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2024-11-05 22:57:51 +0100 |
commit | 4f5fabe7a39f046e0456eba07472df061e85c94e (patch) | |
tree | 675e0a52b7ed3301fae38c0b49c8e76af016b027 | |
parent | man: tone down claims on processes having exited already in ExecStop= (diff) | |
download | systemd-4f5fabe7a39f046e0456eba07472df061e85c94e.tar.xz systemd-4f5fabe7a39f046e0456eba07472df061e85c94e.zip |
man: add brief entrypoint man page for sd-varlink
We have this in a similar fashion for the other APIs libsystemd
provides. Add the same for sd-varlink. There isn't too much on it for
now, but at least it's a start.
Also link it up everywhere.
-rw-r--r-- | man/libsystemd.xml | 4 | ||||
-rw-r--r-- | man/rules/meson.build | 1 | ||||
-rw-r--r-- | man/sd-bus.xml | 1 | ||||
-rw-r--r-- | man/sd-json.xml | 3 | ||||
-rw-r--r-- | man/sd-varlink.xml | 64 |
5 files changed, 71 insertions, 2 deletions
diff --git a/man/libsystemd.xml b/man/libsystemd.xml index d3d9798d6b..ef34571dd6 100644 --- a/man/libsystemd.xml +++ b/man/libsystemd.xml @@ -35,6 +35,7 @@ #include <systemd/sd-login.h> #include <systemd/sd-messages.h> #include <systemd/sd-path.h> +#include <systemd/sd-varlink.h> </programlisting> <cmdsynopsis> @@ -61,8 +62,9 @@ <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - and <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry> for information about different parts of the library interface.</para> </refsect1> diff --git a/man/rules/meson.build b/man/rules/meson.build index eb4300386d..ce587efb21 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -155,6 +155,7 @@ manpages = [ ['sd-journal', '3', [], ''], ['sd-json', '3', [], ''], ['sd-login', '3', [], 'HAVE_PAM'], + ['sd-varlink', '3', [], ''], ['sd_booted', '3', [], ''], ['sd_bus_add_match', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 26392d7a31..238c5a68c9 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -189,6 +189,7 @@ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry project='man-pages'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> <member><citerefentry project='man-pages'><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> </simplelist></para> diff --git a/man/sd-json.xml b/man/sd-json.xml index e10ef0d953..95a1985d6f 100644 --- a/man/sd-json.xml +++ b/man/sd-json.xml @@ -84,7 +84,8 @@ <refsect1> <title>See Also</title> <para><simplelist type="inline"> - <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>, + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/sd-varlink.xml b/man/sd-varlink.xml new file mode 100644 index 0000000000..b28d100b31 --- /dev/null +++ b/man/sd-varlink.xml @@ -0,0 +1,64 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="sd-varlink" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>sd-varlink</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>sd-varlink</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd-varlink</refname> + <refpurpose>APIs for Varlink IPC</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-varlink.h></funcsynopsisinfo> + </funcsynopsis> + + <cmdsynopsis> + <command>pkg-config --cflags --libs libsystemd</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><filename>sd-varlink.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs for implementing Varlink IPC clients and services. See <ulink url="https://varlink.org/"/> + for more information about Varlink IPC.</para> + + <para>Varlink IPC uses <ulink url="https://json.org/">JSON</ulink> as marshalling format. The sd-varlink + API relies on the + <citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry> API for JSON + seralization, deserialization and manipulation.</para> + + <para>The <citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool + makes the functionality implemented by sd-varlink available from the command line.</para> + </refsect1> + + <xi:include href="libsystemd-pkgconfig.xml" /> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> |