diff --git a/man/libsystemd.xml b/man/libsystemd.xml new file mode 100644 index 00000000000..e9de64ca708 --- /dev/null +++ b/man/libsystemd.xml @@ -0,0 +1,89 @@ + + + + + + + + libsystemd + systemd + + + + libsystemd + 3 + + + + libsystemd + Functions for implementing services and interacting with systemd + + + + +#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> + + + + pkg-config --cflags --libs libsystemd + + + + + Description + + The libsystemd library provides functions that allow interacting with various + interfaces provided by the + systemd1 service + manager, as well as various other functions and constants useful for implementing services in + general. + + See + sd-bus3, + sd-bus-errors3, + sd-daemon3, + sd-device3, + sd-event3, + sd-hwdb3, + sd-id1283, + sd-journal3, + and + sd-login3 + for information about different parts of the library interface. + + + + Interface stability + + 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. + + + + + + + See Also + + systemd1, + libudev1, + pkg-config1, + Interface Portability and Stability Promise + + + + diff --git a/man/rules/meson.build b/man/rules/meson.build index b5aa2bff8a3..6bd54739af3 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 dc9d9fc63b5..cade523763b 100644 --- a/man/sd-bus-errors.xml +++ b/man/sd-bus-errors.xml @@ -274,6 +274,7 @@ systemd1, + libsystemd3, sd-bus3, sd_bus_error3, sd_bus_message_set_allow_interactive_authorization3, diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 36925ba8c4c..4c9c00986a2 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -34,10 +34,11 @@ Description - sd-bus.h provides an implementation of a D-Bus IPC client. See + sd-bus.h is part of + libsystemd3 and + provides an implementation of a D-Bus IPC client. See - for more information about D-Bus IPC. - + for more information about D-Bus IPC. See sd_bus_add_match3, diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 5dee3e893c8..6cd06a81e3a 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -44,10 +44,11 @@ Description - sd-daemon.h provides APIs for new-style - daemons, as implemented by the - systemd1 - service manager. + sd-daemon.h is part of + libsystemd3 and + provides APIs for new-style daemons, as implemented by the + systemd1 service + manager. See sd_listen_fds3, diff --git a/man/sd-device.xml b/man/sd-device.xml index 7af839b4bda..4950781f84b 100644 --- a/man/sd-device.xml +++ b/man/sd-device.xml @@ -34,8 +34,10 @@ Description - sd-device.h 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 + sd-device.h is part of + libsystemd3 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 systemd-udevd.service8. This API is a replacement for libudev3 and diff --git a/man/sd-event.xml b/man/sd-event.xml index cb3108aee6a..2f17b89145d 100644 --- a/man/sd-event.xml +++ b/man/sd-event.xml @@ -34,8 +34,9 @@ Description - sd-event.h provides a generic event - loop implementation, based on Linux sd-event.h is part of + libsystemd3 and + provides a generic event loop implementation, based on Linux epoll7. diff --git a/man/sd-hwdb.xml b/man/sd-hwdb.xml index 254c218ac63..189fcd6b6c8 100644 --- a/man/sd-hwdb.xml +++ b/man/sd-hwdb.xml @@ -34,8 +34,10 @@ Description - sd-hwdb.h allows read-only access the systemd database of hardware properties. - See hwdb7 and + sd-hwdb.h is part of + libsystemd3 and allows + read-only access the systemd database of hardware properties. See + hwdb7 and systemd-hwdb8 for more information about the database. diff --git a/man/sd-id128.xml b/man/sd-id128.xml index c869943ad72..245bfbb4d39 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -121,11 +121,13 @@ Description - sd-id128.h 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 RFC 4122 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. + sd-id128.h is part of + libsystemd3 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 RFC 4122 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. A 128-bit ID is implemented as the following diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 4609868c113..34debb4d36c 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -36,8 +36,9 @@ Description - sd-journal.h provides APIs to submit - and query log entries. The APIs exposed act both as client for the + sd-journal.h is part of + libsystemd3 and + provides APIs to submit and query log entries. The APIs exposed act both as client for the systemd-journald.service8 journal service and as parser for the journal files on disk. diff --git a/man/sd-login.xml b/man/sd-login.xml index 0127b691f55..61b555a7ab7 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -35,9 +35,10 @@ Description - sd-login.h provides APIs to introspect - and monitor seat, login session and user status information on the - local system. + sd-login.h is part of + libsystemd3 and + provides APIs to introspect and monitor seat, login session, and user status information on the local + system. Note that these APIs only allow purely passive access and monitoring of seats, sessions and users. To actively make changes