diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-05-15 15:17:13 +0200 |
|---|---|---|
| committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2023-05-15 22:53:22 +0200 |
| commit | 4bc96dc16258d38d752a32612f196de6516fb27f (patch) | |
| tree | c404b982fbb53b0a94b526ff3b70df8cb40498af /man/libsystemd.xml | |
| parent | meson: add sd_pid_notify_barrier link (diff) | |
| download | systemd-4bc96dc16258d38d752a32612f196de6516fb27f.tar.xz systemd-4bc96dc16258d38d752a32612f196de6516fb27f.zip | |
man: add libsystemd(3)
Before libsystemd-daemon, libsystemd-journal, libsystemd-id128, etc., were
merged into libsystemd, it was enough to have individual man pages for them.
But they have been delivered as one thing for many years, so it's better to
have a landing page for libsystemd. It mostly directs to individual pages
anyway.
Diffstat (limited to 'man/libsystemd.xml')
| -rw-r--r-- | man/libsystemd.xml | 89 |
1 files changed, 89 insertions, 0 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> |