diff options
-rw-r--r-- | man/libsystemd.xml | 89 | ||||
-rw-r--r-- | man/rules/meson.build | 1 | ||||
-rw-r--r-- | man/sd-bus-errors.xml | 1 | ||||
-rw-r--r-- | man/sd-bus.xml | 7 | ||||
-rw-r--r-- | man/sd-daemon.xml | 9 | ||||
-rw-r--r-- | man/sd-device.xml | 6 | ||||
-rw-r--r-- | man/sd-event.xml | 5 | ||||
-rw-r--r-- | man/sd-hwdb.xml | 6 | ||||
-rw-r--r-- | man/sd-id128.xml | 12 | ||||
-rw-r--r-- | man/sd-journal.xml | 5 | ||||
-rw-r--r-- | man/sd-login.xml | 7 |
11 files changed, 125 insertions, 23 deletions
diff --git a/man/libsystemd.xml b/man/libsystemd.xml new file mode 100644 index 0000000000..e9de64ca70 --- /dev/null +++ b/man/libsystemd.xml @@ -0,0 +1,89 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="libsystemd" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>libsystemd</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>libsystemd</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>libsystemd</refname> + <refpurpose>Functions for implementing services and interacting with systemd</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting> +#include <systemd/sd-bus.h> +#include <systemd/sd-bus-vtable.h> +#include <systemd/sd-bus-protocol.h> +#include <systemd/sd-daemon.h> +#include <systemd/sd-device.h> +#include <systemd/sd-event.h> +#include <systemd/sd-gpt.h> +#include <systemd/sd-hwdb.h> +#include <systemd/sd-id128.h> +#include <systemd/sd-journal.h> +#include <systemd/sd-login.h> +#include <systemd/sd-messages.h> +#include <systemd/sd-path.h> + </programlisting> + + <cmdsynopsis> + <command>pkg-config --cflags --libs libsystemd</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>The <filename>libsystemd</filename> library provides functions that allow interacting with various + interfaces provided by the + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> service + manager, as well as various other functions and constants useful for implementing services in + general.</para> + + <para>See + <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-device</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + and + <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry> + for information about different parts of the library interface.</para> + </refsect1> + + <refsect1> + <title>Interface stability</title> + + <para>Strict backwards-compatibility is maintained for the API (application programming interface) and + ABI (application binary interface). Symbol versioning is used, with symbols only added and never removed. + </para> + </refsect1> + + <xi:include href="libsystemd-pkgconfig.xml" /> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>libudev</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <ulink url="https://systemd.io/PORTABILITY_AND_STABILITY/">Interface Portability and Stability Promise</ulink> + </para> + </refsect1> + +</refentry> diff --git a/man/rules/meson.build b/man/rules/meson.build index b5aa2bff8a..6bd54739af 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -31,6 +31,7 @@ manpages = [ ['journald.conf', '5', ['journald.conf.d', 'journald@.conf'], ''], ['kernel-command-line', '7', [], ''], ['kernel-install', '8', [], 'ENABLE_KERNEL_INSTALL'], + ['libsystemd', '3', [], ''], ['libudev', '3', [], ''], ['loader.conf', '5', [], 'ENABLE_BOOTLOADER'], ['locale.conf', '5', [], ''], diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml index dc9d9fc63b..cade523763 100644 --- a/man/sd-bus-errors.xml +++ b/man/sd-bus-errors.xml @@ -274,6 +274,7 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 36925ba8c4..4c9c00986a 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -34,10 +34,11 @@ <refsect1> <title>Description</title> - <para><filename>sd-bus.h</filename> provides an implementation of a D-Bus IPC client. See + <para><filename>sd-bus.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides an implementation of a D-Bus IPC client. See <ulink url="https://www.freedesktop.org/software/dbus/" /> - for more information about D-Bus IPC. - </para> + for more information about D-Bus IPC.</para> <para>See <literallayout><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 5dee3e893c..6cd06a81e3 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -44,10 +44,11 @@ <refsect1> <title>Description</title> - <para><filename>sd-daemon.h</filename> provides APIs for new-style - daemons, as implemented by the - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - service manager.</para> + <para><filename>sd-daemon.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs for new-style daemons, as implemented by the + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> service + manager.</para> <para>See <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, diff --git a/man/sd-device.xml b/man/sd-device.xml index 7af839b4bd..4950781f84 100644 --- a/man/sd-device.xml +++ b/man/sd-device.xml @@ -34,8 +34,10 @@ <refsect1> <title>Description</title> - <para><filename>sd-device.h</filename> provides an API to introspect and enumerate devices on the local - system. It provides a programmatic interface to the database of devices and their properties mananaged by + <para><filename>sd-device.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides an API to introspect and enumerate devices on the local system. It provides a programmatic + interface to the database of devices and their properties mananaged by <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. This API is a replacement for <citerefentry><refentrytitle>libudev</refentrytitle><manvolnum>3</manvolnum></citerefentry> and diff --git a/man/sd-event.xml b/man/sd-event.xml index cb3108aee6..2f17b89145 100644 --- a/man/sd-event.xml +++ b/man/sd-event.xml @@ -34,8 +34,9 @@ <refsect1> <title>Description</title> - <para><filename>sd-event.h</filename> provides a generic event - loop implementation, based on Linux <citerefentry + <para><filename>sd-event.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides a generic event loop implementation, based on Linux <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para> diff --git a/man/sd-hwdb.xml b/man/sd-hwdb.xml index 254c218ac6..189fcd6b6c 100644 --- a/man/sd-hwdb.xml +++ b/man/sd-hwdb.xml @@ -34,8 +34,10 @@ <refsect1> <title>Description</title> - <para><filename>sd-hwdb.h</filename> allows read-only access the systemd database of hardware properties. - See <citerefentry><refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum></citerefentry> and + <para><filename>sd-hwdb.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and allows + read-only access the systemd database of hardware properties. See + <citerefentry><refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum></citerefentry> and <citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry> for more information about the database.</para> diff --git a/man/sd-id128.xml b/man/sd-id128.xml index c869943ad7..245bfbb4d3 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -121,11 +121,13 @@ <refsect1> <title>Description</title> - <para><filename>sd-id128.h</filename> provides APIs to generate, convert, and compare 128-bit ID values. - The 128-bit ID values processed and generated by these APIs are a generalization of OSF UUIDs as defined - by <ulink url="https://tools.ietf.org/html/rfc4122">RFC 4122</ulink> but use a simpler string format. - These functions impose no structure on the used IDs, much unlike OSF UUIDs or Microsoft GUIDs, but are - mostly compatible with those types of IDs. + <para><filename>sd-id128.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs to generate, convert, and compare 128-bit ID values. The 128-bit ID values processed and + generated by these APIs are a generalization of OSF UUIDs as defined by <ulink + url="https://tools.ietf.org/html/rfc4122">RFC 4122</ulink> but use a simpler string format. These + functions impose no structure on the used IDs, much unlike OSF UUIDs or Microsoft GUIDs, but are mostly + compatible with those types of IDs. </para> <para>A 128-bit ID is implemented as the following diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 4609868c11..34debb4d36 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -36,8 +36,9 @@ <refsect1> <title>Description</title> - <para><filename>sd-journal.h</filename> provides APIs to submit - and query log entries. The APIs exposed act both as client for the + <para><filename>sd-journal.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs to submit and query log entries. The APIs exposed act both as client for the <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> journal service and as parser for the journal files on disk. </para> diff --git a/man/sd-login.xml b/man/sd-login.xml index 0127b691f5..61b555a7ab 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -35,9 +35,10 @@ <refsect1> <title>Description</title> - <para><filename>sd-login.h</filename> provides APIs to introspect - and monitor seat, login session and user status information on the - local system. </para> + <para><filename>sd-login.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs to introspect and monitor seat, login session, and user status information on the local + system.</para> <para>Note that these APIs only allow purely passive access and monitoring of seats, sessions and users. To actively make changes |