diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 03:50:40 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-12 03:50:40 +0000 |
| commit | fc53809803cd2bc2434e312b19a18fa36776da12 (patch) | |
| tree | b4b43bd6538f51965ce32856e9c053d0f90919c8 /man | |
| parent | Adding upstream version 255.5. (diff) | |
| download | systemd-fc53809803cd2bc2434e312b19a18fa36776da12.tar.xz systemd-fc53809803cd2bc2434e312b19a18fa36776da12.zip | |
Adding upstream version 256.upstream/256
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man')
441 files changed, 12294 insertions, 6878 deletions
diff --git a/man/binfmt.d.xml b/man/binfmt.d.xml index ab56460..1442e2c 100644 --- a/man/binfmt.d.xml +++ b/man/binfmt.d.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="binfmt.d" conditional='ENABLE_BINFMT' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -23,9 +23,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/binfmt.d/*.conf</filename></para> - <para><filename>/run/binfmt.d/*.conf</filename></para> - <para><filename>/usr/lib/binfmt.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/binfmt.d/*.conf</filename></member> + <member><filename>/run/binfmt.d/*.conf</filename></member> + <member><filename>/usr/local/lib/binfmt.d/*.conf</filename></member> + <member><filename>/usr/lib/binfmt.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -63,12 +66,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-binfmt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-binfmt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/bootctl.xml b/man/bootctl.xml index 68e4774..d5ded28 100644 --- a/man/bootctl.xml +++ b/man/bootctl.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="bootctl" conditional='ENABLE_BOOTLOADER' +<refentry id="bootctl" xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>bootctl</title> @@ -353,7 +353,7 @@ Specification Type #2 entries should be placed in the directory <literal>$(bootctl -x)/EFI/Linux/</literal>.</para> - <para>Note that this option (similarly to the <option>--print-boot-path</option> option mentioned + <para>Note that this option (similarly to the <option>--print-esp-path</option> option mentioned above), is available independently from the boot loader used, i.e. also without <command>systemd-boot</command> being installed.</para> @@ -638,11 +638,11 @@ Boot Loader Entries: <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>, - <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, - <citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member> + <member><ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink></member> + <member><citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/bootup.xml b/man/bootup.xml index c872b13..c942bab 100644 --- a/man/bootup.xml +++ b/man/bootup.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="bootup"> @@ -31,13 +31,12 @@ boot loader will then invoke an OS kernel from disk (or the network). On systems using EFI or other types of firmware, this firmware may also load the kernel directly.</para> - <para>The kernel (optionally) mounts an in-memory file system, often generated by <citerefentry - project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry>, which - looks for the root file system. Nowadays this is implemented as an "initramfs" — a compressed CPIO - archive that the kernel extracts into a tmpfs. In the past normal file systems using an in-memory block - device (ramdisk) were used, and the name "initrd" is still used to describe both concepts. It's the boot - loader or the firmware that loads both the kernel and initrd/initramfs images into memory, but the kernel - which interprets it as a file system. + <para>The kernel (optionally) mounts an in-memory file system, which looks for the root file system. + Nowadays this is implemented as an "initramfs" — a compressed CPIO archive that the kernel extracts into + a tmpfs. In the past normal file systems using an in-memory block device (ramdisk) were used, and the + name "initrd" is still used to describe both concepts. It's the boot loader or the firmware that loads + both the kernel and initrd/initramfs images into memory, but the kernel which interprets it as a file + system. <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> may be used to manage services in the initrd, similarly to the real system.</para> @@ -313,21 +312,23 @@ emergency.service | | | v final.target | - ___________________________/ \_________________ - / | | \ - | | | | - v | | | -systemd-reboot.service | | | - | v | | - | systemd-poweroff.service | | - v | v | - <emphasis>reboot.target</emphasis> | systemd-halt.service | - v | v - <emphasis>poweroff.target</emphasis> | systemd-kexec.service - v | - <emphasis>halt.target</emphasis> | - v - <emphasis>kexec.target</emphasis></programlisting> + ___________________________/ \_________________________________ + / | | | \ + | | | | | + v | | | | +systemd-reboot.service | | | | + | v | | | + | systemd-poweroff.service | | | + v | v | | + <emphasis>reboot.target</emphasis> | systemd-halt.service | | + v | v | + <emphasis>poweroff.target</emphasis> | systemd-kexec.service | + v | | + <emphasis>halt.target</emphasis> | systemd-soft-reboot.service + v | + <emphasis>kexec.target</emphasis> | + v + <emphasis>soft-reboot.target</emphasis></programlisting> <para>Commonly used system shutdown targets are <emphasis>emphasized</emphasis>.</para> @@ -345,14 +346,14 @@ systemd-reboot.service | | | <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/busctl.xml b/man/busctl.xml index cc40452..27327ee 100644 --- a/man/busctl.xml +++ b/man/busctl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="busctl" @@ -315,7 +315,7 @@ </varlistentry> <varlistentry> - <term><option>--json=</option><replaceable>MODE</replaceable></term> + <term><option>--json=<replaceable>MODE</replaceable></option></term> <listitem> <para>When used with the <command>call</command> or <command>get-property</command> command, shows output @@ -341,7 +341,7 @@ </varlistentry> <varlistentry> - <term><option>--expect-reply=</option><replaceable>BOOL</replaceable></term> + <term><option>--expect-reply=<replaceable>BOOL</replaceable></option></term> <listitem> <para>When used with the <command>call</command> command, @@ -361,7 +361,7 @@ </varlistentry> <varlistentry> - <term><option>--auto-start=</option><replaceable>BOOL</replaceable></term> + <term><option>--auto-start=<replaceable>BOOL</replaceable></option></term> <listitem> <para>When used with the <command>call</command> or <command>emit</command> command, specifies @@ -375,7 +375,7 @@ </varlistentry> <varlistentry> - <term><option>--allow-interactive-authorization=</option><replaceable>BOOL</replaceable></term> + <term><option>--allow-interactive-authorization=<replaceable>BOOL</replaceable></option></term> <listitem> <para>When used with the <command>call</command> command, @@ -389,7 +389,7 @@ </varlistentry> <varlistentry> - <term><option>--timeout=</option><replaceable>SECS</replaceable></term> + <term><option>--timeout=<replaceable>SECS</replaceable></option></term> <listitem> <para>When used with the <command>call</command> command, @@ -407,7 +407,7 @@ </varlistentry> <varlistentry> - <term><option>--augment-creds=</option><replaceable>BOOL</replaceable></term> + <term><option>--augment-creds=<replaceable>BOOL</replaceable></option></term> <listitem> <para>Controls whether credential data reported by @@ -423,7 +423,7 @@ </varlistentry> <varlistentry> - <term><option>--watch-bind=</option><replaceable>BOOL</replaceable></term> + <term><option>--watch-bind=<replaceable>BOOL</replaceable></option></term> <listitem> <para>Controls whether to wait for the specified <constant>AF_UNIX</constant> bus socket to appear in the @@ -435,7 +435,7 @@ </varlistentry> <varlistentry> - <term><option>--destination=</option><replaceable>SERVICE</replaceable></term> + <term><option>--destination=<replaceable>SERVICE</replaceable></option></term> <listitem> <para>Takes a service name. When used with the <command>emit</command> command, a signal is @@ -449,6 +449,7 @@ <xi:include href="user-system-options.xml" xpointer="system" /> <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> + <xi:include href="user-system-options.xml" xpointer="capsule" /> <varlistentry> <term><option>-l</option></term> @@ -578,14 +579,14 @@ o "/org/freedesktop/systemd1/job/42684"</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>wireshark</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/capsule@.service.xml b/man/capsule@.service.xml new file mode 100644 index 0000000..aa5b1bb --- /dev/null +++ b/man/capsule@.service.xml @@ -0,0 +1,122 @@ +<?xml version="1.0"?> +<!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="capsule_.service" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>capsule@.service</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>capsule@.service</refentrytitle> + <manvolnum>5</manvolnum> + </refmeta> + + <refnamediv> + <refname>capsule@.service</refname> + <refpurpose>System unit for the capsule service manager</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>capsule@<replaceable>NAME</replaceable>.service</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para>Service managers for capsules run in + <filename>capsule@<replaceable>NAME</replaceable>.service</filename> system units, with the capsule name as the + instance identifier. Capsules are way to run additional instances of the service manager, under dynamic + user IDs, i.e. UIDs that are allocated when the capsule service manager is started, and released when it + is stopped.</para> + + <para>In many ways <filename>capsule@.service</filename> is similar to the per-user + <filename>user@.service</filename> service manager, but there are a few important distinctions:</para> + + <itemizedlist> + <listitem><para>The capsule service manager utilizes <varname>DynamicUser=</varname> (see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>) to + allocate a new UID dynamically on invocation. The user name is automatically generated from the capsule + name, by prefixng <literal>p_</literal>. The UID is released when the service is terminated. The user + service manager on the other hand operates under a statically allocated user ID that must be + pre-existing, before the user service manager is invoked.</para></listitem> + + <listitem><para>User service managers register themselves with <citerefentry + project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>, capsule + service managers do not.</para></listitem> + + <listitem><para>User service managers typically read their configuration from a + <varname>$HOME</varname> directory below <filename>/home/</filename>, capsule service managers from a + <varname>$HOME</varname> directory below <filename>/var/lib/capsules/</filename>.</para></listitem> + + <listitem><para>User service managers are collectively contained in the <filename>user.slice</filename> + unit, capsule service managers in <filename>capsule.slice</filename>. Also see + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem> + + <listitem><para>User service managers start the user unit <filename>default.target</filename> + initially. Capsule service managers invoke the user unit <filename>capsule@.target</filename> + instead.</para></listitem> + </itemizedlist> + + <para>The capsule service manager and the capsule's bus broker can be reached via the + <option>--capsule=</option> switch to + <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry> and + <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <para>New capsules can be started via a simple <command>systemctl start + capsule@<replaceable>NAME</replaceable>.service</command> command, and stopped via <command>systemctl + stop capsule@<replaceable>NAME</replaceable>.service</command>. Starting a capsule will implicitly create + a home directory <filename>/var/lib/capsules/<replaceable>NAME</replaceable>/</filename>, if missing. A + runtime directory is created as <filename>/run/capsules/<replaceable>NAME</replaceable>/</filename>. To + remove these resources use <command>systemctl clean capsule@<replaceable>NAME</replaceable>.service</command>, + for example with the <option>--what=all</option> switch.</para> + + <para>The <filename>capsule@.service</filename> unit invokes a <command>systemd --user</command> + service manager process. This means unit files are looked for according to the sames rules as for regular user + service managers, for example in + <filename>/var/lib/capsules/<replaceable>NAME</replaceable>/.config/systemd/user/</filename>.</para> + + <para>Capsule names may be chosen freely by the user, however, they must be suitable as UNIX filenames + (i.e. 255 characters max, and contain no <literal>/</literal>), and when prefixed with + <literal>p-</literal> be suitable as a user name matching strict POSIX rules, see <ulink + url="https://systemd.io/USER_NAMES">User/Group Name Syntax</ulink> for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </refsect1> + + <refsect1> + <title>Examples</title> + <example> + <title>Create a new capsule, invoke two programs in it (one interactively), terminate it, and clean everything up</title> + + <programlisting># systemctl start capsule@tatze.service +# systemd-run --capsule=tatze --unit=sleeptest.service sleep 999 +# systemctl --capsule=tatze status sleeptest.service +# systemd-run -t --capsule=tatze bash +# systemctl --capsule=tatze stop sleeptest.service +# systemctl stop capsule@tatze.service +# systemctl clean --all capsule@tatze.service</programlisting> + </example> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>user@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/cgroup-sandboxing.xml b/man/cgroup-sandboxing.xml index 56f7c40..6aa62df 100644 --- a/man/cgroup-sandboxing.xml +++ b/man/cgroup-sandboxing.xml @@ -1,16 +1,17 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> -<para id="singular">This option cannot be bypassed by prefixing <literal>+</literal> to the executable path -in the service unit, as it applies to the whole control group.</para> + <para id="singular">This option cannot be bypassed by prefixing <literal>+</literal> to the executable path + in the service unit, as it applies to the whole control group.</para> -<para id="plural">These options cannot be bypassed by prefixing <literal>+</literal> to the executable path -in the service unit, as it applies to the whole control group.</para> + <para id="plural">These options cannot be bypassed by prefixing <literal>+</literal> to the executable path + in the service unit, as they apply to the whole control group.</para> </refsect1> diff --git a/man/common-variables.xml b/man/common-variables.xml index 1aa31e1..2d26bf7 100644 --- a/man/common-variables.xml +++ b/man/common-variables.xml @@ -1,5 +1,5 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE refsect1 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 --> @@ -11,13 +11,18 @@ <term><varname>$SYSTEMD_LOG_LEVEL</varname></term> <listitem><para id='log-level-body'>The maximum log level of emitted messages (messages with a higher - log level, i.e. less important ones, will be suppressed). Either one of (in order of decreasing - importance) <constant>emerg</constant>, <constant>alert</constant>, <constant>crit</constant>, - <constant>err</constant>, <constant>warning</constant>, <constant>notice</constant>, - <constant>info</constant>, <constant>debug</constant>, or an integer in the range 0…7. See + log level, i.e. less important ones, will be suppressed). Takes a comma-separated list of values. A + value may be either one of (in order of decreasing importance) <constant>emerg</constant>, + <constant>alert</constant>, <constant>crit</constant>, <constant>err</constant>, + <constant>warning</constant>, <constant>notice</constant>, <constant>info</constant>, + <constant>debug</constant>, or an integer in the range 0…7. See <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> - for more information.</para> - </listitem> + for more information. Each value may optionally be prefixed with one of <constant>console</constant>, + <constant>syslog</constant>, <constant>kmsg</constant> or <constant>journal</constant> followed by a + colon to set the maximum log level for that specific log target (e.g. + <constant>SYSTEMD_LOG_LEVEL=debug,console:info</constant> specifies to log at debug level except when + logging to the console which should be at info level). Note that the global maximum log level takes + priority over any per target maximum log levels.</para></listitem> </varlistentry> <varlistentry id='log-color'> @@ -116,24 +121,28 @@ <varlistentry> <term><option>K</option></term> - <para>This option instructs the pager to exit immediately when - <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> is pressed. To allow - <command>less</command> to handle <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> - itself to switch back to the pager command prompt, unset this option.</para> - - <para>If the value of <varname>$SYSTEMD_LESS</varname> does not include <literal>K</literal>, - and the pager that is invoked is <command>less</command>, - <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> will be ignored by the - executable, and needs to be handled by the pager.</para> + <listitem> + <para>This option instructs the pager to exit immediately when + <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> is pressed. To allow + <command>less</command> to handle <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> + itself to switch back to the pager command prompt, unset this option.</para> + + <para>If the value of <varname>$SYSTEMD_LESS</varname> does not include <literal>K</literal>, + and the pager that is invoked is <command>less</command>, + <keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo> will be ignored by the + executable, and needs to be handled by the pager.</para> + </listitem> </varlistentry> <varlistentry> <term><option>X</option></term> - <para>This option instructs the pager to not send termcap initialization and deinitialization - strings to the terminal. It is set by default to allow command output to remain visible in the - terminal even after the pager exits. Nevertheless, this prevents some pager functionality from - working, in particular paged output cannot be scrolled with the mouse.</para> + <listitem> + <para>This option instructs the pager to not send termcap initialization and deinitialization + strings to the terminal. It is set by default to allow command output to remain visible in the + terminal even after the pager exits. Nevertheless, this prevents some pager functionality from + working, in particular paged output cannot be scrolled with the mouse.</para> + </listitem> </varlistentry> </variablelist> diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index 61014d3..2eedf94 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="coredump.conf" conditional="ENABLE_COREDUMP" @@ -22,10 +22,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/coredump.conf</filename></para> - <para><filename>/etc/systemd/coredump.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/coredump.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/coredump.conf</filename></member> + <member><filename>/run/systemd/coredump.conf</filename></member> + <member><filename>/usr/local/lib/systemd/coredump.conf</filename></member> + <member><filename>/usr/lib/systemd/coredump.conf</filename></member> + <member><filename>/etc/systemd/coredump.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/coredump.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/coredump.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/coredump.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -149,11 +155,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/coredumpctl.xml b/man/coredumpctl.xml index 71eee17..6179d6b 100644 --- a/man/coredumpctl.xml +++ b/man/coredumpctl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="coredumpctl" conditional='ENABLE_COREDUMP' @@ -226,7 +226,7 @@ <varlistentry> <term><option>-F</option> <replaceable>FIELD</replaceable></term> - <term><option>--field=</option><replaceable>FIELD</replaceable></term> + <term><option>--field=<replaceable>FIELD</replaceable></option></term> <listitem><para>Print all possible data values the specified field takes in matching core dump entries of the @@ -237,7 +237,7 @@ <varlistentry> <term><option>-o</option> <replaceable>FILE</replaceable></term> - <term><option>--output=</option><replaceable>FILE</replaceable></term> + <term><option>--output=<replaceable>FILE</replaceable></option></term> <listitem><para>Write the core to <option>FILE</option>. </para> @@ -246,7 +246,7 @@ </varlistentry> <varlistentry> - <term><option>--debugger=</option><replaceable>DEBUGGER</replaceable></term> + <term><option>--debugger=<replaceable>DEBUGGER</replaceable></option></term> <listitem><para>Use the given debugger for the <command>debug</command> command. If not given and <varname>$SYSTEMD_DEBUGGER</varname> is unset, then @@ -258,7 +258,7 @@ <varlistentry> <term><option>-A</option> <replaceable>ARGS</replaceable></term> - <term><option>--debugger-arguments=</option><replaceable>ARGS</replaceable></term> + <term><option>--debugger-arguments=<replaceable>ARGS</replaceable></option></term> <listitem><para>Pass the given <replaceable>ARGS</replaceable> as extra command line arguments to the debugger. Quote as appropriate when <replaceable>ARGS</replaceable> contain whitespace. @@ -282,7 +282,7 @@ <varlistentry> <term><option>-D</option> <replaceable>DIR</replaceable></term> - <term><option>--directory=</option><replaceable>DIR</replaceable></term> + <term><option>--directory=<replaceable>DIR</replaceable></option></term> <listitem><para>Use the journal files in the specified <option>DIR</option>. </para> @@ -489,12 +489,12 @@ Fri … 552351 1000 1000 SIGSEGV present /usr/lib64/firefox/firefox 28.7M <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>gdb</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/crypttab.xml b/man/crypttab.xml index 126d3a0..955111f 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -104,10 +104,14 @@ see above and below.</para></listitem> <listitem><para>The key may be acquired via a PKCS#11 compatible hardware security token or - smartcard. In this case an encrypted key is stored on disk/removable media, acquired via - <constant>AF_UNIX</constant>, or stored in the LUKS2 JSON token metadata header. The encrypted key is - then decrypted by the PKCS#11 token with an RSA key stored on it, and then used to unlock the encrypted - volume. Use the <option>pkcs11-uri=</option> option described below to use this mechanism.</para></listitem> + smartcard. In this case a saved key used in unlock process is stored on disk/removable media, acquired via + <constant>AF_UNIX</constant>, or stored in the LUKS2 JSON token metadata header. For RSA, the saved key + is an encrypted volume key. The encrypted volume key is then decrypted by the PKCS#11 token with an RSA + private key stored on it, and used to unlock the encrypted volume. For elliptic-curve (EC) cryptography, + the saved key is the public key generated in enrollment process. The public key is then used to derive + a shared secret with a private key stored in the PKCS#11 token. The derived shared secret is then used + to unlock the volume. Use the <option>pkcs11-uri=</option> option described below to use this mechanism. + </para></listitem> <listitem><para>Similarly, the key may be acquired via a FIDO2 compatible hardware security token (which must implement the "hmac-secret" extension). In this case a key generated randomly during @@ -257,6 +261,29 @@ </varlistentry> <varlistentry> + <term><option>link-volume-key=</option></term> + + <listitem><para>Specifies the kernel keyring and key description + (see <citerefentry project='man-pages'><refentrytitle>keyrings</refentrytitle><manvolnum>7</manvolnum></citerefentry>) + where LUKS2 volume key gets linked during device activation. The kernel keyring + description and key description must be separated by <literal>::</literal>.</para> + + <para>The kernel keyring part can be a string description or a predefined + kernel keyring prefixed with <literal>@</literal> (e.g.: to use <literal>@s</literal> session or + <literal>@u</literal> user keyring directly). The type prefix text in the kernel keyring description + is not required. The specified kernel keyring must already exist at the time of device activation.</para> + + <para>The key part is a string description optionally prefixed by a <literal>%key_type:</literal>. + If no type is specified, the <literal>user</literal> type key is linked by default. See + <citerefentry project='man-pages'><refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + for more information on key descriptions (KEY IDENTIFIERS section).</para> + + <para>Note that the linked volume key is not cleaned up automatically when the device is detached.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>luks</option></term> <listitem><para>Force LUKS mode. When this mode is used, the @@ -322,7 +349,9 @@ unsuccessful. Note that other units that depend on the unlocked device may still fail. In particular, if the device is used for a mount point, the mount point itself also needs to have the <option>nofail</option> option, or the boot will fail if the device is not unlocked - successfully.</para> + successfully. If a keyfile and/or a <option>header</option> are specified, the dependencies on + their respective directories will also not be fatal, so that umounting said directories will + not cause the generated cryptset unit to be deactivated.</para> <xi:include href="version-info.xml" xpointer="v186"/></listitem> </varlistentry> @@ -452,10 +481,12 @@ <citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>. This option implies <option>plain</option>.</para> - <para>WARNING: Using the <option>swap</option> option will - destroy the contents of the named partition during every boot, - so make sure the underlying block device is specified - correctly.</para> + <warning> + <para>Using the <option>swap</option> option will + destroy the contents of the named partition during every boot, + so make sure the underlying block device is specified + correctly.</para> + </warning> <xi:include href="version-info.xml" xpointer="v186"/></listitem> </varlistentry> @@ -585,8 +616,10 @@ <literal>btrfs</literal>. If no argument is specified defaults to <literal>ext4</literal>. This option implies <option>plain</option>.</para> - <para>WARNING: Using the <option>tmp</option> option will destroy the contents of the named partition - during every boot, so make sure the underlying block device is specified correctly.</para> + <warning> + <para>Using the <option>tmp</option> option will destroy the contents of the named partition + during every boot, so make sure the underlying block device is specified correctly.</para> + </warning> <xi:include href="version-info.xml" xpointer="v186"/></listitem> </varlistentry> @@ -641,7 +674,7 @@ <term><option>pkcs11-uri=</option></term> <listitem><para>Takes either the special value <literal>auto</literal> or an <ulink - url="https://tools.ietf.org/html/rfc7512">RFC7512 PKCS#11 URI</ulink> pointing to a private RSA key + url="https://tools.ietf.org/html/rfc7512">RFC7512 PKCS#11 URI</ulink> pointing to a private key which is used to decrypt the encrypted key specified in the third column of the line. This is useful for unlocking encrypted volumes through PKCS#11 compatible security tokens or smartcards. See below for an example how to set up this mechanism for unlocking a LUKS2 volume with a YubiKey security @@ -651,16 +684,16 @@ security token metadata in its LUKS2 JSON token section. In this mode the URI and the encrypted key are automatically read from the LUKS2 JSON token header. Use <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> - as simple tool for enrolling PKCS#11 security tokens or smartcards in a way compatible with + as a simple tool for enrolling PKCS#11 security tokens or smartcards in a way compatible with <literal>auto</literal>. In this mode the third column of the line should remain empty (that is, specified as <literal>-</literal>).</para> - <para>The specified URI can refer directly to a private RSA key stored on a token or alternatively - just to a slot or token, in which case a search for a suitable private RSA key will be performed. In - this case if multiple suitable objects are found the token is refused. The encrypted key configured - in the third column of the line is passed as is (i.e. in binary form, unprocessed) to RSA - decryption. The resulting decrypted key is then Base64 encoded before it is used to unlock the LUKS - volume.</para> + <para>The specified URI can refer directly to a private key stored on a token or alternatively + just to a slot or token, in which case a search for a suitable private key will be performed. In + this case if multiple suitable objects are found the token is refused. The keyfile configured + in the third column of the line is used as is (i.e. in binary form, unprocessed). The resulting + decrypted key (for RSA) or derived shared secret (for ECC) is then Base64 encoded before it is used + to unlock the LUKS volume.</para> <para>Use <command>systemd-cryptenroll --pkcs11-token-uri=list</command> to list all suitable PKCS#11 security tokens currently plugged in, along with their URIs.</para> @@ -967,8 +1000,8 @@ external /dev/sda3 keyfile:LABEL=keydev keyfile-timeout=10s,cipher=xchac <title>Yubikey-based PKCS#11 Volume Unlocking Example</title> <para>The PKCS#11 logic allows hooking up any compatible security token that is capable of storing RSA - decryption keys for unlocking an encrypted volume. Here's an example how to set up a Yubikey security - token for this purpose on a LUKS2 volume, using <citerefentry + or EC cryptographic keys for unlocking an encrypted volume. Here's an example how to set up a Yubikey + security token for this purpose on a LUKS2 volume, using <citerefentry project='debian'><refentrytitle>ykmap</refentrytitle><manvolnum>1</manvolnum></citerefentry> from the yubikey-manager project to initialize the token and <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -1012,16 +1045,16 @@ external /dev/sda3 keyfile:LABEL=keydev keyfile-timeout=10s,cipher=xchac <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkswap</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mke2fs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/custom-entities.ent.in b/man/custom-entities.ent.in index 9513235..8dfc1eb 100644 --- a/man/custom-entities.ent.in +++ b/man/custom-entities.ent.in @@ -19,4 +19,4 @@ <!ENTITY DEFAULT_USER_TIMEOUT "{{DEFAULT_USER_TIMEOUT_SEC}} s"> <!ENTITY DEFAULT_KEYMAP "{{SYSTEMD_DEFAULT_KEYMAP}}"> <!ENTITY fedora_latest_version "40"> -<!ENTITY fedora_cloud_release "1.6"> +<!ENTITY fedora_cloud_release "1.10"> diff --git a/man/custom-html.xsl b/man/custom-html.xsl index 2373bc3..e5551fc 100644 --- a/man/custom-html.xsl +++ b/man/custom-html.xsl @@ -54,18 +54,6 @@ </a> </xsl:template> -<xsl:template match="citerefentry[@project='wireguard']"> - <a> - <xsl:attribute name="href"> - <xsl:text>https://git.zx2c4.com/WireGuard/about/src/tools/</xsl:text> - <xsl:value-of select="refentrytitle"/> - <xsl:text>.</xsl:text> - <xsl:value-of select="manvolnum"/> - </xsl:attribute> - <xsl:call-template name="inline.charseq"/> - </a> -</xsl:template> - <xsl:template match="citerefentry[@project='mankier']"> <a> <xsl:attribute name="href"> diff --git a/man/daemon.xml b/man/daemon.xml index 819ff9b..42630d2 100644 --- a/man/daemon.xml +++ b/man/daemon.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="daemon"> @@ -686,15 +686,15 @@ fi</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/dnssec-trust-anchors.d.xml b/man/dnssec-trust-anchors.d.xml index 39b9515..8a5523f 100644 --- a/man/dnssec-trust-anchors.d.xml +++ b/man/dnssec-trust-anchors.d.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="dnssec-trust-anchors.d" conditional='ENABLE_RESOLVE' @@ -23,12 +23,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/dnssec-trust-anchors.d/*.positive</filename></para> - <para><filename>/run/dnssec-trust-anchors.d/*.positive</filename></para> - <para><filename>/usr/lib/dnssec-trust-anchors.d/*.positive</filename></para> - <para><filename>/etc/dnssec-trust-anchors.d/*.negative</filename></para> - <para><filename>/run/dnssec-trust-anchors.d/*.negative</filename></para> - <para><filename>/usr/lib/dnssec-trust-anchors.d/*.negative</filename></para> + <para><simplelist> + <member><filename>/etc/dnssec-trust-anchors.d/*.positive</filename></member> + <member><filename>/run/dnssec-trust-anchors.d/*.positive</filename></member> + <member><filename>/usr/local/lib/dnssec-trust-anchors.d/*.positive</filename></member> + <member><filename>/usr/lib/dnssec-trust-anchors.d/*.positive</filename></member> + <member><filename>/etc/dnssec-trust-anchors.d/*.negative</filename></member> + <member><filename>/run/dnssec-trust-anchors.d/*.negative</filename></member> + <member><filename>/usr/local/lib/dnssec-trust-anchors.d/*.negative</filename></member> + <member><filename>/usr/lib/dnssec-trust-anchors.d/*.negative</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -161,12 +165,12 @@ stag <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/environment.d.xml b/man/environment.d.xml index fc03405..942122e 100644 --- a/man/environment.d.xml +++ b/man/environment.d.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -26,11 +26,14 @@ </refnamediv> <refsynopsisdiv> - <para><filename>~/.config/environment.d/*.conf</filename></para> - <para><filename>/etc/environment.d/*.conf</filename></para> - <para><filename>/run/environment.d/*.conf</filename></para> - <para><filename>/usr/lib/environment.d/*.conf</filename></para> - <para><filename>/etc/environment</filename></para> + <para><simplelist> + <member><filename>~/.config/environment.d/*.conf</filename></member> + <member><filename>/etc/environment.d/*.conf</filename></member> + <member><filename>/run/environment.d/*.conf</filename></member> + <member><filename>/usr/local/lib/environment.d/*.conf</filename></member> + <member><filename>/usr/lib/environment.d/*.conf</filename></member> + <member><filename>/etc/environment</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -123,11 +126,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/event-quick-child.c b/man/event-quick-child.c index b95ee1b..828f0cd 100644 --- a/man/event-quick-child.c +++ b/man/event-quick-child.c @@ -1,5 +1,6 @@ /* SPDX-License-Identifier: MIT-0 */ +#define _GNU_SOURCE 1 #include <assert.h> #include <stdio.h> #include <unistd.h> diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml index 583b9ab..02841a7 100644 --- a/man/file-hierarchy.xml +++ b/man/file-hierarchy.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="file-hierarchy" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -907,16 +907,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>hier</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-path</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>hier</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-path</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/homectl.xml b/man/homectl.xml index 7fc7d5f..43bde52 100644 --- a/man/homectl.xml +++ b/man/homectl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="homectl" conditional='ENABLE_HOMED' @@ -18,6 +18,7 @@ <refnamediv> <refname>homectl</refname> + <refname>systemd-homed-firstboot.service</refname> <refpurpose>Create, remove, change or inspect home directories</refpurpose> </refnamediv> @@ -116,7 +117,7 @@ <variablelist> <varlistentry> - <term><option>--identity=</option><replaceable>FILE</replaceable></term> + <term><option>--identity=<replaceable>FILE</replaceable></option></term> <listitem><para>Read the user's JSON record from the specified file. If passed as <literal>-</literal> read the user record from standard input. The supplied JSON object must follow @@ -129,7 +130,7 @@ </varlistentry> <varlistentry> - <term><option>--json=</option><replaceable>FORMAT</replaceable></term> + <term><option>--json=<replaceable>FORMAT</replaceable></option></term> <term><option>-j</option></term> <listitem><para>Controls whether to output the user record in JSON format, if the @@ -145,7 +146,7 @@ </varlistentry> <varlistentry> - <term><option>--export-format=</option><replaceable>FORMAT</replaceable></term> + <term><option>--export-format=<replaceable>FORMAT</replaceable></option></term> <term><option>-E</option></term> <term><option>-EE</option></term> @@ -168,6 +169,16 @@ <xi:include href="version-info.xml" xpointer="v245"/></listitem> </varlistentry> + <varlistentry> + <term><option>--offline</option></term> + + <listitem><para>Do not attempt to update the copy of the user record and blob directory that is embedded inside + of the home area. This allows for operation on home areas that are absent, or without needing to authenticate as + the user being modified.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> @@ -190,7 +201,7 @@ <variablelist> <varlistentry> - <term><option>--real-name=</option><replaceable>NAME</replaceable></term> + <term><option>--real-name=<replaceable>NAME</replaceable></option></term> <term><option>-c</option> <replaceable>NAME</replaceable></term> <listitem><para>The real name for the user. This corresponds with the GECOS field on classic UNIX NSS @@ -200,7 +211,7 @@ </varlistentry> <varlistentry> - <term><option>--realm=</option><replaceable>REALM</replaceable></term> + <term><option>--realm=<replaceable>REALM</replaceable></option></term> <listitem><para>The realm for the user. The realm associates a user with a specific organization or installation, and allows distinguishing users of the same name defined in different contexts. The @@ -216,7 +227,7 @@ </varlistentry> <varlistentry> - <term><option>--email-address=</option><replaceable>EMAIL</replaceable></term> + <term><option>--email-address=<replaceable>EMAIL</replaceable></option></term> <listitem><para>Takes an electronic mail address to associate with the user. On log-in the <varname>$EMAIL</varname> environment variable is initialized from this value.</para> @@ -225,7 +236,7 @@ </varlistentry> <varlistentry> - <term><option>--location=</option><replaceable>TEXT</replaceable></term> + <term><option>--location=<replaceable>TEXT</replaceable></option></term> <listitem><para>Takes location specification for this user. This is free-form text, which might or might not be usable by geo-location applications. Example: <option>--location="Berlin, @@ -235,7 +246,7 @@ </varlistentry> <varlistentry> - <term><option>--icon-name=</option><replaceable>ICON</replaceable></term> + <term><option>--icon-name=<replaceable>ICON</replaceable></option></term> <listitem><para>Takes an icon name to associate with the user, following the scheme defined by the <ulink url="https://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html">Icon Naming @@ -245,8 +256,8 @@ </varlistentry> <varlistentry> - <term><option>--home-dir=</option><replaceable>PATH</replaceable></term> - <term><option>-d</option><replaceable>PATH</replaceable></term> + <term><option>--home-dir=<replaceable>PATH</replaceable></option></term> + <term><option>-d<replaceable>PATH</replaceable></option></term> <listitem><para>Takes a path to use as home directory for the user. Note that this is the directory the user's home directory is mounted to while the user is logged in. This is not where the user's @@ -257,7 +268,7 @@ </varlistentry> <varlistentry> - <term><option>--uid=</option><replaceable>UID</replaceable></term> + <term><option>--uid=<replaceable>UID</replaceable></option></term> <listitem><para>Takes a preferred numeric UNIX UID to assign this user. If a user is to be created with the specified UID and it is already taken by a different user on the local system then creation @@ -282,7 +293,7 @@ </varlistentry> <varlistentry> - <term><option>--member-of=</option><replaceable>GROUP</replaceable></term> + <term><option>--member-of=<replaceable>GROUP</replaceable></option></term> <term><option>-G</option> <replaceable>GROUP</replaceable></term> <listitem><para>Takes a comma-separated list of auxiliary UNIX groups this user shall belong @@ -299,8 +310,8 @@ </varlistentry> <varlistentry> - <term><option>--capability-bounding-set=</option><replaceable>CAPABILITIES</replaceable></term> - <term><option>--capability-ambient-set=</option><replaceable>CAPABILITIES</replaceable></term> + <term><option>--capability-bounding-set=<replaceable>CAPABILITIES</replaceable></option></term> + <term><option>--capability-ambient-set=<replaceable>CAPABILITIES</replaceable></option></term> <listitem><para>These options take a space separated list of process capabilities (e.g. <constant>CAP_WAKE_ALARM</constant>, <constant>CAP_BLOCK_SUSPEND</constant>, …) that shall be @@ -314,7 +325,7 @@ </varlistentry> <varlistentry> - <term><option>--skel=</option><replaceable>PATH</replaceable></term> + <term><option>--skel=<replaceable>PATH</replaceable></option></term> <listitem><para>Takes a file system path to a directory. Specifies the skeleton directory to initialize the home directory with. All files and directories in the specified path are copied into @@ -325,7 +336,7 @@ </varlistentry> <varlistentry> - <term><option>--shell=</option><replaceable>SHELL</replaceable></term> + <term><option>--shell=<replaceable>SHELL</replaceable></option></term> <listitem><para>Takes a file system path. Specifies the shell binary to execute on terminal logins. If not specified defaults to <filename>/bin/bash</filename>.</para> @@ -334,7 +345,7 @@ </varlistentry> <varlistentry> - <term><option>--setenv=</option><replaceable>VARIABLE</replaceable>[=<replaceable>VALUE</replaceable>]</term> + <term><option>--setenv=<replaceable>VARIABLE</replaceable>[=<replaceable>VALUE</replaceable>]</option></term> <listitem><para>Takes an environment variable assignment to set for all user processes. May be used multiple times to set multiple environment variables. When <literal>=</literal> and @@ -349,7 +360,7 @@ </varlistentry> <varlistentry> - <term><option>--timezone=</option><replaceable>TIMEZONE</replaceable></term> + <term><option>--timezone=<replaceable>TIMEZONE</replaceable></option></term> <listitem><para>Takes a time zone location name that sets the timezone for the specified user. When the user logs in the <varname>$TZ</varname> environment variable is initialized from this @@ -363,18 +374,19 @@ </varlistentry> <varlistentry> - <term><option>--language=</option><replaceable>LANG</replaceable></term> + <term><option>--language=<replaceable>LANG</replaceable></option></term> - <listitem><para>Takes a specifier indicating the preferred language of the user. The - <varname>$LANG</varname> environment variable is initialized from this value on login, and thus a - value suitable for this environment variable is accepted here, for example - <option>--language=de_DE.UTF8</option>.</para> + <listitem><para>Takes a comma- or colon-separated list of languages preferred by the user, ordered + by descending priority. The <varname>$LANG</varname> and <varname>$LANGUAGE</varname> environment + variables are initialized from this value on login, and thus values suitible for these environment + variables are accepted here, for example <option>--language=de_DE.UTF-8</option>. This option may + be used more than once, in which case the language lists are concatenated.</para> <xi:include href="version-info.xml" xpointer="v245"/></listitem> </varlistentry> <varlistentry> - <term><option>--ssh-authorized-keys=</option><replaceable>KEYS</replaceable></term> + <term><option>--ssh-authorized-keys=<replaceable>KEYS</replaceable></option></term> <listitem><para>Either takes a SSH authorized key line to associate with the user record or a <literal>@</literal> character followed by a path to a file to read one or more such lines from. SSH keys configured this way are made available to SSH to permit access to this home directory and user @@ -384,7 +396,7 @@ </varlistentry> <varlistentry> - <term><option>--pkcs11-token-uri=</option><replaceable>URI</replaceable></term> + <term><option>--pkcs11-token-uri=<replaceable>URI</replaceable></option></term> <listitem><para>Takes an RFC 7512 PKCS#11 URI referencing a security token (e.g. YubiKey or PIV smartcard) that shall be able to unlock the user account. The security token URI should reference a security token with exactly one pair of X.509 certificate and private key. A random secret key is @@ -413,7 +425,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-credential-algorithm=</option><replaceable>STRING</replaceable></term> + <term><option>--fido2-credential-algorithm=<replaceable>STRING</replaceable></option></term> <listitem><para>Specify COSE algorithm used in credential generation. The default value is <literal>es256</literal>. Supported values are <literal>es256</literal>, <literal>rs256</literal> and <literal>eddsa</literal>.</para> @@ -422,13 +434,13 @@ denotes 2048-bit RSA with PKCS#1.5 padding and SHA-256. <literal>eddsa</literal> denotes EDDSA over Curve25519 with SHA-512.</para> - <para>Note that your authenticator may not support some algorithms.</para> + <para>Note that your authenticator may choose not to support some algorithms.</para> <xi:include href="version-info.xml" xpointer="v251"/></listitem> </varlistentry> <varlistentry> - <term><option>--fido2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--fido2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Takes a path to a Linux <literal>hidraw</literal> device (e.g. <filename>/dev/hidraw1</filename>), referring to a FIDO2 security token implementing the @@ -459,7 +471,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-client-pin=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-client-pin=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the account (the FIDO2 <literal>clientPin</literal> feature). Defaults to @@ -471,7 +483,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-user-presence=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-user-presence=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2 <literal>up</literal> feature) when unlocking the account. @@ -483,7 +495,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-user-verification=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-user-verification=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the account (the FIDO2 <literal>uv</literal> feature). Defaults to @@ -494,7 +506,7 @@ </varlistentry> <varlistentry> - <term><option>--recovery-key=</option><replaceable>BOOL</replaceable></term> + <term><option>--recovery-key=<replaceable>BOOL</replaceable></option></term> <listitem><para>Accepts a boolean argument. If enabled a recovery key is configured for the account. A recovery key is a computer generated access key that may be used to regain access to an @@ -505,8 +517,42 @@ <xi:include href="version-info.xml" xpointer="v247"/></listitem> </varlistentry> + <varlistentry> + <term><option>--blob=<replaceable>PATH</replaceable></option></term> + <term><option>-b</option> <replaceable>PATH</replaceable></term> + <term><option>--blob=<replaceable>FILENAME</replaceable>=<replaceable>PATH</replaceable></option></term> + <term><option>-b</option> <replaceable>FILENAME</replaceable>=<replaceable>PATH</replaceable></term> + + <listitem><para>Accepts either a directory path, or a file name followed by a file path. If just a + directory path is specified, then the user's entire blob directory is replaced the specified path. + Note that this replacement is performed before per-file manipulations are applied, which means these per-file + manipulations will be applied on top of the specified directory. If a filename and file path are specified, then + the single specified blob file will be overwritten with the specified path. If completely blank, the entire blob + directory is emptied out (which also resets all previous blob-related flags up to this point). If a filename is + specified but the corresponding path is blank, that single file will be deleted from the blob directory. All changes + are performed in temporary copies of the specified files in directories, which means that the originals specified on + the command line are not modified. See <ulink url="https://systemd.io/USER_RECORD_BLOB_DIRS">User Record Blob Directories</ulink> + for more information about blob directories.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--avatar=<replaceable>PATH</replaceable></option></term> + <term><option>--login-background=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Accept a file path. If set, the specified file is used to overwrite the + corresponding file in the user's blob directory. If blank, the corresponding file is deleted + from the blob directory. Essentially, these options are shortcuts to + <option>--blob=<replaceable>FILENAME</replaceable>=<replaceable>PATH</replaceable></option> + for the known filenames defined in + <ulink url="https://systemd.io/USER_RECORD_BLOB_DIRS">User Record Blob Directories</ulink>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + <varlistentry> - <term><option>--locked=</option><replaceable>BOOLEAN</replaceable></term> + <term><option>--locked=<replaceable>BOOLEAN</replaceable></option></term> <listitem><para>Takes a boolean argument. Specifies whether this user account shall be locked. If true logins into this account are prohibited, if false (the default) they are permitted (of course, @@ -516,8 +562,8 @@ </varlistentry> <varlistentry> - <term><option>--not-before=</option><replaceable>TIMESTAMP</replaceable></term> - <term><option>--not-after=</option><replaceable>TIMESTAMP</replaceable></term> + <term><option>--not-before=<replaceable>TIMESTAMP</replaceable></option></term> + <term><option>--not-after=<replaceable>TIMESTAMP</replaceable></option></term> <listitem><para>These options take a timestamp string, in the format documented in <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> and @@ -528,8 +574,8 @@ </varlistentry> <varlistentry> - <term><option>--rate-limit-interval=</option><replaceable>SECS</replaceable></term> - <term><option>--rate-limit-burst=</option><replaceable>NUMBER</replaceable></term> + <term><option>--rate-limit-interval=<replaceable>SECS</replaceable></option></term> + <term><option>--rate-limit-burst=<replaceable>NUMBER</replaceable></option></term> <listitem><para>Configures a rate limit on authentication attempts for this user. If the user attempts to authenticate more often than the specified number, on a specific system, within the @@ -540,7 +586,7 @@ </varlistentry> <varlistentry> - <term><option>--password-hint=</option><replaceable>TEXT</replaceable></term> + <term><option>--password-hint=<replaceable>TEXT</replaceable></option></term> <listitem><para>Takes a password hint to store alongside the user record. This string is stored accessible only to privileged users and the user itself and may not be queried by other users. @@ -550,7 +596,7 @@ </varlistentry> <varlistentry> - <term><option>--enforce-password-policy=</option><replaceable>BOOL</replaceable></term> + <term><option>--enforce-password-policy=<replaceable>BOOL</replaceable></option></term> <term><option>-P</option></term> <listitem><para>Takes a boolean argument. Configures whether to enforce the system's password policy @@ -562,7 +608,7 @@ </varlistentry> <varlistentry> - <term><option>--password-change-now=</option><replaceable>BOOL</replaceable></term> + <term><option>--password-change-now=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean argument. If true the user is asked to change their password on next login.</para> @@ -571,10 +617,10 @@ </varlistentry> <varlistentry> - <term><option>--password-change-min=</option><replaceable>TIME</replaceable></term> - <term><option>--password-change-max=</option><replaceable>TIME</replaceable></term> - <term><option>--password-change-warn=</option><replaceable>TIME</replaceable></term> - <term><option>--password-change-inactive=</option><replaceable>TIME</replaceable></term> + <term><option>--password-change-min=<replaceable>TIME</replaceable></option></term> + <term><option>--password-change-max=<replaceable>TIME</replaceable></option></term> + <term><option>--password-change-warn=<replaceable>TIME</replaceable></option></term> + <term><option>--password-change-inactive=<replaceable>TIME</replaceable></option></term> <listitem><para>Each of these options takes a time span specification as argument (in the syntax documented in @@ -597,7 +643,7 @@ </varlistentry> <varlistentry> - <term><option>--disk-size=</option><replaceable>BYTES</replaceable></term> + <term><option>--disk-size=<replaceable>BYTES</replaceable></option></term> <listitem><para>Either takes a size in bytes as argument (possibly using the usual K, M, G, … suffixes for 1024 base values), a percentage value, or the special strings <literal>min</literal> or <literal>max</literal>, and configures the disk space to assign to the user. If a percentage value is @@ -614,7 +660,7 @@ </varlistentry> <varlistentry> - <term><option>--access-mode=</option><replaceable>MODE</replaceable></term> + <term><option>--access-mode=<replaceable>MODE</replaceable></option></term> <listitem><para>Takes a UNIX file access mode written in octal. Configures the access mode of the home directory itself. Note that this is only used when the directory is first created, and the user @@ -625,7 +671,7 @@ </varlistentry> <varlistentry> - <term><option>--umask=</option><replaceable>MASK</replaceable></term> + <term><option>--umask=<replaceable>MASK</replaceable></option></term> <listitem><para>Takes the access mode mask (in octal syntax) to apply to newly created files and directories of the user ("umask"). If set this controls the initial umask set for all login sessions of @@ -635,7 +681,7 @@ </varlistentry> <varlistentry> - <term><option>--nice=</option><replaceable>NICE</replaceable></term> + <term><option>--nice=<replaceable>NICE</replaceable></option></term> <listitem><para>Takes the numeric scheduling priority ("nice level") to apply to the processes of the user at login time. Takes a numeric value in the range -20 (highest priority) to 19 (lowest priority).</para> @@ -644,7 +690,7 @@ </varlistentry> <varlistentry> - <term><option>--rlimit=</option><replaceable>LIMIT</replaceable>=<replaceable>VALUE</replaceable><optional>:<replaceable>VALUE</replaceable></optional></term> + <term><option>--rlimit=<replaceable>LIMIT</replaceable>=<replaceable>VALUE</replaceable><optional>:<replaceable>VALUE</replaceable></optional></option></term> <listitem><para>Allows configuration of resource limits for processes of this user, see <citerefentry project='man-pages'><refentrytitle>getrlimit</refentrytitle><manvolnum>2</manvolnum></citerefentry> @@ -657,7 +703,7 @@ </varlistentry> <varlistentry> - <term><option>--tasks-max=</option><replaceable>TASKS</replaceable></term> + <term><option>--tasks-max=<replaceable>TASKS</replaceable></option></term> <listitem><para>Takes a non-zero unsigned integer as argument. Configures the maximum number of tasks (i.e. threads, where each process is at least one thread) the user may have at any given time. This @@ -674,8 +720,8 @@ </varlistentry> <varlistentry> - <term><option>--memory-high=</option><replaceable>BYTES</replaceable></term> - <term><option>--memory-max=</option><replaceable>BYTES</replaceable></term> + <term><option>--memory-high=<replaceable>BYTES</replaceable></option></term> + <term><option>--memory-max=<replaceable>BYTES</replaceable></option></term> <listitem><para>Set a limit on the memory a user may take up on a system at any given time in bytes (the usual K, M, G, … suffixes are supported, to the base of 1024). This includes all memory used by @@ -689,8 +735,8 @@ </varlistentry> <varlistentry> - <term><option>--cpu-weight=</option><replaceable>WEIGHT</replaceable></term> - <term><option>--io-weight=</option><replaceable>WEIGHT</replaceable></term> + <term><option>--cpu-weight=<replaceable>WEIGHT</replaceable></option></term> + <term><option>--io-weight=<replaceable>WEIGHT</replaceable></option></term> <listitem><para>Set CPU and IO scheduling weights of the processes of the user, including those of processes forked off by the user that changed user credentials. Takes a numeric value in the range @@ -703,7 +749,7 @@ </varlistentry> <varlistentry> - <term><option>--storage=</option><replaceable>STORAGE</replaceable></term> + <term><option>--storage=<replaceable>STORAGE</replaceable></option></term> <listitem><para>Selects the storage mechanism to use for this home directory. Takes one of <literal>luks</literal>, <literal>fscrypt</literal>, <literal>directory</literal>, @@ -716,7 +762,7 @@ </varlistentry> <varlistentry> - <term><option>--image-path=</option><replaceable>PATH</replaceable></term> + <term><option>--image-path=<replaceable>PATH</replaceable></option></term> <listitem><para>Takes a file system path. Configures where to place the user's home directory. When LUKS2 storage is used refers to the path to the loopback file, otherwise to the path to the home @@ -732,7 +778,7 @@ </varlistentry> <varlistentry> - <term><option>--drop-caches=</option><replaceable>BOOL</replaceable></term> + <term><option>--drop-caches=<replaceable>BOOL</replaceable></option></term> <listitem><para>Automatically flush OS file system caches on logout. This is useful in combination with the fscrypt storage backend to ensure the OS does not keep decrypted versions of the files and @@ -745,7 +791,7 @@ </varlistentry> <varlistentry> - <term><option>--fs-type=</option><replaceable>TYPE</replaceable></term> + <term><option>--fs-type=<replaceable>TYPE</replaceable></option></term> <listitem><para>When LUKS2 storage is used configures the file system type to use inside the home directory LUKS2 container. One of <literal>btrfs</literal>, <literal>ext4</literal>, @@ -758,7 +804,7 @@ </varlistentry> <varlistentry> - <term><option>--luks-discard=</option><replaceable>BOOL</replaceable></term> + <term><option>--luks-discard=<replaceable>BOOL</replaceable></option></term> <listitem><para>When LUKS2 storage is used configures whether to enable the <literal>discard</literal> feature of the file system. If enabled the file system on top of the LUKS2 @@ -774,7 +820,7 @@ </varlistentry> <varlistentry> - <term><option>--luks-offline-discard=</option><replaceable>BOOL</replaceable></term> + <term><option>--luks-offline-discard=<replaceable>BOOL</replaceable></option></term> <listitem><para>Similar to <option>--luks-discard=</option>, controls the trimming of the file system. However, while <option>--luks-discard=</option> controls what happens when the home directory @@ -786,7 +832,7 @@ </varlistentry> <varlistentry> - <term><option>--luks-extra-mount-options=</option><replaceable>OPTIONS</replaceable></term> + <term><option>--luks-extra-mount-options=<replaceable>OPTIONS</replaceable></option></term> <listitem><para>Takes a string containing additional mount options to use when mounting the LUKS volume. If specified, this string will be appended to the default, built-in mount @@ -796,16 +842,16 @@ </varlistentry> <varlistentry> - <term><option>--luks-cipher=</option><replaceable>CIPHER</replaceable></term> - <term><option>--luks-cipher-mode=</option><replaceable>MODE</replaceable></term> - <term><option>--luks-volume-key-size=</option><replaceable>BYTES</replaceable></term> - <term><option>--luks-pbkdf-type=</option><replaceable>TYPE</replaceable></term> - <term><option>--luks-pbkdf-hash-algorithm=</option><replaceable>ALGORITHM</replaceable></term> - <term><option>--luks-pbkdf-force-iterations=</option><replaceable>ITERATIONS</replaceable></term> - <term><option>--luks-pbkdf-time-cost=</option><replaceable>SECONDS</replaceable></term> - <term><option>--luks-pbkdf-memory-cost=</option><replaceable>BYTES</replaceable></term> - <term><option>--luks-pbkdf-parallel-threads=</option><replaceable>THREADS</replaceable></term> - <term><option>--luks-sector-size=</option><replaceable>BYTES</replaceable></term> + <term><option>--luks-cipher=<replaceable>CIPHER</replaceable></option></term> + <term><option>--luks-cipher-mode=<replaceable>MODE</replaceable></option></term> + <term><option>--luks-volume-key-size=<replaceable>BYTES</replaceable></option></term> + <term><option>--luks-pbkdf-type=<replaceable>TYPE</replaceable></option></term> + <term><option>--luks-pbkdf-hash-algorithm=<replaceable>ALGORITHM</replaceable></option></term> + <term><option>--luks-pbkdf-force-iterations=<replaceable>ITERATIONS</replaceable></option></term> + <term><option>--luks-pbkdf-time-cost=<replaceable>SECONDS</replaceable></option></term> + <term><option>--luks-pbkdf-memory-cost=<replaceable>BYTES</replaceable></option></term> + <term><option>--luks-pbkdf-parallel-threads=<replaceable>THREADS</replaceable></option></term> + <term><option>--luks-sector-size=<replaceable>BYTES</replaceable></option></term> <listitem><para>Configures various cryptographic parameters for the LUKS2 storage mechanism. See <citerefentry @@ -863,9 +909,9 @@ </varlistentry> <varlistentry> - <term><option>--nosuid=</option><replaceable>BOOL</replaceable></term> - <term><option>--nodev=</option><replaceable>BOOL</replaceable></term> - <term><option>--noexec=</option><replaceable>BOOL</replaceable></term> + <term><option>--nosuid=<replaceable>BOOL</replaceable></option></term> + <term><option>--nodev=<replaceable>BOOL</replaceable></option></term> + <term><option>--noexec=<replaceable>BOOL</replaceable></option></term> <listitem><para>Configures the <literal>nosuid</literal>, <literal>nodev</literal> and <literal>noexec</literal> mount options for the home directories. By default <literal>nodev</literal> @@ -877,10 +923,10 @@ </varlistentry> <varlistentry> - <term><option>--cifs-domain=</option><replaceable>DOMAIN</replaceable></term> - <term><option>--cifs-user-name=</option><replaceable>USER</replaceable></term> - <term><option>--cifs-service=</option><replaceable>SERVICE</replaceable></term> - <term><option>--cifs-extra-mount-options=</option><replaceable>OPTIONS</replaceable></term> + <term><option>--cifs-domain=<replaceable>DOMAIN</replaceable></option></term> + <term><option>--cifs-user-name=<replaceable>USER</replaceable></option></term> + <term><option>--cifs-service=<replaceable>SERVICE</replaceable></option></term> + <term><option>--cifs-extra-mount-options=<replaceable>OPTIONS</replaceable></option></term> <listitem><para>Configures the Windows File Sharing (CIFS) domain and user to associate with the home directory/user account, as well as the file share ("service") to mount as directory. The latter is @@ -896,7 +942,7 @@ </varlistentry> <varlistentry> - <term><option>--stop-delay=</option><replaceable>SECS</replaceable></term> + <term><option>--stop-delay=<replaceable>SECS</replaceable></option></term> <listitem><para>Configures the time the per-user service manager shall continue to run after the all sessions of the user ended. The default is configured in @@ -909,7 +955,7 @@ </varlistentry> <varlistentry> - <term><option>--kill-processes=</option><replaceable>BOOL</replaceable></term> + <term><option>--kill-processes=<replaceable>BOOL</replaceable></option></term> <listitem><para>Configures whether to kill all processes of the user on logout. The default is configured in @@ -919,7 +965,7 @@ </varlistentry> <varlistentry> - <term><option>--auto-login=</option><replaceable>BOOL</replaceable></term> + <term><option>--auto-login=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean argument. Configures whether the graphical UI of the system should automatically log this user in if possible. Defaults to off. If less or more than one user is marked @@ -927,6 +973,28 @@ <xi:include href="version-info.xml" xpointer="v245"/></listitem> </varlistentry> + + <varlistentry> + <term><option>--session-launcher=<replaceable>LAUNCHER</replaceable></option></term> + + <listitem><para>Takes a string argument. Configures the user's preferred session launcher + .desktop entry file (i.e. <literal>gnome</literal>, <literal>plasma</literal>, or other names that + appear in <filename>/usr/share/xesssions/</filename> or <filename>/usr/share/wayland-sessions</filename>). + This is read by the display manager to pick the default session that is launched when the user logs in.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--session-type=<replaceable>TYPE</replaceable></option></term> + + <listitem><para>Takes a string argument. Configures the user's preferred session type + (i.e. <literal>x11</literal>, <literal>wayland</literal>, and other values accepted by + <varname>$XDG_SESSION_TYPE</varname>). This is read by the display manage to pick the + default session type the user is logged into.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> @@ -1002,7 +1070,7 @@ <varlistentry> <term><command>create</command> <replaceable>USER</replaceable></term> - <term><command>create</command> <option>--identity=</option><replaceable>PATH</replaceable> <optional><replaceable>USER</replaceable></optional></term> + <term><command>create</command> <option>--identity=<replaceable>PATH</replaceable></option> <optional><replaceable>USER</replaceable></optional></term> <listitem><para>Create a new home directory/user account of the specified name. Use the various user record property options (as documented above) to control various aspects of the home directory @@ -1026,7 +1094,7 @@ <varlistentry> <term><command>update</command> <replaceable>USER</replaceable></term> - <term><command>update</command> <option>--identity=</option><replaceable>PATH</replaceable> <optional><replaceable>USER</replaceable></optional></term> + <term><command>update</command> <option>--identity=<replaceable>PATH</replaceable></option> <optional><replaceable>USER</replaceable></optional></term> <listitem><para>Update a home directory/user account. Use the various user record property options (as documented above) to make changes to the account, or alternatively provide a full, updated JSON @@ -1138,6 +1206,59 @@ <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> + + <varlistentry> + <term><command>firstboot</command></term> + + <listitem><para>This command is supposed to be invoked during the initial boot of the system. It + checks whether any regular home area exists so far, and if not queries the user interactively on the + console for user name and password and creates one. Alternatively, if one or more service credentials + whose name starts with <literal>home.create.</literal> are passed to the command (containing a user + record in JSON format) these users are automatically created at boot.</para> + + <para>This command is invoked by the <filename>systemd-homed-firstboot.service</filename> service + unit.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Credentials</title> + + <para>When invoked with the <command>firstboot</command> command, <command>homectl</command> supports the + service credentials logic as implemented by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>home.create.*</varname></term> + + <listitem><para>If one or more credentials whose names begin with <literal>home.create.</literal>, + followed by a valid UNIX username are passed, a new home area is created, one for each specified user + record.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Kernel Command Line</title> + + <variablelist class='kernel-commandline-options'> + <varlistentry> + <term><varname>systemd.firstboot=</varname></term> + + <listitem><para>This boolean will disable the effect of <command>homectl firstboot</command> + command. It's primarily interpreted by + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> @@ -1206,14 +1327,14 @@ homectl update nihilbaxter --fido2-device=auto</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>useradd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/homed.conf.xml b/man/homed.conf.xml index acc5f5f..4b51093 100644 --- a/man/homed.conf.xml +++ b/man/homed.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="homed.conf" conditional='ENABLE_HOMED' @@ -22,10 +22,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/homed.conf</filename></para> - <para><filename>/etc/systemd/homed.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/homed.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/homed.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/homed.conf</filename></member> + <member><filename>/run/systemd/homed.conf</filename></member> + <member><filename>/usr/local/lib/systemd/homed.conf</filename></member> + <member><filename>/usr/lib/systemd/homed.conf</filename></member> + <member><filename>/etc/systemd/homed.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/homed.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/homed.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/homed.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -79,10 +85,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/hostname.xml b/man/hostname.xml index a3dae72..746de21 100644 --- a/man/hostname.xml +++ b/man/hostname.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -100,17 +100,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/hostnamectl.xml b/man/hostnamectl.xml index 85594b0..0f50bf9 100644 --- a/man/hostnamectl.xml +++ b/man/hostnamectl.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -201,6 +201,7 @@ <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> <xi:include href="standard-options.xml" xpointer="json" /> + <xi:include href="standard-options.xml" xpointer="j" /> </variablelist> </refsect1> @@ -213,15 +214,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/hwdb-usb-device.c b/man/hwdb-usb-device.c index facd8c4..3ce3ccd 100644 --- a/man/hwdb-usb-device.c +++ b/man/hwdb-usb-device.c @@ -1,5 +1,6 @@ /* SPDX-License-Identifier: MIT-0 */ +#define _GNU_SOURCE 1 #include <stdio.h> #include <stdint.h> #include <systemd/sd-hwdb.h> diff --git a/man/hwdb.xml b/man/hwdb.xml index 4efa375..3822552 100644 --- a/man/hwdb.xml +++ b/man/hwdb.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="hwdb" conditional="ENABLE_HWDB"> diff --git a/man/importctl.xml b/man/importctl.xml new file mode 100644 index 0000000..3e2e33f --- /dev/null +++ b/man/importctl.xml @@ -0,0 +1,442 @@ +<?xml version='1.0'?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="importctl" conditional='ENABLE_MACHINED' + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>importctl</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>importctl</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>importctl</refname> + <refpurpose>Download, import or export disk images</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>importctl</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="req">COMMAND</arg> + <arg choice="opt" rep="repeat">NAME</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>importctl</command> may be used to download, import, and export disk images via + <citerefentry><refentrytitle>systemd-importd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <para><command>importctl</command> operates both on block-level disk images (such as DDIs) as well as + file-system-level images (tarballs). It supports disk images are one of the four following + classes:</para> + + <itemizedlist> + <listitem><para>VM images or full OS container images, that may be run via + <citerefentry><refentrytitle>systemd-vmspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> or + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, and + managed via + <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + + <listitem><para>Portable service images, that may be attached an managed via + <citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para></listitem> + + <listitem><para>System extension (sysext) images, that may be activated via + <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem> + + <listitem><para>Configuration extension (confext) images, that may be activated via + <citerefentry><refentrytitle>systemd-confext</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para></listitem> + </itemizedlist> + + <para>When images are downloaded or imported they are placed in the following directories, depending on + the <option>--class=</option> parameter:</para> + + <table> + <title>Classes and Directories</title> + <tgroup cols='2'> + <colspec colname='class' /> + <colspec colname='directory' /> + <thead> + <row> + <entry>Class</entry> + <entry>Directory</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>machine</literal></entry> + <entry><filename>/var/lib/machines/</filename></entry> + </row> + <row> + <entry><literal>portable</literal></entry> + <entry><filename>/var/lib/portables/</filename></entry> + </row> + <row> + <entry><literal>sysext</literal></entry> + <entry><filename>/var/lib/extensions/</filename></entry> + </row> + <row> + <entry><literal>confext</literal></entry> + <entry><filename>/var/lib/confexts/</filename></entry> + </row> + </tbody> + </tgroup> + </table> + </refsect1> + + <refsect1> + <title>Commands</title> + + <para>The following commands are understood:</para> + + <variablelist> + <varlistentry> + <term><command>pull-tar</command> <replaceable>URL</replaceable> [<replaceable>NAME</replaceable>]</term> + + <listitem><para>Downloads a <filename>.tar</filename> image from the specified URL, and makes it + available under the specified local name in the image directory for the selected + <option>--class=</option>. The URL must be of type <literal>http://</literal> or + <literal>https://</literal>, and must refer to a <filename>.tar</filename>, + <filename>.tar.gz</filename>, <filename>.tar.xz</filename> or <filename>.tar.bz2</filename> archive + file. If the local image name is omitted, it is automatically derived from the last component of the + URL, with its suffix removed.</para> + + <para>The image is verified before it is made available, unless <option>--verify=no</option> is + specified. Verification is done either via an inline signed file with the name of the image and the + suffix <filename>.sha256</filename> or via separate <filename>SHA256SUMS</filename> and + <filename>SHA256SUMS.gpg</filename> files. The signature files need to be made available on the same + web server, under the same URL as the <filename>.tar</filename> file. With + <option>--verify=checksum</option>, only the SHA256 checksum for the file is verified, based on the + <filename>.sha256</filename> suffixed file or the <filename>SHA256SUMS</filename> file. With + <option>--verify=signature</option>, the sha checksum file is first verified with the inline + signature in the <filename>.sha256</filename> file or the detached GPG signature file + <filename>SHA256SUMS.gpg</filename>. The public key for this verification step needs to be available + in <filename>/usr/lib/systemd/import-pubring.gpg</filename> or + <filename>/etc/systemd/import-pubring.gpg</filename>.</para> + + <para>If <option>-keep-download=yes</option> is specified the image will be downloaded and stored in + a read-only subvolume/directory in the image directory that is named after the specified URL and its + HTTP etag. A writable snapshot is then taken from this subvolume, and named after the specified local + name. This behavior ensures that creating multiple instances of the same URL is efficient, as + multiple downloads are not necessary. In order to create only the read-only image, and avoid creating + its writable snapshot, specify <literal>-</literal> as local name.</para> + + <para>Note that pressing C-c during execution of this command will not abort the download. Use + <command>cancel-transfer</command>, described below.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>pull-raw</command> <replaceable>URL</replaceable> [<replaceable>NAME</replaceable>]</term> + + <listitem><para>Downloads a <filename>.raw</filename> disk image from the specified URL, and makes it + available under the specified local name in the image directory for the selected + <option>--class=</option>. The URL must be of type <literal>http://</literal> or + <literal>https://</literal>. The image must either be a <filename>.qcow2</filename> or raw disk + image, optionally compressed as <filename>.gz</filename>, <filename>.xz</filename>, or + <filename>.bz2</filename>. If the local name is omitted, it is automatically derived from the last + component of the URL, with its suffix removed.</para> + + <para>Image verification is identical for raw and tar images (see above).</para> + + <para>If the downloaded image is in <filename>.qcow2</filename> format it is converted into a raw + image file before it is made available.</para> + + <para>If <option>-keep-download=yes</option> is specified the image will be downloaded and stored in + a read-only file in the image directory that is named after the specified URL and its HTTP etag. A + writable copy is then made from this file, and named after the specified local name. This behavior + ensures that creating multiple instances of the same URL is efficient, as multiple downloads are not + necessary. In order to create only the read-only image, and avoid creating its writable copy, + specify <literal>-</literal> as local name.</para> + + <para>Note that pressing C-c during execution of this command will not abort the download. Use + <command>cancel-transfer</command>, described below.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>import-tar</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> + <term><command>import-raw</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> + + <listitem><para>Imports a TAR or RAW image, and places it under the specified name in the image + directory for the image class selected via <option>--class=</option>. When + <command>import-tar</command> is used, the file specified as the first argument should be a tar + archive, possibly compressed with xz, gzip or bzip2. It will then be unpacked into its own + subvolume/directory. When <command>import-raw</command> is used, the file should be a qcow2 or raw + disk image, possibly compressed with xz, gzip or bzip2. If the second argument (the resulting image + name) is not specified, it is automatically derived from the file name. If the filename is passed as + <literal>-</literal>, the image is read from standard input, in which case the second argument is + mandatory.</para> + + <para>No cryptographic validation is done when importing the images.</para> + + <para>Much like image downloads, ongoing imports may be listed with <command>list</command> + and aborted with <command>cancel-transfer</command>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>import-fs</command> <replaceable>DIRECTORY</replaceable> [<replaceable>NAME</replaceable>]</term> + + <listitem><para>Imports an image stored in a local directory into the image directory for the image + class selected via <option>--class=</option> and operates similarly to <command>import-tar</command> + or <command>import-raw</command>, but the first argument is the source directory. If supported, this + command will create a btrfs snapshot or subvolume for the new image.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>export-tar</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> + <term><command>export-raw</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> + + <listitem><para>Exports a TAR or RAW image and stores it in the specified file. The first parameter + should be an image name. The second parameter should be a file path the TAR or RAW + image is written to. If the path ends in <literal>.gz</literal>, the file is compressed with gzip, if + it ends in <literal>.xz</literal>, with xz, and if it ends in <literal>.bz2</literal>, with bzip2. If + the path ends in neither, the file is left uncompressed. If the second argument is missing, the image + is written to standard output. The compression may also be explicitly selected with the + <option>--format=</option> switch. This is in particular useful if the second parameter is left + unspecified.</para> + + <para>Much like image downloads and imports, ongoing exports may be listed with + <command>list</command> and aborted with <command>cancel-transfer</command>.</para> + + <para>Note that, currently, only directory and subvolume images may be exported as TAR images, and + only raw disk images as RAW images.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>list-transfer</command></term> + + <listitem><para>Shows a list of image downloads, imports and exports that are currently in + progress.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>cancel-transfer</command> <replaceable>ID</replaceable>…</term> + + <listitem><para>Aborts a download, import or export of the image with the specified ID. To list + ongoing transfers and their IDs, use <command>list</command>. </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><command>list-images</command></term> + + <listitem><para>Shows a list of already downloaded/imported images.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>--read-only</option></term> + + <listitem> + <para>When used with <command>pull-raw</command>, <command>pull-tar</command>, + <command>import-raw</command>, <command>import-tar</command> or <command>import-fs</command> a + read-only image is created.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--verify=</option></term> + + <listitem><para>When downloading an image, specify whether the image shall be verified before it is + made available. Takes one of <literal>no</literal>, <literal>checksum</literal> and + <literal>signature</literal>. If <literal>no</literal>, no verification is done. If + <literal>checksum</literal> is specified, the download is checked for integrity after the transfer is + complete, but no signatures are verified. If <literal>signature</literal> is specified, the checksum + is verified and the image's signature is checked against a local keyring of trustable vendors. It is + strongly recommended to set this option to <literal>signature</literal> if the server and protocol + support this. Defaults to <literal>signature</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--force</option></term> + + <listitem><para>When downloading an image, and a local copy by the specified local name already + exists, delete it first and replace it by the newly downloaded image.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--format=</option></term> + + <listitem><para>When used with the <option>export-tar</option> or <option>export-raw</option> + commands, specifies the compression format to use for the resulting file. Takes one of + <literal>uncompressed</literal>, <literal>xz</literal>, <literal>gzip</literal>, + <literal>bzip2</literal>. By default, the format is determined automatically from the output image + file name passed.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>-q</option></term> + <term><option>--quiet</option></term> + + <listitem><para>Suppresses additional informational output while running.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <xi:include href="user-system-options.xml" xpointer="host" /> + + <varlistentry> + <term><option>-M</option></term> + <term><option>--machine=</option></term> + + <listitem><para>Connect to + <citerefentry><refentrytitle>systemd-import.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + running in a local container, to perform the specified operation within the container.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--class=</option></term> + <term><option>-m</option></term> + <term><option>-P</option></term> + <term><option>-S</option></term> + <term><option>-C</option></term> + + <listitem><para>Selects the image class for the downloaded images. This primarily selects the + directory to download into. The <option>--class=</option> switch takes <literal>machine</literal>, + <literal>portable</literal>, <literal>sysext</literal> or <literal>confext</literal> as argument. The + short options <option>-m</option>, <option>-P</option>, <option>-S</option>, <option>-C</option> are + shortcuts for <option>--class=machine</option>, <option>--class=portable</option>, + <option>--class=sysext</option>, <option>--class=confext</option>.</para> + + <para>Note that <option>--keep-download=</option> defaults to true for + <option>--class=machine</option> and false otherwise, see below.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--keep-download=</option></term> + <term><option>-N</option></term> + + <listitem><para>Takes a boolean argument. When specified with <command>pull-raw</command> or + <command>pull-tar</command>, selects whether to download directly into the specified local image + name, or whether to download into a read-only copy first of which to make a writable copy after the + download is completed. Defaults to true for <option>--class=machine</option>, false otherwise.</para> + + <para>The <option>-N</option> switch is a shortcut for <option>--keep-download=no</option>.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <xi:include href="standard-options.xml" xpointer="json" /> + <xi:include href="standard-options.xml" xpointer="j" /> + <xi:include href="standard-options.xml" xpointer="no-pager" /> + <xi:include href="standard-options.xml" xpointer="no-legend" /> + <xi:include href="standard-options.xml" xpointer="no-ask-password" /> + <xi:include href="standard-options.xml" xpointer="help" /> + <xi:include href="standard-options.xml" xpointer="version" /> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + <example id="example-import-tar"> + <title>Download an Ubuntu TAR image and open a shell in it</title> + + <programlisting># importctl pull-tar -mN https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64-root.tar.xz +# systemd-nspawn -M jammy-server-cloudimg-amd64-root</programlisting> + + <para>This downloads and verifies the specified <filename>.tar</filename> image, and then uses + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> to + open a shell in it.</para> + </example> + + <example id="example-import-raw"> + <title>Download an Ubuntu RAW image, set a root password in it, start + it as a service</title> + + <programlisting># importctl pull-raw -mN \ + https://cloud-images.ubuntu.com/jammy/current/jammy-server-cloudimg-amd64-disk-kvm.img \ + jammy +# systemd-firstboot --image=/var/lib/machines/jammy.raw --prompt-root-password --force +# machinectl start jammy +# machinectl login jammy</programlisting> + + <para>This downloads the specified <filename>.raw</filename> image and makes it available under the + local name <literal>jammy</literal>. Then, a root password is set with + <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>. Afterwards + the machine is started as system service. With the last command a login prompt into the container is + requested.</para> + </example> + + <example id="example-export-tar"> + <title>Exports a container image as tar file</title> + + <programlisting># importctl export-tar -m fedora myfedora.tar.xz</programlisting> + + <para>Exports the container <literal>fedora</literal> as an xz-compressed tar file + <filename>myfedora.tar.xz</filename> into the current directory.</para> + </example> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success, 0 is returned, a non-zero failure code + otherwise.</para> + </refsect1> + + <xi:include href="common-variables.xml" /> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-importd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-vmspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-confext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + +</refentry> diff --git a/man/integritytab.xml b/man/integritytab.xml index a4b18af..519ed1c 100644 --- a/man/integritytab.xml +++ b/man/integritytab.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -80,7 +80,7 @@ <listitem><para> Enable journaled, bitmapped or direct (passthrough) mode. Journaled mode is the default when this option is not specified. It provides safety against crashes, but can be slow because all data has to be written twice. - Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it may not be detected. + Bitmap mode is more efficient since it requires only a single write, but it is less reliable because if data corruption happens when the machine crashes, it might not be detected. Direct mode disables the journal and the bitmap. Corresponds to the "direct writes" mode documented in <ulink url="https://docs.kernel.org/admin-guide/device-mapper/dm-integrity.html">the dm-integrity documentation</ulink>. Note that without a journal, if there is a crash, it is possible that the integrity tags and data will not match. If used, the journal-* @@ -176,12 +176,12 @@ data PARTUUID=5d4b1808-be76-774d-88af-03c4c3a41761 - allow-discards <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/iocost.conf.xml b/man/iocost.conf.xml index a7fdc66..88e4edd 100644 --- a/man/iocost.conf.xml +++ b/man/iocost.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="iocost.conf" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -67,12 +67,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://github.com/iocost-benchmark/iocost-benchmarks">The iocost-benchmarks github project</ulink>, - <ulink url="https://github.com/facebookexperimental/resctl-demo/tree/main/resctl-bench/doc">The resctl-bench - documentation details how the values are obtained</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://github.com/iocost-benchmark/iocost-benchmarks">The + iocost-benchmarks github project</ulink></member> + <member><ulink url="https://github.com/facebookexperimental/resctl-demo/tree/main/resctl-bench/doc">The resctl-bench + documentation details how the values are obtained</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/journal-enumerate-fields.c b/man/journal-enumerate-fields.c index bb09319..3d35b00 100644 --- a/man/journal-enumerate-fields.c +++ b/man/journal-enumerate-fields.c @@ -11,8 +11,7 @@ int main(int argc, char *argv[]) { r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to open journal: %m\n"); + fprintf(stderr, "Failed to open journal: %s\n", strerror(-r)); return 1; } SD_JOURNAL_FOREACH_FIELD(j, field) diff --git a/man/journal-iterate-foreach.c b/man/journal-iterate-foreach.c index 381b50f..9c0fa0e 100644 --- a/man/journal-iterate-foreach.c +++ b/man/journal-iterate-foreach.c @@ -7,10 +7,10 @@ int main(int argc, char *argv[]) { int r; sd_journal *j; + r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to open journal: %m\n"); + fprintf(stderr, "Failed to open journal: %s\n", strerror(-r)); return 1; } SD_JOURNAL_FOREACH(j) { @@ -19,8 +19,7 @@ int main(int argc, char *argv[]) { r = sd_journal_get_data(j, "MESSAGE", (const void **)&d, &l); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to read message field: %m\n"); + fprintf(stderr, "Failed to read message field: %s\n", strerror(-r)); continue; } diff --git a/man/journal-iterate-poll.c b/man/journal-iterate-poll.c index d377324..6b78296 100644 --- a/man/journal-iterate-poll.c +++ b/man/journal-iterate-poll.c @@ -1,5 +1,6 @@ /* SPDX-License-Identifier: MIT-0 */ +#define _GNU_SOURCE 1 #include <poll.h> #include <time.h> #include <systemd/sd-journal.h> diff --git a/man/journal-iterate-unique.c b/man/journal-iterate-unique.c index 5fe98b3..f44303d 100644 --- a/man/journal-iterate-unique.c +++ b/man/journal-iterate-unique.c @@ -12,14 +12,12 @@ int main(int argc, char *argv[]) { r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to open journal: %m\n"); + fprintf(stderr, "Failed to open journal: %s\n", strerror(-r)); return 1; } r = sd_journal_query_unique(j, "_SYSTEMD_UNIT"); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to query journal: %m\n"); + fprintf(stderr, "Failed to query journal: %s\n", strerror(-r)); return 1; } SD_JOURNAL_FOREACH_UNIQUE(j, d, l) diff --git a/man/journal-iterate-wait.c b/man/journal-iterate-wait.c index ac4b60b..69d3ccc 100644 --- a/man/journal-iterate-wait.c +++ b/man/journal-iterate-wait.c @@ -7,39 +7,38 @@ int main(int argc, char *argv[]) { int r; sd_journal *j; + r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to open journal: %m\n"); + fprintf(stderr, "Failed to open journal: %s\n", strerror(-r)); return 1; } + for (;;) { const void *d; size_t l; r = sd_journal_next(j); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to iterate to next entry: %m\n"); + fprintf(stderr, "Failed to iterate to next entry: %s\n", strerror(-r)); break; } if (r == 0) { /* Reached the end, let's wait for changes, and try again */ r = sd_journal_wait(j, (uint64_t) -1); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to wait for changes: %m\n"); + fprintf(stderr, "Failed to wait for changes: %s\n", strerror(-r)); break; } continue; } r = sd_journal_get_data(j, "MESSAGE", &d, &l); if (r < 0) { - errno = -r; - fprintf(stderr, "Failed to read message field: %m\n"); + fprintf(stderr, "Failed to read message field: %s\n", strerror(-r)); continue; } printf("%.*s\n", (int) l, (const char*) d); } + sd_journal_close(j); return 0; } diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml index a5a5b56..01dc94d 100644 --- a/man/journal-remote.conf.xml +++ b/man/journal-remote.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -27,10 +27,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/journal-remote.conf</filename></para> - <para><filename>/etc/systemd/journal-remote.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/journal-remote.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/journal-remote.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/journal-remote.conf</filename></member> + <member><filename>/run/systemd/journal-remote.conf</filename></member> + <member><filename>/usr/local/lib/systemd/journal-remote.conf</filename></member> + <member><filename>/usr/lib/systemd/journal-remote.conf</filename></member> + <member><filename>/etc/systemd/journal-remote.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/journal-remote.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/journal-remote.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/journal-remote.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -129,12 +135,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/journal-stream-fd.c b/man/journal-stream-fd.c index 8aad5ff..595091a 100644 --- a/man/journal-stream-fd.c +++ b/man/journal-stream-fd.c @@ -1,5 +1,6 @@ /* SPDX-License-Identifier: MIT-0 */ +#define _GNU_SOURCE 1 #include <errno.h> #include <syslog.h> #include <stdio.h> @@ -10,15 +11,16 @@ int main(int argc, char *argv[]) { int fd; FILE *log; + fd = sd_journal_stream_fd("test", LOG_INFO, 1); if (fd < 0) { - errno = -fd; - fprintf(stderr, "Failed to create stream fd: %m\n"); + fprintf(stderr, "Failed to create stream fd: %s\n", strerror(-fd)); return 1; } + log = fdopen(fd, "w"); if (!log) { - fprintf(stderr, "Failed to create file object: %m\n"); + fprintf(stderr, "Failed to create file object: %s\n", strerror(errno)); close(fd); return 1; } diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index 1bc7f08..7d3f22f 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="journal-upload.conf" conditional='HAVE_MICROHTTPD' @@ -23,6 +23,8 @@ <refsynopsisdiv> <para><filename>/etc/systemd/journal-upload.conf</filename></para> + <para><filename>/run/systemd/journal-upload.conf</filename></para> + <para><filename>/usr/lib/systemd/journal-upload.conf</filename></para> <para><filename>/etc/systemd/journal-upload.conf.d/*.conf</filename></para> <para><filename>/run/systemd/journal-upload.conf.d/*.conf</filename></para> <para><filename>/usr/lib/systemd/journal-upload.conf.d/*.conf</filename></para> @@ -101,11 +103,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/journalctl.xml b/man/journalctl.xml index d1066b8..5fd9263 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="journalctl" @@ -77,7 +77,7 @@ <emphasis>are</emphasis> being shown.</para> <para>The set of journal files which will be used can be modified using the <option>--user</option>, - <option>--system</option>, <option>--directory</option>, and <option>--file</option> options, see + <option>--system</option>, <option>--directory=</option>, and <option>--file=</option> options, see below.</para> <para>All users are granted access to their private per-user journals. However, by default, only root and @@ -160,6 +160,7 @@ </varlistentry> <varlistentry> + <term><option>-i <replaceable>GLOB</replaceable></option></term> <term><option>--file=<replaceable>GLOB</replaceable></option></term> <listitem><para>Takes a file glob as an argument. If specified, journalctl will operate on the @@ -295,7 +296,7 @@ <constant>2</constant> the second and so on; while <constant>-0</constant> is the last boot, <constant>-1</constant> the boot before last, and so on. An empty <replaceable>offset</replaceable> is equivalent to specifying <constant>-0</constant>, except when the current boot is not the last - boot (e.g. because <option>--directory</option> was specified to look at logs from a different + boot (e.g. because <option>--directory=</option> was specified to look at logs from a different machine).</para> <para>If the 32-character <replaceable>ID</replaceable> is specified, it may optionally be followed @@ -362,6 +363,18 @@ </varlistentry> <varlistentry> + <term><option>-T</option></term> + <term><option>--exclude-identifier=<replaceable>SYSLOG_IDENTIFIER</replaceable></option></term> + + <listitem><para>Exclude messages for the specified syslog identifier + <replaceable>SYSLOG_IDENTIFIER</replaceable>.</para> + + <para>This parameter can be specified multiple times.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>-p</option></term> <term><option>--priority=</option></term> @@ -677,8 +690,7 @@ will explain the context of an error or log event, possible solutions, as well as pointers to support forums, developer documentation, and any other relevant manuals. Note that help texts are not available for all messages, but only for selected ones. For more information on the message catalog, - please refer to the <ulink url="https://www.freedesktop.org/wiki/Software/systemd/catalog">Message - Catalog Developer Documentation</ulink>.</para> + see <ulink url="https://systemd.io/CATALOG">Journal Message Catalogs</ulink>.</para> <para>Note: when attaching <command>journalctl</command> output to bug reports, please do <emphasis>not</emphasis> use <option>-x</option>.</para> @@ -838,10 +850,16 @@ <varlistentry> <term><option>--list-boots</option></term> - <listitem><para>Show a tabular list of boot numbers (relative to the current boot), their IDs, and - the timestamps of the first and last message pertaining to the boot.</para> + <listitem> + <para>Show a tabular list of boot numbers (relative to the current boot), their IDs, and the + timestamps of the first and last message pertaining to the boot. When specified with + <option>-n/--lines=<optional>+</optional><replaceable>N</replaceable></option> option, only the + first (when the number prefixed with <literal>+</literal>) or the last (without prefix) + <replaceable>N</replaceable> entries will be shown. When specified with + <option>-r/--reverse</option>, the list will be shown in the reverse order.</para> - <xi:include href="version-info.xml" xpointer="v209"/></listitem> + <xi:include href="version-info.xml" xpointer="v209"/> + </listitem> </varlistentry> <varlistentry> @@ -1096,17 +1114,17 @@ journalctl _SYSTEMD_CGROUP=/user.slice/user-42.slice/session-c1.scope</programli <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cat</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/journald.conf.xml b/man/journald.conf.xml index e150d04..1aa7492 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="journald.conf" @@ -23,14 +23,21 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/journald.conf</filename></para> - <para><filename>/etc/systemd/journald.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/journald.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/journald.conf.d/*.conf</filename></para> - <para><filename>/etc/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf</filename></para> - <para><filename>/etc/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/journald.conf</filename></member> + <member><filename>/run/systemd/journald.conf</filename></member> + <member><filename>/usr/local/lib/systemd/journald.conf</filename></member> + <member><filename>/usr/lib/systemd/journald.conf</filename></member> + <member><filename>/etc/systemd/journald.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/journald.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/journald.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/journald.conf.d/*.conf</filename></member> + <member><filename>/etc/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf</filename></member> + <member><filename>/etc/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/journald@<replaceable>NAMESPACE</replaceable>.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -99,6 +106,10 @@ <para>Note that per-user journal files are not supported unless persistent storage is enabled, thus making <command>journalctl --user</command> unavailable.</para> + <para>The storage to use can also be specified via the <literal>journal.storage</literal> + credential. Values configured via configuration files take priority over values configured via the + credential.</para> + <xi:include href="version-info.xml" xpointer="v186"/> </listitem> </varlistentry> @@ -286,7 +297,7 @@ large individual journal files may grow at most. This influences the granularity in which disk space is made available through rotation, i.e. deletion of historic data. Defaults to one eighth of the values configured with <varname>SystemMaxUse=</varname> and <varname>RuntimeMaxUse=</varname> capped - to 128M, so that usually seven rotated journal files are kept as history. If the journal compact + to 128M, so that usually seven rotated journal files are kept as history. If the journal compact mode is enabled (enabled by default), the maximum file size is capped to 4G.</para> <para>Specify values in bytes or use K, M, G, T, P, E as units for the specified sizes (equal to @@ -366,11 +377,13 @@ <term><varname>ForwardToKMsg=</varname></term> <term><varname>ForwardToConsole=</varname></term> <term><varname>ForwardToWall=</varname></term> + <term><varname>ForwardToSocket=</varname></term> <listitem><para>Control whether log messages received by the journal daemon shall be forwarded to a - traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, or sent as wall - messages to all logged-in users. These options take boolean arguments. If forwarding to syslog is - enabled but nothing reads messages from the socket, forwarding to syslog has no effect. By default, + traditional syslog daemon, to the kernel log buffer (kmsg), to the system console, sent as wall + messages to all logged-in users or sent over a socket. These options take boolean arguments except + for <literal>ForwardToSocket=</literal> which takes an address instead. If forwarding + to syslog is enabled but nothing reads messages from the socket, forwarding to syslog has no effect. By default, only forwarding to wall is enabled. These settings may be overridden at boot time with the kernel command line options <literal>systemd.journald.forward_to_syslog</literal>, <literal>systemd.journald.forward_to_kmsg</literal>, @@ -379,22 +392,45 @@ <literal>=</literal> and the following argument, true is assumed. Otherwise, the argument is parsed as a boolean.</para> + <para>The socket forwarding address can be specified with the credential + <literal>journal.forward_to_socket</literal>. The following socket types are supported:</para> + + <para><simplelist type="inline"> + <member><constant>AF_INET</constant> (e.g. <literal>192.168.0.11:4444</literal>)</member> + <member><constant>AF_INET6</constant> (e.g. <literal>[2001:db8::ff00:42:8329]:4444</literal>)</member> + <member><constant>AF_UNIX</constant> (e.g. <literal>/run/host/journal/socket</literal>)</member> + <member><constant>AF_VSOCK</constant> (e.g. <literal>vsock:2:1234</literal>)</member> + </simplelist></para> + <para>When forwarding to the console, the TTY to log to can be changed with <varname>TTYPath=</varname>, described below.</para> <para>When forwarding to the kernel log buffer (kmsg), make sure to select a suitably large size for the log buffer, for example by adding <literal>log_buf_len=8M</literal> to the kernel command line. <command>systemd</command> will automatically disable kernel's rate-limiting applied to userspace - processes (equivalent to setting <literal>printk.devkmsg=on</literal>).</para></listitem> + processes (equivalent to setting <literal>printk.devkmsg=on</literal>).</para> + + <para>When forwarding over a socket the <ulink url="https://systemd.io/JOURNAL_EXPORT_FORMATS/#journal-export-format"> + Journal Export Format</ulink> is used when sending over the wire. Notably this includes the metadata + field <varname>__REALTIME_TIMESTAMP</varname> so that + <command>systemd-journal-remote</command> (see + <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>) + can be used to receive the forwarded journal entries.</para> <para>Note: Forwarding is performed synchronously within journald, and may significantly affect its performance. This is particularly relevant when using ForwardToConsole=yes in cloud environments, - where the console is often a slow, virtual serial port. Since journald is implemented as a - conventional single-process daemon, forwarding to a completely hung console will block journald. - This can have a cascading effect resulting in any services synchronously logging to the blocked - journal also becoming blocked. Unless actively debugging/developing something, it's generally - preferable to setup a <command>journalctl --follow</command> style service redirected to the + where the console is often a slow, virtual serial port. + Since journald is implemented as a conventional single-process daemon, forwarding to a completely + hung console will block journald. This can have a cascading effect resulting in any services synchronously + logging to the blocked journal also becoming blocked. Unless actively debugging/developing something, it's + generally preferable to setup a <command>journalctl --follow</command> style service redirected to the console, instead of ForwardToConsole=yes, for production use.</para> + </listitem> + + <para>Note: Using <varname>ForwardToSocket=</varname> over IPv4/IPv6 links can be very slow due to the synchronous nature of the sockets. + Take care to ensure your link is a low-latency local link if possible. Typically IP networking is not available everywhere + journald runs, e.g. in the initrd during boot. Consider using <constant>AF_VSOCK</constant>/<constant>AF_UNIX</constant> sockets for this if possible. + </para> </varlistentry> <varlistentry> @@ -403,36 +439,27 @@ <term><varname>MaxLevelKMsg=</varname></term> <term><varname>MaxLevelConsole=</varname></term> <term><varname>MaxLevelWall=</varname></term> - - <listitem><para>Controls the maximum log level of messages - that are stored in the journal, forwarded to syslog, kmsg, the - console or wall (if that is enabled, see above). As argument, - takes one of - <literal>emerg</literal>, - <literal>alert</literal>, - <literal>crit</literal>, - <literal>err</literal>, - <literal>warning</literal>, - <literal>notice</literal>, - <literal>info</literal>, - <literal>debug</literal>, - or integer values in the range of 0–7 (corresponding to the - same levels). Messages equal or below the log level specified - are stored/forwarded, messages above are dropped. Defaults to - <literal>debug</literal> for <varname>MaxLevelStore=</varname> - and <varname>MaxLevelSyslog=</varname>, to ensure that the all - messages are stored in the journal and forwarded to syslog. - Defaults to - <literal>notice</literal> for <varname>MaxLevelKMsg=</varname>, - <literal>info</literal> for <varname>MaxLevelConsole=</varname>, - and <literal>emerg</literal> for - <varname>MaxLevelWall=</varname>. These settings may be - overridden at boot time with the kernel command line options + <term><varname>MaxLevelSocket=</varname></term> + + <listitem><para>Controls the maximum log level of messages that are stored in the journal, forwarded + to syslog, kmsg, the console, the wall, or a socket (if that is enabled, see above). As argument, + takes one of <literal>emerg</literal>, <literal>alert</literal>, <literal>crit</literal>, + <literal>err</literal>, <literal>warning</literal>, <literal>notice</literal>, + <literal>info</literal>, <literal>debug</literal>, or integer values in the range of 0–7 + (corresponding to the same levels). Messages equal or below the log level specified are + stored/forwarded, messages above are dropped. Defaults to <literal>debug</literal> for + <varname>MaxLevelStore=</varname>, <varname>MaxLevelSyslog=</varname> and + <varname>MaxLevelSocket=</varname>, to ensure that the all messages are stored in the journal, + forwarded to syslog and the socket if one exists. Defaults to <literal>notice</literal> for + <varname>MaxLevelKMsg=</varname>, <literal>info</literal> for <varname>MaxLevelConsole=</varname>, + and <literal>emerg</literal> for <varname>MaxLevelWall=</varname>. These settings may be overridden + at boot time with the kernel command line options <literal>systemd.journald.max_level_store=</literal>, <literal>systemd.journald.max_level_syslog=</literal>, <literal>systemd.journald.max_level_kmsg=</literal>, <literal>systemd.journald.max_level_console=</literal>, - <literal>systemd.journald.max_level_wall=</literal>.</para> + <literal>systemd.journald.max_level_wall=</literal>, + <literal>systemd.journald.max_level_socket=</literal>.</para> <xi:include href="version-info.xml" xpointer="v185"/> </listitem> @@ -529,13 +556,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml index 004b394..3dd5449 100644 --- a/man/kernel-command-line.xml +++ b/man/kernel-command-line.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="kernel-command-line" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -40,10 +40,8 @@ and <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> - <para>For command line parameters understood by the initrd, see - <citerefentry project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - or the documentation of the specific initrd implementation of your - installation.</para> + <para>For command line parameters understood by the initrd, see the documentation of the specific initrd + implementation of your installation.</para> </refsect1> <refsect1> @@ -56,7 +54,7 @@ <term><varname>systemd.dump_core</varname></term> <term><varname>systemd.crash_chvt</varname></term> <term><varname>systemd.crash_shell</varname></term> - <term><varname>systemd.crash_reboot</varname></term> + <term><varname>systemd.crash_action=</varname></term> <term><varname>systemd.confirm_spawn</varname></term> <term><varname>systemd.service_watchdogs</varname></term> <term><varname>systemd.show_status</varname></term> @@ -88,6 +86,7 @@ <term><varname>systemd.mask=</varname></term> <term><varname>systemd.wants=</varname></term> <term><varname>systemd.debug_shell</varname></term> + <term><varname>systemd.default_debug_tty=</varname></term> <listitem> <para>Additional parameters understood by <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, @@ -139,6 +138,18 @@ </varlistentry> <varlistentry> + <term><varname>systemd.ssh_auto=</varname></term> + <term><varname>systemd.ssh_listen=</varname></term> + <listitem> + <para>These parameters are interpreted by + <citerefentry><refentrytitle>systemd-ssh-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> + and may be used to control SSH sockets the system shall be reachable on.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>systemd.volatile=</varname></term> <listitem> <para>This parameter controls whether the system shall boot up in volatile mode. Takes a boolean argument, or @@ -306,7 +317,7 @@ <term><varname>udev.blockdev_read_only</varname></term> <term><varname>rd.udev.blockdev_read_only</varname></term> <term><varname>net.ifnames=</varname></term> - <term><varname>net.naming-scheme=</varname></term> + <term><varname>net.naming_scheme=</varname></term> <listitem> <para>Parameters understood by the device event managing @@ -579,10 +590,9 @@ <term><varname>resumeflags=</varname></term> <listitem> - <para>Enables resume from hibernation using the specified - device and mount options. All - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-like - paths are supported. For details, see + <para>Enable resume from hibernation using the specified device and timeout options. All + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>-style + device identifiers are supported. For details, see <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> <xi:include href="version-info.xml" xpointer="v217"/> @@ -590,13 +600,25 @@ </varlistentry> <varlistentry> + <term><varname>resume_offset=</varname></term> + + <listitem><para>Configure the page offset of the swap space from the resume device. For details, see + <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + </para> + + <xi:include href="version-info.xml" xpointer="v254"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>systemd.firstboot=</varname></term> <listitem><para>Takes a boolean argument, defaults to on. If off, <citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>systemd-homed-firstboot.service</refentrytitle><manvolnum>1</manvolnum></citerefentry> will not query the user for basic system settings, even if the system boots up for the first time and the relevant settings are not initialized yet. Not to be confused with - <varname>systemd.condition-first-boot=</varname> (see below), which overrides the result of the + <varname>systemd.condition_first_boot=</varname> (see below), which overrides the result of the <varname>ConditionFirstBoot=</varname> unit file condition, and thus controls more than just <filename>systemd-firstboot.service</filename> behaviour.</para> @@ -604,7 +626,7 @@ </varlistentry> <varlistentry> - <term><varname>systemd.condition-needs-update=</varname></term> + <term><varname>systemd.condition_needs_update=</varname></term> <listitem><para>Takes a boolean argument. If specified, overrides the result of <varname>ConditionNeedsUpdate=</varname> unit condition checks. See @@ -615,7 +637,7 @@ </varlistentry> <varlistentry> - <term><varname>systemd.condition-first-boot=</varname></term> + <term><varname>systemd.condition_first_boot=</varname></term> <listitem><para>Takes a boolean argument. If specified, overrides the result of <varname>ConditionFirstBoot=</varname> unit condition checks. See @@ -628,7 +650,7 @@ </varlistentry> <varlistentry> - <term><varname>systemd.clock-usec=</varname></term> + <term><varname>systemd.clock_usec=</varname></term> <listitem><para>Takes a decimal, numeric timestamp in μs since January 1st 1970, 00:00am, to set the system clock to. The system time is set to the specified timestamp early during boot. It is not @@ -638,7 +660,7 @@ </varlistentry> <varlistentry> - <term><varname>systemd.random-seed=</varname></term> + <term><varname>systemd.random_seed=</varname></term> <listitem><para>Takes a base64 encoded random seed value to credit with full entropy to the kernel's random pool during early service manager initialization. This option is useful in testing @@ -664,6 +686,17 @@ </varlistentry> <varlistentry> + <term><varname>systemd.allow_userspace_verity=</varname></term> + + <listitem><para>Takes a boolean argument. Controls whether disk images that are Verity protected may + be authenticated in userspace signature checks via <filename>/etc/verity.d/</filename> (and related + directories) public key drop-ins, or whether in-kernel signature checking only. Defaults to + on.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>systemd.hostname=</varname></term> <listitem><para>Accepts a hostname to set during early boot. If specified takes precedence over what @@ -710,6 +743,15 @@ <xi:include href="version-info.xml" xpointer="v245"/></listitem> </varlistentry> + <varlistentry> + <term><varname>systemd.tpm2_wait=</varname></term> + + <listitem><para>Controls whether to wait for a TPM2 device at boot, implemented by + <citerefentry><refentrytitle>systemd-tpm2-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> </refsect1> @@ -730,33 +772,32 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry> - <citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-getty-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-volatile-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-rfkill.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>bootparam</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-getty-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-volatile-root.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-backlight@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-rfkill.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/kernel-install.xml b/man/kernel-install.xml index c05176a..54c254e 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="kernel-install" conditional='ENABLE_KERNEL_INSTALL' @@ -33,6 +33,11 @@ <cmdsynopsis> <command>kernel-install</command> <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="plain">add-all</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>kernel-install</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain">remove</arg> <arg choice="plain"><replaceable>KERNEL-VERSION</replaceable></arg> </cmdsynopsis> @@ -510,8 +515,12 @@ <para><varname>$KERNEL_INSTALL_CONF_ROOT</varname> can be set to override the location of the configuration files read by <command>kernel-install</command>. When set, - <filename>install.conf</filename>, <filename>entry-token</filename>, and other files will be - read from this directory.</para> + <filename>install.conf</filename>, <filename>entry-token</filename>, and other files will be read from + this directory only. Note that this path is relative to the host, and in particular <emphasis>symlinks + in this directory are resolved relative to the host</emphasis>, even if + <option>--root=<replaceable>root</replaceable></option> is used. This means that it is generally + <emphasis>not</emphasis> correct to use this variable to specify a directory underneath + <replaceable>root</replaceable> if symlinks are used there.</para> <para><varname>$KERNEL_INSTALL_PLUGINS</varname> can be set to override the list of plugins executed by <command>kernel-install</command>. The argument is a whitespace-separated list of paths. @@ -639,14 +648,23 @@ </varlistentry> <varlistentry> <term><filename>/etc/kernel/install.conf</filename></term> + <term><filename>/run/kernel/install.conf</filename></term> + <term><filename>/usr/local/lib/kernel/install.conf</filename></term> <term><filename>/usr/lib/kernel/install.conf</filename></term> + <term><filename>/etc/kernel/install.conf.d/*.conf</filename></term> + <term><filename>/run/kernel/install.conf.d/*.conf</filename></term> + <term><filename>/usr/local/lib/kernel/install.conf.d/*.conf</filename></term> + <term><filename>/usr/lib/kernel/install.conf.d/*.conf</filename></term> <listitem> <para>Configuration file with options for <command>kernel-install</command>, as a series of <varname>KEY=</varname><replaceable>VALUE</replaceable> assignments, compatible with shell syntax, following the same rules as described in <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The first of the files that is found will be used. <varname>$KERNEL_INSTALL_CONF_ROOT</varname> may be - used to override the search path; see below for details.</para> + used to override the search path; see below for details. Drop-in files may also be used + to extend the configuration with overrides, see + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para> <para>Currently, the following keys are supported: <varname>MACHINE_ID=</varname>, @@ -709,14 +727,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/libsystemd-pkgconfig.xml b/man/libsystemd-pkgconfig.xml index 3d22870..02e4b8f 100644 --- a/man/libsystemd-pkgconfig.xml +++ b/man/libsystemd-pkgconfig.xml @@ -1,5 +1,5 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE refsect1 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 --> diff --git a/man/libsystemd.xml b/man/libsystemd.xml index e9de64c..34bd62e 100644 --- a/man/libsystemd.xml +++ b/man/libsystemd.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="libsystemd" @@ -78,12 +78,12 @@ <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> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>libudev</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/PORTABILITY_AND_STABILITY/">Interface Portability and Stability Promise</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/libudev.xml b/man/libudev.xml index 684bd47..3683b8b 100644 --- a/man/libudev.xml +++ b/man/libudev.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -83,17 +83,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-device</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-device</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/loader.conf.xml b/man/loader.conf.xml index a7db82d..068aa3b 100644 --- a/man/loader.conf.xml +++ b/man/loader.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="loader.conf" conditional='ENABLE_BOOTLOADER' @@ -422,9 +422,9 @@ editor no <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/locale.conf.xml b/man/locale.conf.xml index 24be105..8dc9cb4 100644 --- a/man/locale.conf.xml +++ b/man/locale.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="locale.conf"> @@ -117,12 +117,12 @@ LC_MESSAGES=en_US.UTF-8</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/localectl.xml b/man/localectl.xml index eb22857..e18462a 100644 --- a/man/localectl.xml +++ b/man/localectl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="localectl" conditional='ENABLE_LOCALED' @@ -50,10 +50,8 @@ <para>Note that the changes performed using this tool might require the initrd to be rebuilt to take effect during early system boot. The initrd is not rebuilt automatically by - <filename>localectl</filename>, this task has to be performed manually, usually using a tool like - <citerefentry - project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - </para> + <filename>localectl</filename>, this task has to be performed manually, usually by reinstalling the + distribution's kernel package.</para> <para>Note that <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -209,21 +207,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry>, - <ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html"> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kbd</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + <member><ulink url="http://www.x.org/releases/current/doc/xorg-docs/input/XKB-Config.html"> The XKB Configuration Guide - </ulink>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + </ulink></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/localtime.xml b/man/localtime.xml index e486474..3a13e04 100644 --- a/man/localtime.xml +++ b/man/localtime.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="localtime"> @@ -59,14 +59,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>tzset</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>tzset</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/logcontrol-example.c b/man/logcontrol-example.c index c199ec7..23e7384 100644 --- a/man/logcontrol-example.c +++ b/man/logcontrol-example.c @@ -43,13 +43,10 @@ #define _cleanup_(f) __attribute__((cleanup(f))) -#define check(log_level, x) ({ \ - int _r = (x); \ - errno = _r < 0 ? -_r : 0; \ - sd_journal_print((log_level), #x ": %m"); \ - if (_r < 0) \ - return EXIT_FAILURE; \ - }) +static int log_error(int log_level, int error, const char *str) { + sd_journal_print(log_level, "%s failed: %s", str, strerror(-error)); + return error; +} typedef enum LogTarget { LOG_TARGET_JOURNAL, @@ -127,7 +124,8 @@ static int property_set( return r; if (strcmp(property, "LogLevel") == 0) { - for (int i = 0; i < LOG_DEBUG + 1; i++) + int i; + for (i = 0; i < LOG_DEBUG + 1; i++) if (strcmp(value, log_level_table[i]) == 0) { o->log_level = i; setlogmask(LOG_UPTO(i)); @@ -141,7 +139,8 @@ static int property_set( } if (strcmp(property, "LogTarget") == 0) { - for (LogTarget i = 0; i < _LOG_TARGET_MAX; i++) + LogTarget i; + for (i = 0; i < _LOG_TARGET_MAX; i++) if (strcmp(value, log_target_table[i]) == 0) { o->log_target = i; return 0; @@ -193,6 +192,7 @@ int main(int argc, char **argv) { .log_target = LOG_TARGET_JOURNAL, .syslog_identifier = "example", }; + int r; /* https://man7.org/linux/man-pages/man3/setlogmask.3.html * Programs using syslog() instead of sd_journal can use this API to cut logs @@ -203,37 +203,49 @@ int main(int argc, char **argv) { /* Acquire a connection to the bus, letting the library work out the details. * https://www.freedesktop.org/software/systemd/man/sd_bus_default.html */ - check(o.log_level, sd_bus_default(&bus)); + r = sd_bus_default(&bus); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_default()"); /* Publish an interface on the bus, specifying our well-known object access * path and public interface name. * https://www.freedesktop.org/software/systemd/man/sd_bus_add_object.html * https://dbus.freedesktop.org/doc/dbus-tutorial.html */ - check(o.log_level, sd_bus_add_object_vtable(bus, NULL, - "/org/freedesktop/LogControl1", - "org.freedesktop.LogControl1", - vtable, - &o)); + r = sd_bus_add_object_vtable(bus, NULL, + "/org/freedesktop/LogControl1", + "org.freedesktop.LogControl1", + vtable, + &o); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_add_object_vtable()"); /* By default the service is assigned an ephemeral name. Also add a fixed * one, so that clients know whom to call. * https://www.freedesktop.org/software/systemd/man/sd_bus_request_name.html */ - check(o.log_level, sd_bus_request_name(bus, "org.freedesktop.Example", 0)); + r = sd_bus_request_name(bus, "org.freedesktop.Example", 0); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_request_name()"); for (;;) { /* https://www.freedesktop.org/software/systemd/man/sd_bus_wait.html */ - check(o.log_level, sd_bus_wait(bus, UINT64_MAX)); + r = sd_bus_wait(bus, UINT64_MAX); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_wait()"); /* https://www.freedesktop.org/software/systemd/man/sd_bus_process.html */ - check(o.log_level, sd_bus_process(bus, NULL)); + r = sd_bus_process(bus, NULL); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_process()"); } /* https://www.freedesktop.org/software/systemd/man/sd_bus_release_name.html */ - check(o.log_level, sd_bus_release_name(bus, "org.freedesktop.Example")); + r = sd_bus_release_name(bus, "org.freedesktop.Example"); + if (r < 0) + return log_error(o.log_level, r, "sd_bus_release_name()"); return 0; } diff --git a/man/loginctl.xml b/man/loginctl.xml index bf489a2..099de1d 100644 --- a/man/loginctl.xml +++ b/man/loginctl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="loginctl" conditional='ENABLE_LOGIND' @@ -50,7 +50,8 @@ <varlistentry> <term><command>list-sessions</command></term> - <listitem><para>List current sessions.</para></listitem> + <listitem><para>List current sessions. The JSON format output can be toggled using <option>--json=</option> + or <option>-j</option> option.</para></listitem> </varlistentry> <varlistentry> @@ -145,8 +146,8 @@ <varlistentry> <term><command>list-users</command></term> - <listitem><para>List currently logged in users. - </para></listitem> + <listitem><para>List currently logged in users. The JSON format output can be toggled using + <option>--json=</option> or <option>-j</option> option.</para></listitem> </varlistentry> <varlistentry> @@ -225,8 +226,8 @@ <varlistentry> <term><command>list-seats</command></term> - <listitem><para>List currently available seats on the local - system.</para></listitem> + <listitem><para>List currently available seats on the local system. The JSON format output can be + toggled using <option>--json=</option> or <option>-j</option> option.</para></listitem> </varlistentry> <varlistentry> @@ -411,6 +412,8 @@ <xi:include href="standard-options.xml" xpointer="no-pager" /> <xi:include href="standard-options.xml" xpointer="no-legend" /> + <xi:include href="standard-options.xml" xpointer="json" /> + <xi:include href="standard-options.xml" xpointer="j" /> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> </variablelist> @@ -458,12 +461,12 @@ Apr 09 14:40:30 laptop login[2325]: LOGIN ON tty3 BY fatima <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/logind.conf.xml b/man/logind.conf.xml index 72f657c..c52431f 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -25,10 +25,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/logind.conf</filename></para> - <para><filename>/etc/systemd/logind.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/logind.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/logind.conf</filename></member> + <member><filename>/run/systemd/logind.conf</filename></member> + <member><filename>/usr/local/lib/systemd/logind.conf</filename></member> + <member><filename>/usr/lib/systemd/logind.conf</filename></member> + <member><filename>/etc/systemd/logind.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/logind.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/logind.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/logind.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -143,18 +149,10 @@ <term><varname>IdleAction=</varname></term> <listitem><para>Configures the action to take when the system - is idle. Takes one of - <literal>ignore</literal>, - <literal>poweroff</literal>, - <literal>reboot</literal>, - <literal>halt</literal>, - <literal>kexec</literal>, - <literal>suspend</literal>, - <literal>hibernate</literal>, - <literal>hybrid-sleep</literal>, - <literal>suspend-then-hibernate</literal>, and - <literal>lock</literal>. - Defaults to <literal>ignore</literal>.</para> + is idle. Takes one of <literal>ignore</literal>, <literal>poweroff</literal>, <literal>reboot</literal>, + <literal>halt</literal>, <literal>kexec</literal>, <literal>suspend</literal>, <literal>hibernate</literal>, + <literal>hybrid-sleep</literal>, <literal>suspend-then-hibernate</literal>, <literal>sleep</literal>, + and <literal>lock</literal>. Defaults to <literal>ignore</literal>.</para> <para>Note that this requires that user sessions correctly report the idle status to the system. The system will execute @@ -201,6 +199,20 @@ </varlistentry> <varlistentry> + <term><varname>SleepOperation=</varname></term> + + <listitem><para>Takes a list of sleep operations. Possible values are <literal>suspend</literal>, + <literal>hibernate</literal>, <literal>hybrid-sleep</literal>, and <literal>suspend-then-hibernate</literal>. + Controls the candidate sleep operations for the <literal>sleep</literal> action. When <literal>sleep</literal> + action is performed, the specified sleep operations are checked in a fixed order (<literal>suspend-then-hibernate</literal> + → <literal>hybrid-sleep</literal> → <literal>suspend</literal> → <literal>hibernate</literal>), and + the first one supported by the machine is used to put the system into sleep. Defaults to + <literal>suspend-then-hibernate suspend hibernate</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>HandlePowerKey=</varname></term> <term><varname>HandlePowerKeyLongPress=</varname></term> <term><varname>HandleRebootKey=</varname></term> @@ -215,10 +227,9 @@ <listitem><para>Controls how logind shall handle the system power, reboot and sleep keys and the lid switch to trigger actions such as system power-off, reboot or suspend. Can be one of - <literal>ignore</literal>, <literal>poweroff</literal>, <literal>reboot</literal>, - <literal>halt</literal>, <literal>kexec</literal>, <literal>suspend</literal>, - <literal>hibernate</literal>, <literal>hybrid-sleep</literal>, - <literal>suspend-then-hibernate</literal>, <literal>lock</literal>, and + <literal>ignore</literal>, <literal>poweroff</literal>, <literal>reboot</literal>, <literal>halt</literal>, + <literal>kexec</literal>, <literal>suspend</literal>, <literal>hibernate</literal>, <literal>hybrid-sleep</literal>, + <literal>suspend-then-hibernate</literal>, <literal>sleep</literal>, <literal>lock</literal>, and <literal>factory-reset</literal>. If <literal>ignore</literal>, <command>systemd-logind</command> will never handle these keys. If <literal>lock</literal>, all running sessions will be screen-locked; otherwise, the specified action will be taken in the respective event. Only input devices with the @@ -372,10 +383,11 @@ <term><varname>StopIdleSessionSec=</varname></term> <listitem><para>Specifies a timeout in seconds, or a time span value after which - <filename>systemd-logind</filename> checks the idle state of all sessions. Every session that is idle for - longer then the timeout will be stopped. Defaults to <literal>infinity</literal> - (<filename>systemd-logind</filename> is not checking the idle state of sessions). For details about the syntax - of time spans, see + <filename>systemd-logind</filename> checks the idle state of all sessions. Every session that is idle + for longer than the timeout will be stopped. Note that this option doesn't apply to + <literal>greeter</literal> or <literal>lock-screen</literal> sessions. Defaults to + <literal>infinity</literal> (<filename>systemd-logind</filename> is not checking the idle state + of sessions). For details about the syntax of time spans, see <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para> @@ -386,12 +398,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/machine-id.xml b/man/machine-id.xml index e57a7c1..4ee100b 100644 --- a/man/machine-id.xml +++ b/man/machine-id.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="machine-id"> @@ -188,17 +188,17 @@ id[8] = (id[8] & 0x3F) | 0x80;</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>gethostid</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/machine-info.xml b/man/machine-info.xml index 1b26531..bdd213c 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="machine-info" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -168,14 +168,14 @@ DEPLOYMENT=production</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/machinectl.xml b/man/machinectl.xml index 1afd431..3964dc0 100644 --- a/man/machinectl.xml +++ b/man/machinectl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -80,6 +80,9 @@ <listitem><para>The file system tree of the host OS itself.</para></listitem> </itemizedlist> + <para>Images may be downloaded, imported and exported via the + <citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + tool.</para> </refsect1> <refsect1> @@ -87,8 +90,9 @@ <para>The following commands are understood:</para> - <refsect2><title>Machine Commands</title><variablelist> + <refsect2><title>Machine Commands</title> + <variablelist> <varlistentry> <term><command>list</command></term> @@ -279,7 +283,8 @@ trigger a reboot by sending SIGINT to the container's init process, which is roughly equivalent to pressing Ctrl+Alt+Del on a non-containerized system, and is compatible with - containers running any system manager.</para> + containers running any system manager. Use <command>restart</command> as alias + for <command>reboot</command>.</para> <xi:include href="version-info.xml" xpointer="v209"/></listitem> </varlistentry> @@ -360,8 +365,9 @@ </varlistentry> </variablelist></refsect2> - <refsect2><title>Image Commands</title><variablelist> + <refsect2><title>Image Commands</title> + <variablelist> <varlistentry> <term><command>list-images</command></term> @@ -514,7 +520,7 @@ <para>When combined with the <option>--all</option> switch removes all images, not just hidden ones. This command effectively empties <filename>/var/lib/machines/</filename>.</para> - <para>Note that commands such as <command>machinectl pull-tar</command> or <command>machinectl + <para>Note that commands such as <command>importctl pull-tar</command> or <command>importctl pull-raw</command> usually create hidden, read-only, unmodified machine images from the downloaded image first, before cloning a writable working copy of it, in order to avoid duplicate downloads in case of images that are reused multiple times. Use <command>machinectl clean</command> to remove old, hidden images created this @@ -524,197 +530,6 @@ </varlistentry> </variablelist></refsect2> - - <refsect2><title>Image Transfer Commands</title><variablelist> - - <varlistentry> - <term><command>pull-tar</command> <replaceable>URL</replaceable> [<replaceable>NAME</replaceable>]</term> - - <listitem><para>Downloads a <filename>.tar</filename> - container image from the specified URL, and makes it available - under the specified local machine name. The URL must be of - type <literal>http://</literal> or - <literal>https://</literal>, and must refer to a - <filename>.tar</filename>, <filename>.tar.gz</filename>, - <filename>.tar.xz</filename> or <filename>.tar.bz2</filename> - archive file. If the local machine name is omitted, it - is automatically derived from the last component of the URL, - with its suffix removed.</para> - - <para>The image is verified before it is made available, unless - <option>--verify=no</option> is specified. - Verification is done either via an inline signed file with the name - of the image and the suffix <filename>.sha256</filename> or via - separate <filename>SHA256SUMS</filename> and - <filename>SHA256SUMS.gpg</filename> files. - The signature files need to be made available on the same web - server, under the same URL as the <filename>.tar</filename> file. - With <option>--verify=checksum</option>, only the SHA256 checksum - for the file is verified, based on the <filename>.sha256</filename> - suffixed file or the <filename>SHA256SUMS</filename> file. - With <option>--verify=signature</option>, the sha checksum file is - first verified with the inline signature in the - <filename>.sha256</filename> file or the detached GPG signature file - <filename>SHA256SUMS.gpg</filename>. - The public key for this verification step needs to be available in - <filename>/usr/lib/systemd/import-pubring.gpg</filename> or - <filename>/etc/systemd/import-pubring.gpg</filename>.</para> - - <para>The container image will be downloaded and stored in a - read-only subvolume in - <filename>/var/lib/machines/</filename> that is named after - the specified URL and its HTTP etag. A writable snapshot is - then taken from this subvolume, and named after the specified - local name. This behavior ensures that creating multiple - container instances of the same URL is efficient, as multiple - downloads are not necessary. In order to create only the - read-only image, and avoid creating its writable snapshot, - specify <literal>-</literal> as local machine name.</para> - - <para>Note that the read-only subvolume is prefixed with - <filename>.tar-</filename>, and is thus not shown by - <command>list-images</command>, unless <option>--all</option> - is passed.</para> - - <para>Note that pressing C-c during execution of this command - will not abort the download. Use - <command>cancel-transfer</command>, described - below.</para> - - <xi:include href="version-info.xml" xpointer="v219"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>pull-raw</command> <replaceable>URL</replaceable> [<replaceable>NAME</replaceable>]</term> - - <listitem><para>Downloads a <filename>.raw</filename> - container or VM disk image from the specified URL, and makes - it available under the specified local machine name. The URL - must be of type <literal>http://</literal> or - <literal>https://</literal>. The container image must either - be a <filename>.qcow2</filename> or raw disk image, optionally - compressed as <filename>.gz</filename>, - <filename>.xz</filename>, or <filename>.bz2</filename>. If the - local machine name is omitted, it is automatically - derived from the last component of the URL, with its suffix - removed.</para> - - <para>Image verification is identical for raw and tar images - (see above).</para> - - <para>If the downloaded image is in - <filename>.qcow2</filename> format it is converted into a raw - image file before it is made available.</para> - - <para>Downloaded images of this type will be placed as - read-only <filename>.raw</filename> file in - <filename>/var/lib/machines/</filename>. A local, writable - (reflinked) copy is then made under the specified local - machine name. To omit creation of the local, writable copy - pass <literal>-</literal> as local machine name.</para> - - <para>Similarly to the behavior of <command>pull-tar</command>, the read-only image is prefixed with - <filename>.raw-</filename>, and thus not shown by <command>list-images</command>, unless - <option>--all</option> is passed.</para> - - <para>Note that pressing C-c during execution of this command - will not abort the download. Use - <command>cancel-transfer</command>, described - below.</para> - - <xi:include href="version-info.xml" xpointer="v219"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>import-tar</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> - <term><command>import-raw</command> <replaceable>FILE</replaceable> [<replaceable>NAME</replaceable>]</term> - <listitem><para>Imports a TAR or RAW container or VM image, - and places it under the specified name in - <filename>/var/lib/machines/</filename>. When - <command>import-tar</command> is used, the file specified as - the first argument should be a tar archive, possibly compressed - with xz, gzip or bzip2. It will then be unpacked into its own - subvolume in <filename>/var/lib/machines/</filename>. When - <command>import-raw</command> is used, the file should be a - qcow2 or raw disk image, possibly compressed with xz, gzip or - bzip2. If the second argument (the resulting image name) is - not specified, it is automatically derived from the file - name. If the filename is passed as <literal>-</literal>, the - image is read from standard input, in which case the second - argument is mandatory.</para> - - <para>Optionally, the <option>--read-only</option> switch may be used to create a read-only container or VM - image. No cryptographic validation is done when importing the images.</para> - - <para>Much like image downloads, ongoing imports may be listed - with <command>list-transfers</command> and aborted with - <command>cancel-transfer</command>.</para> - - <xi:include href="version-info.xml" xpointer="v220"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>import-fs</command> <replaceable>DIRECTORY</replaceable> [<replaceable>NAME</replaceable>]</term> - - <listitem><para>Imports a container image stored in a local directory into - <filename>/var/lib/machines/</filename>, operates similarly to <command>import-tar</command> or - <command>import-raw</command>, but the first argument is the source directory. If supported, this - command will create a btrfs snapshot or subvolume for the new image.</para> - - <xi:include href="version-info.xml" xpointer="v240"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>export-tar</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> - <term><command>export-raw</command> <replaceable>NAME</replaceable> [<replaceable>FILE</replaceable>]</term> - <listitem><para>Exports a TAR or RAW container or VM image and - stores it in the specified file. The first parameter should be - a VM or container image name. The second parameter should be a - file path the TAR or RAW image is written to. If the path ends - in <literal>.gz</literal>, the file is compressed with gzip, if - it ends in <literal>.xz</literal>, with xz, and if it ends in - <literal>.bz2</literal>, with bzip2. If the path ends in - neither, the file is left uncompressed. If the second argument - is missing, the image is written to standard output. The - compression may also be explicitly selected with the - <option>--format=</option> switch. This is in particular - useful if the second parameter is left unspecified.</para> - - <para>Much like image downloads and imports, ongoing exports - may be listed with <command>list-transfers</command> and - aborted with - <command>cancel-transfer</command>.</para> - - <para>Note that, currently, only directory and subvolume images - may be exported as TAR images, and only raw disk images as RAW - images.</para> - - <xi:include href="version-info.xml" xpointer="v220"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>list-transfers</command></term> - - <listitem><para>Shows a list of container or VM image - downloads, imports and exports that are currently in - progress.</para> - - <xi:include href="version-info.xml" xpointer="v219"/></listitem> - </varlistentry> - - <varlistentry> - <term><command>cancel-transfer</command> <replaceable>ID</replaceable>…</term> - - <listitem><para>Aborts a download, import or export of the - container or VM image with the specified ID. To list ongoing - transfers and their IDs, use - <command>list-transfers</command>. </para> - - <xi:include href="version-info.xml" xpointer="v219"/></listitem> - </varlistentry> - - </variablelist></refsect2> - </refsect1> <refsect1> @@ -738,6 +553,17 @@ <xi:include href="version-info.xml" xpointer="v206"/></listitem> </varlistentry> + <varlistentry> + <term><option>--value</option></term> + + <listitem><para>When printing properties with <command>show</command>, only print the value, + and skip the property name and <literal>=</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v230"/></listitem> + </varlistentry> + + <xi:include href="timedatectl.xml" xpointer="option-P"/> + <varlistentry> <term><option>-a</option></term> <term><option>--all</option></term> @@ -755,15 +581,6 @@ <xi:include href="version-info.xml" xpointer="v206"/></listitem> </varlistentry> - <varlistentry> - <term><option>--value</option></term> - - <listitem><para>When printing properties with <command>show</command>, only print the value, - and skip the property name and <literal>=</literal>.</para> - - <xi:include href="version-info.xml" xpointer="v230"/></listitem> - </varlistentry> - <varlistentry> <term><option>-l</option></term> <term><option>--full</option></term> @@ -833,8 +650,7 @@ <listitem><para>When used with <command>bind</command>, creates a read-only bind mount.</para> - <para>When used with <command>clone</command>, <command>import-raw</command> or <command>import-tar</command> a - read-only container or VM image is created.</para> + <para>When used with <command>clone</command> a read-only container or VM image is created.</para> <xi:include href="version-info.xml" xpointer="v219"/></listitem> </varlistentry> @@ -866,24 +682,26 @@ </varlistentry> <varlistentry> - <term><option>--verify=</option></term> - - <listitem><para>When downloading a container or VM image, - specify whether the image shall be verified before it is made - available. Takes one of <literal>no</literal>, - <literal>checksum</literal> and <literal>signature</literal>. - If <literal>no</literal>, no verification is done. If - <literal>checksum</literal> is specified, the download is - checked for integrity after the transfer is complete, but no - signatures are verified. If <literal>signature</literal> is - specified, the checksum is verified and the image's signature - is checked against a local keyring of trustable vendors. It is - strongly recommended to set this option to - <literal>signature</literal> if the server and protocol - support this. Defaults to - <literal>signature</literal>.</para> + <term><option>--runner=</option><option>nspawn</option>|<option>vmspawn</option></term> - <xi:include href="version-info.xml" xpointer="v219"/></listitem> + <listitem><para>When operating on machines choose whether to use + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> + or + <citerefentry><refentrytitle>systemd-vmspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>. + By default + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> + is used. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option></term> + + <listitem><para><option>-V</option> is a shorthand for <option>--runner=vmspawn</option>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> <varlistentry> @@ -902,29 +720,12 @@ <varlistentry> <term><option>--force</option></term> - <listitem><para>When downloading a container or VM image, and - a local copy by the specified local machine name already - exists, delete it first and replace it by the newly downloaded - image.</para> + <listitem><para>Replace target file when copying files.</para> <xi:include href="version-info.xml" xpointer="v219"/></listitem> </varlistentry> <varlistentry> - <term><option>--format=</option></term> - - <listitem><para>When used with the <option>export-tar</option> - or <option>export-raw</option> commands, specifies the - compression format to use for the resulting file. Takes one of - <literal>uncompressed</literal>, <literal>xz</literal>, - <literal>gzip</literal>, <literal>bzip2</literal>. By default, - the format is determined automatically from the image file - name passed.</para> - - <xi:include href="version-info.xml" xpointer="v220"/></listitem> - </varlistentry> - - <varlistentry> <term><option>--max-addresses=</option></term> <listitem><para>When used with the <option>list-machines</option> command, limits the number of IP @@ -1045,58 +846,8 @@ <refsect1> <title>Examples</title> - <example> - <title>Download a Ubuntu image and open a shell in it</title> - - <programlisting># machinectl pull-tar https://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-root.tar.gz -# systemd-nspawn -M trusty-server-cloudimg-amd64-root</programlisting> - - <para>This downloads and verifies the specified - <filename>.tar</filename> image, and then uses - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> - to open a shell in it.</para> - </example> - - <example> - <title>Download a Fedora image, set a root password in it, start - it as a service</title> - - <programlisting># machinectl pull-raw --verify=no \ - https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz \ - Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64 -# systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64 -# passwd -# exit -# machinectl start Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64 -# machinectl login Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64</programlisting> - - <para>This downloads the specified <filename>.raw</filename> - image with verification disabled. Then, a shell is opened in it - and a root password is set. Afterwards the shell is left, and - the machine started as system service. With the last command a - login prompt into the container is requested.</para> - </example> - - <example> - <title>Exports a container image as tar file</title> - - <programlisting># machinectl export-tar fedora myfedora.tar.xz</programlisting> - - <para>Exports the container <literal>fedora</literal> as an - xz-compressed tar file <filename>myfedora.tar.xz</filename> into the - current directory.</para> - </example> - - <example> - <title>Create a new shell session</title> - - <programlisting># machinectl shell --uid=lennart</programlisting> - - <para>This creates a new shell session on the local host for - the user ID <literal>lennart</literal>, in a <citerefentry - project='die-net'><refentrytitle>su</refentrytitle><manvolnum>1</manvolnum></citerefentry>-like - fashion.</para> - </example> + + <xi:include href="importctl.xml" xpointer="example-import-raw" /> </refsect1> @@ -1111,16 +862,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/meson.build b/man/meson.build index 403098a..69ea5c4 100644 --- a/man/meson.build +++ b/man/meson.build @@ -59,7 +59,15 @@ foreach tuple : manpages mandirn = get_option('mandir') / ('man' + section) - if condition == '' or conf.get(condition) == 1 + have = true + foreach word : condition.split() + if conf.get(word) != 1 + have = false + break + endif + endforeach + + if have file = files(tuple[0] + '.xml') source_xml_files += file if tuple[0].startswith('org.freedesktop.') @@ -240,3 +248,89 @@ update_man_rules = custom_target( '@0@/man/*.xml'.format(project_source_root), '@0@/rules/meson.build'.format(meson.current_source_dir())], depends : man_page_depends) + +############################################################ + +simple_examples = files( + 'event-quick-child.c', + 'hwdb-usb-device.c', + 'id128-app-specific.c', + 'inotify-watch-tmp.c', + 'journal-enumerate-fields.c', + 'journal-iterate-foreach.c', + 'journal-iterate-poll.c', + 'journal-iterate-unique.c', + 'journal-iterate-wait.c', + 'journal-stream-fd.c', + 'logcontrol-example.c', + 'notify-selfcontained-example.c', + 'path-documents.c', + 'print-unit-path-call-method.c', + 'print-unit-path.c', + 'sd-bus-container-append.c', + 'sd-bus-container-read.c', + 'sd_bus_error-example.c', + 'sd_bus_service_reconnect.c', + 'send-unit-files-changed.c', + 'vtable-example.c', +) + +examples = [] +foreach example : simple_examples + examples += [ { 'file' : example } ] +endforeach + +if conf.get('HAVE_GLIB') == 1 + examples += [ + { + 'file' : files('glib-event-glue.c'), + 'opts' : [ + '-I', libglib.get_variable('includedir') / 'glib-2.0', + '-I', libglib.get_variable('libdir') / 'glib-2.0/include', + ], + }, + ] +endif + +default_args = [ + cc.cmd_array(), + '-c', + '-x', 'c', + '-pedantic', + '-Wall', + '-Werror', + '-Wextra', + '-Wno-unused-parameter', + '-o', '/dev/null', + '-I', meson.current_source_dir() / '../src', +] + +std_args_in = [ + [ '-std=c90', '-Wno-pedantic', '-Wno-variadic-macros', ], + [ '-std=c99', ], + [ '-std=c11', ], + [ '-std=c17', ], + [ '-std=c23', ], + [ '-std=gnu90', '-Wno-pedantic', '-Wno-variadic-macros', ], + [ '-std=gnu99', ], + [ '-std=gnu11', ], + [ '-std=gnu17', ], + [ '-std=gnu23', ], +] + +std_args = [] +foreach std : std_args_in + if cc.has_argument(std[0]) + std_args += [std] + endif +endforeach + +foreach item : examples + foreach std : std_args + file = item.get('file') + test('cc-' + fs.stem(file) + '-' + std[0].split('=')[1], + env, + suite : 'example', + args : default_args + std + item.get('opts', []) + [file]) + endforeach +endforeach diff --git a/man/modules-load.d.xml b/man/modules-load.d.xml index cd0c006..2ff71da 100644 --- a/man/modules-load.d.xml +++ b/man/modules-load.d.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="modules-load.d" conditional='HAVE_KMOD' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -22,9 +22,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/modules-load.d/*.conf</filename></para> - <para><filename>/run/modules-load.d/*.conf</filename></para> - <para><filename>/usr/lib/modules-load.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/modules-load.d/*.conf</filename></member> + <member><filename>/run/modules-load.d/*.conf</filename></member> + <member><filename>/usr/local/lib/modules-load.d/*.conf</filename></member> + <member><filename>/usr/lib/modules-load.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -65,12 +68,12 @@ virtio-net</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-modules-load.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/networkctl.xml b/man/networkctl.xml index 68b1d97..5e2126f 100644 --- a/man/networkctl.xml +++ b/man/networkctl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="networkctl" conditional='ENABLE_NETWORKD' @@ -302,15 +302,15 @@ details.</para> <para>Produces output similar to: - <programlisting>LINK CHASSIS ID SYSTEM NAME CAPS PORT ID PORT DESCRIPTION -enp0s25 00:e0:4c:00:00:00 GS1900 ..b........ 2 Port #2 + <programlisting>LINK SYSTEM-NAME SYSTEM-DESCRIPTION CHASSIS-ID PORT-ID PORT-DESCRIPTION CAPS +enp0s25 GS1900 - 00:e0:4c:00:00:00 2 Port #2 ..b........ Capability Flags: o - Other; p - Repeater; b - Bridge; w - WLAN Access Point; r - Router; t - Telephone; d - DOCSIS cable device; a - Station; c - Customer VLAN; s - Service VLAN, m - Two-port MAC Relay (TPMR) -1 neighbors listed.</programlisting></para> +1 neighbor(s) listed.</programlisting></para> <xi:include href="version-info.xml" xpointer="v219"/> </listitem> @@ -430,7 +430,8 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) </term> <listitem><para>Edit network configuration files, which include <filename>.network</filename>, <filename>.netdev</filename>, and <filename>.link</filename> files. If no network config file - matching the given name is found, a new one will be created under <filename>/etc/</filename>. + matching the given name is found, a new one will be created under <filename>/etc/</filename> or + <filename>/run/</filename>, depending on whether <option>--runtime</option> is specified. Specially, if the name is prefixed by <literal>@</literal>, it will be treated as a network interface, and editing will be performed on the network config files associated with it. Additionally, the interface name can be suffixed with <literal>:network</literal> (default) @@ -453,12 +454,65 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) <varlistentry> <term> <command>cat</command> - <replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>… + <optional><replaceable>FILE</replaceable>|<replaceable>@DEVICE</replaceable>…</optional> </term> - <listitem><para>Show network configuration files. This command honors - the <literal>@</literal> prefix in the same way as <command>edit</command>.</para> + <listitem> + <para>Show network configuration files. This command honors the <literal>@</literal> prefix in the + same way as <command>edit</command>. When no argument is specified, + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + and its drop-in files will be shown.</para> - <xi:include href="version-info.xml" xpointer="v254"/></listitem> + <xi:include href="version-info.xml" xpointer="v254"/> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>mask</command> + <replaceable>FILE</replaceable>… + </term> + <listitem><para>Mask network configuration files, which include <filename>.network</filename>, + <filename>.netdev</filename>, and <filename>.link</filename> files. A symlink of the given name will + be created under <filename>/etc/</filename> or <filename>/run/</filename>, depending on + whether <option>--runtime</option> is specified, that points to <filename>/dev/null</filename>. + If a non-empty config file with the specified name exists under the target directory or a directory + with higher priority (e.g. <option>--runtime</option> is used while an existing config resides + in <filename>/etc/</filename>), the operation is aborted.</para> + + <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term> + <command>unmask</command> + <replaceable>FILE</replaceable>… + </term> + <listitem><para>Unmask network configuration files, i.e. reverting the effect of <command>mask</command>. + Note that this command operates regardless of the scope of the directory, i.e. <option>--runtime</option> + is of no effect.</para> + + <para>This command honors <option>--no-reload</option> in the same way as <command>edit</command> + and <command>mask</command>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term> + <command>persistent-storage</command> + <replaceable>BOOL</replaceable> + </term> + <listitem> + <para>Notify <filename>systemd-networkd.service</filename> that the persistent storage for the + service is ready. This is called by + <filename>systemd-networkd-persistent-storage.service</filename>. Usually, this command should not + be called manually by users or administrators.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> </varlistentry> </variablelist> </refsect1> @@ -519,7 +573,7 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) </varlistentry> <varlistentry> - <term><option>--drop-in=</option><replaceable>NAME</replaceable></term> + <term><option>--drop-in=<replaceable>NAME</replaceable></option></term> <listitem> <para>When used with <command>edit</command>, edit the drop-in file <replaceable>NAME</replaceable> @@ -533,16 +587,27 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) <term><option>--no-reload</option></term> <listitem> - <para>When used with <command>edit</command>, + <para>When used with <command>edit</command>, <command>mask</command>, or <command>unmask</command>, <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> or <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - will not be reloaded after the editing finishes.</para> + will not be reloaded after the operation finishes.</para> <xi:include href="version-info.xml" xpointer="v254"/> </listitem> </varlistentry> + <varlistentry> + <term><option>--runtime</option></term> + + <listitem> + <para>When used with <command>edit</command> or <command>mask</command>, + operate on the file under <filename>/run/</filename> instead of <filename>/etc/</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="json" /> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> @@ -560,11 +625,11 @@ s - Service VLAN, m - Two-port MAC Relay (TPMR) <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>ip</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/networkd.conf.xml b/man/networkd.conf.xml index 018bde0..cac1d3b 100644 --- a/man/networkd.conf.xml +++ b/man/networkd.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -27,17 +27,22 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/networkd.conf</filename></para> - <para><filename>/etc/systemd/networkd.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/networkd.conf</filename></member> + <member><filename>/run/systemd/networkd.conf</filename></member> + <member><filename>/usr/local/lib/systemd/networkd.conf</filename></member> + <member><filename>/usr/lib/systemd/networkd.conf</filename></member> + <member><filename>/etc/systemd/networkd.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/networkd.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/networkd.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/networkd.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> <title>Description</title> - <para>These configuration files control global network parameters. - Currently the DHCP Unique Identifier (DUID).</para> - + <para>These configuration files control global network parameters.</para> </refsect1> <xi:include href="standard-conf.xml" xpointer="main-conf" /> @@ -91,6 +96,17 @@ </varlistentry> <varlistentry> + <term><varname>ManageForeignNextHops=</varname></term> + <listitem><para>A boolean. When true, <command>systemd-networkd</command> will remove nexthops + that are not configured in .network files (except for routes with protocol + <literal>kernel</literal>). When false, it will + not remove any foreign nexthops, keeping them even if they are not configured in a .network file. + Defaults to yes.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>RouteTable=</varname></term> <listitem><para>Defines the route table name. Takes a whitespace-separated list of the pairs of route table name and number. The route table name and number in each pair are separated with a @@ -106,6 +122,34 @@ </varlistentry> <varlistentry> + <term><varname>IPv4Forwarding=</varname></term> + <listitem> + <para>Configures IPv4 packet forwarding for the system. Takes a boolean value. This controls the + <filename>net.ipv4.conf.default.forwarding</filename> and + <filename>net.ipv4.conf.all.forwarding</filename>sysctl options. See + <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> + for more details about the sysctl options. Defaults to unset and the sysctl options will not be + changed.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>IPv6Forwarding=</varname></term> + <listitem> + <para>Configures IPv6 packet forwarding for the system. Takes a boolean value. This controls the + <filename>net.ipv6.conf.default.forwarding</filename> and + <filename>net.ipv6.conf.all.forwarding</filename> sysctl options. See + <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> + for more details about the sysctl options. Defaults to unset and the sysctl options will not be + changed.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>IPv6PrivacyExtensions=</varname></term> <listitem> <para>Specifies the default value for per-network <varname>IPv6PrivacyExtensions=</varname>. @@ -117,6 +161,43 @@ <xi:include href="version-info.xml" xpointer="v254"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem> + <para>Specifies the network- and protocol-independent default value for the same settings in + [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below. Takes a boolean, or the special value + <option>route</option>. See the same setting in + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + Defaults to <literal>no</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>[IPv6AcceptRA] Section Options</title> + + <para>This section configures the default setting of the Neighbor Discovery. The following options are + available in the [IPv6AcceptRA] section:</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem> + <para>Specifies the network-independent default value for the same setting in the [IPv6AcceptRA] + section in + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + Takes a boolean, or the special value <option>route</option>. When unspecified, the value specified + in the [Network] section in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + which defaults to <literal>no</literal>, will be used.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -215,6 +296,15 @@ DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting> <xi:include href="version-info.xml" xpointer="v230"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem> + <para>Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -239,18 +329,43 @@ DUIDRawData=00:00:ab:11:f9:2a:c2:77:29:f9:5c:00</programlisting> <xi:include href="version-info.xml" xpointer="v249"/></listitem> </varlistentry> + + <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem><para>As in the [DHCPv4] section.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>[DHCPServer] Section Options</title> + + <para>This section configures the default setting of the DHCP server. The following options are available + in the [DHCPServer] section:</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem> + <para>Same as the one in the [IPv6AcceptRA] section, but applied for DHCPv4 protocol.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_machine_app_specific</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/notify-selfcontained-example.c b/man/notify-selfcontained-example.c index 9a7553e..6bbe4f2 100644 --- a/man/notify-selfcontained-example.c +++ b/man/notify-selfcontained-example.c @@ -7,6 +7,7 @@ * This protocol is guaranteed to be stable as per: * https://systemd.io/PORTABILITY_AND_STABILITY/ */ +#define _GNU_SOURCE 1 #include <errno.h> #include <inttypes.h> #include <signal.h> @@ -40,10 +41,7 @@ static int notify(const char *message) { _cleanup_(closep) int fd = -1; const char *socket_path; - socket_path = getenv("NOTIFY_SOCKET"); - if (!socket_path) - return 0; /* Not running under systemd? Nothing to do */ - + /* Verify the argument first */ if (!message) return -EINVAL; @@ -51,6 +49,11 @@ static int notify(const char *message) { if (message_length == 0) return -EINVAL; + /* If the variable is not set, the protocol is a noop */ + socket_path = getenv("NOTIFY_SOCKET"); + if (!socket_path) + return 0; /* Not set? Nothing to do */ + /* Only AF_UNIX is supported, with path or abstract sockets */ if (socket_path[0] != '/' && socket_path[0] != '@') return -EAFNOSUPPORT; @@ -108,6 +111,10 @@ static int notify_reloading(void) { return notify(reload_message); } +static int notify_stopping(void) { + return notify("STOPPING=1"); +} + static volatile sig_atomic_t reloading = 0; static volatile sig_atomic_t terminating = 0; @@ -169,5 +176,13 @@ int main(int argc, char **argv) { sleep(5); } + r = notify_stopping(); + if (r < 0) { + fprintf(stderr, "Failed to report termination to $NOTIFY_SOCKET: %s\n", strerror(-r)); + return EXIT_FAILURE; + } + + /* Do some shutdown work here … */ + return EXIT_SUCCESS; } diff --git a/man/notify-selfcontained-example.py b/man/notify-selfcontained-example.py new file mode 100644 index 0000000..a1efb41 --- /dev/null +++ b/man/notify-selfcontained-example.py @@ -0,0 +1,104 @@ +#!/usr/bin/env python3 +# SPDX-License-Identifier: MIT-0 +# +# Implement the systemd notify protocol without external dependencies. +# Supports both readiness notification on startup and on reloading, +# according to the protocol defined at: +# https://www.freedesktop.org/software/systemd/man/latest/sd_notify.html +# This protocol is guaranteed to be stable as per: +# https://systemd.io/PORTABILITY_AND_STABILITY/ + +import errno +import os +import signal +import socket +import sys +import time + +reloading = False +terminating = False + +def notify(message): + if not message: + raise ValueError("notify() requires a message") + + socket_path = os.environ.get("NOTIFY_SOCKET") + if not socket_path: + return + + if socket_path[0] not in ("/", "@"): + raise OSError(errno.EAFNOSUPPORT, "Unsupported socket type") + + # Handle abstract socket. + if socket_path[0] == "@": + socket_path = "\0" + socket_path[1:] + + with socket.socket(socket.AF_UNIX, socket.SOCK_DGRAM | socket.SOCK_CLOEXEC) as sock: + sock.connect(socket_path) + sock.sendall(message) + +def notify_ready(): + notify(b"READY=1") + +def notify_reloading(): + microsecs = time.clock_gettime_ns(time.CLOCK_MONOTONIC) // 1000 + notify(f"RELOADING=1\nMONOTONIC_USEC={microsecs}".encode()) + +def notify_stopping(): + notify(b"STOPPING=1") + +def reload(signum, frame): + global reloading + reloading = True + +def terminate(signum, frame): + global terminating + terminating = True + +def main(): + print("Doing initial setup") + global reloading, terminating + + # Set up signal handlers. + print("Setting up signal handlers") + signal.signal(signal.SIGHUP, reload) + signal.signal(signal.SIGINT, terminate) + signal.signal(signal.SIGTERM, terminate) + + # Do any other setup work here. + + # Once all setup is done, signal readiness. + print("Done setting up") + notify_ready() + + print("Starting loop") + while not terminating: + if reloading: + print("Reloading") + reloading = False + + # Support notifying the manager when reloading configuration. + # This allows accurate state tracking as well as automatically + # enabling 'systemctl reload' without needing to manually + # specify an ExecReload= line in the unit file. + + notify_reloading() + + # Do some reconfiguration work here. + + print("Done reloading") + notify_ready() + + # Do the real work here ... + + print("Sleeping for five seconds") + time.sleep(5) + + print("Terminating") + notify_stopping() + +if __name__ == "__main__": + sys.stdout.reconfigure(line_buffering=True) + print("Starting app") + main() + print("Stopped app") diff --git a/man/nss-myhostname.xml b/man/nss-myhostname.xml index 360e6d7..e0cfffe 100644 --- a/man/nss-myhostname.xml +++ b/man/nss-myhostname.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="nss-myhostname" conditional='ENABLE_NSS_MYHOSTNAME'> @@ -126,14 +126,14 @@ netgroup: nis</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/nss-mymachines.xml b/man/nss-mymachines.xml index 717ecc5..8ca0d62 100644 --- a/man/nss-mymachines.xml +++ b/man/nss-mymachines.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="nss-mymachines" conditional='ENABLE_NSS_MYMACHINES'> @@ -122,16 +122,16 @@ Connection to machine rawhide terminated. <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/nss-resolve.xml b/man/nss-resolve.xml index d633be2..0922eef 100644 --- a/man/nss-resolve.xml +++ b/man/nss-resolve.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="nss-resolve" conditional='ENABLE_NSS_RESOLVE' @@ -168,15 +168,15 @@ netgroup: nis</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.syntax</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/nss-systemd.xml b/man/nss-systemd.xml index bc975c0..4233bf6 100644 --- a/man/nss-systemd.xml +++ b/man/nss-systemd.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="nss-systemd" conditional='ENABLE_NSS_SYSTEMD'> @@ -166,18 +166,18 @@ vu-rawhide-1000 1637 pts/8 -zsh <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-userdbd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-myhostname</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-userdbd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/oomctl.xml b/man/oomctl.xml index fd366c7..02289f6 100644 --- a/man/oomctl.xml +++ b/man/oomctl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="oomctl" conditional='ENABLE_OOMD' @@ -78,11 +78,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/oomd.conf.xml b/man/oomd.conf.xml index 4fc7abd..582fb27 100644 --- a/man/oomd.conf.xml +++ b/man/oomd.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="oomd.conf" conditional='ENABLE_OOMD' @@ -22,9 +22,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/oomd.conf</filename></para> - <para><filename>/etc/systemd/oomd.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/oomd.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/oomd.conf</filename></member> + <member><filename>/run/systemd/oomd.conf</filename></member> + <member><filename>/usr/local/lib/systemd/oomd.conf</filename></member> + <member><filename>/usr/lib/systemd/oomd.conf</filename></member> + <member><filename>/etc/systemd/oomd.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/oomd.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/oomd.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/oomd.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -95,12 +102,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>oomctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>oomctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/org.freedesktop.LogControl1.xml b/man/org.freedesktop.LogControl1.xml index 1694453..5738a3d 100644 --- a/man/org.freedesktop.LogControl1.xml +++ b/man/org.freedesktop.LogControl1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.LogControl1" @@ -132,12 +132,12 @@ node /org/freedesktop/LogControl1 { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project="man-pages"><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/org.freedesktop.home1.xml b/man/org.freedesktop.home1.xml index f217fb8..9334f1a 100644 --- a/man/org.freedesktop.home1.xml +++ b/man/org.freedesktop.home1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.home1" conditional='ENABLE_HOMED' @@ -63,14 +63,18 @@ node /org/freedesktop/home1 { out b incomplete, out o bus_path); ListHomes(out a(susussso) home_areas); - @org.freedesktop.systemd1.Privileged("true") ActivateHome(in s user_name, in s secret); + ActivateHomeIfReferenced(in s user_name, + in s secret); @org.freedesktop.systemd1.Privileged("true") DeactivateHome(in s user_name); RegisterHome(in s user_record); UnregisterHome(in s user_name); CreateHome(in s user_record); + CreateHomeEx(in s user_record, + in a{sh} blobs, + in t flags); RealizeHome(in s user_name, in s secret); RemoveHome(in s user_name); @@ -80,6 +84,9 @@ node /org/freedesktop/home1 { AuthenticateHome(in s user_name, in s secret); UpdateHome(in s user_record); + UpdateHomeEx(in s user_record, + in a{sh} blobs, + in t flags); ResizeHome(in s user_name, in t size, in s secret); @@ -100,6 +107,10 @@ node /org/freedesktop/home1 { in b please_suspend, out h send_fd); @org.freedesktop.systemd1.Privileged("true") + RefHomeUnrestricted(in s user_name, + in b please_suspend, + out h send_fd); + @org.freedesktop.systemd1.Privileged("true") ReleaseHome(in s user_name); @org.freedesktop.systemd1.Privileged("true") LockAllHomes(); @@ -134,6 +145,8 @@ node /org/freedesktop/home1 { <variablelist class="dbus-method" generated="True" extra-ref="ActivateHome()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ActivateHomeIfReferenced()"/> + <variablelist class="dbus-method" generated="True" extra-ref="DeactivateHome()"/> <variablelist class="dbus-method" generated="True" extra-ref="RegisterHome()"/> @@ -142,6 +155,8 @@ node /org/freedesktop/home1 { <variablelist class="dbus-method" generated="True" extra-ref="CreateHome()"/> + <variablelist class="dbus-method" generated="True" extra-ref="CreateHomeEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="RealizeHome()"/> <variablelist class="dbus-method" generated="True" extra-ref="RemoveHome()"/> @@ -152,6 +167,8 @@ node /org/freedesktop/home1 { <variablelist class="dbus-method" generated="True" extra-ref="UpdateHome()"/> + <variablelist class="dbus-method" generated="True" extra-ref="UpdateHomeEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ResizeHome()"/> <variablelist class="dbus-method" generated="True" extra-ref="ChangePasswordHome()"/> @@ -164,6 +181,8 @@ node /org/freedesktop/home1 { <variablelist class="dbus-method" generated="True" extra-ref="RefHome()"/> + <variablelist class="dbus-method" generated="True" extra-ref="RefHomeUnrestricted()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ReleaseHome()"/> <variablelist class="dbus-method" generated="True" extra-ref="LockAllHomes()"/> @@ -185,7 +204,9 @@ node /org/freedesktop/home1 { the numeric UID and GID, the real name, home directory and shell. In addition it returns a state identifier describing the state the user's home directory is in, as well as a bus path referring to the bus object encapsulating the user record and home directory. This object implements the - <classname>org.freedesktop.home1.Home</classname> interface documented below.</para> + <classname>org.freedesktop.home1.Home</classname> interface documented below. This method, and most others + in this interface that take user names, will try to use the caller's home area if the specified user name is + an empty string.</para> <para><function>GetHomeByUID()</function> is similar to <function>GetHomeByName()</function> but acquires the information based on the numeric UID of the user.</para> @@ -220,6 +241,11 @@ node /org/freedesktop/home1 { <classname>org.freedesktop.home1.Home</classname> interface documented below, but may be called on the manager object and takes a user name as additional argument, instead.</para> + <para><function>ActivateHomeIfReferenced()</function> is identical to + <function>ActivateHome()</function>. However, the call only succeeds if the home directory is currently + referenced. Useful in conjunction with <function>RefHomeUnrestricted()</function>, which allows + creating a reference to a home directory even if the home directory is not active.</para> + <para><function>DeactivateHome()</function> deactivates (i.e. unmounts) the home directory of the specified user. It is equivalent to the <function>Deactivate()</function> method on the <classname>org.freedesktop.home1.Home</classname> interface documented below.</para> @@ -247,6 +273,19 @@ node /org/freedesktop/home1 { the user record locally and creates a home directory matching it, depending on the settings specified in the record in combination with local configuration.</para> + <para><function>CreateHomeEx()</function> is like <function>CreateHome()</function>, but it allows the + home directory to be created with a pre-populated blob directory (see + <ulink url="https://systemd.io/USER_RECORD_BLOB_DIRS">User Record Blob Directories</ulink> for more info). + This can be done via the dictionary passed as the <varname>blobs</varname> argument to this method: the values + are open file descriptors to regular files, and the keys are the filenames that should contain their respective + file's data in the blob directory. Note that for security reasons, the file descriptors passed into this method + must have enough privileges to read their target file and thus cannot be <literal>O_PATH</literal>; this + is done to ensure the caller is actually permitted to read the file they are asking to publish in the + blob directories. If the user record passed as the first argument contains a <literal>blobManifest</literal> + field it will be enforced; otherwise, a <literal>blobManifest</literal> field will be generated and inserted + into the record. The <varname>flags</varname> argument may be used for future expansion, but for now + pass 0.</para> + <para><function>RealizeHome()</function> creates a home directory whose user record is already registered locally. This takes a user name plus a user record consisting only of the <literal>secret</literal> section. Invoking <function>RegisterHome()</function> followed by @@ -281,23 +320,38 @@ node /org/freedesktop/home1 { interface.</para> <para><function>UpdateHome()</function> updates a locally registered user record. Takes a fully - specified JSON user record as argument (including the <literal>secret</literal> section). A user with a - matching name and realm must be registered locally already, and the last change timestamp of the newly - supplied record must be newer than the previously existing user record. Note this operation updates the - user record only, it does not propagate passwords/authentication tokens from the user record to the + specified JSON user record as argument (possibly including the <literal>secret</literal> section). A user + with a matching name and realm must be registered locally already, and the last change timestamp of the + newly supplied record must be newer than the previously existing user record. Note this operation updates + the user record only, it does not propagate passwords/authentication tokens from the user record to the storage back-end, or resizes the storage back-end. Typically a home directory is first updated, and then the password of the underlying storage updated using <function>ChangePasswordHome()</function> as well as the storage resized using <function>ResizeHome()</function>. This method is equivalent to <function>Update()</function> on the <classname>org.freedesktop.home1.Home</classname> interface.</para> + <para><function>UpdateHomeEx()</function> is like <function>UpdateHome()</function>, but it allows for + changes to the blob directory (see <ulink url="https://systemd.io/USER_RECORD_BLOB_DIRS">User Record Blob + Directories</ulink> for more info). The <varname>blobs</varname> argument works in the same way as + <function>CreateHomeEx()</function>, so check there for details. The new blob directory contents passed into + this method will completely replace the user's existing blob directory. The <varname>flags</varname> argument + can be used to further customize the behavior of this method via flags defined as follows:</para> + <programlisting> +#define SD_HOMED_UPDATE_OFFLINE (UINT64_C(1) << 0) + </programlisting> + <para>When <constant>SD_HOMED_UPDATE_OFFLINE</constant> (0x01) is set, no attempt is made to update the copies + of the user record and blob directory that are embedded into the home directory. Changes will be stored, however, + and may be propagated into the home directory the next time it is reconciled (most likely when the user next logs in). + Note that any changes made with this flag set may be lost if the home area has a newer record, which can happen + if the home area is updated on another machine after this method call. This method is equivalent to + <function>UpdateEx()</function> on the <classname>org.freedesktop.home1.Home</classname> interface.</para> + <para><function>ResizeHome()</function> resizes the storage associated with a user record. Takes a user - name, a disk size in bytes and a user record consisting only of the <literal>secret</literal> section - as argument. If the size is specified as <constant>UINT64_MAX</constant> the storage is resized to the - size already specified in the user record. Typically, if the user record is updated using + name, a disk size in bytes, and optionally a user record consisting only of the <literal>secret</literal> + section as arguments. If the size is specified as <constant>UINT64_MAX</constant> the storage is resized to + the size already specified in the user record. Typically, if the user record is updated using <function>UpdateHome()</function> above this is used to propagate the size configured there-in down to - the underlying storage back-end. This method is equivalent to - <function>Resize()</function> on the <classname>org.freedesktop.home1.Home</classname> - interface.</para> + the underlying storage back-end. This method is equivalent to <function>Resize()</function> on the + <classname>org.freedesktop.home1.Home</classname> interface.</para> <para><function>ChangePasswordHome()</function> changes the passwords/authentication tokens of a home directory. Takes a user name, and two JSON user record objects, each consisting only of the @@ -315,7 +369,7 @@ node /org/freedesktop/home1 { <classname>org.freedesktop.home1.Home</classname> interface.</para> <para><function>LockHome()</function> temporarily suspends access to a home directory, flushing out any - cryptographic keys from memory. This is only supported on some back-ends, and usually done during system + cryptographic keys from memory. This is only supported on some back-ends, and is usually done during system suspend, in order to effectively secure home directories while the system is sleeping. Takes a user name as single argument. If an application attempts to access a home directory while it is locked it will typically freeze until the home directory is unlocked again. This method is equivalent to @@ -350,6 +404,10 @@ node /org/freedesktop/home1 { <function>Ref()</function> on the <classname>org.freedesktop.home1.Home</classname> interface.</para> + <para><function>RefHomeUnrestricted()</function> is identical to <function>RefHome()</function> but + succeeds even if the home area is not active currently. This is useful on conjunction with + <function>ActivateHomeIfReferenced()</function>.</para> + <para><function>ReleaseHome()</function> releases a home directory again, if all file descriptors referencing it are already closed, that where acquired through <function>AcquireHome()</function> or <function>RefHome()</function>. Note that this call does not actually cause the deactivation of the @@ -388,8 +446,8 @@ node /org/freedesktop/home1 { node /org/freedesktop/home1/home { interface org.freedesktop.home1.Home { methods: - @org.freedesktop.systemd1.Privileged("true") Activate(in s secret); + ActivateIfReferenced(in s secret); @org.freedesktop.systemd1.Privileged("true") Deactivate(); Unregister(); @@ -399,6 +457,9 @@ node /org/freedesktop/home1/home { Fixate(in s secret); Authenticate(in s secret); Update(in s user_record); + UpdateEx(in s user_record, + in a{sh} blobs, + in t flags); Resize(in t size, in s secret); ChangePassword(in s new_secret, @@ -415,6 +476,9 @@ node /org/freedesktop/home1/home { Ref(in b please_suspend, out h send_fd); @org.freedesktop.systemd1.Privileged("true") + RefUnrestricted(in b please_suspend, + out h send_fd); + @org.freedesktop.systemd1.Privileged("true") Release(); properties: @org.freedesktop.DBus.Property.EmitsChangedSignal("const") @@ -445,6 +509,8 @@ node /org/freedesktop/home1/home { <variablelist class="dbus-method" generated="True" extra-ref="Activate()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ActivateIfReferenced()"/> + <variablelist class="dbus-method" generated="True" extra-ref="Deactivate()"/> <variablelist class="dbus-method" generated="True" extra-ref="Unregister()"/> @@ -459,6 +525,8 @@ node /org/freedesktop/home1/home { <variablelist class="dbus-method" generated="True" extra-ref="Update()"/> + <variablelist class="dbus-method" generated="True" extra-ref="UpdateEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="Resize()"/> <variablelist class="dbus-method" generated="True" extra-ref="ChangePassword()"/> @@ -471,6 +539,8 @@ node /org/freedesktop/home1/home { <variablelist class="dbus-method" generated="True" extra-ref="Ref()"/> + <variablelist class="dbus-method" generated="True" extra-ref="RefUnrestricted()"/> + <variablelist class="dbus-method" generated="True" extra-ref="Release()"/> <variablelist class="dbus-property" generated="True" extra-ref="UserName"/> @@ -488,19 +558,21 @@ node /org/freedesktop/home1/home { <refsect2> <title>Methods</title> - <para><function>Activate()</function>, <function>Deactivate()</function>, - <function>Unregister()</function>, <function>Realize()</function>, <function>Remove()</function>, - <function>Fixate()</function>, <function>Authenticate()</function>, <function>Update()</function>, - <function>Resize()</function>, <function>ChangePassword()</function>, <function>Lock()</function>, - <function>Unlock()</function>, <function>Acquire()</function>, <function>Ref()</function>, - <function>Release()</function> operate like their matching counterparts on the - <classname>org.freedesktop.home1.Manager</classname> interface (see above). The main difference is that - they are methods of the home directory objects, and hence carry no additional user name - parameter. Which of the two flavors of methods to call depends on the handles to the user known on the - client side: if only the user name is known, it's preferable to use the methods on the manager object - since they operate with user names only. If however the home object path was already acquired some way - it is preferable to operate on the <classname>org.freedesktop.home1.Home</classname> objects - instead.</para> + <para><function>Activate()</function>, <function>ActivateIfReferenced()</function>, + <function>Deactivate()</function>, <function>Unregister()</function>, <function>Realize()</function>, + <function>Remove()</function>, <function>Fixate()</function>, <function>Authenticate()</function>, + <function>Update()</function>, <function>UpdateEx()</function>, <function>Resize()</function>, + <function>ChangePassword()</function>, <function>Lock()</function>, <function>Unlock()</function>, + <function>Acquire()</function>, <function>Ref()</function>, <function>RefUnrestricted()</function>, + <function>Release()</function>, + operate like their matching counterparts on the <classname>org.freedesktop.home1.Manager</classname> + interface (see above). The main difference is that they are methods of the home directory objects, and + hence carry no additional user name parameter. Which of the two flavors of methods to call depends on + the handles to the user known on the client side: if only the user name is known, it's preferable to use + the methods on the manager object since they operate with user names only. Clients can also easily operate + on their own home area by using the methods on the manager object with an empty string as the user name. + If the client has the home's object path already acquired in some way, however, it is preferable to operate + on the <classname>org.freedesktop.home1.Home</classname> objects instead.</para> </refsect2> <refsect2> @@ -522,12 +594,26 @@ node /org/freedesktop/home1/home { <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> <refsect1> + <title>History</title> + <refsect2> + <title>The Manager Object</title> + <para><function>ActivateHomeIfReferenced()</function>, <function>RefHomeUnrestricted()</function>, + <function>CreateHomeEx()</function>, and <function>UpdateHomeEx()</function> were added in version 256.</para> + </refsect2> + <refsect2> + <title>Home Objects</title> + <para><function>ActivateIfReferenced()</function>, <function>RefUnrestricted()</function>, and + <function>UpdateEx()</function> were added in version 256.</para> + </refsect2> + </refsect1> + + <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/org.freedesktop.hostname1.xml b/man/org.freedesktop.hostname1.xml index 0c5b0f2..d16ae9a 100644 --- a/man/org.freedesktop.hostname1.xml +++ b/man/org.freedesktop.hostname1.xml @@ -1,7 +1,7 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -99,6 +99,8 @@ node /org/freedesktop/hostname1 { readonly ay MachineID = [...]; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly ay BootID = [...]; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly u VSockCID = ...; }; interface org.freedesktop.DBus.Peer { ... }; interface org.freedesktop.DBus.Introspectable { ... }; @@ -106,24 +108,6 @@ node /org/freedesktop/hostname1 { }; </programlisting> - <!--method GetHardwareSerial is not documented!--> - - <!--property OperatingSystemSupportEnd is not documented!--> - - <!--property HardwareVendor is not documented!--> - - <!--property HardwareModel is not documented!--> - - <!--property FirmwareVersion is not documented!--> - - <!--property FirmwareVendor is not documented!--> - - <!--property FirmwareDate is not documented!--> - - <!--property MachineID is not documented!--> - - <!--property BootID is not documented!--> - <!--Autogenerated cross-references for systemd.directives, do not edit--> <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.hostname1"/> @@ -196,6 +180,8 @@ node /org/freedesktop/hostname1 { <variablelist class="dbus-property" generated="True" extra-ref="BootID"/> + <variablelist class="dbus-property" generated="True" extra-ref="VSockCID"/> + <!--End of Autogenerated section--> <para>Whenever the hostname or other metadata is changed via the daemon, @@ -287,6 +273,34 @@ node /org/freedesktop/hostname1 { purpose of those properties is to allow remote clients to access this information over D-Bus. Local clients can access the information directly.</para> + <para><varname>MachineID</varname> expose the 128bit machine ID, see + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details.</para> + + <para><varname>BootID</varname> expose the 128bit boot ID, as per + <filename>/proc/sys/kernel/random/boot_id</filename>.</para> + + <para><varname>VSockCID</varname> exposes the system's local <constant>AF_VSOCK</constant> CID (Context + Identifier, i.e. address) for the system, if one is available in the virtual machine environment. Set to + <constant>UINT32_MAX</constant> otherwise. See <citerefentry project="man-pages"><refentrytitle>vsock</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details.</para> + + <para><varname>OperatingSystemSupportEnd</varname> exposes when the OS' vendor support ends, if this + information is known. It's an unsigned 64bit value, in µs since the UNIX epoch, UTC. If this information + is not known carries the value 2^64-1, i.e. <constant>UINT64_MAX</constant>.</para> + + <para><varname>HardwareVendor</varname> and <varname>HardwareModel</varname> expose information about the + vendor of the hardware of the system. If no such information can be determined these properties are set + to empty strings.</para> + + <para><varname>FirmwareVersion</varname> and <varname>FirmwareVendor</varname> expose information about + the system's firmware, i.e. a version string and a vendor name. If no such information can be determined + these properties are set to empty strings.</para> + + <para><varname>FirmwareDate</varname> exposes the firmware build date, if that information is known. It's + an unsigned 64bit value, in µs since the UNIX epoch, UTC. If not known + <constant>UNIT64_MAX</constant>.</para> + <refsect2> <title>Methods</title> @@ -321,6 +335,10 @@ node /org/freedesktop/hostname1 { requires root privileges, and this method allows access to unprivileged clients through the polkit framework.</para> + <para><function>GetHardwareSerial()</function> returns the "hardware serial" as exposed by the kernel + based on DMI information. Reading the file directly requires root privileges, and this method allows + access to unprivileged clients through the polkit framework.</para> + <para><function>Describe()</function> returns a JSON representation of all properties in one.</para> </refsect2> @@ -425,7 +443,7 @@ node /org/freedesktop/hostname1 { </refsect1> <refsect1> - <title>See also</title> + <title>See Also</title> <para>David Zeuthen's original Fedora <ulink url="https://fedoraproject.org/wiki/Features/BetterHostname">Feature page about xdg-hostname</ulink></para> @@ -440,8 +458,8 @@ node /org/freedesktop/hostname1 { <para><varname>OperatingSystemSupportEnd</varname>, <varname>FirmwareVendor</varname>, and <varname>FirmwareDate</varname> were added in version 253.</para> - <para><varname>MachineID</varname>, and - <varname>BootID</varname> were added in version 256.</para> + <para><varname>MachineID</varname>, <varname>BootID</varname> and + <varname>VSockCID</varname> were added in version 256.</para> </refsect2> </refsect1> </refentry> diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml index 3ef6264..2486eea 100644 --- a/man/org.freedesktop.import1.xml +++ b/man/org.freedesktop.import1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.import1" conditional='ENABLE_IMPORTD' @@ -25,11 +25,11 @@ <para> <citerefentry><refentrytitle>systemd-importd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - is a system service which may be used to import, export and download additional system images. These - images can be used by tools such as - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> - to run local containers. The service is used as the backend for <command>machinectl pull-raw</command>, - <command>machinectl pull-tar</command> and related commands. This page describes the D-Bus interface. + is a system service which may be used to import, export and download disk images. These images can be + used by tools such as + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> to run + local containers. The service is used as the backend for <command>importctl pull-raw</command>, + <command>importctl pull-tar</command> and related commands. This page describes the D-Bus interface. </para> <para>Note that @@ -56,42 +56,94 @@ node /org/freedesktop/import1 { in b read_only, out u transfer_id, out o transfer_path); + ImportTarEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ImportRaw(in h fd, in s local_name, in b force, in b read_only, out u transfer_id, out o transfer_path); + ImportRawEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ImportFileSystem(in h fd, in s local_name, in b force, in b read_only, out u transfer_id, out o transfer_path); + ImportFileSystemEx(in h fd, + in s local_name, + in s class, + in t flags, + out u transfer_id, + out o transfer_path); ExportTar(in s local_name, in h fd, in s format, out u transfer_id, out o transfer_path); + ExportTarEx(in s local_name, + in s class, + in h fd, + in s format, + in t flags, + out u transfer_id, + out o transfer_path); ExportRaw(in s local_name, in h fd, in s format, out u transfer_id, out o transfer_path); + ExportRawEx(in s local_name, + in s class, + in h fd, + in s format, + in t flags, + out u transfer_id, + out o transfer_path); PullTar(in s url, in s local_name, in s verify_mode, in b force, out u transfer_id, out o transfer_path); + PullTarEx(in s url, + in s local_name, + in s class, + in s verify_mode, + in t flags, + out u transfer_id, + out o transfer_path); PullRaw(in s url, in s local_name, in s verify_mode, in b force, out u transfer_id, out o transfer_path); + PullRawEx(in s url, + in s local_name, + in s class, + in s verify_mode, + in t flags, + out u transfer_id, + out o transfer_path); ListTransfers(out a(usssdo) transfers); + ListTransfersEx(in s class, + in t flags, + out a(ussssdo) transfers); CancelTransfer(in u transfer_id); + ListImages(in s class, + in t flags, + out a(ssssbtttttt) images); signals: TransferNew(u transfer_id, o transfer_path); @@ -105,8 +157,6 @@ node /org/freedesktop/import1 { }; </programlisting> - <!--method ImportFileSystem is not documented!--> - <!--Autogenerated cross-references for systemd.directives, do not edit--> <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.import1.Manager"/> @@ -115,116 +165,167 @@ node /org/freedesktop/import1 { <variablelist class="dbus-method" generated="True" extra-ref="ImportTar()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ImportTarEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ImportRaw()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ImportRawEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ImportFileSystem()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ImportFileSystemEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ExportTar()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ExportTarEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ExportRaw()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ExportRawEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="PullTar()"/> + <variablelist class="dbus-method" generated="True" extra-ref="PullTarEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="PullRaw()"/> + <variablelist class="dbus-method" generated="True" extra-ref="PullRawEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ListTransfers()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ListTransfersEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="CancelTransfer()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="TransferNew"/> + <variablelist class="dbus-method" generated="True" extra-ref="ListImages()"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="TransferNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="TransferRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="TransferRemoved()"/> <!--End of Autogenerated section--> <refsect2> <title>Methods</title> - <para><function>ImportTar()</function> and <function>ImportRaw()</function> import a system image and - place it into <filename>/var/lib/machines/</filename>. The first argument should be a file descriptor - (opened for reading) referring to the tar or raw file to import. It should reference a file on disk, - a pipe or a socket. When <function>ImportTar()</function> is used the file descriptor should - refer to a tar file, optionally compressed with - <citerefentry project="die-net"><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project="die-net"><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - or + <para><function>ImportTar()</function>/<function>ImportTarEx()</function> and + <function>ImportRaw()</function>/<function>ImportRawEx()</function> import a disk image and place it + into the image directory. The first argument should be a file descriptor (opened for reading) referring + to the tar or raw file to import. It should reference a file on disk, a pipe or a socket. When + <function>ImportTar()</function>/<function>ImportTarEx()</function> is used the file descriptor should + refer to a tar file, optionally compressed with <citerefentry project="die-net"><refentrytitle>gzip</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project="die-net"><refentrytitle>bzip2</refentrytitle><manvolnum>1</manvolnum></citerefentry>, or <citerefentry project="die-net"><refentrytitle>xz</refentrytitle><manvolnum>1</manvolnum></citerefentry>. <command>systemd-importd</command> will detect the used compression scheme (if any) automatically. When - <function>ImportRaw()</function> is used the file descriptor should refer to a raw or qcow2 disk image - containing an MBR or GPT disk label, also optionally compressed with gzip, bzip2 or xz. In either case, - if the file is specified as a file descriptor on disk, progress information is generated for the import - operation (as in that case we know the total size on disk). If a socket or pipe is specified, progress information is not - available. The file descriptor argument is followed by a local name for the image. This should be a - name suitable as a hostname and will be used to name the imported image below - <filename>/var/lib/machines/</filename>. A tar import is placed as a directory tree or a - <citerefentry project="url"><refentrytitle url="https://btrfs.readthedocs.io/en/latest/btrfs.html">btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - subvolume below <filename>/var/lib/machines/</filename> under the specified name with no suffix - appended. A raw import is placed as a file in <filename>/var/lib/machines/</filename> with the - <filename>.raw</filename> suffix appended. If the <option>force</option> argument is true, any - pre-existing image with the same name is removed before starting the operation. Otherwise, the - operation fails if an image with the same name already exists. Finally, the - <option>read_only</option> argument controls - whether to create a writable or read-only image. Both methods return immediately after starting the import, - with the import transfer ongoing. They return a pair of transfer identifier and object path, which may - be used to retrieve progress information about the transfer or to cancel it. The transfer identifier is a - simple numeric identifier, the object path references an + <function>ImportRaw()</function>/<function>ImportRawEx()</function> is used the file descriptor should + refer to a raw or qcow2 disk image containing an MBR or GPT disk label, also optionally compressed with + gzip, bzip2 or xz. In either case, if the file is specified as a file descriptor on disk, progress + information is generated for the import operation (as in that case we know the total size on disk). If + a socket or pipe is specified, progress information is not available. The file descriptor argument is + followed by a local name for the image. This should be a name suitable as a hostname and will be used + to name the imported image below <filename>/var/lib/machines/</filename>. A tar import is placed as a + directory tree or a <citerefentry project="url"><refentrytitle url="https://btrfs.readthedocs.io/en/latest/btrfs.html">btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> + subvolume below the image directory under the specified name with no suffix appended. A raw import is + placed as a file in the image directory with the <filename>.raw</filename> suffix appended. In case of + <function>ImportTar()</function>/<function>ImportRaw()</function>, if the <option>force</option> + argument is true, any pre-existing image with the same name is removed before starting the + operation. Otherwise, the operation fails if an image with the same name already exists. The + <option>read_only</option> argument controls whether to create a writable or read-only image. In case + of <function>ImportTarEx()</function>/<function>ImportRawEx()</function> these boolean flags are + provided via a 64bit flags parameter instead, with bit 0 mapping to the <option>force</option> + parameter, and bit 1 mapping to <option>read_only</option>. The <option>class</option> parameter + specifies the image class, and takes one of <literal>machine</literal>, <literal>portable</literal>, + <literal>sysext</literal>, <literal>confext</literal>. All four methods return immediately after + starting the import, with the import transfer ongoing. They return a pair of transfer identifier and + object path, which may be used to retrieve progress information about the transfer or to cancel it. The + transfer identifier is a simple numeric identifier, the object path references an <interfacename>org.freedesktop.import1.Transfer</interfacename> object, see below. Listen for a - <function>TransferRemoved</function> signal for the transfer ID in order to detect when a transfer is + <function>TransferRemoved()</function> signal for the transfer ID in order to detect when a transfer is complete. The returned transfer object is useful to determine the current progress or log output of the ongoing import operation.</para> - <para><function>ExportTar()</function> and <function>ExportRaw()</function> implement the reverse - operation, and may be used to export a system image in order to place it in a tar or raw image. They - take the machine name to export as their first parameter, followed by a file descriptor (opened for writing) - where the tar or raw file will be written. It may either reference a file on disk or a pipe/socket. The - third argument specifies in which compression format to write the image. It takes one of + <para><function>ExportTar()</function>/<function>ExportTarEx()</function> and + <function>ExportRaw()</function>/<function>ExportRaw()</function> implement the reverse operation, and + may be used to export a system image in order to place it in a tar or raw image. They take the machine + name to export as their first parameter, followed by a file descriptor (opened for writing) where the + tar or raw file will be written. It may either reference a file on disk or a pipe/socket. The third + argument specifies in which compression format to write the image. It takes one of <literal>uncompressed</literal>, <literal>xz</literal>, <literal>bzip2</literal> or <literal>gzip</literal>, depending on which compression scheme is required. The image written to the - specified file descriptor will be a tar file in case of <function>ExportTar()</function> or a raw disk - image in case of <function>ExportRaw()</function>. Note that currently raw disk images may not be - exported as tar files, and vice versa. This restriction might be lifted eventually. The method - returns a transfer identifier and object path for cancelling or tracking the export operation, similarly - to <function>ImportTar()</function> or <function>ImportRaw()</function> as described above.</para> - - <para><function>PullTar()</function> and <function>PullRaw()</function> may be used to download, verify - and import a system image from a URL. They take a URL argument which should point to a tar or - raw file on the <literal>http://</literal> or <literal>https://</literal> protocols, possibly - compressed with xz, bzip2 or gzip. The second argument is a local name for the image. It should be - suitable as a hostname, similarly to the matching argument of the <function>ImportTar()</function> and - <function>ImportRaw()</function> methods above. The third argument indicates the verification mode for - the image. It may be one of <literal>no</literal>, <literal>checksum</literal>, - <literal>signature</literal>. <literal>no</literal> turns off any kind of verification of the image; - <literal>checksum</literal> looks for a <filename>SHA256SUM</filename> file next to the downloaded - image and verifies any SHA256 hash value in that file against the image; <literal>signature</literal> - does the same but also tries to authenticate the <filename>SHA256SUM</filename> file via - <citerefentry project="man-pages"><refentrytitle>gpg</refentrytitle><manvolnum>8</manvolnum></citerefentry> - first. The last argument indicates whether to replace a possibly pre-existing image with the same local - name (if <literal>true</literal>), or whether to fail (if <literal>false</literal>). Like the import - and export calls above, these calls return a pair of transfer identifier and object path for the ongoing + specified file descriptor will be a tar file in case of + <function>ExportTar()</function>/<function>ExportTarEx()</function> or a raw disk image in case of + <function>ExportRaw()</function>/<function>ExportRawEx()</function>. Note that currently raw disk + images may not be exported as tar files, and vice versa. This restriction might be lifted + eventually. The method returns a transfer identifier and object path for cancelling or tracking the + export operation, similarly to <function>ImportTar()</function>/<function>ImportTarEx()</function> or + <function>ImportRaw()</function>/<function>ImportRawEx()</function> as described + above. <function>ExportTarEx()</function>/<function>ExportRawEx()</function> expect the image class as + additional parameter, as well as a 64bit flags parameter that currently must be specified as + zero.</para> + + <para><function>PullTar()</function>/<function>PullTarEx()</function> and + <function>PullRaw()</function>/<function>PullRawEx()</function> may be used to download, verify and + import a system image from a URL. They take a URL argument which should point to a tar or raw file on + the <literal>http://</literal> or <literal>https://</literal> protocols, possibly compressed with xz, + bzip2 or gzip. The second argument is a local name for the image. It should be suitable as a hostname, + similarly to the matching argument of the + <function>ImportTar()</function>/<function>ImportTarEx()</function> and + <function>ImportRaw()</function>/<function>ImportRawEx()</function> methods above. The third argument + indicates the verification mode for the image. It may be one of <literal>no</literal>, + <literal>checksum</literal>, <literal>signature</literal>. <literal>no</literal> turns off any kind of + verification of the image; <literal>checksum</literal> looks for a <filename>SHA256SUM</filename> file + next to the downloaded image and verifies any SHA256 hash value in that file against the image; + <literal>signature</literal> does the same but also tries to authenticate the + <filename>SHA256SUM</filename> file via <citerefentry project="man-pages"><refentrytitle>gpg</refentrytitle><manvolnum>8</manvolnum></citerefentry> first. In + case of <function>PullTar()</function>/<function>PullRaw()</function> the last argument indicates + whether to replace a possibly pre-existing image with the same local name (if <literal>true</literal>), + or whether to fail (if <literal>false</literal>). In case of + <function>PullTarEx()</function>/<function>PullRawEx()</function> the last argument is a 64bit flags + parameter, where bit 0 controls the <literal>force</literal> flag, bit 1 is a + <literal>read_only</literal> flag that controls whether the created image shall be marked read-only, + and bit 2 is a <literal>keep_download</literal> flag that indicates whether a pristine, read-only copy + of the downloaded image shell be kept, in addition for the local copy of the image. The + <function>…_Ex()</function> variants also expect an image class string (as above). Like the import and + export calls above, these calls return a pair of transfer identifier and object path for the ongoing download.</para> - <para><function>ListTransfers()</function> returns a list of ongoing import, export or download - operations as created with the six calls described above. It returns an array of structures which - consist of the numeric transfer identifier, a string indicating the operation (one of - <literal>import-tar</literal>, <literal>import-raw</literal>, <literal>export-tar</literal>, - <literal>export-raw</literal>, <literal>pull-tar</literal> or <literal>pull-raw</literal>), a string - describing the remote file (in case of download operations this is the source URL, in case of - import/export operations this is a short string describing the file descriptor passed in), a string - with the local machine image name, a progress value between 0.0 (for 0%) and 1.0 (for 100%), as well as - the transfer object path.</para> + <para><function>ImportFileSystem()</function>/<function>ImportFileSystemEx()</function> are similar to + <function>ImportTar()</function>/<function>ImportTarEx()</function> but import a directory tree. The + first argument must refer to a directory file descriptor for the source hierarchy to import.</para> + + <para><function>ListTransfers()</function>/<function>ListTransfersEx()</function> return a list of + ongoing import, export or download operations as created with the six calls described above. They + return an array of structures which consist of the numeric transfer identifier, a string indicating the + operation (one of <literal>import-tar</literal>, <literal>import-raw</literal>, + <literal>export-tar</literal>, <literal>export-raw</literal>, <literal>pull-tar</literal> or + <literal>pull-raw</literal>), a string describing the remote file (in case of download operations this + is the source URL, in case of import/export operations this is a short string describing the file + descriptor passed in), a string with the local machine image name, the image class (only in case of + <function>ListTransfersEx()</function>; one of <literal>machine</literal>, <literal>portable</literal>, + <literal>sysext</literal>, <literal>confext</literal>), a progress value between 0.0 (for 0%) and 1.0 + (for 100%), as well as the transfer object path.</para> <para><function>CancelTransfer()</function> may be used to cancel an ongoing import, export or download operation. Simply specify the transfer identifier to cancel the ongoing operation.</para> + + <para><function>ListImages()</function> returns a list of currently installed images. It takes a image + class string and a flags parameter. The image class is either the empty string or specifies one of the + four image classes, by which it will then filter. The flags parameter must be zero at this time. It + returns an array of items, each describing one image. The item fields are in order: the image class, + the local image name, the image type, the image path, the read-only flag, the creation and modification + times (in microseconds since the UNIX epoch), as well as the current disk usage in bytes (both overall, + and exclusive), as well as any size limit in bytes set on the image (both overall and + exclusive).</para> </refsect2> <refsect2> <title>Signals</title> - <para>The <function>TransferNew</function> signal is generated each time a new transfer is started with + <para>The <function>TransferNew()</function> signal is generated each time a new transfer is started with the import, export or download calls described above. It carries the transfer ID and object path that have just been created.</para> - <para>The <function>TransferRemoved</function> signal is sent each time a transfer finishes, + <para>The <function>TransferRemoved()</function> signal is sent each time a transfer finishes, is canceled or fails. It also carries the transfer ID and object path, followed by a string indicating the result of the operation, which is one of <literal>done</literal> (on success), <literal>canceled</literal> or <literal>failed</literal>.</para> @@ -242,6 +343,7 @@ node /org/freedesktop/import1/transfer/_1 { signals: LogMessage(u priority, s line); + ProgressUpdate(d progress); properties: @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly u Id = ...; @@ -262,8 +364,6 @@ node /org/freedesktop/import1/transfer/_1 { }; </programlisting> - <!--signal LogMessage is not documented!--> - <!--Autogenerated cross-references for systemd.directives, do not edit--> <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.import1.Transfer"/> @@ -272,7 +372,9 @@ node /org/freedesktop/import1/transfer/_1 { <variablelist class="dbus-method" generated="True" extra-ref="Cancel()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="LogMessage"/> + <variablelist class="dbus-signal" generated="True" extra-ref="LogMessage()"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="ProgressUpdate()"/> <variablelist class="dbus-property" generated="True" extra-ref="Id"/> @@ -315,6 +417,17 @@ node /org/freedesktop/import1/transfer/_1 { between 0.0 and 1.0. To show a progress bar on screen we recommend to query this value in regular intervals, for example every 500 ms or so.</para> </refsect2> + + <refsect2> + <title>Signals</title> + + <para>The <function>LogMessage()</function> signal is emitted for log messages generated by a transfer. It + carries a pair of syslog log level integer and log string.</para> + + <para>The <function>ProgressUpdate()</function> signal is emitted in regular intervals when new + download progress information is available for a transfer. It carries a double precision floating + pointer number between 0.0 and 1.0 indicating the transfer progress.</para> + </refsect2> </refsect1> <refsect1> @@ -340,4 +453,20 @@ node /org/freedesktop/import1/transfer/_1 { </refsect1> <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> + <refsect1> + <title>History</title> + <refsect2> + <title>The Manager Object</title> + <para><function>ImportTarEx()</function>, <function>ImportRawEx()</function>, + <function>ImportFileSystemEx()</function>, <function>ExportTarEx()</function>, + <function>ExportRawEx()</function>, <function>PullTarEx()</function>, <function>PullRawEx()</function>, + <function>ListTransfersEx()</function>, <function>ListImages()</function> were added in version + 256.</para> + </refsect2> + <refsect2> + <title>Transfer Objects</title> + <para><function>ProgressUpdate()</function> was added in version 256.</para> + </refsect2> + </refsect1> + </refentry> diff --git a/man/org.freedesktop.locale1.xml b/man/org.freedesktop.locale1.xml index d5c93af..6e0d118 100644 --- a/man/org.freedesktop.locale1.xml +++ b/man/org.freedesktop.locale1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.locale1" conditional='ENABLE_LOCALED' diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index 519a686..aacaa1b 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.login1" conditional='ENABLE_LOGIND' @@ -53,6 +53,7 @@ node /org/freedesktop/login1 { GetSeat(in s seat_id, out o object_path); ListSessions(out a(susso) sessions); + ListSessionsEx(out a(sussussbto) sessions); ListUsers(out a(uso) users); ListSeats(out a(so) seats); ListInhibitors(out a(ssssuu) inhibitors); @@ -103,7 +104,6 @@ node /org/freedesktop/login1 { out s seat_id, out u vtnr, out b existing); - @org.freedesktop.systemd1.Privileged("true") ReleaseSession(in s session_id); ActivateSession(in s session_id); ActivateSessionOnSeat(in s session_id, @@ -141,6 +141,7 @@ node /org/freedesktop/login1 { HybridSleepWithFlags(in t flags); SuspendThenHibernate(in b interactive); SuspendThenHibernateWithFlags(in t flags); + Sleep(in t flags); CanPowerOff(out s result); CanReboot(out s result); CanHalt(out s result); @@ -148,6 +149,7 @@ node /org/freedesktop/login1 { CanHibernate(out s result); CanHybridSleep(out s result); CanSuspendThenHibernate(out s result); + CanSleep(out s result); ScheduleShutdown(in s type, in t usec); CancelScheduledShutdown(out b cancelled); @@ -218,6 +220,8 @@ node /org/freedesktop/login1 { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly t UserStopDelayUSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly as SleepOperation = ['...', ...]; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s HandlePowerKey = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s HandlePowerKeyLongPress = '...'; @@ -279,6 +283,8 @@ node /org/freedesktop/login1 { }; </programlisting> + <!--property SleepOperation is not documented!--> + <!--property HandlePowerKeyLongPress is not documented!--> <!--property HandleRebootKey is not documented!--> @@ -309,6 +315,8 @@ node /org/freedesktop/login1 { <variablelist class="dbus-method" generated="True" extra-ref="ListSessions()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ListSessionsEx()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ListUsers()"/> <variablelist class="dbus-method" generated="True" extra-ref="ListSeats()"/> @@ -377,6 +385,8 @@ node /org/freedesktop/login1 { <variablelist class="dbus-method" generated="True" extra-ref="SuspendThenHibernateWithFlags()"/> + <variablelist class="dbus-method" generated="True" extra-ref="Sleep()"/> + <variablelist class="dbus-method" generated="True" extra-ref="CanPowerOff()"/> <variablelist class="dbus-method" generated="True" extra-ref="CanReboot()"/> @@ -391,6 +401,8 @@ node /org/freedesktop/login1 { <variablelist class="dbus-method" generated="True" extra-ref="CanSuspendThenHibernate()"/> + <variablelist class="dbus-method" generated="True" extra-ref="CanSleep()"/> + <variablelist class="dbus-method" generated="True" extra-ref="ScheduleShutdown()"/> <variablelist class="dbus-method" generated="True" extra-ref="CancelScheduledShutdown()"/> @@ -415,23 +427,23 @@ node /org/freedesktop/login1 { <variablelist class="dbus-method" generated="True" extra-ref="SetWallMessage()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="SessionNew"/> + <variablelist class="dbus-signal" generated="True" extra-ref="SessionNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="SessionRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="SessionRemoved()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="UserNew"/> + <variablelist class="dbus-signal" generated="True" extra-ref="UserNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="UserRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="UserRemoved()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="SeatNew"/> + <variablelist class="dbus-signal" generated="True" extra-ref="SeatNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="SeatRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="SeatRemoved()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdown"/> + <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdown()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdownWithMetadata"/> + <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForShutdownWithMetadata()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForSleep"/> + <variablelist class="dbus-signal" generated="True" extra-ref="PrepareForSleep()"/> <variablelist class="dbus-property" generated="True" extra-ref="EnableWallMessages"/> @@ -469,6 +481,8 @@ node /org/freedesktop/login1 { <variablelist class="dbus-property" generated="True" extra-ref="UserStopDelayUSec"/> + <variablelist class="dbus-property" generated="True" extra-ref="SleepOperation"/> + <variablelist class="dbus-property" generated="True" extra-ref="HandlePowerKey"/> <variablelist class="dbus-property" generated="True" extra-ref="HandlePowerKeyLongPress"/> @@ -537,8 +551,17 @@ node /org/freedesktop/login1 { is any.</para> <para><function>ListSessions()</function> returns an array of all current sessions. The structures in - the array consist of the following fields: session id, user id, user name, seat id, session object - path. If a session does not have a seat attached, the seat id field will be an empty string.</para> + the array consist of the following fields: <varname>session id</varname>, <varname>user id</varname>, + <varname>user name</varname>, <varname>seat id</varname>, and <varname>session object path</varname>. + If a session does not have a seat attached, the seat id field will be an empty string.</para> + + <para><function>ListSessionsEx()</function> returns an array of all current sessions with more metadata + than <function>ListSessions()</function>. The structures in the array consist of the following fields: + <varname>session id</varname>, <varname>user id</varname>, <varname>user name</varname>, + <varname>seat id</varname>, <varname>leader pid</varname>, <varname>session class</varname>, + <varname>tty name</varname>, <varname>idle hint</varname>, <varname>idle hint monotonic timestamp</varname>, + and <varname>session object path</varname>. <varname>tty</varname> and <varname>seat id</varname> fields + could be empty, if the session has no associated tty or session has no seat attached, respectively.</para> <para><function>ListUsers()</function> returns an array of all currently logged in users. The structures in the array consist of the following fields: user id, user name, user object path.</para> @@ -608,17 +631,20 @@ node /org/freedesktop/login1 { off, rebooted, halted (shut down without turning off power), suspended (the system state is saved to RAM and the CPU is turned off), or hibernated (the system state is saved to disk and the machine is powered down). <function>HybridSleep()</function> results in the system entering a hybrid-sleep mode, - i.e. the system is both hibernated and suspended. <function>SuspendThenHibernate()</function> results + i.e. the system is both hibernated and suspended. <function>SuspendThenHibernate()</function> results in the system being suspended, then later woken using an RTC timer and hibernated. The only argument is the polkit interactivity boolean <varname>interactive</varname> (see below). The main purpose of these calls is that they enforce polkit policy and hence allow powering off/rebooting/suspending/hibernating - even by unprivileged users. They also enforce inhibition locks for non-privileged users. UIs should - expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine. Methods + even by unprivileged users. They also enforce inhibition locks for non-privileged users. + <function>Sleep()</function> automatically selects the most suitable sleep operation supported by the + machine. The candidate sleep operations to check for support can be configured through <varname>SleepOperation=</varname> + setting in <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + UIs should expose these calls as the primary mechanism to poweroff/reboot/suspend/hibernate the machine. Methods <function>PowerOffWithFlags()</function>, <function>RebootWithFlags()</function>, <function>HaltWithFlags()</function>, <function>SuspendWithFlags()</function>, - <function>HibernateWithFlags()</function>, <function>HybridSleepWithFlags()</function> and - <function>SuspendThenHibernateWithFlags()</function> add <varname>flags</varname> to allow for - extendability, defined as follows:</para> + <function>HibernateWithFlags()</function>, <function>HybridSleepWithFlags()</function>, + <function>SuspendThenHibernateWithFlags()</function>, and <function>Sleep()</function> take + <varname>flags</varname> to allow for extendability, defined as follows:</para> <programlisting> #define SD_LOGIND_ROOT_CHECK_INHIBITORS (UINT64_C(1) << 0) #define SD_LOGIND_KEXEC_REBOOT (UINT64_C(1) << 1) @@ -648,20 +674,18 @@ node /org/freedesktop/login1 { <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for the corresponding command line interface.</para> - <para><function>CanPowerOff()</function>, <function>CanReboot()</function>, - <function>CanHalt()</function>, <function>CanSuspend()</function>, <function>CanHibernate()</function>, - <function>CanHybridSleep()</function>, <function>CanSuspendThenHibernate()</function>, + <para><function>CanPowerOff()</function>, <function>CanReboot()</function>, <function>CanHalt()</function>, + <function>CanSuspend()</function>, <function>CanHibernate()</function>, <function>CanHybridSleep()</function>, + <function>CanSuspendThenHibernate()</function>, <function>CanSleep()</function>, <function>CanRebootParameter()</function>, <function>CanRebootToFirmwareSetup()</function>, - <function>CanRebootToBootLoaderMenu()</function>, and - <function>CanRebootToBootLoaderEntry()</function> test whether the system supports the respective - operation and whether the calling user is allowed to execute it. Returns one of <literal>na</literal>, - <literal>yes</literal>, <literal>no</literal>, and <literal>challenge</literal>. If - <literal>na</literal> is returned, the operation is not available because hardware, kernel, or drivers - do not support it. If <literal>yes</literal> is returned, the operation is supported and the user may - execute the operation without further authentication. If <literal>no</literal> is returned, the - operation is available but the user is not allowed to execute the operation. If - <literal>challenge</literal> is returned, the operation is available but only after - authorization.</para> + <function>CanRebootToBootLoaderMenu()</function>, and <function>CanRebootToBootLoaderEntry()</function> + test whether the system supports the respective operation and whether the calling user is allowed to + execute it. Returns one of <literal>na</literal>, <literal>yes</literal>, <literal>no</literal>, and + <literal>challenge</literal>. If <literal>na</literal> is returned, the operation is not available because + hardware, kernel, or drivers do not support it. If <literal>yes</literal> is returned, the operation is + supported and the user may execute the operation without further authentication. If <literal>no</literal> + is returned, the operation is available but the user is not allowed to execute the operation. If + <literal>challenge</literal> is returned, the operation is available but only after authorization.</para> <para><function>ScheduleShutdown()</function> schedules a shutdown operation <varname>type</varname> at time <varname>usec</varname> in microseconds since the UNIX epoch. <varname>type</varname> can be one @@ -691,7 +715,7 @@ node /org/freedesktop/login1 { whether the inhibit shall be consider mandatory or whether it should just delay the operation to a certain maximum time. The method returns a file descriptor. The lock is released the moment this file descriptor and all its duplicates are closed. For more information on the inhibition logic see - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor Locks</ulink>. + <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>. </para> </refsect2> @@ -701,26 +725,26 @@ node /org/freedesktop/login1 { <para>Whenever the inhibition state or idle hint changes, <function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para> - <para>The <function>SessionNew</function>, <function>SessionRemoved</function>, - <function>UserNew</function>, <function>UserRemoved</function>, <function>SeatNew</function>, and - <function>SeatRemoved</function> signals are sent each time a session is created or removed, a user + <para>The <function>SessionNew()</function>, <function>SessionRemoved()</function>, + <function>UserNew()</function>, <function>UserRemoved()</function>, <function>SeatNew()</function>, and + <function>SeatRemoved()</function> signals are sent each time a session is created or removed, a user logs in or out, or a seat is added or removed. They each contain the ID of the object plus the object path.</para> - <para>The <function>PrepareForShutdown</function>, - <function>PrepareForShutdownWithMetadata</function>, and <function>PrepareForSleep</function> + <para>The <function>PrepareForShutdown()</function>, + <function>PrepareForShutdownWithMetadata()</function>, and <function>PrepareForSleep()</function> signals are sent right before (with the argument <literal>true</literal>) or after (with the argument <literal>false</literal>) the system goes down for reboot/poweroff and suspend/hibernate, respectively. This may be used by applications to save data on disk, release memory, or do other jobs that should be done shortly before shutdown/sleep, in conjunction with delay inhibitor locks. After completion of this work they should release their inhibition locks in order to not delay the operation any further. For more information see - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor Locks</ulink>. The + <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>. The <function>PrepareForShutdownWithMetadata()</function> signal additionally sends a list of key/value pair metadata fields. Currently it sends a <varname>type</varname> string which defines the type of shutdown. The type can be one of <literal>power-off</literal>, <literal>reboot</literal>, <literal>halt</literal>, <literal>kexec</literal> or <literal>soft-reboot</literal>. This signal is - sent first, followed by <function>PrepareForShutdown</function> (for backward compatibility).</para> + sent first, followed by <function>PrepareForShutdown()</function> (for backward compatibility).</para> </refsect2> <refsect2> @@ -763,8 +787,8 @@ node /org/freedesktop/login1 { for more information.</para> <para>The <varname>PreparingForShutdown</varname> and <varname>PreparingForSleep</varname> boolean - properties are true during the interval between the two <function>PrepareForShutdown</function> and - <function>PrepareForSleep</function> signals respectively. Note that these properties do not + properties are true during the interval between the two <function>PrepareForShutdown()</function> and + <function>PrepareForSleep()</function> signals respectively. Note that these properties do not send out <function>PropertyChanged</function> signals.</para> <para>The <varname>RebootParameter</varname> property shows the value set with the @@ -775,9 +799,9 @@ node /org/freedesktop/login1 { <para><varname>RebootToFirmwareSetup</varname>, <varname>RebootToBootLoaderMenu</varname>, and <varname>RebootToBootLoaderEntry</varname> are true when the resprective post-reboot operation was - selected with <function>SetRebootToFirmwareSetup</function>, - <function>SetRebootToBootLoaderMenu</function>, or - <function>SetRebootToBootLoaderEntry</function>.</para> + selected with <function>SetRebootToFirmwareSetup()</function>, + <function>SetRebootToBootLoaderMenu()</function>, or + <function>SetRebootToBootLoaderEntry()</function>.</para> <para>The <varname>WallMessage</varname> and <varname>EnableWallMessages</varname> properties reflect the shutdown reason and wall message enablement switch which can be set with the @@ -818,19 +842,19 @@ node /org/freedesktop/login1 { <interfacename>org.freedesktop.login1.hibernate-ignore-inhibit</interfacename>, respectively depending on whether there are other sessions around or active inhibits are present. <function>HybridSleep()</function> and <function>SuspendThenHibernate()</function> - use the same privileges as <function>Hibernate()</function>. - <function>SetRebootParameter()</function> requires + use the same privileges as <function>Hibernate()</function>. <function>Sleep()</function> uses + the inhibits of the auto-selected sleep operation. <function>SetRebootParameter()</function> requires <interfacename>org.freedesktop.login1.set-reboot-parameter</interfacename>.</para> - <para><function>SetRebootToFirmwareSetup</function> requires + <para><function>SetRebootToFirmwareSetup()</function> requires <interfacename>org.freedesktop.login1.set-reboot-to-firmware-setup</interfacename>. - <function>SetRebootToBootLoaderMenu</function> requires + <function>SetRebootToBootLoaderMenu()</function> requires <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-menu</interfacename>. - <function>SetRebootToBootLoaderEntry</function> requires + <function>SetRebootToBootLoaderEntry()</function> requires <interfacename>org.freedesktop.login1.set-reboot-to-boot-loader-entry</interfacename>. </para> - <para><function>ScheduleShutdown</function> and <function>CancelScheduledShutdown</function> require + <para><function>ScheduleShutdown()</function> and <function>CancelScheduledShutdown()</function> require the same privileges (listed above) as the immediate poweroff/reboot/halt operations.</para> <para><function>Inhibit()</function> is protected via one of @@ -1121,6 +1145,7 @@ node /org/freedesktop/login1/session/1 { TakeControl(in b force); ReleaseControl(); SetType(in s type); + SetClass(in s class); SetDisplay(in s display); SetTTY(in h tty_fd); TakeDevice(in u major, @@ -1177,7 +1202,6 @@ node /org/freedesktop/login1/session/1 { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly u Audit = ...; readonly s Type = '...'; - @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s Class = '...'; readonly b Active = ...; readonly s State = '...'; @@ -1218,6 +1242,8 @@ node /org/freedesktop/login1/session/1 { <variablelist class="dbus-method" generated="True" extra-ref="SetType()"/> + <variablelist class="dbus-method" generated="True" extra-ref="SetClass()"/> + <variablelist class="dbus-method" generated="True" extra-ref="SetDisplay()"/> <variablelist class="dbus-method" generated="True" extra-ref="SetTTY()"/> @@ -1230,13 +1256,13 @@ node /org/freedesktop/login1/session/1 { <variablelist class="dbus-method" generated="True" extra-ref="SetBrightness()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="PauseDevice"/> + <variablelist class="dbus-signal" generated="True" extra-ref="PauseDevice()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="ResumeDevice"/> + <variablelist class="dbus-signal" generated="True" extra-ref="ResumeDevice()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="Lock"/> + <variablelist class="dbus-signal" generated="True" extra-ref="Lock()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="Unlock"/> + <variablelist class="dbus-signal" generated="True" extra-ref="Unlock()"/> <variablelist class="dbus-property" generated="True" extra-ref="Id"/> @@ -1318,6 +1344,12 @@ node /org/freedesktop/login1/session/1 { connection. This should help prevent a session from entering an inconsistent state, for example if the controller crashes. The only argument <varname>type</varname> is the new session type.</para> + <para><function>SetClass()</function> allows the caller to change the class of the session dynamically. + It may only be called by session's owening user. Currently, this call may be exclusively used to change + the class from <literal>user-incomplete</literal> to <literal>user</literal>. The call is synchronous, + and will return only once the user's service manager has successfully been started, if necessary. The + only argument <varname>type</varname> is the new session type.</para> + <para><function>SetDisplay()</function> allows the display name of the graphical session to be changed. This is useful if the display server is started as part of the session. It can only be called by session's current controller. If <function>TakeControl()</function> has not been called, this method will fail. The only argument @@ -1368,28 +1400,28 @@ node /org/freedesktop/login1/session/1 { <refsect2> <title>Signals</title> - <para>The active session controller exclusively gets <function>PauseDevice</function> and - <function>ResumeDevice</function> events for any device it requested via + <para>The active session controller exclusively gets <function>PauseDevice()</function> and + <function>ResumeDevice()</function> events for any device it requested via <function>TakeDevice()</function>. They notify the controller whenever a device is paused or resumed. A - device is never resumed if its session is inactive. Also note that <function>PauseDevice</function> + device is never resumed if its session is inactive. Also note that <function>PauseDevice()</function> signals are sent before the <function>PropertyChanged</function> signal for the - <function>Active</function> state. The inverse is true for <function>ResumeDevice</function>. A device + <function>Active</function> state. The inverse is true for <function>ResumeDevice()</function>. A device may remain paused for unknown reasons even though the <interfacename>Session</interfacename> is active. </para> - <para>A <function>PauseDevice</function> signal carries the major and minor numbers and a string describing the + <para>A <function>PauseDevice()</function> signal carries the major and minor numbers and a string describing the type as arguments. <function>force</function> means the device was already paused by <filename>systemd-logind</filename> and the signal is only an asynchronous notification. <function>pause</function> means <filename>systemd-logind</filename> grants you a limited amount of time to pause the device. You must respond to this via <function>PauseDeviceComplete()</function>. This synchronous pausing mechanism is used for backwards-compatibility to VTs and <filename>systemd-logind</filename> is free to not make use of - it. It is also free to send a forced <function>PauseDevice</function> if you don't respond in a timely + it. It is also free to send a forced <function>PauseDevice()</function> if you don't respond in a timely manner (or for any other reason). <function>gone</function> means the device was unplugged from the system and you will no longer get any notifications about it. There is no need to call <function>ReleaseDevice()</function>. You may call <function>TakeDevice()</function> again if a new device is assigned the major+minor combination.</para> - <para><function>ResumeDevice</function> is sent whenever a session is active and a device is + <para><function>ResumeDevice()</function> is sent whenever a session is active and a device is resumed. It carries the major/minor numbers as arguments and provides a new open file descriptor. You should switch to the new descriptor and close the old one. They are not guaranteed to have the same underlying open file descriptor in the kernel (except for a limited set of device types).</para> @@ -1397,7 +1429,7 @@ node /org/freedesktop/login1/session/1 { <para>Whenever <function>Active</function> or the idle state changes, <function>PropertyChanged</function> signals are sent out to which clients can subscribe.</para> - <para><function>Lock</function>/<function>Unlock</function> is sent when the session is asked to be + <para><function>Lock()</function>/<function>Unlock()</function> is sent when the session is asked to be screen-locked/unlocked. A session manager of the session should listen to this signal and act accordingly. This signal is sent out as a result of the <function>Lock()</function> and <function>Unlock()</function> methods, respectively.</para> @@ -1543,13 +1575,18 @@ node /org/freedesktop/login1/session/1 { <varname>HandleSuspendKeyLongPress</varname>, and <varname>HandleHibernateKeyLongPress</varname> were added in version 251.</para> <para><varname>StopIdleSessionUSec</varname> was added in version 252.</para> - <para><function>PrepareForShutdownWithMetadata</function> and + <para><function>PrepareForShutdownWithMetadata()</function> and <function>CreateSessionWithPIDFD()</function> were added in version 255.</para> + <para><function>Sleep()</function>, + <function>CanSleep()</function>, + <varname>SleepOperation</varname>, and + <function>ListSessionsEx()</function> were added in version 256.</para> </refsect2> <refsect2> <title>Session Objects</title> <para><function>SetDisplay()</function> was added in version 252.</para> <para><function>SetTTY()</function> was added in version 254.</para> + <para><function>SetClass()</function> was added in version 256.</para> </refsect2> </refsect1> </refentry> diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index 1af77e0..8abef00 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.machine1" conditional='ENABLE_MACHINED' @@ -89,6 +89,9 @@ node /org/freedesktop/machine1 { in i signal); GetMachineAddresses(in s name, out a(iay) addresses); + GetMachineSSHInfo(in s name, + out s ssh_address, + out s ssh_private_key_path); GetMachineOSRelease(in s name, out a{ss} fields); @org.freedesktop.systemd1.Privileged("true") @@ -184,8 +187,6 @@ node /org/freedesktop/machine1 { <!--method UnregisterMachine is not documented!--> - <!--method CopyToMachineWithFlags is not documented!--> - <!--method OpenMachineRootDirectory is not documented!--> <!--method GetMachineUIDShift is not documented!--> @@ -232,6 +233,8 @@ node /org/freedesktop/machine1 { <variablelist class="dbus-method" generated="True" extra-ref="GetMachineAddresses()"/> + <variablelist class="dbus-method" generated="True" extra-ref="GetMachineSSHInfo()"/> + <variablelist class="dbus-method" generated="True" extra-ref="GetMachineOSRelease()"/> <variablelist class="dbus-method" generated="True" extra-ref="OpenMachinePTY()"/> @@ -284,9 +287,9 @@ node /org/freedesktop/machine1 { <variablelist class="dbus-method" generated="True" extra-ref="MapToMachineGroup()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="MachineNew"/> + <variablelist class="dbus-signal" generated="True" extra-ref="MachineNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="MachineRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="MachineRemoved()"/> <variablelist class="dbus-property" generated="True" extra-ref="PoolPath"/> @@ -344,7 +347,7 @@ node /org/freedesktop/machine1 { unit for the calling client (utilizing the passed scope_properties) and move the leader PID into it. The method returns an object path for the registered machine object that implements the <interfacename>org.freedesktop.machine1.Machine</interfacename> interface (see below). Also see the - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New Control Group + <ulink url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group Interfaces</ulink> for details about scope units and how to alter resource control settings on the created machine at runtime.</para> @@ -380,6 +383,10 @@ node /org/freedesktop/machine1 { <constant>AF_INET6</constant>) and a byte array containing the addresses. This is only supported for containers that make use of network namespacing.</para> + <para><function>GetMachineSSHInfo()</function> retrieves the SSH information of a machine. This method + returns two strings, the SSH address which can be used to tell SSH where to connect, and the path + to the SSH private key required for the connection to succeed.</para> + <para><function>GetMachineOSRelease()</function> retrieves the OS release information of a container. This method returns an array of key value pairs read from the <citerefentry><refentrytitle>os-release</refentrytitle><manvolnum>5</manvolnum></citerefentry> file in @@ -411,7 +418,7 @@ node /org/freedesktop/machine1 { host as arguments. <function>CopyToMachine()</function> does the opposite and copies files from a source directory on the host into a destination directory in the container. - <function>CopyFromMachineWithFlags()</function> and <function>CopyToMachineWithFlags</function> do the same but take an additional flags argument.</para> + <function>CopyFromMachineWithFlags()</function> and <function>CopyToMachineWithFlags()</function> do the same but take an additional flags argument.</para> <para><function>RemoveImage()</function> removes the image with the specified name.</para> @@ -434,7 +441,7 @@ node /org/freedesktop/machine1 { <refsect2> <title>Signals</title> - <para><function>MachineNew</function> and <function>MachineRemoved</function> are sent whenever a new + <para><function>MachineNew()</function> and <function>MachineRemoved()</function> are sent whenever a new machine is registered or removed. These signals carry the machine name and the object path to the corresponding <interfacename>org.freedesktop.machine1.Machine</interfacename> interface (see below).</para> </refsect2> @@ -461,6 +468,8 @@ node /org/freedesktop/machine1/machine/rawhide { Kill(in s who, in i signal); GetAddresses(out a(iay) addresses); + GetSSHInfo(out s ssh_address, + out s ssh_private_key_path); GetOSRelease(out a{ss} fields); GetUIDShift(out u shift); OpenPTY(out h pty, @@ -509,6 +518,12 @@ node /org/freedesktop/machine1/machine/rawhide { readonly s RootDirectory = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly ai NetworkInterfaces = [...]; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly u VSockCID = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s SSHAddress = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s SSHPrivateKeyPath = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s State = '...'; }; @@ -550,6 +565,8 @@ node /org/freedesktop/machine1/machine/rawhide { <variablelist class="dbus-method" generated="True" extra-ref="GetAddresses()"/> + <variablelist class="dbus-method" generated="True" extra-ref="GetSSHInfo()"/> + <variablelist class="dbus-method" generated="True" extra-ref="GetOSRelease()"/> <variablelist class="dbus-method" generated="True" extra-ref="GetUIDShift()"/> @@ -592,6 +609,12 @@ node /org/freedesktop/machine1/machine/rawhide { <variablelist class="dbus-property" generated="True" extra-ref="NetworkInterfaces"/> + <variablelist class="dbus-property" generated="True" extra-ref="VSockCID"/> + + <variablelist class="dbus-property" generated="True" extra-ref="SSHAddress"/> + + <variablelist class="dbus-property" generated="True" extra-ref="SSHPrivateKeyPath"/> + <variablelist class="dbus-property" generated="True" extra-ref="State"/> <!--End of Autogenerated section--> @@ -603,9 +626,9 @@ node /org/freedesktop/machine1/machine/rawhide { take the same arguments as <function>TerminateMachine()</function> and <function>KillMachine()</function> on the Manager interface, respectively.</para> - <para><function>GetAddresses()</function> and <function>GetOSRelease()</function> get the IP address and OS - release information from the machine. These methods take the same arguments as - <function>GetMachineAddresses()</function> and <function>GetMachineOSRelease()</function> of the + <para><function>GetAddresses()</function>, <function>GetSSHInfo()</function> and <function>GetOSRelease()</function> get the IP address, + SSH connection and OS release information from the machine. These methods take the same arguments as + <function>GetMachineAddresses()</function>, <function>GetMachineSSHInfo()</function> and <function>GetMachineOSRelease()</function> of the Manager interface, respectively.</para> </refsect2> @@ -638,6 +661,15 @@ node /org/freedesktop/machine1/machine/rawhide { towards the container, the VM or the host. For details about this information see the description of <function>CreateMachineWithNetwork()</function> above.</para> + <para><varname>VSockCID</varname> is the VSOCK CID of the VM if it is known, or + <constant>VMADDR_CID_ANY</constant> otherwise.</para> + + <para><varname>SSHAddress</varname> is the address of the VM in a format <command>ssh</command> can understand + if it is known or the empty string.</para> + + <para><varname>SSHPrivateKeyPath</varname> is the path to the SSH private key of the VM if it is known + or the empty string.</para> + <para><varname>State</varname> is the state of the machine and is one of <literal>opening</literal>, <literal>running</literal>, or <literal>closing</literal>. Note that the state machine is not considered part of the API and states might be removed or added without this being considered API breakage. @@ -677,11 +709,14 @@ $ gdbus introspect --system \ <title>The Manager Object</title> <para><function>CopyFromMachineWithFlags()</function> and <function>CopyToMachineWithFlags()</function> were added in version 252.</para> + <para><function>GetMachineSSHInfo()</function> was added in version 256.</para> </refsect2> <refsect2> <title>Machine Objects</title> <para><function>CopyFromWithFlags()</function> and <function>CopyToWithFlags()</function> were added in version 252.</para> + <para><function>GetSSHInfo()</function>, <varname>VSockCID</varname>, <varname>SSHAddress</varname> + and <varname>SSHPrivateKeyPath</varname> were added in version 256.</para> </refsect2> </refsect1> </refentry> diff --git a/man/org.freedesktop.network1.xml b/man/org.freedesktop.network1.xml index 02013c5..1d8ce0d 100644 --- a/man/org.freedesktop.network1.xml +++ b/man/org.freedesktop.network1.xml @@ -1,7 +1,7 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -87,6 +87,8 @@ node /org/freedesktop/network1 { readonly s OnlineState = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly t NamespaceId = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly u NamespaceNSID = ...; }; interface org.freedesktop.DBus.Peer { ... }; interface org.freedesktop.DBus.Introspectable { ... }; @@ -148,8 +150,6 @@ node /org/freedesktop/network1 { <!--property OnlineState is not documented!--> - <!--property NamespaceId is not documented!--> - <!--Autogenerated cross-references for systemd.directives, do not edit--> <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Manager"/> @@ -212,11 +212,24 @@ node /org/freedesktop/network1 { <variablelist class="dbus-property" generated="True" extra-ref="NamespaceId"/> + <variablelist class="dbus-property" generated="True" extra-ref="NamespaceNSID"/> + <!--End of Autogenerated section--> <para> Provides information about the manager. </para> + + <refsect2> + <title>Properties</title> + + <para><varname>NamespaceId</varname> contains the inode number of the network namespace that the + network service runs in. A client may compare this with the inode number of its own network namespace + to verify whether the service manages the same network namespace.</para> + + <para><varname>NamespaceNSID</varname> contains the "nsid" identifier the kernel maintains for the + network namespace, if there's one assigned.</para> + </refsect2> </refsect1> <refsect1> @@ -584,5 +597,9 @@ $ gdbus introspect --system \ <title>DHCPv6 Client Object</title> <para><varname>State</varname> was added in version 255.</para> </refsect2> + <refsect2> + <title>Manager Object</title> + <para><varname>NamespaceNSID</varname> was added in version 256.</para> + </refsect2> </refsect1> </refentry> diff --git a/man/org.freedesktop.oom1.xml b/man/org.freedesktop.oom1.xml index 8339e63..1b549c3 100644 --- a/man/org.freedesktop.oom1.xml +++ b/man/org.freedesktop.oom1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.oom1" conditional='ENABLE_OOMD' @@ -59,14 +59,14 @@ node /org/freedesktop/oom1 { <variablelist class="dbus-method" generated="True" extra-ref="DumpByFileDescriptor()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="Killed"/> + <variablelist class="dbus-signal" generated="True" extra-ref="Killed()"/> <!--End of Autogenerated section--> <refsect2> <title>Methods</title> - <para><function>Killed</function> signal is sent when any cgroup is killed by oomd.</para> + <para><function>Killed()</function> signal is sent when any cgroup is killed by oomd.</para> <para>Note that more reasons will be added in the future, and the table below will be expanded accordingly.</para> <table> <title>Killing reasons</title> @@ -100,7 +100,7 @@ node /org/freedesktop/oom1 { <title>History</title> <refsect2> <title>The Manager Object</title> - <para><function>Killed</function> was added in version 252.</para> + <para><function>Killed()</function> was added in version 252.</para> </refsect2> </refsect1> </refentry> diff --git a/man/org.freedesktop.portable1.xml b/man/org.freedesktop.portable1.xml index 6da7b0c..4de3da2 100644 --- a/man/org.freedesktop.portable1.xml +++ b/man/org.freedesktop.portable1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.portable1" conditional='ENABLE_PORTABLED' @@ -229,16 +229,23 @@ node /org/freedesktop/portable1 { for the current boot session, and a string representing the preferred copy mode (whether to copy the image or to just symlink it) with the following possible values: <itemizedlist> - <listitem><para>(null)</para></listitem> + <listitem><para>(empty)</para></listitem> <listitem><para>copy</para></listitem> <listitem><para>symlink</para></listitem> + + <listitem><para>mixed</para></listitem> </itemizedlist> - This method returns the list of changes applied to the system (for example, which unit was - added and is now available as a system service). Each change is represented as a triplet of - strings: the type of change applied, the path on which it was applied, and the source - (if any). The type of change applied will be one of the following possible values: + If an empty string is passed the security profile drop-ins and images will be symlinked while unit + files will be copied, <varname>copy</varname> will copy, <varname>symlink</varname> will prefer + linking if possible (e.g.: a unit has to be copied out of an image), and <varname>mixed</varname> will + prefer linking the resources owned by the OS (e.g.: the portable profile located within the host's + /usr/ tree) but will copy the resources owned by the portable image (e.g.: the unit files and the + images). This method returns the list of changes applied to the system (for example, which unit was + added and is now available as a system service). Each change is represented as a triplet of strings: + the type of change applied, the path on which it was applied, and the source (if any). The type of + change applied will be one of the following possible values: <itemizedlist> <listitem><para>copy</para></listitem> @@ -252,6 +259,9 @@ node /org/freedesktop/portable1 { on the system. Note that this method returns only after all the listed operations are completed, and due to the I/O involved it might take some time.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="vpick.xml" xpointer="directory"/> + <para><function>AttachImageWithExtensions()</function> attaches a portable image to the system. This method is a superset of <function>AttachImage()</function> with the addition of a list of extensions as input parameter, which will be overlaid on top of the main @@ -279,8 +289,7 @@ node /org/freedesktop/portable1 { <para><function>DetachImageWithExtensions()</function> detaches a portable image from the system. This method is a superset of <function>DetachImage()</function> with the addition of a list of extensions as input parameter, which were overlaid on top of the main - image via <function>AttachImageWithExtensions()</function>. - The <varname>flag</varname> parameter is currently unused and reserved for future purposes.</para> + image via <function>AttachImageWithExtensions()</function>.</para> <para><function>ReattachImage()</function> combines the effects of the <function>AttachImage()</function> method and the <function>DetachImage()</function> method. @@ -297,7 +306,7 @@ node /org/freedesktop/portable1 { image. For more details on this functionality, see the <varname>MountImages=</varname> entry on <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> and <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>. - The <varname>flag</varname> parameter is currently unused and reserved for future purposes</para> + </para> <para><function>RemoveImage()</function> removes the image with the specified name.</para> diff --git a/man/org.freedesktop.resolve1.xml b/man/org.freedesktop.resolve1.xml index c6b0153..f6b70d6 100644 --- a/man/org.freedesktop.resolve1.xml +++ b/man/org.freedesktop.resolve1.xml @@ -1,7 +1,7 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -103,7 +103,7 @@ node /org/freedesktop/resolve1 { SetLinkDNSSECNegativeTrustAnchors(in i ifindex, in as names); RevertLink(in i ifindex); - RegisterService(in s name, + RegisterService(in s id, in s name_template, in s type, in q service_port, @@ -434,7 +434,7 @@ node /org/freedesktop/resolve1 { <para>The <function>RegisterService()</function> method may be used to register a DNS-SD service on the host. This functionality is closely related to the functionality provided by <citerefentry><refentrytitle>systemd.dnssd</refentrytitle><manvolnum>5</manvolnum></citerefentry> - files. It takes a server identifier string as first parameter (this is jus a local identifier, and + files. It takes a server identifier string as first parameter (this is just a local identifier, and should be chosen so that it neither collides with the basename of <filename>*.dnssd</filename> files nor with names chosen by other IPC clients). It also takes a name template string for the DNS-SD service name visible on the network. This string is subject to specifier expansation, as documented for @@ -454,35 +454,36 @@ node /org/freedesktop/resolve1 { and recommended. However, the following flags are defined to alter the look-up:</para> <programlisting>/* Input+Output: Protocol/scope */ -#define SD_RESOLVED_DNS (UINT64_C(1) << 0) -#define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1) -#define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2) -#define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3) -#define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4) +#define SD_RESOLVED_DNS (UINT64_C(1) << 0) +#define SD_RESOLVED_LLMNR_IPV4 (UINT64_C(1) << 1) +#define SD_RESOLVED_LLMNR_IPV6 (UINT64_C(1) << 2) +#define SD_RESOLVED_MDNS_IPV4 (UINT64_C(1) << 3) +#define SD_RESOLVED_MDNS_IPV6 (UINT64_C(1) << 4) /* Input: Restrictions */ -#define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5) -#define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6) -#define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7) -#define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8) -#define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10) -#define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11) -#define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12) -#define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13) -#define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14) -#define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15) -#define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24) +#define SD_RESOLVED_NO_CNAME (UINT64_C(1) << 5) +#define SD_RESOLVED_NO_TXT (UINT64_C(1) << 6) +#define SD_RESOLVED_NO_ADDRESS (UINT64_C(1) << 7) +#define SD_RESOLVED_NO_SEARCH (UINT64_C(1) << 8) +#define SD_RESOLVED_NO_VALIDATE (UINT64_C(1) << 10) +#define SD_RESOLVED_NO_SYNTHESIZE (UINT64_C(1) << 11) +#define SD_RESOLVED_NO_CACHE (UINT64_C(1) << 12) +#define SD_RESOLVED_NO_ZONE (UINT64_C(1) << 13) +#define SD_RESOLVED_NO_TRUST_ANCHOR (UINT64_C(1) << 14) +#define SD_RESOLVED_NO_NETWORK (UINT64_C(1) << 15) +#define SD_RESOLVED_NO_STALE (UINT64_C(1) << 24) +#define SD_RESOLVED_RELAX_SINGLE_LABEL (UINT64_C(1) << 25) /* Output: Security */ -#define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9) -#define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18) +#define SD_RESOLVED_AUTHENTICATED (UINT64_C(1) << 9) +#define SD_RESOLVED_CONFIDENTIAL (UINT64_C(1) << 18) /* Output: Origin */ -#define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19) -#define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20) -#define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21) -#define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22) -#define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23) +#define SD_RESOLVED_SYNTHETIC (UINT64_C(1) << 19) +#define SD_RESOLVED_FROM_CACHE (UINT64_C(1) << 20) +#define SD_RESOLVED_FROM_ZONE (UINT64_C(1) << 21) +#define SD_RESOLVED_FROM_TRUST_ANCHOR (UINT64_C(1) << 22) +#define SD_RESOLVED_FROM_NETWORK (UINT64_C(1) << 23) </programlisting> <para>On input, the first five flags control the protocols to use for the look-up. They refer to diff --git a/man/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 6008ba0..b0b4509 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.systemd1" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -277,6 +277,11 @@ node /org/freedesktop/systemd1 { GetDynamicUsers(out a(us) users); DumpUnitFileDescriptorStore(in s name, out a(suuutuusu) entries); + StartAuxiliaryScope(in s name, + in ah pidfds, + in t flags, + in a(sv) properties, + out o job); signals: UnitNew(s id, o unit); @@ -335,6 +340,10 @@ node /org/freedesktop/systemd1 { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly t FinishTimestampMonotonic = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly t ShutdownStartTimestamp = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly t ShutdownStartTimestampMonotonic = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly t SecurityStartTimestamp = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly t SecurityStartTimestampMonotonic = ...; @@ -551,6 +560,8 @@ node /org/freedesktop/systemd1 { readonly i DefaultOOMScoreAdjust = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s CtrlAltDelBurstAction = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly u SoftRebootsCount = ...; }; interface org.freedesktop.DBus.Peer { ... }; interface org.freedesktop.DBus.Introspectable { ... }; @@ -564,8 +575,6 @@ node /org/freedesktop/systemd1 { <!--method EnqueueUnitJob is not documented!--> - <!--method CleanUnit is not documented!--> - <!--method FreezeUnit is not documented!--> <!--method ThawUnit is not documented!--> @@ -612,20 +621,6 @@ node /org/freedesktop/systemd1 { <!--method GetDynamicUsers is not documented!--> - <!--signal UnitNew is not documented!--> - - <!--signal UnitRemoved is not documented!--> - - <!--signal JobNew is not documented!--> - - <!--signal JobRemoved is not documented!--> - - <!--signal StartupFinished is not documented!--> - - <!--signal UnitFilesChanged is not documented!--> - - <!--signal Reloading is not documented!--> - <!--property SecurityStartTimestampMonotonic is not documented!--> <!--property SecurityFinishTimestamp is not documented!--> @@ -990,19 +985,21 @@ node /org/freedesktop/systemd1 { <variablelist class="dbus-method" generated="True" extra-ref="DumpUnitFileDescriptorStore()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="UnitNew"/> + <variablelist class="dbus-method" generated="True" extra-ref="StartAuxiliaryScope()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="UnitRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="UnitNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="JobNew"/> + <variablelist class="dbus-signal" generated="True" extra-ref="UnitRemoved()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="JobRemoved"/> + <variablelist class="dbus-signal" generated="True" extra-ref="JobNew()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="StartupFinished"/> + <variablelist class="dbus-signal" generated="True" extra-ref="JobRemoved()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="UnitFilesChanged"/> + <variablelist class="dbus-signal" generated="True" extra-ref="StartupFinished()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="Reloading"/> + <variablelist class="dbus-signal" generated="True" extra-ref="UnitFilesChanged()"/> + + <variablelist class="dbus-signal" generated="True" extra-ref="Reloading()"/> <variablelist class="dbus-property" generated="True" extra-ref="Version"/> @@ -1040,6 +1037,10 @@ node /org/freedesktop/systemd1 { <variablelist class="dbus-property" generated="True" extra-ref="FinishTimestampMonotonic"/> + <variablelist class="dbus-property" generated="True" extra-ref="ShutdownStartTimestamp"/> + + <variablelist class="dbus-property" generated="True" extra-ref="ShutdownStartTimestampMonotonic"/> + <variablelist class="dbus-property" generated="True" extra-ref="SecurityStartTimestamp"/> <variablelist class="dbus-property" generated="True" extra-ref="SecurityStartTimestampMonotonic"/> @@ -1250,6 +1251,8 @@ node /org/freedesktop/systemd1 { <variablelist class="dbus-property" generated="True" extra-ref="CtrlAltDelBurstAction"/> + <variablelist class="dbus-property" generated="True" extra-ref="SoftRebootsCount"/> + <!--End of Autogenerated section--> <refsect2> @@ -1565,7 +1568,7 @@ node /org/freedesktop/systemd1 { <varname>properties</varname> contains properties of the unit, specified like in <function>SetUnitProperties()</function>. <varname>aux</varname> is currently unused and should be passed as an empty array. See the - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New Control Group + <ulink url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group Interface</ulink> for more information how to make use of this functionality for resource control purposes.</para> @@ -1573,6 +1576,19 @@ node /org/freedesktop/systemd1 { file descriptors currently in the file descriptor store of the specified unit. This call is equivalent to <function>DumpFileDescriptorStore()</function> on the <interfacename>org.freedesktop.systemd1.Service</interfacename>. For further details, see below.</para> + + <para><function>StartAuxiliaryScope()</function> creates a new scope unit from a service where calling + process resides. Set of processes that will be migrated to newly created scope is passed in as an array + of pidfds. This is useful for creating auxiliary scopes that should contain worker processes and their lifecycle + shouldn't be bound to a lifecycle of the service, e.g. they should continue running after the restart + of the service. Note that the main PID of the service can not be migrated to an auxiliary scope. + Also, <varname>flags</varname> argument must be 0 and is reserved for future extensions.</para> + + <para><function>CleanUnit()</function> deletes the configuration, state, logs, cache and runtime data + directories and clear out the file descriptors store for the unit, as specified in the mask + parameters. The possible values are <literal>configuration</literal>, <literal>state</literal>, + <literal>logs</literal>, <literal>cache</literal>, <literal>runtime</literal>, + <literal>fdstore</literal>, and <literal>all</literal>.</para> </refsect2> <refsect2> @@ -1644,18 +1660,26 @@ node /org/freedesktop/systemd1 { <listitem><para><filename>/bin</filename>, <filename>/sbin</filename> and <filename>/lib*</filename> are not symlinks to their counterparts under <filename>/usr/</filename>. For more information on this issue consult - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/TheCaseForTheUsrMerge"> - The Case for the /usr Merge - </ulink>.</para> + <ulink url="https://systemd.io/THE_CASE_FOR_THE_USR_MERGE">The Case for the /usr Merge</ulink>. + </para> <xi:include href="version-info.xml" xpointer="v252"/></listitem> + </varlistentry> + + <varlistentry> + <term><literal>unmerged-bin</literal></term> + + <listitem><para><filename>/usr/sbin</filename> is not a symlink to <filename>/usr/bin/</filename>. + </para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> <varlistentry> - <term><literal>cgroups-missing</literal></term> + <term><literal>var-run-bad</literal></term> - <listitem><para>Support for cgroups is unavailable.</para> + <listitem><para><filename>/run/</filename> does not exist or <filename>/var/run</filename> is not a + symlink to <filename>/run/</filename>.</para> <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> @@ -1663,7 +1687,7 @@ node /org/freedesktop/systemd1 { <varlistentry> <term><literal>cgroupsv1</literal></term> - <listitem><para>The system is using the old cgroup hierarchy.</para> + <listitem><para>The system is using the deprecated cgroup v1 hierarchy.</para> <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> @@ -1698,15 +1722,6 @@ node /org/freedesktop/systemd1 { </varlistentry> <varlistentry> - <term><literal>var-run-bad</literal></term> - - <listitem><para><filename>/run/</filename> does not exist or <filename>/var/run</filename> is not a - symlink to <filename>/run/</filename>.</para> - - <xi:include href="version-info.xml" xpointer="v252"/></listitem> - </varlistentry> - - <varlistentry> <term><literal>overflowuid-not-65534</literal></term> <term><literal>overflowgid-not-65534</literal></term> @@ -1724,8 +1739,6 @@ node /org/freedesktop/systemd1 { <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> - - <!-- mtab-not-symlink was removed in b492ce8a22d4527c1372b2d3fbd580627d70c917 --> </variablelist> <para><varname>FirmwareTimestamp</varname>, <varname>FirmwareTimestampMonotonic</varname>, @@ -1733,17 +1746,18 @@ node /org/freedesktop/systemd1 { <varname>KernelTimestamp</varname>, <varname>KernelTimestampMonotonic</varname>, <varname>InitRDTimestamp</varname>, <varname>InitRDTimestampMonotonic</varname>, <varname>UserspaceTimestamp</varname>, <varname>UserspaceTimestampMonotonic</varname>, - <varname>FinishTimestamp</varname>, and <varname>FinishTimestampMonotonic</varname> encode - <constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> microsecond timestamps - taken when the firmware first began execution, when the boot loader first began execution, when the - kernel first began execution, when the initrd first began execution, when the main systemd instance - began execution and finally, when all queued startup jobs finished execution. These values are useful - for determining boot-time performance. Note that as monotonic time begins with the kernel startup, the - <varname>KernelTimestampMonotonic</varname> timestamp will always be 0 and - <varname>FirmwareTimestampMonotonic</varname> and <varname>LoaderTimestampMonotonic</varname> are to - be read as negative values. Also, not all fields are always available, depending on the used firmware, - boot loader or initrd implementation. In these cases the respective pairs of timestamps are both 0, - indicating that no data is available.</para> + <varname>FinishTimestamp</varname>, <varname>FinishTimestampMonotonic</varname>, + <varname>ShutdownStartTimestamp</varname> and <varname>ShutdownStartTimestampMonotonic</varname> + encode <constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> microsecond + timestamps taken when the firmware first began execution, when the boot loader first began execution, + when the kernel first began execution, when the initrd first began execution, when the main systemd + instance began execution, when all queued startup jobs finished execution and finally, when a shutdown + operation first began execution. These values are useful for determining boot-time performance. Note + that as monotonic time begins with the kernel startup, the <varname>KernelTimestampMonotonic</varname> + timestamp will always be 0 and <varname>FirmwareTimestampMonotonic</varname> and + <varname>LoaderTimestampMonotonic</varname> are to be read as negative values. Also, not all fields + are always available, depending on the used firmware, boot loader or initrd implementation. In these + cases the respective pairs of timestamps are both 0, indicating that no data is available.</para> <para><varname>UnitsLoadTimestamp</varname> and <varname>UnitsLoadTimestampMonotonic</varname> encode <constant>CLOCK_REALTIME</constant> and <constant>CLOCK_MONOTONIC</constant> microseconds timestamps @@ -1777,6 +1791,9 @@ node /org/freedesktop/systemd1 { <para><varname>UnitPath</varname> encodes the currently active unit file search path. It is an array of file system paths encoded as strings.</para> + <para><varname>SoftRebootsCount</varname> encodes how many soft-reboots were successfully completed + since the last full boot. Starts at <literal>0</literal>.</para> + <para><varname>Virtualization</varname> contains a short ID string describing the virtualization technology the system runs in. On bare-metal hardware this is the empty string. Otherwise, it contains an identifier such as <literal>kvm</literal>, <literal>vmware</literal> and so on. For a full list of @@ -1864,7 +1881,7 @@ node /org/freedesktop/systemd1 { enablement state (<function>EnableUnitFiles()</function>, <function>DisableUnitFiles()</function>, <function>EnableUnitFilesWithFlags()</function>, <function>DisableUnitFilesWithFlags()</function>, <function>ReenableUnitFiles()</function>, <function>LinkUnitFiles()</function>, - <function>PresetUnitFiles</function>, <function>MaskUnitFiles</function>, and similar) require + <function>PresetUnitFiles()</function>, <function>MaskUnitFiles()</function>, and similar) require <interfacename>org.freedesktop.systemd1.manage-unit-files</interfacename>. Operations which modify the exported environment (<function>SetEnvironment()</function>, <function>UnsetEnvironment()</function>, <function>UnsetAndSetEnvironment()</function>) require @@ -1985,6 +2002,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly as RequiresMountsFor = ['...', ...]; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly as WantsMountsFor = ['...', ...]; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly as Documentation = ['...', ...]; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s Description = '...'; @@ -2141,6 +2160,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <!--property SliceOf is not documented!--> + <!--property WantsMountsFor is not documented!--> + <!--property FreezerState is not documented!--> <!--property DropInPaths is not documented!--> @@ -2301,6 +2322,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="RequiresMountsFor"/> + <variablelist class="dbus-property" generated="True" extra-ref="WantsMountsFor"/> + <variablelist class="dbus-property" generated="True" extra-ref="Documentation"/> <variablelist class="dbus-property" generated="True" extra-ref="Description"/> @@ -2742,6 +2765,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { readonly t ExecMainStartTimestampMonotonic = ...; readonly t ExecMainExitTimestamp = ...; readonly t ExecMainExitTimestampMonotonic = ...; + readonly t ExecMainHandoffTimestamp = ...; + readonly t ExecMainHandoffTimestampMonotonic = ...; readonly u ExecMainPID = ...; readonly i ExecMainCode = ...; readonly i ExecMainStatus = ...; @@ -2792,6 +2817,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -2800,6 +2829,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -2904,6 +2935,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -3425,6 +3458,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -3433,6 +3470,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -3535,6 +3574,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -4015,6 +4056,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="ExecMainExitTimestampMonotonic"/> + <variablelist class="dbus-property" generated="True" extra-ref="ExecMainHandoffTimestamp"/> + + <variablelist class="dbus-property" generated="True" extra-ref="ExecMainHandoffTimestampMonotonic"/> + <variablelist class="dbus-property" generated="True" extra-ref="ExecMainPID"/> <variablelist class="dbus-property" generated="True" extra-ref="ExecMainCode"/> @@ -4067,6 +4112,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -4075,6 +4124,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -4179,6 +4230,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -4656,12 +4709,20 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <para><varname>ExecMainStartTimestamp</varname>, <varname>ExecMainStartTimestampMonotonic</varname>, <varname>ExecMainExitTimestamp</varname>, <varname>ExecMainExitTimestampMonotonic</varname>, + <varname>ExecMainHandoffTimestamp</varname>, <varname>ExecMainHandoffTimestampMonotonic</varname>, <varname>ExecMainPID</varname>, <varname>ExecMainCode</varname>, <varname>ExecMainStatus</varname> - contain information about the main process of the service as far as it is known. This is often the same - runtime information that is stored in <varname>ExecStart</varname>. However, it deviates for - <varname>Type=forking</varname> services where the main process of the service is not forked off - systemd directly. These fields either contain information of the last run of the process or of the - current running process.</para> + contain information about the main process of the service as far as it is known. The + <varname>ExecMainStartTimestamp</varname> timestamps record when the main process of the service is + created. <varname>ExecMainExitTimestamp</varname> timestamps record when the main process exit has been + detected by the service manager. <varname>ExecMainHandoffTimestamp</varname> timestamps records when + the service binary is about to be executed by <command>systemd-executor</command> (this timestamp is + recorded regardless if the immediately following <function>execve()</function> system call succeeds or + fails). This is often the same runtime information that is also maintained for + <varname>ExecStart=</varname>. However, it deviates for services with <varname>Type=forking</varname> + as well as services that use <varname>MAINPID=</varname> <function>sd_notify()</function> messages as + the main process of the service is not forked off by the service manager directly in that case. These + fields either contain information of the last run of the process or of the current running + process.</para> <para><varname>MainPID</varname> and <varname>ControlPID</varname> contain the main and control PID of the service. The main PID is the current main PID of the service and is 0 when the service currently @@ -4791,6 +4852,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PassCredentials = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly b PassFileDescriptorsToExec = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PassSecurity = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PassPacketInfo = ...; @@ -4871,6 +4934,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -4879,6 +4946,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -4983,6 +5052,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -5450,6 +5521,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <!--property PassCredentials is not documented!--> + <!--property PassFileDescriptorsToExec is not documented!--> + <!--property PassSecurity is not documented!--> <!--property PassPacketInfo is not documented!--> @@ -5514,6 +5587,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -5522,6 +5599,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -5624,6 +5703,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -6054,6 +6135,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <variablelist class="dbus-property" generated="True" extra-ref="PassCredentials"/> + <variablelist class="dbus-property" generated="True" extra-ref="PassFileDescriptorsToExec"/> + <variablelist class="dbus-property" generated="True" extra-ref="PassSecurity"/> <variablelist class="dbus-property" generated="True" extra-ref="PassPacketInfo"/> @@ -6138,6 +6221,10 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -6146,6 +6233,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -6250,6 +6339,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -6816,6 +6907,10 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -6824,6 +6919,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -6928,6 +7025,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -7387,6 +7486,10 @@ node /org/freedesktop/systemd1/unit/home_2emount { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -7395,6 +7498,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -7497,6 +7602,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -7925,6 +8032,10 @@ node /org/freedesktop/systemd1/unit/home_2emount { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -7933,6 +8044,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -8037,6 +8150,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -8726,6 +8841,10 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -8734,6 +8853,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -8838,6 +8959,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -9283,6 +9406,10 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -9291,6 +9418,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -9393,6 +9522,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -9807,6 +9938,10 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -9815,6 +9950,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -9919,6 +10056,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -10467,6 +10606,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -10475,6 +10618,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -10579,6 +10724,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -10650,6 +10797,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -10658,6 +10809,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -10760,6 +10913,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -10838,6 +10993,10 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -10846,6 +11005,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -10950,6 +11111,8 @@ node /org/freedesktop/systemd1/unit/system_2eslice { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -11052,6 +11215,10 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryAvailable = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveMemoryHigh = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t CPUUsageNSec = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly ay EffectiveCPUs = [...]; @@ -11060,6 +11227,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t TasksCurrent = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly t EffectiveTasksMax = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressBytes = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t IPIngressPackets = ...; @@ -11164,6 +11333,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t StartupMemoryZSwapMax = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") + readonly b MemoryZSwapWriteback = ...; + @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly t MemoryLimit = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("false") readonly s DevicePolicy = '...'; @@ -11255,6 +11426,10 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <!--property MemoryZSwapCurrent is not documented!--> + <!--property EffectiveMemoryMax is not documented!--> + + <!--property EffectiveMemoryHigh is not documented!--> + <!--property CPUUsageNSec is not documented!--> <!--property EffectiveCPUs is not documented!--> @@ -11263,6 +11438,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <!--property TasksCurrent is not documented!--> + <!--property EffectiveTasksMax is not documented!--> + <!--property IPIngressBytes is not documented!--> <!--property IPIngressPackets is not documented!--> @@ -11365,6 +11542,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <!--property StartupMemoryZSwapMax is not documented!--> + <!--property MemoryZSwapWriteback is not documented!--> + <!--property MemoryLimit is not documented!--> <!--property DevicePolicy is not documented!--> @@ -11441,7 +11620,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <variablelist class="dbus-method" generated="True" extra-ref="AttachProcesses()"/> - <variablelist class="dbus-signal" generated="True" extra-ref="RequestStop"/> + <variablelist class="dbus-signal" generated="True" extra-ref="RequestStop()"/> <variablelist class="dbus-property" generated="True" extra-ref="Controller"/> @@ -11473,6 +11652,10 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <variablelist class="dbus-property" generated="True" extra-ref="MemoryAvailable"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryMax"/> + + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveMemoryHigh"/> + <variablelist class="dbus-property" generated="True" extra-ref="CPUUsageNSec"/> <variablelist class="dbus-property" generated="True" extra-ref="EffectiveCPUs"/> @@ -11481,6 +11664,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <variablelist class="dbus-property" generated="True" extra-ref="TasksCurrent"/> + <variablelist class="dbus-property" generated="True" extra-ref="EffectiveTasksMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="IPIngressBytes"/> <variablelist class="dbus-property" generated="True" extra-ref="IPIngressPackets"/> @@ -11585,6 +11770,8 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <variablelist class="dbus-property" generated="True" extra-ref="StartupMemoryZSwapMax"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryZSwapWriteback"/> + <variablelist class="dbus-property" generated="True" extra-ref="MemoryLimit"/> <variablelist class="dbus-property" generated="True" extra-ref="DevicePolicy"/> @@ -11658,7 +11845,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <refsect2> <title>Signals</title> - <para><function>RequestStop</function> is sent to the peer that is configured in the + <para><function>RequestStop()</function> is sent to the peer that is configured in the <varname>Controller</varname> property when systemd is requested to terminate the scope unit. A program registering a scope can use this to cleanly shut down the processes it added to the scope instead of letting systemd do it with the usual <constant>SIGTERM</constant> logic.</para> @@ -11670,7 +11857,7 @@ node /org/freedesktop/systemd1/unit/session_2d1_2escope { <para>All properties correspond directly with the matching properties of service units.</para> <para><varname>Controller</varname> contains the bus name (unique or well-known) that is notified when - the scope unit is to be shut down via a <function>RequestStop</function> signal (see below). This is + the scope unit is to be shut down via a <function>RequestStop()</function> signal (see below). This is set when the scope is created. If not set, the scope's processes will terminated with <constant>SIGTERM</constant> directly.</para> </refsect2> @@ -11826,6 +12013,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <function>QueueSignalUnit()</function>, <function>SoftReboot()</function>, and <function>DumpUnitFileDescriptorStore()</function> were added in version 254.</para> + <para><function>StartAuxiliaryScope()</function>, + <varname>ShutdownStartTimestamp</varname>, + <varname>ShutdownStartTimestampMonotonic</varname> and + <varname>SoftRebootsCount</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Unit Objects</title> @@ -11835,6 +12026,7 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>ActivationDetails</varname> were added in version 252.</para> <para><function>QueueSignal()</function> was added in version 254.</para> <para><varname>SurviveFinalKillSignal</varname> was added in version 255.</para> + <para><varname>WantsMountsFor</varname> was added in version 256.</para> </refsect2> <refsect2> <title>Service Unit Objects</title> @@ -11872,6 +12064,12 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, + <varname>MemoryZSwapWriteback</varname>, + <varname>ExecMainHandoffTimestampMonotonic</varname>, and + <varname>ExecMainHandoffTimestamp</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Socket Unit Objects</title> @@ -11903,6 +12101,11 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, + <varname>MemoryZSwapWriteback</varname>, and + <varname>PassFileDescriptorsToExec</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Mount Unit Objects</title> @@ -11932,6 +12135,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, and + <varname>MemoryZSwapWriteback</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Swap Unit Objects</title> @@ -11961,6 +12168,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, and + <varname>MemoryZSwapWriteback</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Slice Unit Objects</title> @@ -11981,6 +12192,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, and + <varname>MemoryZSwapWriteback</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Scope Unit Objects</title> @@ -12002,6 +12217,10 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>MemorySwapCurrent</varname>, <varname>MemorySwapPeak</varname>, and <varname>MemoryZSwapCurrent</varname> were added in version 255.</para> + <para><varname>EffectiveMemoryHigh</varname>, + <varname>EffectiveMemoryMax</varname>, + <varname>EffectiveTasksMax</varname>, and + <varname>MemoryZSwapWriteback</varname> were added in version 256.</para> </refsect2> <refsect2> <title>Job Objects</title> diff --git a/man/org.freedesktop.timedate1.xml b/man/org.freedesktop.timedate1.xml index 54f4018..1dfb630 100644 --- a/man/org.freedesktop.timedate1.xml +++ b/man/org.freedesktop.timedate1.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" > + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" > <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="org.freedesktop.timedate1" conditional='ENABLE_TIMEDATED' @@ -193,7 +193,7 @@ $ gdbus introspect --system \ <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> <refsect1> - <title>See also</title> + <title>See Also</title> <para><ulink url="https://lists.freedesktop.org/archives/systemd-devel/2011-May/002526.html">More information on how the system clock and RTC interact</ulink></para> </refsect1> diff --git a/man/os-release.xml b/man/os-release.xml index f2e0f3e..afdb21f 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="os-release" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -22,10 +22,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/os-release</filename></para> - <para><filename>/usr/lib/os-release</filename></para> - <para><filename>/etc/initrd-release</filename></para> - <para><filename>/usr/lib/extension-release.d/extension-release.<replaceable>IMAGE</replaceable></filename></para> + <para><simplelist> + <member><filename>/etc/os-release</filename></member> + <member><filename>/usr/lib/os-release</filename></member> + <member><filename>/etc/initrd-release</filename></member> + <member><filename>/usr/lib/extension-release.d/extension-release.<replaceable>IMAGE</replaceable></filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -60,7 +62,7 @@ compatibility with applications only looking at <filename>/etc/</filename>. A relative symlink instead of an absolute symlink is necessary to avoid breaking the link in a - chroot or initrd environment such as dracut.</para> + chroot or initrd environment.</para> <para><filename>os-release</filename> contains data that is defined by the operating system vendor and should generally not be @@ -638,13 +640,13 @@ VERSION_ID=32</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>lsb_release</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 50f44f0..d6fc6bb 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="pam_systemd" conditional='HAVE_PAM' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -90,11 +90,62 @@ <varlistentry> <term><varname>class=</varname></term> - <listitem><para>Takes a string argument which sets the session class. The <varname>XDG_SESSION_CLASS</varname> - environment variable (see below) takes precedence. One of <literal>user</literal>, <literal>greeter</literal>, - <literal>lock-screen</literal> or <literal>background</literal>. See - <citerefentry><refentrytitle>sd_session_get_class</refentrytitle><manvolnum>3</manvolnum></citerefentry> for - details about the session class.</para> + <listitem><para>Takes a string argument which sets the session class. The + <varname>XDG_SESSION_CLASS</varname> environment variable (see below) takes precedence. See + <citerefentry><refentrytitle>sd_session_get_class</refentrytitle><manvolnum>3</manvolnum></citerefentry> + for a way to query the class of a session. The following session classes are defined:</para> + + <table> + <title>Session Classes</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname="name" /> + <colspec colname="explanation" /> + <thead> + <row> + <entry>Name</entry> + <entry>Explanation</entry> + </row> + </thead> + <tbody> + <row> + <entry><constant>user</constant></entry> + <entry>A regular interactive user session. This is the default class for sessions for which a TTY or X display is known at session registration time.</entry> + </row> + <row> + <entry><constant>user-early</constant></entry> + <entry>Similar to <literal>user</literal> but sessions of this class are not ordered after <filename>systemd-user-sessions.service</filename>, i.e. may be started before regular sessions are allowed to be established. This session class is the default for sessions of the root user that would otherwise qualify for the <constant>user</constant> class, see above. (Added in v256.)</entry> + </row> + <row> + <entry><constant>user-incomplete</constant></entry> + <entry>Similar to <literal>user</literal> but for sessions which are not fully set up yet, i.e. have no home directory mounted or similar. This is used by <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> to allow users to log in via <command>ssh</command> before their home directory is mounted, delaying the mount until the user provided the unlock password. Sessions of this class are upgraded to the regular <constant>user</constant> class once the home directory is activated.</entry> + </row> + <row> + <entry><constant>greeter</constant></entry> + <entry>Similar to <literal>user</literal> but for sessions that are spawned by a display manager ephemerally and which prompt the user for login credentials.</entry> + </row> + <row> + <entry><constant>lock-screen</constant></entry> + <entry>Similar to <literal>user</literal> but for sessions that are spawned by a display manager ephemerally and which show a lock screen that can be used to unlock locked user accounts or sessions.</entry> + </row> + <row> + <entry><constant>background</constant></entry> + <entry>Used for background sessions, such as those invoked by <command>cron</command> and similar tools. This is the default class for sessions for which no TTY or X display is known at session registration time.</entry> + </row> + <row> + <entry><constant>background-light</constant></entry> + <entry>Similar to <constant>background</constant>, but sessions of this class will not pull in the <filename>user@.service</filename> of the user, and thus possibly have no services of the user running. (Added in v256.)</entry> + </row> + <row> + <entry><constant>manager</constant></entry> + <entry>The <filename>user@.service</filename> service of the user is registered under this session class. (Added in v256.)</entry> + </row> + <row> + <entry><constant>manager-early</constant></entry> + <entry>Similar to <constant>manager</constant>, but for the root user. Compare with the <constant>user</constant> vs. <constant>user-early</constant> situation. (Added in v256.)</entry> + </row> + </tbody> + </tgroup> + </table> <xi:include href="version-info.xml" xpointer="v197"/></listitem> </varlistentry> @@ -376,20 +427,20 @@ session required pam_unix.so</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>pam_systemd_home</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>pam_systemd_home</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam_loginuid</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/pam_systemd_home.xml b/man/pam_systemd_home.xml index dd28de1..5bd48de 100644 --- a/man/pam_systemd_home.xml +++ b/man/pam_systemd_home.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="pam_systemd_home" conditional='ENABLE_PAM_HOME' @@ -170,16 +170,16 @@ session required pam_unix.so</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/pam_systemd_loadkey.xml b/man/pam_systemd_loadkey.xml index afb41f3..13d1686 100644 --- a/man/pam_systemd_loadkey.xml +++ b/man/pam_systemd_loadkey.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="pam_systemd_loadkey" conditional='HAVE_PAM' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -49,9 +49,47 @@ <term><varname>keyname=</varname></term> <listitem><para>Takes a string argument which sets the keyname to read. - The default is <literal>cryptsetup</literal>, which is used by + The default is <literal>cryptsetup</literal>. + During boot, <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - to store LUKS passphrase during boot.</para> + stores a passphrase or PIN in the keyring. + The LUKS2 volume key can also be used, via the <option>link-volume-key</option> option in + <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <table> + <title> + Possible values for <varname>keyname</varname>. + </title> + + <tgroup cols='2'> + <colspec colname='value' /> + <colspec colname='description' /> + <thead> + <row> + <entry>Value</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>cryptsetup</entry> + <entry>Passphrase or recovery key</entry> + </row> + <row> + <entry>fido2-pin</entry> + <entry>Security token PIN</entry> + </row> + <row> + <entry>luks2-pin</entry> + <entry>LUKS2 token PIN</entry> + </row> + <row> + <entry>tpm2-pin</entry> + <entry>TPM2 PIN</entry> + </row> + </tbody> + </tgroup> + </table> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> @@ -78,6 +116,7 @@ <programlisting> -auth optional pam_systemd_loadkey.so +-auth optional pam_gnome_keyring.so -session optional pam_gnome_keyring.so auto_start -session optional pam_kwallet5.so auto_start </programlisting> diff --git a/man/portablectl.xml b/man/portablectl.xml index c1946d7..92d8ff0 100644 --- a/man/portablectl.xml +++ b/man/portablectl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="portablectl" conditional='ENABLE_PORTABLED' @@ -141,6 +141,8 @@ immediately started (blocking operation unless <option>--no-block</option> is passed) and/or enabled after attaching the image.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="vpick.xml" xpointer="directory"/> <xi:include href="version-info.xml" xpointer="v239"/> </listitem> </varlistentry> @@ -155,11 +157,11 @@ files. This is a convenience feature to allow all arguments passed as <command>attach</command> also to <command>detach</command>.</para> - <xi:include href="version-info.xml" xpointer="v239"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped (blocking operation) and/or disabled before detaching the image. Prefix(es) are also accepted, to be used in case the unit names do not match the image name as described in the <command>attach</command>.</para> + + <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> <varlistentry> @@ -171,11 +173,11 @@ character has to match. If the new image doesn't exist, the existing one will not be detached. The parameters follow the same syntax as the <command>attach</command> command.</para> - <xi:include href="version-info.xml" xpointer="v248"/></listitem> - <para>If <option>--now</option> and/or <option>--enable</option> are passed, the portable services are immediately stopped if removed, started and/or enabled if added, or restarted if updated. Prefixes are also accepted, in the same way as described in the <command>attach</command> case.</para> + + <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> <varlistentry> @@ -310,7 +312,7 @@ <varlistentry> <term><option>-p</option> <replaceable>PROFILE</replaceable></term> - <term><option>--profile=</option><replaceable>PROFILE</replaceable></term> + <term><option>--profile=<replaceable>PROFILE</replaceable></option></term> <listitem><para>When attaching an image, select the profile to use. By default the <literal>default</literal> profile is used. For details about profiles, see below.</para> @@ -321,12 +323,14 @@ <varlistentry> <term><option>--copy=</option></term> - <listitem><para>When attaching an image, select whether to prefer copying or symlinking of files installed into - the host system. Takes one of <literal>copy</literal> (to prefer copying of files), <literal>symlink</literal> - (to prefer creation of symbolic links) or <literal>auto</literal> for an intermediary mode where security - profile drop-ins are symlinked while unit files are copied. Note that this option expresses a preference only, - in cases where symbolic links cannot be created — for example when the image operated on is a raw disk image, - and hence not directly referentiable from the host file system — copying of files is used + <listitem><para>When attaching an image, select whether to prefer copying or symlinking of files + installed into the host system. Takes one of <literal>copy</literal> (files will be copied), + <literal>symlink</literal> (to prefer creation of symbolic links), <literal>auto</literal> for an + intermediary mode where security profile drop-ins and images are symlinked while unit files are + copied, or <literal>mixed</literal> (since v256) where security profile drop-ins are symlinked while + unit files and images are copied. Note that this option expresses a preference only, in cases where + symbolic links cannot be created — for example when the image operated on is a raw disk image, and + hence not directly referentiable from the host file system — copying of files is used unconditionally.</para> <xi:include href="version-info.xml" xpointer="v239"/></listitem> @@ -390,7 +394,16 @@ </varlistentry> <varlistentry> - <term><option>--extension=</option><replaceable>PATH</replaceable></term> + <term><option>--clean</option></term> + + <listitem><para>When detaching ensure the configuration, state, logs, cache, and runtime data + directories of the portable service are removed from the host system.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--extension=<replaceable>PATH</replaceable></option></term> <listitem><para>Add an additional image <replaceable>PATH</replaceable> as an overlay on top of <replaceable>IMAGE</replaceable> when attaching/detaching. This argument can be specified @@ -410,6 +423,8 @@ <para>Note that the same extensions have to be specified, in the same order, when attaching and detaching.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="vpick.xml" xpointer="directory"/> <xi:include href="version-info.xml" xpointer="v249"/></listitem> </varlistentry> @@ -504,12 +519,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/poweroff.xml b/man/poweroff.xml index 4abfa18..501db12 100644 --- a/man/poweroff.xml +++ b/man/poweroff.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="poweroff" @@ -55,9 +55,11 @@ <varlistentry> <term><option>--help</option></term> - <xi:include href="standard-options.xml" xpointer="help-text" /> + <listitem> + <xi:include href="standard-options.xml" xpointer="help-para" /> - <xi:include href="version-info.xml" xpointer="v253"/> + <xi:include href="version-info.xml" xpointer="v253"/> + </listitem> </varlistentry> <varlistentry> @@ -165,12 +167,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>shutdown</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/print-unit-path-call-method.c b/man/print-unit-path-call-method.c index f73dd07..15e8d3f 100644 --- a/man/print-unit-path-call-method.c +++ b/man/print-unit-path-call-method.c @@ -21,8 +21,7 @@ #define MEMBER "GetUnitByPID" static int log_error(int error, const char *message) { - errno = -error; - fprintf(stderr, "%s: %m\n", message); + fprintf(stderr, "%s: %s\n", message, strerror(-error)); return error; } diff --git a/man/print-unit-path.c b/man/print-unit-path.c index 0b89318..737244f 100644 --- a/man/print-unit-path.c +++ b/man/print-unit-path.c @@ -21,8 +21,7 @@ #define MEMBER "GetUnitByPID" static int log_error(int error, const char *message) { - errno = -error; - fprintf(stderr, "%s: %m\n", message); + fprintf(stderr, "%s: %s\n", message, strerror(-error)); return error; } diff --git a/man/pstore.conf.xml b/man/pstore.conf.xml index f54cef9..6173765 100644 --- a/man/pstore.conf.xml +++ b/man/pstore.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="pstore.conf" conditional="ENABLE_PSTORE" @@ -22,10 +22,16 @@ </refnamediv> <refsynopsisdiv> - <para> - <filename>/etc/systemd/pstore.conf</filename> - <filename>/etc/systemd/pstore.conf.d/*</filename> - </para> + <para><simplelist> + <member><filename>/etc/systemd/pstore.conf</filename></member> + <member><filename>/run/systemd/pstore.conf</filename></member> + <member><filename>/usr/local/lib/systemd/pstore.conf</filename></member> + <member><filename>/usr/lib/systemd/pstore.conf</filename></member> + <member><filename>/etc/systemd/pstore.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/pstore.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/pstore.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/pstore.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> diff --git a/man/repart.d.xml b/man/repart.d.xml index efca8d5..52e6b97 100644 --- a/man/repart.d.xml +++ b/man/repart.d.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="repart.d" conditional='ENABLE_REPART' @@ -22,10 +22,12 @@ </refnamediv> <refsynopsisdiv> - <para><literallayout><filename>/etc/repart.d/*.conf</filename> -<filename>/run/repart.d/*.conf</filename> -<filename>/usr/lib/repart.d/*.conf</filename> - </literallayout></para> + <para><simplelist> + <member><filename>/etc/repart.d/*.conf</filename></member> + <member><filename>/run/repart.d/*.conf</filename></member> + <member><filename>/usr/local/lib/repart.d/*.conf</filename></member> + <member><filename>/usr/lib/repart.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -551,6 +553,22 @@ </varlistentry> <varlistentry> + <term><varname>DefaultSubvolume=</varname></term> + + <listitem><para>Takes an absolute path specifying the default subvolume within the new filesystem. + Note that this setting does not create the subvolume itself, that can be configured with + <varname>Subvolumes=</varname>.</para> + + <para>Note that this option only takes effect if the target filesystem supports subvolumes, such as + <literal>btrfs</literal>.</para> + + <para>Note that due to limitations of <literal>mkfs.btrfs</literal>, this option is only supported + when running with <option>--offline=no</option>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>Encrypt=</varname></term> <listitem><para>Takes one of <literal>off</literal>, <literal>key-file</literal>, @@ -733,6 +751,42 @@ <xi:include href="version-info.xml" xpointer="v253"/></listitem> </varlistentry> + + <varlistentry> + <term><varname>MountPoint=</varname></term> + + <listitem><para>Specifies where and how the partition should be mounted. Takes at least one and at + most two fields separated with a colon (<literal>:</literal>). The first field specifies where the + partition should be mounted. The second field specifies extra mount options to append to the default + mount options. These fields correspond to the second and fourth column of the + <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry> + format. This setting may be specified multiple times to mount the partition multiple times. This can + be used to add mounts for different btrfs subvolumes located on the same btrfs partition.</para> + + <para>Note that this setting is only taken into account when <option>--generate-fstab=</option> is + specified on the <command>systemd-repart</command> command line.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>EncryptedVolume=</varname></term> + + <listitem><para>Specify how the encrypted partition should be set up. Takes at least one and at most + three fields separated with a colon (<literal>:</literal>). The first field specifies the encrypted + volume name under <filename>/dev/mapper/</filename>. If not specified, <literal>luks-UUID</literal> + will be used where <literal>UUID</literal> is the LUKS UUID. The second field specifies the keyfile + to use following the same format as specified in crypttab. The third field specifies a + comma-delimited list of crypttab options. These fields correspond to the first, third and fourth + column of the + <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry> format. + </para> + + <para>Note that this setting is only taken into account when <option>--generate-crypttab=</option> + is specified on the <command>systemd-repart</command> command line.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> @@ -817,6 +871,19 @@ </refsect1> <refsect1> + <title>Environment</title> + + <para>Extra filesystem formatting options can be provided using filesystem-specific environment variables: + <varname>$SYSTEMD_REPART_MKFS_OPTIONS_BTRFS</varname>, <varname>$SYSTEMD_REPART_MKFS_OPTIONS_XFS</varname>, + <varname>$SYSTEMD_REPART_MKFS_OPTIONS_VFAT</varname>, <varname>$SYSTEMD_REPART_MKFS_OPTIONS_EROFS</varname>, + and <varname>$SYSTEMD_REPART_MKFS_OPTIONS_SQUASHFS</varname>. Each variable accepts valid + <command>mkfs.<replaceable>filesystem</replaceable></command> command-line arguments. + The content of those variables is passed as-is to the command, without any verification. + </para> + + </refsect1> + + <refsect1> <title>Examples</title> <example> @@ -925,12 +992,12 @@ VerityMatchKey=root <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sfdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sfdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/resolvectl.xml b/man/resolvectl.xml index 4498732..ed656b4 100644 --- a/man/resolvectl.xml +++ b/man/resolvectl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="resolvectl" conditional='ENABLE_RESOLVE' @@ -69,6 +69,9 @@ <option>--type=</option>/<option>--class=</option> is used IDNA translation is turned off and domain names are processed as specified.</para> + <para>If combined with <option>--json=</option> (only supported in combination with + <option>--type=</option>) will output the resource record data in a JSON object.</para> + <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> @@ -275,7 +278,7 @@ <varlistentry> <term><option>-i</option> <replaceable>INTERFACE</replaceable></term> - <term><option>--interface=</option><replaceable>INTERFACE</replaceable></term> + <term><option>--interface=<replaceable>INTERFACE</replaceable></option></term> <listitem><para>Specifies the network interface to execute the query on. This may either be specified as numeric interface index or as network interface string (e.g. <literal>en0</literal>). Note that this option has no @@ -287,7 +290,7 @@ <varlistentry> <term><option>-p</option> <replaceable>PROTOCOL</replaceable></term> - <term><option>--protocol=</option><replaceable>PROTOCOL</replaceable></term> + <term><option>--protocol=<replaceable>PROTOCOL</replaceable></option></term> <listitem><para>Specifies the network protocol for the query. May be one of <literal>dns</literal> (i.e. classic unicast DNS), <literal>llmnr</literal> (<ulink @@ -309,9 +312,9 @@ <varlistentry> <term><option>-t</option> <replaceable>TYPE</replaceable></term> - <term><option>--type=</option><replaceable>TYPE</replaceable></term> + <term><option>--type=<replaceable>TYPE</replaceable></option></term> <term><option>-c</option> <replaceable>CLASS</replaceable></term> - <term><option>--class=</option><replaceable>CLASS</replaceable></term> + <term><option>--class=<replaceable>CLASS</replaceable></option></term> <listitem><para>When used in conjunction with the <command>query</command> command, specifies the DNS resource record type (e.g. <constant class='dns'>A</constant>, <constant class='dns'>AAAA</constant>, @@ -332,7 +335,7 @@ </varlistentry> <varlistentry> - <term><option>--service-address=</option><replaceable>BOOL</replaceable></term> + <term><option>--service-address=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter. If true (the default), when doing a service lookup with <option>--service</option> the hostnames contained in the <constant class='dns'>SRV</constant> @@ -342,7 +345,7 @@ </varlistentry> <varlistentry> - <term><option>--service-txt=</option><replaceable>BOOL</replaceable></term> + <term><option>--service-txt=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter. If true (the default), when doing a DNS-SD service lookup with <option>--service</option> the <constant class='dns'>TXT</constant> service metadata record is @@ -352,7 +355,7 @@ </varlistentry> <varlistentry> - <term><option>--cname=</option><replaceable>BOOL</replaceable></term> + <term><option>--cname=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter. If true (the default), DNS <constant class='dns'>CNAME</constant> or <constant class='dns'>DNAME</constant> redirections are @@ -363,7 +366,7 @@ </varlistentry> <varlistentry> - <term><option>--validate=</option><replaceable>BOOL</replaceable></term> + <term><option>--validate=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), DNSSEC validation is applied as usual — under the condition that it is enabled for the @@ -377,7 +380,7 @@ </varlistentry> <varlistentry> - <term><option>--synthesize=</option><replaceable>BOOL</replaceable></term> + <term><option>--synthesize=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), select domains are resolved on the local system, among them @@ -392,7 +395,7 @@ </varlistentry> <varlistentry> - <term><option>--cache=</option><replaceable>BOOL</replaceable></term> + <term><option>--cache=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), lookups use the local DNS resource record cache. If false, lookups are routed to the @@ -402,7 +405,7 @@ </varlistentry> <varlistentry> - <term><option>--zone=</option><replaceable>BOOL</replaceable></term> + <term><option>--zone=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), lookups are answered from locally registered LLMNR or mDNS resource records, if @@ -413,7 +416,7 @@ </varlistentry> <varlistentry> - <term><option>--trust-anchor=</option><replaceable>BOOL</replaceable></term> + <term><option>--trust-anchor=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), lookups for DS and DNSKEY are answered from the local DNSSEC trust anchors if @@ -423,7 +426,7 @@ </varlistentry> <varlistentry> - <term><option>--network=</option><replaceable>BOOL</replaceable></term> + <term><option>--network=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), lookups are answered via DNS, LLMNR or mDNS network requests if they cannot be @@ -435,7 +438,7 @@ </varlistentry> <varlistentry> - <term><option>--search=</option><replaceable>BOOL</replaceable></term> + <term><option>--search=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter. If true (the default), any specified single-label hostnames will be searched in the domains configured in the search domain list, if it is @@ -459,7 +462,7 @@ </varlistentry> <varlistentry> - <term><option>--legend=</option><replaceable>BOOL</replaceable></term> + <term><option>--legend=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter. If true (the default), column headers and meta information about the query response are shown. Otherwise, this output is suppressed.</para> @@ -468,7 +471,7 @@ </varlistentry> <varlistentry> - <term><option>--stale-data=</option><replaceable>BOOL</replaceable></term> + <term><option>--stale-data=<replaceable>BOOL</replaceable></option></term> <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If true (the default), lookups are answered with stale data (expired resource records) if @@ -477,16 +480,23 @@ <xi:include href="version-info.xml" xpointer="v254"/></listitem> </varlistentry> - <xi:include href="standard-options.xml" xpointer="json" /> - <varlistentry> - <term><option>-j</option></term> + <term><option>--relax-single-label=<replaceable>BOOL</replaceable></option></term> - <listitem><para>Short for <option>--json=auto</option></para> + <listitem><para>Takes a boolean parameter; used in conjunction with <command>query</command>. If + true, rules regarding routing of single-label names are relaxed. Defaults to false. By default, + lookups of single label names are assumed to refer to local hosts to be resolved via local resolution + such as LLMNR or via search domain qualification and are not routed to upstream servers as is. If + this option is enabled these rules are disabled and the queries are routed upstream anyway. Also see + the <varname>ResolveUnicastSingleLabel=</varname> option in + <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + which provides a system-wide option that controls this behaviour.</para> - <xi:include href="version-info.xml" xpointer="v252"/></listitem> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> + <xi:include href="standard-options.xml" xpointer="json" /> + <xi:include href="standard-options.xml" xpointer="j" /> <xi:include href="standard-options.xml" xpointer="no-pager" /> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> @@ -669,12 +679,12 @@ _443._tcp.fedoraproject.org IN TLSA 0 0 1 19400be5b7a31fb733917700789d2f0a2471c0 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.dnssd</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.dnssd</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/resolved.conf.xml b/man/resolved.conf.xml index d153865..65dd83f 100644 --- a/man/resolved.conf.xml +++ b/man/resolved.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -25,10 +25,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/resolved.conf</filename></para> - <para><filename>/etc/systemd/resolved.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/resolved.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/resolved.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/resolved.conf</filename></member> + <member><filename>/run/systemd/resolved.conf</filename></member> + <member><filename>/usr/local/lib/systemd/resolved.conf</filename></member> + <member><filename>/usr/lib/systemd/resolved.conf</filename></member> + <member><filename>/etc/systemd/resolved.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/resolved.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/resolved.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/resolved.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -168,9 +174,7 @@ downgrade to non-DNSSEC mode by synthesizing a DNS response that suggests DNSSEC was not supported.</para> - <para>If set to false, DNS lookups are not DNSSEC validated. In this mode, or when set to - <literal>allow-downgrade</literal> and the downgrade has happened, the resolver becomes - security-unaware and all forwarded queries have DNSSEC OK (DO) bit unset.</para> + <para>If set to false, DNS lookups are not DNSSEC validated.</para> <para>Note that DNSSEC validation requires retrieval of additional DNS data, and thus results in a small DNS lookup time penalty.</para> @@ -394,13 +398,13 @@ DNSStubListenerExtra=udp:[2001:db8:0:f102::13]:9953</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/rules/meson.build b/man/rules/meson.build index 5dc3e08..a9a2a25 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -5,9 +5,10 @@ # ninja -C build update-man-rules manpages = [ ['binfmt.d', '5', [], 'ENABLE_BINFMT'], - ['bootctl', '1', [], 'ENABLE_BOOTLOADER'], + ['bootctl', '1', [], ''], ['bootup', '7', [], ''], ['busctl', '1', [], ''], + ['capsule@.service', '5', [], ''], ['coredump.conf', '5', ['coredump.conf.d'], 'ENABLE_COREDUMP'], ['coredumpctl', '1', [], 'ENABLE_COREDUMP'], ['crypttab', '5', [], 'HAVE_LIBCRYPTSETUP'], @@ -18,11 +19,12 @@ manpages = [ 'ENABLE_RESOLVE'], ['environment.d', '5', [], 'ENABLE_ENVIRONMENT_D'], ['file-hierarchy', '7', [], ''], - ['homectl', '1', [], 'ENABLE_HOMED'], + ['homectl', '1', ['systemd-homed-firstboot.service'], 'ENABLE_HOMED'], ['homed.conf', '5', ['homed.conf.d'], 'ENABLE_HOMED'], ['hostname', '5', [], ''], ['hostnamectl', '1', [], 'ENABLE_HOSTNAMED'], ['hwdb', '7', [], 'ENABLE_HWDB'], + ['importctl', '1', [], 'ENABLE_MACHINED'], ['integritytab', '5', [], 'HAVE_LIBCRYPTSETUP'], ['iocost.conf', '5', [], ''], ['journal-remote.conf', '5', ['journal-remote.conf.d'], 'HAVE_MICROHTTPD'], @@ -74,6 +76,7 @@ manpages = [ ['repart.d', '5', [], 'ENABLE_REPART'], ['resolvectl', '1', ['resolvconf'], 'ENABLE_RESOLVE'], ['resolved.conf', '5', ['resolved.conf.d'], 'ENABLE_RESOLVE'], + ['run0', '1', [], ''], ['runlevel', '8', [], 'HAVE_SYSV_COMPAT'], ['sd-bus-errors', '3', @@ -202,6 +205,7 @@ manpages = [ 'sd_bus_creds_get_fsuid', 'sd_bus_creds_get_gid', 'sd_bus_creds_get_owner_uid', + 'sd_bus_creds_get_pidfd_dup', 'sd_bus_creds_get_ppid', 'sd_bus_creds_get_selinux_context', 'sd_bus_creds_get_session', @@ -227,6 +231,7 @@ manpages = [ '3', ['sd_bus_creds_get_augmented_mask', 'sd_bus_creds_get_mask', + 'sd_bus_creds_new_from_pidfd', 'sd_bus_creds_ref', 'sd_bus_creds_unref', 'sd_bus_creds_unrefp'], @@ -548,7 +553,8 @@ manpages = [ '3', ['sd_event_add_inotify_fd', 'sd_event_inotify_handler_t', - 'sd_event_source_get_inotify_mask'], + 'sd_event_source_get_inotify_mask', + 'sd_event_source_get_inotify_path'], ''], ['sd_event_add_io', '3', @@ -792,7 +798,7 @@ manpages = [ 'sd_journal_seek_realtime_usec', 'sd_journal_seek_tail'], ''], - ['sd_journal_stream_fd', '3', [], ''], + ['sd_journal_stream_fd', '3', ['sd_journal_stream_fd_with_namespace'], ''], ['sd_listen_fds', '3', ['SD_LISTEN_FDS_START', 'sd_listen_fds_with_names'], @@ -897,14 +903,14 @@ manpages = [ ['systemd-bless-boot.service', '8', ['systemd-bless-boot'], - 'ENABLE_BOOTLOADER'], + 'ENABLE_BOOTLOADER HAVE_BLKID'], ['systemd-boot-check-no-failures.service', '8', ['systemd-boot-check-no-failures'], ''], ['systemd-boot-random-seed.service', '8', [], 'ENABLE_BOOTLOADER'], ['systemd-boot', '7', ['sd-boot'], 'ENABLE_BOOTLOADER'], - ['systemd-bsod.service', '8', ['systemd-bsod'], 'HAVE_QRENCODE'], + ['systemd-bsod.service', '8', ['systemd-bsod'], 'HAVE_QRENCODE ENABLE_INITRD'], ['systemd-cat', '1', [], ''], ['systemd-cgls', '1', [], ''], ['systemd-cgtop', '1', [], ''], @@ -939,7 +945,7 @@ manpages = [ ['systemd-hibernate-resume-generator', '8', [], 'ENABLE_HIBERNATE'], ['systemd-hibernate-resume.service', '8', - ['systemd-hibernate-resume'], + ['systemd-hibernate-clear.service', 'systemd-hibernate-resume'], 'ENABLE_HIBERNATE'], ['systemd-homed.service', '8', ['systemd-homed'], 'ENABLE_HOMED'], ['systemd-hostnamed.service', '8', ['systemd-hostnamed'], 'ENABLE_HOSTNAMED'], @@ -959,15 +965,15 @@ manpages = [ ['systemd-journal-gatewayd.service', '8', ['systemd-journal-gatewayd', 'systemd-journal-gatewayd.socket'], - 'HAVE_MICROHTTPD'], + 'ENABLE_REMOTE HAVE_MICROHTTPD'], ['systemd-journal-remote.service', '8', ['systemd-journal-remote', 'systemd-journal-remote.socket'], - 'HAVE_MICROHTTPD'], + 'ENABLE_REMOTE HAVE_MICROHTTPD'], ['systemd-journal-upload.service', '8', ['systemd-journal-upload'], - 'HAVE_MICROHTTPD'], + 'ENABLE_REMOTE HAVE_LIBCURL'], ['systemd-journald.service', '8', ['systemd-journald', @@ -991,9 +997,10 @@ manpages = [ 'systemd-makefs', 'systemd-mkswap@.service'], ''], - ['systemd-measure', '1', [], 'ENABLE_BOOTLOADER'], + ['systemd-measure', '1', [], 'HAVE_TPM2 HAVE_BLKID HAVE_OPENSSL'], ['systemd-modules-load.service', '8', ['systemd-modules-load'], 'HAVE_KMOD'], ['systemd-mount', '1', ['systemd-umount'], ''], + ['systemd-mountfsd.service', '8', ['systemd-mountfsd'], 'ENABLE_MOUNTFSD'], ['systemd-network-generator.service', '8', ['systemd-network-generator'], ''], ['systemd-networkd-wait-online.service', '8', @@ -1002,6 +1009,10 @@ manpages = [ ['systemd-networkd.service', '8', ['systemd-networkd'], 'ENABLE_NETWORKD'], ['systemd-notify', '1', [], ''], ['systemd-nspawn', '1', [], ''], + ['systemd-nsresourced.service', + '8', + ['systemd-nsresourced'], + 'ENABLE_NSRESOURCED'], ['systemd-oomd.service', '8', ['systemd-oomd'], 'ENABLE_OOMD'], ['systemd-path', '1', [], ''], ['systemd-pcrlock', @@ -1013,7 +1024,7 @@ manpages = [ 'systemd-pcrlock-make-policy.service', 'systemd-pcrlock-secureboot-authority.service', 'systemd-pcrlock-secureboot-policy.service'], - 'ENABLE_BOOTLOADER'], + 'ENABLE_BOOTLOADER HAVE_OPENSSL HAVE_TPM2'], ['systemd-pcrphase.service', '8', ['systemd-pcrextend', @@ -1022,7 +1033,7 @@ manpages = [ 'systemd-pcrmachine.service', 'systemd-pcrphase-initrd.service', 'systemd-pcrphase-sysinit.service'], - 'ENABLE_BOOTLOADER'], + 'ENABLE_BOOTLOADER HAVE_OPENSSL HAVE_TPM2'], ['systemd-portabled.service', '8', ['systemd-portabled'], 'ENABLE_PORTABLED'], ['systemd-poweroff.service', '8', @@ -1054,6 +1065,8 @@ manpages = [ ['systemd-socket-activate', '1', [], ''], ['systemd-socket-proxyd', '8', [], ''], ['systemd-soft-reboot.service', '8', [], ''], + ['systemd-ssh-generator', '8', [], ''], + ['systemd-ssh-proxy', '1', [], ''], ['systemd-stdio-bridge', '1', [], ''], ['systemd-storagetm.service', '8', ['systemd-storagetm'], 'ENABLE_STORAGETM'], ['systemd-stub', @@ -1071,7 +1084,7 @@ manpages = [ ['systemd-sysext', '8', ['systemd-confext', 'systemd-confext.service', 'systemd-sysext.service'], - ''], + 'ENABLE_SYSEXT'], ['systemd-system-update-generator', '8', [], ''], ['systemd-system.conf', '5', @@ -1100,6 +1113,7 @@ manpages = [ 'systemd-tmpfiles-setup-dev.service', 'systemd-tmpfiles-setup.service'], ''], + ['systemd-tpm2-generator', '8', [], ''], ['systemd-tpm2-setup.service', '8', ['systemd-tpm2-setup', 'systemd-tpm2-setup-early.service'], @@ -1130,6 +1144,7 @@ manpages = [ 'HAVE_LIBCRYPTSETUP'], ['systemd-vmspawn', '1', [], 'ENABLE_VMSPAWN'], ['systemd-volatile-root.service', '8', ['systemd-volatile-root'], ''], + ['systemd-vpick', '1', [], ''], ['systemd-xdg-autostart-generator', '8', [], 'ENABLE_XDG_AUTOSTART'], ['systemd', '1', ['init'], ''], ['systemd.automount', '5', [], ''], @@ -1164,6 +1179,7 @@ manpages = [ ['systemd.time', '7', [], ''], ['systemd.timer', '5', [], ''], ['systemd.unit', '5', [], ''], + ['systemd.v', '7', [], ''], ['sysupdate.d', '5', [], 'ENABLE_SYSUPDATE'], ['sysusers.d', '5', [], 'ENABLE_SYSUSERS'], ['telinit', '8', [], 'HAVE_SYSV_COMPAT'], @@ -1171,7 +1187,7 @@ manpages = [ ['timesyncd.conf', '5', ['timesyncd.conf.d'], 'ENABLE_TIMESYNCD'], ['tmpfiles.d', '5', [], ''], ['udev', '7', [], ''], - ['udev.conf', '5', [], ''], + ['udev.conf', '5', ['udev.conf.d'], ''], ['udev_device_get_syspath', '3', ['udev_device_get_action', diff --git a/man/run0.xml b/man/run0.xml new file mode 100644 index 0000000..d7460d9 --- /dev/null +++ b/man/run0.xml @@ -0,0 +1,279 @@ +<?xml version='1.0'?> +<!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="run0" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>run0</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>run0</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>run0</refname> + <refpurpose>Elevate privileges</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>run0</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="opt" rep="repeat">COMMAND</arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>run0</command> may be used to temporarily and interactively acquire elevated or different + privileges. It serves a similar purpose as <citerefentry + project='man-pages'><refentrytitle>sudo</refentrytitle><manvolnum>8</manvolnum></citerefentry>, but + operates differently in a couple of key areas:</para> + + <itemizedlist> + <listitem><para>No execution or security context credentials are inherited from the caller into the + invoked commands, as they are invoked from a fresh, isolated service forked off by the service manager. + </para></listitem> + + <listitem><para>Authentication takes place via <ulink + url="https://www.freedesktop.org/wiki/Software/polkit">polkit</ulink>, thus isolating the + authentication prompt from the terminal (if possible).</para></listitem> + + <listitem><para>An independent pseudo-tty is allocated for the invoked command, detaching its lifecycle and + isolating it for security.</para></listitem> + + <listitem><para>No SetUID/SetGID file access bit functionality is used for the implementation.</para></listitem> + </itemizedlist> + + <para>Altogether this should provide a safer and more robust alternative to the <command>sudo</command> + mechanism, in particular in OS environments where SetUID/SetGID support is not available (for example by + setting the <varname>NoNewPrivileges=</varname> variable in + <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para> + + <para>Any session invoked via <command>run0</command> will run through the + <literal>systemd-run0</literal> PAM stack.</para> + + <para>Note that <command>run0</command> is implemented as an alternative multi-call invocation of + <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>--no-ask-password</option></term> + + <listitem><para>Do not query the user for authentication for privileged operations.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--unit=</option></term> + + <listitem><para>Use this unit name instead of an automatically generated one.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--property=</option></term> + + <listitem><para>Sets a property on the service unit that is created. This option takes an assignment + in the same format as + <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s + <command>set-property</command> command.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--description=</option></term> + + <listitem><para>Provide a description for the service unit that is invoked. If not specified, + the command itself will be used as a description. See <varname>Description=</varname> in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--slice=</option></term> + + <listitem><para>Make the new <filename>.service</filename> unit part of the specified slice, instead + of <filename>user.slice</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--slice-inherit</option></term> + + <listitem><para>Make the new <filename>.service</filename> unit part of the slice the + <command>run0</command> itself has been invoked in. This option may be combined with + <option>--slice=</option>, in which case the slice specified via <option>--slice=</option> is placed + within the slice the <command>run0</command> command is invoked in.</para> + + <para>Example: consider <command>run0</command> being invoked in the slice + <filename>foo.slice</filename>, and the <option>--slice=</option> argument is + <filename>bar</filename>. The unit will then be placed under + <filename>foo-bar.slice</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--user=</option></term> + <term><option>-u</option></term> + <term><option>--group=</option></term> + <term><option>-g</option></term> + + <listitem><para>Switches to the specified user/group instead of root.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--nice=</option></term> + + <listitem><para>Runs the invoked session with the specified nice level.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--chdir=</option></term> + <term><option>-D</option></term> + + <listitem><para>Runs the invoked session with the specified working directory. If not specified + defaults to the client's current working directory if switching to the root user, or the target + user's home directory otherwise.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--setenv=<replaceable>NAME</replaceable>[=<replaceable>VALUE</replaceable>]</option></term> + + <listitem><para>Runs the invoked session with the specified environment variable set. This parameter + may be used more than once to set multiple variables. When <literal>=</literal> and + <replaceable>VALUE</replaceable> are omitted, the value of the variable with the same name in the + invoking environment will be used.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--background=<replaceable>COLOR</replaceable></option></term> + + <listitem><para>Change the terminal background color to the specified ANSI color as long as the + session lasts. If not specified, the background will be tinted in a reddish tone when operating as + root, and in a yellowish tone when operating under another UID, as reminder of the changed + privileges. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such as + <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>, + <literal>48;5;…</literal>. See <ulink + url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI + Escape Code (Wikipedia)</ulink> for details. Set to an empty string to disable.</para> + + <para>Example: <literal>--background=44</literal> for a blue background.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--machine=</option></term> + + <listitem> + <para>Execute operation on a local container. Specify a container name to connect to.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <xi:include href="standard-options.xml" xpointer="help" /> + <xi:include href="standard-options.xml" xpointer="version" /> + </variablelist> + + <para>All command line arguments after the first non-option argument become part of the command line of + the launched process. If no command line is specified an interactive shell is invoked. The shell to + invoke may be controlled via <option>--setenv=SHELL=…</option> and currently defaults to the + <emphasis>originating user's</emphasis> shell (i.e. not the target user's!) if operating locally, or + <filename>/bin/sh</filename> when operating with <option>--machine=</option>.</para> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success, 0 is returned. If <command>run0</command> failed to start the session or the specified command fails, a + non-zero return value will be returned.</para> + </refsect1> + + <refsect1> + <title>Environment Variables</title> + + <para>As with <command>systemd-run</command>, the session will inherit the system + environment from the service manager. In addition, the following environment variables will be set:</para> + + <variablelist> + <varlistentry> + <term><varname>$TERM</varname></term> + <listitem><para>Copied from the <varname>$TERM</varname> of the caller. Can be overridden with + <option>--setenv=</option></para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>$SUDO_USER</varname></term> + <listitem><para>Set to the username of the originating user.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>$SUDO_UID</varname></term> + <listitem><para>Set to the numeric UNIX user id of the originating user.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>$SUDO_GID</varname></term> + <listitem><para>Set to the primary numeric UNIX group id of the originating session.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sudo</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + +</refentry> diff --git a/man/runlevel.xml b/man/runlevel.xml index 08447e6..7b7e24b 100644 --- a/man/runlevel.xml +++ b/man/runlevel.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="runlevel" conditional='HAVE_SYSV_COMPAT' @@ -155,10 +155,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-bus-container-append.c b/man/sd-bus-container-append.c index 8bb4f33..07a24f2 100644 --- a/man/sd-bus-container-append.c +++ b/man/sd-bus-container-append.c @@ -3,13 +3,14 @@ #include <systemd/sd-bus.h> int append_strings_to_message(sd_bus_message *m, const char *const *arr) { + const char *s; int r; r = sd_bus_message_open_container(m, 'a', "s"); if (r < 0) return r; - for (const char *s = *arr; *s; s++) { + for (s = *arr; *s; s++) { r = sd_bus_message_append(m, "s", s); if (r < 0) return r; diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml index 25e3913..b9919b1 100644 --- a/man/sd-bus-errors.xml +++ b/man/sd-bus-errors.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-bus-errors" @@ -332,15 +332,15 @@ <refsect1> <title>See Also</title> - <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>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 4c9c009..26392d7 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-bus" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -41,142 +41,143 @@ for more information about D-Bus IPC.</para> <para>See - <literallayout><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_object</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_object_manager</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_object_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_fallback</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_fallback_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_filter</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_add_node_enumerator</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_interfaces_added</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_interfaces_added_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_interfaces_removed</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_interfaces_removed_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_object_added</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_object_removed</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_properties_changed</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_properties_changed_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_signalv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_signal_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_emit_signal_tov</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_bus_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_creds_mask</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_current_slot</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_exit_on_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_n_queued_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_name_machine_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_property_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_property_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_property_trivial</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_scope</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_tid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_get_unique_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_interface_name_is_valid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_is_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_is_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_is_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_list_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_append_string_memfd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_append_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_at_end</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_close_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_copy</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_dump</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_enter_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_exit_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_new_signal_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_open_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_peek_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_read_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_read_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_rewind</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_seal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_set_expect_reply</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_message_verify_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_negotiate_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_query_sender_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_query_sender_privilege</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_reply_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_send_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_exit_on_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_propertyv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry> -<citerefentry><refentrytitle>sd_bus_slot_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_track_add_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry> -</literallayout> + <simplelist> + <member><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_object</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_object_manager</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_object_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_fallback</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_fallback_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_filter</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_add_node_enumerator</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_added</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_added_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_removed</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_removed_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_object_added</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_object_removed</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_properties_changed</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_properties_changed_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_signalv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_signal_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_emit_signal_tov</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_bus_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_creds_mask</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_current_slot</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_exit_on_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_n_queued_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_name_machine_id</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_property_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_property_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_property_trivial</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_scope</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_tid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_get_unique_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_interface_name_is_valid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_is_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_is_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_is_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_list_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_append_string_memfd</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_append_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_at_end</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_close_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_copy</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_dump</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_enter_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_exit_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_cookie</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_signature</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_get_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_new_signal_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_open_container</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_peek_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_read_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_read_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_rewind</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_seal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_set_expect_reply</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_message_verify_type</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_negotiate_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_query_sender_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_query_sender_privilege</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_reply_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_send_to</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_address</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_allow_interactive_authorization</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_exit_on_disconnect</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_method_call_timeout</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_monitor</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_propertyv</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_server</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_get_current_handler</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_get_current_message</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_track_add_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist> for more information about the functions available.</para> </refsect1> @@ -184,13 +185,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <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>busctl</refentrytitle><manvolnum>1</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> </refsect1> </refentry> diff --git a/man/sd-daemon.xml b/man/sd-daemon.xml index 6cd06a8..ed7905a 100644 --- a/man/sd-daemon.xml +++ b/man/sd-daemon.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-daemon" @@ -97,19 +97,19 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-device.xml b/man/sd-device.xml index 4950781..c887482 100644 --- a/man/sd-device.xml +++ b/man/sd-device.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-device" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -44,9 +44,10 @@ <filename>libudev.h</filename>.</para> <para>See - <literallayout><citerefentry><refentrytitle>sd_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -<citerefentry><refentrytitle>sd_device_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry> -</literallayout> + <simplelist> + <member><citerefentry><refentrytitle>sd_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>,</member> + <member><citerefentry><refentrytitle>sd_device_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist> for more information about the functions available.</para> </refsect1> @@ -54,11 +55,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <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>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-event.xml b/man/sd-event.xml index 276770f..46b50ea 100644 --- a/man/sd-event.xml +++ b/man/sd-event.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-event" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -132,36 +132,36 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_memory_pressure</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_get_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_get_pending</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_ratelimit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>timerfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_memory_pressure</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_get_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_get_pending</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_ratelimit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>timerfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-hwdb.xml b/man/sd-hwdb.xml index 189fcd6..eeaa407 100644 --- a/man/sd-hwdb.xml +++ b/man/sd-hwdb.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-hwdb" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -50,10 +50,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-id128.xml b/man/sd-id128.xml index d264220..5a2ca46 100644 --- a/man/sd-id128.xml +++ b/man/sd-id128.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-id128" @@ -41,35 +41,37 @@ <refsynopsisdiv> <funcsynopsis> <funcsynopsisinfo>#include <systemd/sd-id128.h></funcsynopsisinfo> + </funcsynopsis> - <para> - <constant>SD_ID128_ALLF</constant> - </para> - <para> - <constant>SD_ID128_NULL</constant> - </para> - <para> - <constant>SD_ID128_CONST_STR(<replaceable>id</replaceable>)</constant> - </para> - <para> - <constant>SD_ID128_FORMAT_STR</constant> - </para> - <para> - <constant>SD_ID128_FORMAT_VAL(<replaceable>id</replaceable>)</constant> - </para> - <para> - <constant>SD_ID128_MAKE(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> - </para> - <para> - <constant>SD_ID128_MAKE_STR(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> - </para> - <para> - <constant>SD_ID128_MAKE_UUID_STR(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> - </para> - <para> - <constant>SD_ID128_UUID_FORMAT_STR</constant> - </para> + <para> + <constant>SD_ID128_ALLF</constant> + </para> + <para> + <constant>SD_ID128_NULL</constant> + </para> + <para> + <constant>SD_ID128_CONST_STR(<replaceable>id</replaceable>)</constant> + </para> + <para> + <constant>SD_ID128_FORMAT_STR</constant> + </para> + <para> + <constant>SD_ID128_FORMAT_VAL(<replaceable>id</replaceable>)</constant> + </para> + <para> + <constant>SD_ID128_MAKE(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> + </para> + <para> + <constant>SD_ID128_MAKE_STR(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> + </para> + <para> + <constant>SD_ID128_MAKE_UUID_STR(<replaceable>v0</replaceable>, <replaceable>v1</replaceable>, <replaceable>v2</replaceable>, <replaceable>v3</replaceable>, <replaceable>v4</replaceable>, <replaceable>v5</replaceable>, <replaceable>v6</replaceable>, <replaceable>v7</replaceable>, <replaceable>v8</replaceable>, <replaceable>v9</replaceable>, <replaceable>vA</replaceable>, <replaceable>vB</replaceable>, <replaceable>vC</replaceable>, <replaceable>vD</replaceable>, <replaceable>vE</replaceable>, <replaceable>vF</replaceable>)</constant> + </para> + <para> + <constant>SD_ID128_UUID_FORMAT_STR</constant> + </para> + <funcsynopsis> <funcprototype> <funcdef>int <function>sd_id128_equal</function></funcdef> <paramdef>sd_id128_t <parameter>a</parameter></paramdef> @@ -102,7 +104,7 @@ <funcdef>int <function>sd_id128_in_set_sentinel</function></funcdef> <paramdef>sd_id128_t <parameter>id</parameter></paramdef> <paramdef>…</paramdef> - <paramdef><constant>SD_ID128_NULL</constant></paramdef> + <paramdef><parameter><constant>SD_ID128_NULL</constant></parameter></paramdef> </funcprototype> <funcprototype> @@ -280,17 +282,17 @@ int main(int argc, char **argv) { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_to_string</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-journal.xml b/man/sd-journal.xml index 34debb4..6fc18e7 100644 --- a/man/sd-journal.xml +++ b/man/sd-journal.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-journal" @@ -86,34 +86,45 @@ — are fully thread-safe and may be called from multiple threads in parallel.</para> </refsect1> + <refsect1> + <title>Optional dependencies</title> + + <para>Depending on which build-time options are enabled, functions that operate on + <structname>sd_journal</structname> objects might cause optional shared libraries to be dynamically + loaded via + <citerefentry project='man-pages'><refentrytitle>dlopen</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + such as decompression libraries (xz, lz4, zstd) or cryptographic libraries (gcrypt). + </para> + </refsect1> + <xi:include href="libsystemd-pkgconfig.xml" /> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cutoff_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_has_runtime_files</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_has_persistent_files</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_seek_head</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cutoff_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_usage</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_catalog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_has_runtime_files</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_has_persistent_files</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd-login.xml b/man/sd-login.xml index 13035df..9e06d01 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd-login" conditional='HAVE_PAM' @@ -242,17 +242,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_uid_get_state</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_seat_get_active</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_login_monitor_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_uid_get_state</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_seat_get_active</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_login_monitor_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> <para> <ulink url="https://www.freedesktop.org/wiki/Software/systemd/multiseat">Multi-Seat on Linux</ulink> diff --git a/man/sd_booted.xml b/man/sd_booted.xml index d9b3ddc..8a13203 100644 --- a/man/sd_booted.xml +++ b/man/sd_booted.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_booted" @@ -59,10 +59,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_add_match.xml b/man/sd_bus_add_match.xml index 15376d4..575d628 100644 --- a/man/sd_bus_add_match.xml +++ b/man/sd_bus_add_match.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -156,7 +156,7 @@ <refsect1> <title>History</title> <para><function>sd_bus_add_match()</function> and - <function>sd_bus_message_handler_t()</function> were added in version 231.</para> + <function>sd_bus_message_handler_t()</function> were added in version 221.</para> <para><function>sd_bus_add_match_async()</function>, <function>sd_bus_match_signal()</function>, and <function>sd_bus_match_signal_async()</function> were added in version 237.</para> @@ -165,14 +165,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_bus_client</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_add_node_enumerator.xml b/man/sd_bus_add_node_enumerator.xml index f97746c..5aeb782 100644 --- a/man/sd_bus_add_node_enumerator.xml +++ b/man/sd_bus_add_node_enumerator.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_add_node_enumerator" @@ -98,34 +98,25 @@ <term><constant>-EINVAL</constant></term> <listitem><para>One of the required parameters is <constant>NULL</constant> or - <parameter>path</parameter> is not a valid object path. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <parameter>path</parameter> is not a valid object path.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -136,17 +127,17 @@ <refsect1> <title>History</title> <para><function>sd_bus_node_enumerator_t()</function> and - <function>sd_bus_add_node_enumerator()</function> were added in version 246.</para> + <function>sd_bus_add_node_enumerator()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_fallback_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_fallback_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_add_object.xml b/man/sd_bus_add_object.xml index db667e3..4d14a7e 100644 --- a/man/sd_bus_add_object.xml +++ b/man/sd_bus_add_object.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_add_object" @@ -121,124 +121,124 @@ <paramdef>sd_bus_message_handler_t <parameter>callback</parameter></paramdef> <paramdef>void *<parameter>userdata</parameter></paramdef> </funcprototype> + </funcsynopsis> - <para> - <constant>SD_BUS_VTABLE_CAPABILITY(<replaceable>capability</replaceable>)</constant> - </para> + <para> + <constant>SD_BUS_VTABLE_CAPABILITY(<replaceable>capability</replaceable>)</constant> + </para> - <para> - <constant>SD_BUS_VTABLE_START(<replaceable>flags</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_VTABLE_END</constant> - </para> - <para> - <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET(<replaceable>member</replaceable>, - <replaceable>args</replaceable>, - <replaceable>result</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>offset</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_METHOD_WITH_ARGS(<replaceable>member</replaceable>, - <replaceable>args</replaceable>, - <replaceable>result</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_METHOD_WITH_NAMES_OFFSET(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>in_names</replaceable>, - <replaceable>result</replaceable>, - <replaceable>out_names</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>offset</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_METHOD_WITH_NAMES(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>in_names</replaceable>, - <replaceable>result</replaceable>, - <replaceable>out_names</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_METHOD_WITH_OFFSET(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>result</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>offset</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_METHOD(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>result</replaceable>, - <replaceable>handler</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_SIGNAL_WITH_ARGS(<replaceable>member</replaceable>, - <replaceable>args</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_SIGNAL_WITH_NAMES(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>names</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_SIGNAL(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_WRITABLE_PROPERTY(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>get</replaceable>, - <replaceable>set</replaceable>, - <replaceable>offset</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_PROPERTY(<replaceable>member</replaceable>, - <replaceable>signature</replaceable>, - <replaceable>get</replaceable>, - <replaceable>offset</replaceable>, - <replaceable>flags</replaceable>) - </constant> - </para> - <para> - <constant>SD_BUS_PARAM(<replaceable>name</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_ARGS(<replaceable>...</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_RESULT(<replaceable>...</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_NO_ARGS</constant> - </para> - <para> - <constant>SD_BUS_NO_RESULT</constant> - </para> - </funcsynopsis> + <para> + <constant>SD_BUS_VTABLE_START(<replaceable>flags</replaceable>)</constant> + </para> + <para> + <constant>SD_BUS_VTABLE_END</constant> + </para> + <para> + <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET(<replaceable>member</replaceable>, + <replaceable>args</replaceable>, + <replaceable>result</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>offset</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_METHOD_WITH_ARGS(<replaceable>member</replaceable>, + <replaceable>args</replaceable>, + <replaceable>result</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_METHOD_WITH_NAMES_OFFSET(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>in_names</replaceable>, + <replaceable>result</replaceable>, + <replaceable>out_names</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>offset</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_METHOD_WITH_NAMES(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>in_names</replaceable>, + <replaceable>result</replaceable>, + <replaceable>out_names</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_METHOD_WITH_OFFSET(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>result</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>offset</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_METHOD(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>result</replaceable>, + <replaceable>handler</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_SIGNAL_WITH_ARGS(<replaceable>member</replaceable>, + <replaceable>args</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_SIGNAL_WITH_NAMES(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>names</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_SIGNAL(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_WRITABLE_PROPERTY(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>get</replaceable>, + <replaceable>set</replaceable>, + <replaceable>offset</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_PROPERTY(<replaceable>member</replaceable>, + <replaceable>signature</replaceable>, + <replaceable>get</replaceable>, + <replaceable>offset</replaceable>, + <replaceable>flags</replaceable>) + </constant> + </para> + <para> + <constant>SD_BUS_PARAM(<replaceable>name</replaceable>)</constant> + </para> + <para> + <constant>SD_BUS_ARGS(<replaceable>...</replaceable>)</constant> + </para> + <para> + <constant>SD_BUS_RESULT(<replaceable>...</replaceable>)</constant> + </para> + <para> + <constant>SD_BUS_NO_ARGS</constant> + </para> + <para> + <constant>SD_BUS_NO_RESULT</constant> + </para> </refsynopsisdiv> <refsect1> @@ -377,10 +377,7 @@ combination of flags, see below.</para> <para><constant>SD_BUS_METHOD_WITH_ARGS()</constant> is a shorthand for calling - <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET()</constant> with an offset of zero.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> + <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET()</constant> with an offset of zero.</para></listitem> </varlistentry> <varlistentry> @@ -406,10 +403,7 @@ <para>Prefer using <constant>SD_BUS_METHOD_WITH_ARGS_OFFSET()</constant> and <constant>SD_BUS_METHOD_WITH_ARGS()</constant> over these macros as they allow specifying argument types and names next to each other which is less error-prone than first specifying all argument - types followed by specifying all argument names.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> + types followed by specifying all argument names.</para></listitem> </varlistentry> <varlistentry> @@ -423,9 +417,7 @@ <replaceable>args</replaceable>. If a signal has no parameters, pass <constant>SD_BUS_NO_ARGS</constant> to <replaceable>args</replaceable>. The elements at uneven indices describe the names of the signal's arguments. Parameter <replaceable>flags</replaceable> is - a combination of flags. See below for a complete example.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + a combination of flags. See below for a complete example.</para></listitem> </varlistentry> <varlistentry> @@ -445,10 +437,7 @@ <para>Prefer using <constant>SD_BUS_SIGNAL_WITH_ARGS()</constant> over these macros as it allows specifying argument types and names next to each other which is less error-prone than first - specifying all argument types followed by specifying all argument names.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> + specifying all argument types followed by specifying all argument names.</para></listitem> </varlistentry> <varlistentry> @@ -473,17 +462,13 @@ </para> <para><constant>SD_BUS_PROPERTY()</constant> is used to define a read-only property. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> <term><constant>SD_BUS_PARAM()</constant></term> <listitem><para>Parameter names should be wrapped in this macro, see the example below. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> </variablelist> </refsect2> @@ -502,9 +487,7 @@ <listitem><para>Mark this vtable entry as deprecated using the <constant>org.freedesktop.DBus.Deprecated</constant> annotation in introspection data. If specified for <constant>SD_BUS_VTABLE_START()</constant>, the annotation is applied to the - enclosing interface.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + enclosing interface.</para></listitem> </varlistentry> <varlistentry> @@ -512,9 +495,7 @@ <listitem><para>Make this vtable entry hidden. It will not be shown in introspection data. If specified for <constant>SD_BUS_VTABLE_START()</constant>, all entries in the array are - hidden.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + hidden.</para></listitem> </varlistentry> <varlistentry> @@ -522,9 +503,7 @@ <listitem><para>Mark this vtable entry as a method that will not return a reply using the <constant>org.freedesktop.DBus.Method.NoReply</constant> annotation in introspection data. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> @@ -543,9 +522,7 @@ <constant>true</constant> and means that the signal is emitted. <constant>SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION</constant> corresponds to <constant>invalidates</constant> and means that the signal is emitted, but the value is - not included in the signal.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + not included in the signal.</para></listitem> </varlistentry> <varlistentry> @@ -556,9 +533,7 @@ cannot be combined with <constant>SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE</constant>, and will not be shown in property listings by default (e.g. <command>busctl introspect</command>). This corresponds to the <constant>org.freedesktop.systemd1.Explicit</constant> annotation - in introspection data.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + in introspection data.</para></listitem> </varlistentry> <varlistentry> @@ -567,9 +542,7 @@ <listitem><para>Mark this vtable method entry as processing sensitive data. When set, incoming method call messages and their outgoing reply messages are marked as sensitive using <citerefentry><refentrytitle>sd_bus_message_sensitive</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - so that they are erased from memory when freed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + so that they are erased from memory when freed.</para></listitem> </varlistentry> <varlistentry> @@ -579,9 +552,7 @@ its associated handler functions is determined slightly differently: instead of adding the offset parameter of the entry to the user data pointer specified during vtable registration, the offset is passed directly, converted to a pointer, without taking the user data pointer specified during - vtable registration into account.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + vtable registration into account.</para></listitem> </varlistentry> <varlistentry> @@ -597,10 +568,7 @@ for information about capabilities.</para> <para>Note that vtable entries may be marked as unprivileged and the whole bus may be marked as - trusted, see the discussion of <constant>SD_BUS_VTABLE_UNPRIVILEGED</constant> below.</para> - - <xi:include href="version-info.xml" xpointer="v251"/> - </listitem> + trusted, see the discussion of <constant>SD_BUS_VTABLE_UNPRIVILEGED</constant> below.</para></listitem> </varlistentry> <varlistentry> @@ -625,9 +593,7 @@ additional policy that may permit or deny connections, see "CONFIGURATION FILE" in <citerefentry project='man-pages'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> </variablelist> </refsect2> @@ -667,33 +633,25 @@ <listitem><para>One of the required parameters is <constant>NULL</constant> or invalid. A reserved D-Bus interface was passed as the <replaceable>interface</replaceable> parameter. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> <varlistentry> @@ -701,19 +659,14 @@ <listitem><para><function>sd_bus_add_object_vtable()</function> and <function>sd_bus_add_fallback_vtable()</function> have been both called for the same bus - object path, which is not allowed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + object path, which is not allowed.</para></listitem> </varlistentry> <varlistentry> <term><constant>-EEXIST</constant></term> <listitem><para>This vtable has already been registered for this - <replaceable>interface</replaceable> and <replaceable>path</replaceable>. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <replaceable>interface</replaceable> and <replaceable>path</replaceable>.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -730,17 +683,17 @@ <function>sd_bus_add_fallback()</function>, <function>sd_bus_add_object_vtable()</function>, <function>sd_bus_add_fallback_vtable()</function>, and - <function>sd_bus_add_filter()</function> were added in version 246.</para> + <function>sd_bus_add_filter()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_emit_properties_changed</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_emit_object_added</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_emit_properties_changed</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_emit_object_added</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_add_object_manager.xml b/man/sd_bus_add_object_manager.xml index e5f410b..c47577e 100644 --- a/man/sd_bus_add_object_manager.xml +++ b/man/sd_bus_add_object_manager.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_add_object_manager" @@ -77,34 +77,25 @@ <term><constant>-EINVAL</constant></term> <listitem><para>One of the required parameters is <constant>NULL</constant> or - <parameter>path</parameter> is not a valid object path. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <parameter>path</parameter> is not a valid object path.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -114,18 +105,18 @@ <refsect1> <title>History</title> - <para><function>sd_bus_add_object_manager()</function> was added in version 246.</para> + <para><function>sd_bus_add_object_manager()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_object_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_emit_interfaces_added</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_object_vtable</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_emit_interfaces_added</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_attach_event.xml b/man/sd_bus_attach_event.xml index 979783c..16d46e5 100644 --- a/man/sd_bus_attach_event.xml +++ b/man/sd_bus_attach_event.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_attach_event" @@ -106,21 +106,21 @@ <title>History</title> <para><function>sd_bus_attach_event()</function>, <function>sd_bus_detach_event()</function>, and - <function>sd_bus_get_event()</function> were added in version 240.</para> + <function>sd_bus_get_event()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_call.xml b/man/sd_bus_call.xml index 0bd863d..531a68a 100644 --- a/man/sd_bus_call.xml +++ b/man/sd_bus_call.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_call" @@ -122,74 +122,62 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>The input parameter <parameter>m</parameter> is <constant>NULL</constant>. - </para> + <listitem> + <para>The input parameter <parameter>m</parameter> is <constant>NULL</constant>. + </para> - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <para>The input parameter <parameter>m</parameter> is not a D-Bus method call. + To create a new D-Bus method call, use + <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>. + </para> - <listitem><para>The input parameter <parameter>m</parameter> is not a D-Bus method call. - To create a new D-Bus method call, use - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>. - </para></listitem> - - <listitem><para>The input parameter <parameter>m</parameter> has the - <constant>BUS_MESSAGE_NO_REPLY_EXPECTED</constant> flag set.</para></listitem> + <para>The input parameter <parameter>m</parameter> has the + <constant>BUS_MESSAGE_NO_REPLY_EXPECTED</constant> flag set.</para> - <listitem><para>The input parameter <parameter>error</parameter> is - non-<constant>NULL</constant> but was not set to <constant>SD_BUS_ERROR_NULL</constant>. - </para></listitem> + <para>The input parameter <parameter>error</parameter> is + non-<constant>NULL</constant> but was not set to <constant>SD_BUS_ERROR_NULL</constant>. + </para> + </listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> <listitem><para>The bus connection was allocated in a parent process and is being reused - in a child process after <function>fork()</function>.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + in a child process after <function>fork()</function>.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOTCONN</constant></term> <listitem><para>The input parameter <parameter>bus</parameter> is - <constant>NULL</constant> or the bus is not connected.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <constant>NULL</constant> or the bus is not connected.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECONNRESET</constant></term> <listitem><para>The bus connection was closed while waiting for the response. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> <term><constant>-ETIMEDOUT</constant></term> - <listitem><para>A response was not received within the given timeout.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>A response was not received within the given timeout.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ELOOP</constant></term> <listitem><para>The message <parameter>m</parameter> is addressed to its own client. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -200,21 +188,21 @@ <refsect1> <title>History</title> <para><function>sd_bus_call()</function> and - <function>sd_bus_call_async()</function> were added in version 246.</para> + <function>sd_bus_call_async()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_call_method.xml b/man/sd_bus_call_method.xml index f25c8c7..1178a95 100644 --- a/man/sd_bus_call_method.xml +++ b/man/sd_bus_call_method.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_call_method" @@ -141,24 +141,24 @@ <refsect1> <title>History</title> - <para><function>sd_bus_call_method()</function>, - <function>sd_bus_call_methodv()</function>, - <function>sd_bus_call_method_async()</function>, and + <para><function>sd_bus_call_method()</function>, and + <function>sd_bus_call_method_async()</function> were added in version 221.</para> + <para><function>sd_bus_call_methodv()</function>, <function>sd_bus_call_method_asyncv()</function> were added in version 246.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_property</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_can_send.xml b/man/sd_bus_can_send.xml index 321b19d..09e8026 100644 --- a/man/sd_bus_can_send.xml +++ b/man/sd_bus_can_send.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_can_send" @@ -58,28 +58,21 @@ <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus object <parameter>bus</parameter> could not be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> + <listitem><para>The bus object <parameter>bus</parameter> could not be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOTCONN</constant></term> <listitem><para>The input parameter <parameter>bus</parameter> is - <constant>NULL</constant> or the bus is not connected.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <constant>NULL</constant> or the bus is not connected.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> <listitem><para>The bus object <parameter>bus</parameter> was created in a different - process.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + process.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -89,16 +82,16 @@ <refsect1> <title>History</title> - <para><function>sd_bus_can_send()</function> was added in version 246.</para> + <para><function>sd_bus_can_send()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_close.xml b/man/sd_bus_close.xml index 997e67b..70d0b86 100644 --- a/man/sd_bus_close.xml +++ b/man/sd_bus_close.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_close" @@ -108,19 +108,19 @@ <refsect1> <title>History</title> <para><function>sd_bus_close()</function> and - <function>sd_bus_flush()</function> were added in version 240.</para> - <para><function>sd_bus_default_flush_close()</function> was added in version 246.</para> + <function>sd_bus_flush()</function> were added in version 221.</para> + <para><function>sd_bus_default_flush_close()</function> was added in version 227.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_close_on_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_creds_get_pid.xml b/man/sd_bus_creds_get_pid.xml index 66fcaa7..0630329 100644 --- a/man/sd_bus_creds_get_pid.xml +++ b/man/sd_bus_creds_get_pid.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_creds_get_pid" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -17,6 +17,7 @@ <refnamediv> <refname>sd_bus_creds_get_pid</refname> + <refname>sd_bus_creds_get_pidfd_dup</refname> <refname>sd_bus_creds_get_ppid</refname> <refname>sd_bus_creds_get_tid</refname> <refname>sd_bus_creds_get_uid</refname> @@ -65,6 +66,12 @@ </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_creds_get_pidfd_dup</function></funcdef> + <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> + <paramdef>int *<parameter>ret_fd</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>int <function>sd_bus_creds_get_ppid</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> <paramdef>pid_t *<parameter>ppid</parameter></paramdef> @@ -289,11 +296,14 @@ <citerefentry><refentrytitle>sd_bus_creds_get_mask</refentrytitle><manvolnum>3</manvolnum></citerefentry> to determine the mask of fields available.</para> - <para><function>sd_bus_creds_get_pid()</function> will retrieve - the PID (process identifier). Similarly, - <function>sd_bus_creds_get_ppid()</function> will retrieve the - parent PID. Note that PID 1 has no parent process, in which case - -ENXIO is returned.</para> + <para><function>sd_bus_creds_get_pid()</function> will retrieve the PID (process identifier). Similarly, + <function>sd_bus_creds_get_ppid()</function> will retrieve the parent PID. Note that PID 1 has no parent + process, in which case -ENXIO is returned.</para> + + <para><function>sd_bus_creds_get_pidfd_dup()</function> will retrieve the PID file descriptor (pidfd), + see <citerefentry + project='man-pages'><refentrytitle>pidfd_open</refentrytitle><manvolnum>2</manvolnum></citerefentry> for + details. The file descriptor is duplicated and thus must be closed by the caller.</para> <para><function>sd_bus_creds_get_tid()</function> will retrieve the TID (thread identifier).</para> @@ -529,9 +539,9 @@ <function>sd_bus_creds_get_selinux_context()</function>, <function>sd_bus_creds_get_audit_session_id()</function>, <function>sd_bus_creds_get_audit_login_uid()</function>, - <function>sd_bus_creds_get_unique_name()</function>, and - <function>sd_bus_creds_get_well_known_names()</function> were added in version 209.</para> - <para><function>sd_bus_creds_get_ppid()</function>, + <function>sd_bus_creds_get_unique_name()</function>, + <function>sd_bus_creds_get_well_known_names()</function>, + <function>sd_bus_creds_get_ppid()</function>, <function>sd_bus_creds_get_uid()</function>, <function>sd_bus_creds_get_euid()</function>, <function>sd_bus_creds_get_suid()</function>, @@ -540,25 +550,26 @@ <function>sd_bus_creds_get_sgid()</function>, <function>sd_bus_creds_get_fsgid()</function>, <function>sd_bus_creds_get_supplementary_gids()</function>, - <function>sd_bus_creds_get_tty()</function>, and - <function>sd_bus_creds_get_description()</function> were added in version 220.</para> - <para><function>sd_bus_creds_get_user_slice()</function> was added in version 223.</para> + <function>sd_bus_creds_get_tty()</function>, + <function>sd_bus_creds_get_description()</function>, and + <function>sd_bus_creds_get_user_slice()</function> were added in version 221.</para> + <para><function>sd_bus_creds_get_pidfd_dup()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_creds_new_from_pid.xml b/man/sd_bus_creds_new_from_pid.xml index 239f996..1dffd13 100644 --- a/man/sd_bus_creds_new_from_pid.xml +++ b/man/sd_bus_creds_new_from_pid.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_creds_new_from_pid" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -17,6 +17,7 @@ <refnamediv> <refname>sd_bus_creds_new_from_pid</refname> + <refname>sd_bus_creds_new_from_pidfd</refname> <refname>sd_bus_creds_get_mask</refname> <refname>sd_bus_creds_get_augmented_mask</refname> <refname>sd_bus_creds_ref</refname> @@ -38,6 +39,13 @@ </funcprototype> <funcprototype> + <funcdef>int <function>sd_bus_creds_new_from_pidfd</function></funcdef> + <paramdef>int <parameter>pidfd</parameter></paramdef> + <paramdef>uint64_t <parameter>creds_mask</parameter></paramdef> + <paramdef>sd_bus_creds **<parameter>ret</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>uint64_t <function>sd_bus_creds_get_mask</function></funcdef> <paramdef>sd_bus_creds *<parameter>c</parameter></paramdef> </funcprototype> @@ -98,6 +106,7 @@ <constant>SD_BUS_CREDS_UNIQUE_NAME</constant>, <constant>SD_BUS_CREDS_WELL_KNOWN_NAMES</constant>, <constant>SD_BUS_CREDS_DESCRIPTION</constant>, + <constant>SD_BUS_CREDS_PIDFD</constant>, <constant>SD_BUS_CREDS_AUGMENT</constant>, <constant>_SD_BUS_CREDS_ALL</constant> </para> @@ -116,91 +125,65 @@ and <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> - <para>The information that will be stored is determined by - <parameter>creds_mask</parameter>. It may contain a subset of ORed - constants <constant>SD_BUS_CREDS_PID</constant>, - <constant>SD_BUS_CREDS_PPID</constant>, - <constant>SD_BUS_CREDS_TID</constant>, - <constant>SD_BUS_CREDS_UID</constant>, - <constant>SD_BUS_CREDS_EUID</constant>, - <constant>SD_BUS_CREDS_SUID</constant>, - <constant>SD_BUS_CREDS_FSUID</constant>, - <constant>SD_BUS_CREDS_GID</constant>, - <constant>SD_BUS_CREDS_EGID</constant>, - <constant>SD_BUS_CREDS_SGID</constant>, - <constant>SD_BUS_CREDS_FSGID</constant>, - <constant>SD_BUS_CREDS_SUPPLEMENTARY_GIDS</constant>, - <constant>SD_BUS_CREDS_COMM</constant>, - <constant>SD_BUS_CREDS_TID_COMM</constant>, - <constant>SD_BUS_CREDS_EXE</constant>, - <constant>SD_BUS_CREDS_CMDLINE</constant>, - <constant>SD_BUS_CREDS_CGROUP</constant>, - <constant>SD_BUS_CREDS_UNIT</constant>, - <constant>SD_BUS_CREDS_SLICE</constant>, - <constant>SD_BUS_CREDS_USER_UNIT</constant>, - <constant>SD_BUS_CREDS_USER_SLICE</constant>, - <constant>SD_BUS_CREDS_SESSION</constant>, - <constant>SD_BUS_CREDS_OWNER_UID</constant>, - <constant>SD_BUS_CREDS_EFFECTIVE_CAPS</constant>, - <constant>SD_BUS_CREDS_PERMITTED_CAPS</constant>, - <constant>SD_BUS_CREDS_INHERITABLE_CAPS</constant>, - <constant>SD_BUS_CREDS_BOUNDING_CAPS</constant>, - <constant>SD_BUS_CREDS_SELINUX_CONTEXT</constant>, - <constant>SD_BUS_CREDS_AUDIT_SESSION_ID</constant>, - <constant>SD_BUS_CREDS_AUDIT_LOGIN_UID</constant>, - <constant>SD_BUS_CREDS_TTY</constant>, - <constant>SD_BUS_CREDS_UNIQUE_NAME</constant>, - <constant>SD_BUS_CREDS_WELL_KNOWN_NAMES</constant>, and - <constant>SD_BUS_CREDS_DESCRIPTION</constant>. Use the special - value <constant>_SD_BUS_CREDS_ALL</constant> to request all - supported fields. The <constant>SD_BUS_CREDS_AUGMENT</constant> - constant may not be ORed into the mask for invocations of - <function>sd_bus_creds_new_from_pid()</function>.</para> + <para><function>sd_bus_creds_new_from_pidfd()</function> is identical to + <function>sd_bus_creds_new_from_pid()</function>, but takes a PID file descriptor rather than a numeric + PID as reference to the process. See <citerefentry + project='man-pages'><refentrytitle>pidfd_open</refentrytitle><manvolnum>2</manvolnum></citerefentry>.</para> + + <para>The information that will be stored is determined by <parameter>creds_mask</parameter>. It may + contain a subset of ORed constants <constant>SD_BUS_CREDS_PID</constant>, + <constant>SD_BUS_CREDS_PPID</constant>, <constant>SD_BUS_CREDS_TID</constant>, + <constant>SD_BUS_CREDS_UID</constant>, <constant>SD_BUS_CREDS_EUID</constant>, + <constant>SD_BUS_CREDS_SUID</constant>, <constant>SD_BUS_CREDS_FSUID</constant>, + <constant>SD_BUS_CREDS_GID</constant>, <constant>SD_BUS_CREDS_EGID</constant>, + <constant>SD_BUS_CREDS_SGID</constant>, <constant>SD_BUS_CREDS_FSGID</constant>, + <constant>SD_BUS_CREDS_SUPPLEMENTARY_GIDS</constant>, <constant>SD_BUS_CREDS_COMM</constant>, + <constant>SD_BUS_CREDS_TID_COMM</constant>, <constant>SD_BUS_CREDS_EXE</constant>, + <constant>SD_BUS_CREDS_CMDLINE</constant>, <constant>SD_BUS_CREDS_CGROUP</constant>, + <constant>SD_BUS_CREDS_UNIT</constant>, <constant>SD_BUS_CREDS_SLICE</constant>, + <constant>SD_BUS_CREDS_USER_UNIT</constant>, <constant>SD_BUS_CREDS_USER_SLICE</constant>, + <constant>SD_BUS_CREDS_SESSION</constant>, <constant>SD_BUS_CREDS_OWNER_UID</constant>, + <constant>SD_BUS_CREDS_EFFECTIVE_CAPS</constant>, <constant>SD_BUS_CREDS_PERMITTED_CAPS</constant>, + <constant>SD_BUS_CREDS_INHERITABLE_CAPS</constant>, <constant>SD_BUS_CREDS_BOUNDING_CAPS</constant>, + <constant>SD_BUS_CREDS_SELINUX_CONTEXT</constant>, <constant>SD_BUS_CREDS_AUDIT_SESSION_ID</constant>, + <constant>SD_BUS_CREDS_AUDIT_LOGIN_UID</constant>, <constant>SD_BUS_CREDS_TTY</constant>, + <constant>SD_BUS_CREDS_UNIQUE_NAME</constant>, <constant>SD_BUS_CREDS_WELL_KNOWN_NAMES</constant>, + <constant>SD_BUS_CREDS_DESCRIPTION</constant>, and <constant>SD_BUS_CREDS_PIDFD</constant>. Use the + special value <constant>_SD_BUS_CREDS_ALL</constant> to request all supported fields. The + <constant>SD_BUS_CREDS_AUGMENT</constant> constant may not be ORed into the mask for invocations of + <function>sd_bus_creds_new_from_pid()</function> or + <function>sd_bus_creds_new_from_pidfd()</function>.</para> <para>Fields can be retrieved from the credentials object using <citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry> and other functions which correspond directly to the constants listed above.</para> - <para>A mask of fields which were actually successfully retrieved - can be retrieved with - <function>sd_bus_creds_get_mask()</function>. If the credentials - object was created with - <function>sd_bus_creds_new_from_pid()</function>, this will be a - subset of fields requested in <parameter>creds_mask</parameter>. + <para>A mask of fields which were actually successfully retrieved can be retrieved with + <function>sd_bus_creds_get_mask()</function>. If the credentials object was created with + <function>sd_bus_creds_new_from_pid()</function> or <function>sd_bus_creds_new_from_pidfd()</function>, + this will be a subset of fields requested in <parameter>creds_mask</parameter>. </para> - <para>Similar to <function>sd_bus_creds_get_mask()</function>, the - function <function>sd_bus_creds_get_augmented_mask()</function> - returns a bitmask of field constants. The mask indicates which - credential fields have been retrieved in a non-atomic fashion. For - credential objects created via - <function>sd_bus_creds_new_from_pid()</function>, this mask will be - identical to the mask returned by - <function>sd_bus_creds_get_mask()</function>. However, for - credential objects retrieved via - <function>sd_bus_get_name_creds()</function>, this mask will be set - for the credential fields that could not be determined atomically - at peer connection time, and which were later added by reading - augmenting credential data from - <filename>/proc/</filename>. Similarly, for credential objects - retrieved via <function>sd_bus_get_owner_creds()</function>, the - mask is set for the fields that could not be determined atomically - at bus creation time, but have been augmented. Similarly, for - credential objects retrieved via - <function>sd_bus_message_get_creds()</function>, the mask is set - for the fields that could not be determined atomically at message - sending time, but have been augmented. The mask returned by - <function>sd_bus_creds_get_augmented_mask()</function> is always a - subset of (or identical to) the mask returned by - <function>sd_bus_creds_get_mask()</function> for the same - object. The latter call hence returns all credential fields - available in the credential object, the former then marks the - subset of those that have been augmented. Note that augmented - fields are unsuitable for authorization decisions, as they may be - retrieved at different times, thus being subject to races. Hence, - augmented fields should be used exclusively for informational - purposes. + <para>Similar to <function>sd_bus_creds_get_mask()</function>, the function + <function>sd_bus_creds_get_augmented_mask()</function> returns a bitmask of field constants. The mask + indicates which credential fields have been retrieved in a non-atomic fashion. For credential objects + created via <function>sd_bus_creds_new_from_pid()</function> or + <function>sd_bus_creds_new_from_pidfd()</function>, this mask will be identical to the mask returned by + <function>sd_bus_creds_get_mask()</function>. However, for credential objects retrieved via + <function>sd_bus_get_name_creds()</function>, this mask will be set for the credential fields that could + not be determined atomically at peer connection time, and which were later added by reading augmenting + credential data from <filename>/proc/</filename>. Similarly, for credential objects retrieved via + <function>sd_bus_get_owner_creds()</function>, the mask is set for the fields that could not be + determined atomically at bus creation time, but have been augmented. Similarly, for credential objects + retrieved via <function>sd_bus_message_get_creds()</function>, the mask is set for the fields that could + not be determined atomically at message sending time, but have been augmented. The mask returned by + <function>sd_bus_creds_get_augmented_mask()</function> is always a subset of (or identical to) the mask + returned by <function>sd_bus_creds_get_mask()</function> for the same object. The latter call hence + returns all credential fields available in the credential object, the former then marks the subset of + those that have been augmented. Note that augmented fields are unsuitable for authorization decisions, as + they may be retrieved at different times, thus being subject to races. Hence, augmented fields should be + used exclusively for informational purposes. </para> <para><function>sd_bus_creds_ref()</function> creates a new @@ -234,9 +217,9 @@ <refsect1> <title>Return Value</title> - <para>On success, <function>sd_bus_creds_new_from_pid()</function> - returns 0 or a positive integer. On failure, it returns a negative - errno-style error code.</para> + <para>On success, <function>sd_bus_creds_new_from_pid()</function> and + <function>sd_bus_creds_new_from_pidfd()</function> return 0 or a positive integer. On failure, they return + a negative errno-style error code.</para> <para><function>sd_bus_creds_get_mask()</function> returns the mask of successfully acquired fields.</para> @@ -256,9 +239,9 @@ <refsect1> <title>Reference ownership</title> - <para>Function <function>sd_bus_creds_new_from_pid()</function> - creates a new object and the caller owns the sole reference. When - not needed anymore, this reference should be destroyed with + <para>The functions <function>sd_bus_creds_new_from_pid()</function> and + <function>sd_bus_creds_new_from_pidfd()</function> create a new object and the caller owns the sole + reference. When not needed anymore, this reference should be destroyed with <citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>. </para> @@ -303,23 +286,24 @@ <title>History</title> <para><function>sd_bus_creds_new_from_pid()</function>, <function>sd_bus_creds_get_mask()</function>, - <function>sd_bus_creds_ref()</function>, and - <function>sd_bus_creds_unref()</function> were added in version 209.</para> - <para><function>sd_bus_creds_get_augmented_mask()</function> was added in version 223.</para> + <function>sd_bus_creds_ref()</function>, + <function>sd_bus_creds_unref()</function>, and + <function>sd_bus_creds_get_augmented_mask()</function> were added in version 221.</para> <para><function>sd_bus_creds_unrefp()</function> was added in version 229.</para> + <para><function>sd_bus_creds_new_from_pidfd()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_creds_get_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_default.xml b/man/sd_bus_default.xml index 05c438f..f32fbc0 100644 --- a/man/sd_bus_default.xml +++ b/man/sd_bus_default.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_default" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -306,9 +306,7 @@ <listitem><para>The requested bus type is not available because of invalid environment (for example the user session bus is not available because <varname>$XDG_RUNTIME_DIR</varname> is not set). - </para> - - <xi:include href="version-info.xml" xpointer="v247"/></listitem> + </para></listitem> </varlistentry> <varlistentry> @@ -341,27 +339,27 @@ <function>sd_bus_open_user()</function>, <function>sd_bus_open_system()</function>, <function>sd_bus_open_system_remote()</function>, and - <function>sd_bus_open_system_machine()</function> were added in version 220.</para> + <function>sd_bus_open_system_machine()</function> were added in version 221.</para> <para><function>sd_bus_open_with_description()</function>, <function>sd_bus_open_user_with_description()</function>, and - <function>sd_bus_open_system_with_description()</function> were added in version 240.</para> + <function>sd_bus_open_system_with_description()</function> were added in version 239.</para> <para><function>sd_bus_open_user_machine()</function> was added in version 248.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_emit_signal.xml b/man/sd_bus_emit_signal.xml index 7444e12..b7d7648 100644 --- a/man/sd_bus_emit_signal.xml +++ b/man/sd_bus_emit_signal.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_emit_signal" @@ -214,33 +214,25 @@ <listitem><para>One of the required parameters is <constant>NULL</constant> or invalid. A reserved D-Bus interface was passed as the <replaceable>interface</replaceable> parameter. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> <varlistentry> @@ -251,9 +243,7 @@ <function>sd_bus_emit_object_added()</function> or <function>sd_bus_emit_object_removed()</function> was called on an object without an object manager registered on its own object path or one of its parent object paths. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + </para></listitem> </varlistentry> </variablelist> @@ -270,15 +260,15 @@ <refsect1> <title>History</title> <para><function>sd_bus_emit_signal()</function>, - <function>sd_bus_emit_signalv()</function>, <function>sd_bus_emit_interfaces_added()</function>, <function>sd_bus_emit_interfaces_added_strv()</function>, <function>sd_bus_emit_interfaces_removed()</function>, <function>sd_bus_emit_interfaces_removed_strv()</function>, <function>sd_bus_emit_properties_changed()</function>, - <function>sd_bus_emit_properties_changed_strv()</function>, - <function>sd_bus_emit_object_added()</function>, and - <function>sd_bus_emit_object_removed()</function> were added in version 246.</para> + <function>sd_bus_emit_properties_changed_strv()</function>, were added in version 221.</para> + <para><function>sd_bus_emit_object_added()</function>, and + <function>sd_bus_emit_object_removed()</function> were added in version 222.</para> + <para><function>sd_bus_emit_signalv()</function> was added in version 246.</para> <para><function>sd_bus_emit_signal_to()</function> and <function>sd_bus_emit_signal_tov()</function> were added in version 253.</para> </refsect1> @@ -286,13 +276,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_enqueue_for_read.xml b/man/sd_bus_enqueue_for_read.xml index dac32a0..a1352c1 100644 --- a/man/sd_bus_enqueue_for_read.xml +++ b/man/sd_bus_enqueue_for_read.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_enqueue_for_read" @@ -67,9 +67,7 @@ <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus connection has been created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v245"/></listitem> + <listitem><para>The bus connection has been created in a different process, library or module instance.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -85,11 +83,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_error-example.c b/man/sd_bus_error-example.c index 4b5217c..3836f5e 100644 --- a/man/sd_bus_error-example.c +++ b/man/sd_bus_error-example.c @@ -14,5 +14,5 @@ int writer_with_negative_errno_return(int fd, sd_bus_error *error) { /* On error, initialize the error structure, and also propagate the errno * value that write(2) set for us. */ - return sd_bus_error_set_errnof(error, errno, "Failed to write to fd %i: %m", fd); + return sd_bus_error_set_errnof(error, errno, "Failed to write to fd %i: %s", fd, strerror(errno)); } diff --git a/man/sd_bus_error.xml b/man/sd_bus_error.xml index 3f7a28c..5bf1691 100644 --- a/man/sd_bus_error.xml +++ b/man/sd_bus_error.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_error" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -47,14 +47,16 @@ const char *message; … } sd_bus_error;</funcsynopsisinfo> + </funcsynopsis> - <para> - <constant>SD_BUS_ERROR_MAKE_CONST(<replaceable>name</replaceable>, <replaceable>message</replaceable>)</constant> - </para> - <para> - <constant>SD_BUS_ERROR_NULL</constant> - </para> + <para> + <constant>SD_BUS_ERROR_MAKE_CONST(<replaceable>name</replaceable>, <replaceable>message</replaceable>)</constant> + </para> + <para> + <constant>SD_BUS_ERROR_NULL</constant> + </para> + <funcsynopsis> <funcprototype> <funcdef>void <function>sd_bus_error_free</function></funcdef> <paramdef>sd_bus_error *<parameter>e</parameter></paramdef> @@ -145,12 +147,12 @@ <paramdef>const sd_bus_error *<parameter>e</parameter></paramdef> <paramdef>...</paramdef> </funcprototype> - - <para> - #define sd_bus_error_has_names(e, ...) sd_bus_error_has_names_sentinel(e, ..., NULL) - </para> </funcsynopsis> + <para> + #define sd_bus_error_has_names(e, ...) sd_bus_error_has_names_sentinel(e, ..., NULL) + </para> + </refsynopsisdiv> <refsect1> @@ -400,11 +402,11 @@ <function>sd_bus_error_set_const()</function>, <function>sd_bus_error_set_errno()</function>, <function>sd_bus_error_set_errnof()</function>, + <function>sd_bus_error_set_errnofv()</function>, <function>sd_bus_error_get_errno()</function>, <function>sd_bus_error_copy()</function>, <function>sd_bus_error_is_set()</function>, and - <function>sd_bus_error_has_name()</function> were added in version 209.</para> - <para><function>sd_bus_error_set_errnofv()</function> was added in version 223.</para> + <function>sd_bus_error_has_name()</function> were added in version 221.</para> <para><function>sd_bus_error_move()</function> was added in version 240.</para> <para><function>sd_bus_error_has_names_sentinel()</function> was added in version 247.</para> <para><function>sd_bus_error_setfv()</function> was added in version 252.</para> @@ -413,14 +415,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_error_add_map.xml b/man/sd_bus_error_add_map.xml index 6676455..e6e6351 100644 --- a/man/sd_bus_error_add_map.xml +++ b/man/sd_bus_error_add_map.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_error_add_map" @@ -120,20 +120,20 @@ <refsect1> <title>History</title> - <para><function>sd_bus_error_add_map()</function> was added in version 223.</para> + <para><function>sd_bus_error_add_map()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</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-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>strerror_r</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_get_current_handler.xml b/man/sd_bus_get_current_handler.xml index a1eefc1..98b01d1 100644 --- a/man/sd_bus_get_current_handler.xml +++ b/man/sd_bus_get_current_handler.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_get_current_handler" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -79,16 +79,16 @@ <para><function>sd_bus_get_current_handler()</function>, <function>sd_bus_get_current_message()</function>, <function>sd_bus_get_current_slot()</function>, and - <function>sd_bus_get_current_userdata()</function> were added in version 246.</para> + <function>sd_bus_get_current_userdata()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index 5931527..9d239f3 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -150,9 +150,7 @@ <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -162,23 +160,23 @@ <refsect1> <title>History</title> - <para><function>sd_bus_get_fd()</function> was added in version 231.</para> - <para><function>sd_bus_get_events()</function> and - <function>sd_bus_get_timeout()</function> were added in version 240.</para> + <para><function>sd_bus_get_fd()</function>, + <function>sd_bus_get_events()</function>, and + <function>sd_bus_get_timeout()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>poll</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_get_n_queued_read.xml b/man/sd_bus_get_n_queued_read.xml index e37b54c..2401a1a 100644 --- a/man/sd_bus_get_n_queued_read.xml +++ b/man/sd_bus_get_n_queued_read.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_get_n_queued_read"> @@ -94,13 +94,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_get_name_creds.xml b/man/sd_bus_get_name_creds.xml index d7531af..b223f53 100644 --- a/man/sd_bus_get_name_creds.xml +++ b/man/sd_bus_get_name_creds.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_get_name_creds" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -77,41 +77,31 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>An argument is invalid.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>An argument is invalid.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-EPERM</constant></term> - <listitem><para>The bus has already been started.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus has already been started.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -122,16 +112,16 @@ <refsect1> <title>History</title> <para><function>sd_bus_get_name_creds()</function> and - <function>sd_bus_get_owner_creds()</function> were added in version 246.</para> + <function>sd_bus_get_owner_creds()</function> were added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_get_name_machine_id.xml b/man/sd_bus_get_name_machine_id.xml index 64019c9..4867018 100644 --- a/man/sd_bus_get_name_machine_id.xml +++ b/man/sd_bus_get_name_machine_id.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_get_name_machine_id" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -60,33 +60,25 @@ <varlistentry> <term><constant>-EINVAL</constant></term> - <listitem><para>An argument is invalid.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>An argument is invalid.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -96,16 +88,16 @@ <refsect1> <title>History</title> - <para><function>sd_bus_get_name_machine_id()</function> was added in version 246.</para> + <para><function>sd_bus_get_name_machine_id()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_interface_name_is_valid.xml b/man/sd_bus_interface_name_is_valid.xml index bd526a1..9654801 100644 --- a/man/sd_bus_interface_name_is_valid.xml +++ b/man/sd_bus_interface_name_is_valid.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_interface_name_is_valid" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -77,9 +77,7 @@ <term><constant>-EINVAL</constant></term> <listitem><para>The <parameter>p</parameter> parameter is - <constant>NULL</constant>.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <constant>NULL</constant>.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -98,11 +96,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_is_open.xml b/man/sd_bus_is_open.xml index 586d1f6..b60956c 100644 --- a/man/sd_bus_is_open.xml +++ b/man/sd_bus_is_open.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_is_open" @@ -93,20 +93,20 @@ <refsect1> <title>History</title> - <para><function>sd_bus_is_open()</function> and - <function>sd_bus_is_ready()</function> were added in version 237.</para> + <para><function>sd_bus_is_open()</function> was added in version 221.</para> + <para><function>sd_bus_is_ready()</function> was added in version 237.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_list_names.xml b/man/sd_bus_list_names.xml index 77cd477..b49259b 100644 --- a/man/sd_bus_list_names.xml +++ b/man/sd_bus_list_names.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_list_names" @@ -66,42 +66,31 @@ <term><constant>-EINVAL</constant></term> <listitem><para><parameter>bus</parameter> or both <parameter>acquired</parameter> and - <parameter>activatable</parameter> were <constant>NULL</constant>. - </para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <parameter>activatable</parameter> were <constant>NULL</constant>.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOPKG</constant></term> - <listitem><para>The bus cannot be resolved.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus cannot be resolved.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ECHILD</constant></term> - <listitem><para>The bus was created in a different process, library or module instance.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus was created in a different process, library or module instance.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOMEM</constant></term> - <listitem><para>Memory allocation failed.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>Memory allocation failed.</para></listitem> </varlistentry> <varlistentry> <term><constant>-ENOTCONN</constant></term> - <listitem><para>The bus is not connected.</para> - - <xi:include href="version-info.xml" xpointer="v246"/></listitem> + <listitem><para>The bus is not connected.</para></listitem> </varlistentry> </variablelist> </refsect2> @@ -111,15 +100,15 @@ <refsect1> <title>History</title> - <para><function>sd_bus_list_names()</function> was added in version 246.</para> + <para><function>sd_bus_list_names()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_append.xml b/man/sd_bus_message_append.xml index 98667ad..64c52ff 100644 --- a/man/sd_bus_message_append.xml +++ b/man/sd_bus_message_append.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_append" @@ -95,7 +95,7 @@ <title>Item type specifiers</title> <tgroup cols='5'> - <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers'])//colspec" /> + <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers']//colspec)" /> <xi:include href="sd_bus_message_append_basic.xml" xpointer="xpointer(//table[@id='format-specifiers']//thead)" /> <tbody> @@ -227,13 +227,13 @@ sd_bus_message_append(m, "ynqiuxtd", y, n, q, i, u, x, t, d);</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_open_container</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_open_container</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_append_array.xml b/man/sd_bus_message_append_array.xml index ea8f532..6c4f05d 100644 --- a/man/sd_bus_message_append_array.xml +++ b/man/sd_bus_message_append_array.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_append_array" @@ -166,14 +166,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>memfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_append_basic.xml b/man/sd_bus_message_append_basic.xml index 3509095..2ee8e2e 100644 --- a/man/sd_bus_message_append_basic.xml +++ b/man/sd_bus_message_append_basic.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_append_basic" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -249,13 +249,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_append_string_memfd.xml b/man/sd_bus_message_append_string_memfd.xml index 5a4db0d..4c2d42a 100644 --- a/man/sd_bus_message_append_string_memfd.xml +++ b/man/sd_bus_message_append_string_memfd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_append_string_memfd" @@ -108,12 +108,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_append_strv.xml b/man/sd_bus_message_append_strv.xml index 8bf78dd..19f5b92 100644 --- a/man/sd_bus_message_append_strv.xml +++ b/man/sd_bus_message_append_strv.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_append_strv" @@ -69,13 +69,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_array</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_at_end.xml b/man/sd_bus_message_at_end.xml index cb5bba6..4d7eed5 100644 --- a/man/sd_bus_message_at_end.xml +++ b/man/sd_bus_message_at_end.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_at_end" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -86,10 +86,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_copy.xml b/man/sd_bus_message_copy.xml index 278bc35..8a97ca5 100644 --- a/man/sd_bus_message_copy.xml +++ b/man/sd_bus_message_copy.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_copy" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -101,11 +101,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_dump.xml b/man/sd_bus_message_dump.xml index 83a4a4e..183fffd 100644 --- a/man/sd_bus_message_dump.xml +++ b/man/sd_bus_message_dump.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_dump" @@ -99,10 +99,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_get_cookie.xml b/man/sd_bus_message_get_cookie.xml index ee41bf4..76dc048 100644 --- a/man/sd_bus_message_get_cookie.xml +++ b/man/sd_bus_message_get_cookie.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_get_cookie" @@ -103,11 +103,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_get_monotonic_usec.xml b/man/sd_bus_message_get_monotonic_usec.xml index 2e7017a..7ca0844 100644 --- a/man/sd_bus_message_get_monotonic_usec.xml +++ b/man/sd_bus_message_get_monotonic_usec.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_get_monotonic_usec" @@ -135,14 +135,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_negotiate_timestamp</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_negotiate_timestamp</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_get_signature.xml b/man/sd_bus_message_get_signature.xml index 6eac36c..199e6a3 100644 --- a/man/sd_bus_message_get_signature.xml +++ b/man/sd_bus_message_get_signature.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_get_signature" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -108,11 +108,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_get_type.xml b/man/sd_bus_message_get_type.xml index b2edaa8..a37cde2 100644 --- a/man/sd_bus_message_get_type.xml +++ b/man/sd_bus_message_get_type.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_get_type" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -165,14 +165,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus-errors</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_error_add_map</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_new.xml b/man/sd_bus_message_new.xml index b9a6b2f..ffe950b 100644 --- a/man/sd_bus_message_new.xml +++ b/man/sd_bus_message_new.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_new" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -183,15 +183,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_new_method_call.xml b/man/sd_bus_message_new_method_call.xml index 5a29cb0..1a68d31 100644 --- a/man/sd_bus_message_new_method_call.xml +++ b/man/sd_bus_message_new_method_call.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_new_method_call" @@ -166,13 +166,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_path_encode</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_new_method_error.xml b/man/sd_bus_message_new_method_error.xml index 92c4ac6..64ceb18 100644 --- a/man/sd_bus_message_new_method_error.xml +++ b/man/sd_bus_message_new_method_error.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_new_method_error" @@ -178,10 +178,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_new_signal.xml b/man/sd_bus_message_new_signal.xml index 3f13889..356c4ad 100644 --- a/man/sd_bus_message_new_signal.xml +++ b/man/sd_bus_message_new_signal.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_new_signal" @@ -128,12 +128,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_emit_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_open_container.xml b/man/sd_bus_message_open_container.xml index d08382e..3055cc9 100644 --- a/man/sd_bus_message_open_container.xml +++ b/man/sd_bus_message_open_container.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_open_container" @@ -198,14 +198,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><ulink url="https://dbus.freedesktop.org/doc/dbus-specification.html">The D-Bus specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_read.xml b/man/sd_bus_message_read.xml index 65497aa..7d10ce4 100644 --- a/man/sd_bus_message_read.xml +++ b/man/sd_bus_message_read.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_read" @@ -271,14 +271,14 @@ fd_copy = fcntl(fd, FD_DUPFD_CLOEXEC, 3);</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_enter_container</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_enter_container</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_read_array.xml b/man/sd_bus_message_read_array.xml index 1feec20..0bc276b 100644 --- a/man/sd_bus_message_read_array.xml +++ b/man/sd_bus_message_read_array.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_read_array"> @@ -110,12 +110,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read_strv</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_read_basic.xml b/man/sd_bus_message_read_basic.xml index 9619e2b..6eb0e23 100644 --- a/man/sd_bus_message_read_basic.xml +++ b/man/sd_bus_message_read_basic.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -224,19 +224,19 @@ <refsect1> <title>History</title> - <para><function>sd_bus_message_read_basic()</function> was added in version 231.</para> + <para><function>sd_bus_message_read_basic()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_skip</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_read_strv.xml b/man/sd_bus_message_read_strv.xml index 6e23f6c..3b4910d 100644 --- a/man/sd_bus_message_read_strv.xml +++ b/man/sd_bus_message_read_strv.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_read_strv" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -117,11 +117,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_rewind.xml b/man/sd_bus_message_rewind.xml index 78f1bbc..0daedc0 100644 --- a/man/sd_bus_message_rewind.xml +++ b/man/sd_bus_message_rewind.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_rewind" @@ -83,11 +83,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_seal.xml b/man/sd_bus_message_seal.xml index 6c4b1f1..d64486b 100644 --- a/man/sd_bus_message_seal.xml +++ b/man/sd_bus_message_seal.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_seal" @@ -105,13 +105,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_send</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_sensitive.xml b/man/sd_bus_message_sensitive.xml index ff15a4a..af46a6e 100644 --- a/man/sd_bus_message_sensitive.xml +++ b/man/sd_bus_message_sensitive.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_sensitive" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -82,11 +82,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_set_destination.xml b/man/sd_bus_message_set_destination.xml index d8cff27..1e2775d 100644 --- a/man/sd_bus_message_set_destination.xml +++ b/man/sd_bus_message_set_destination.xml @@ -151,12 +151,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_set_expect_reply.xml b/man/sd_bus_message_set_expect_reply.xml index 674b884..102fcd4 100644 --- a/man/sd_bus_message_set_expect_reply.xml +++ b/man/sd_bus_message_set_expect_reply.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_set_expect_reply" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -148,10 +148,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_skip.xml b/man/sd_bus_message_skip.xml index e10c969..45adb61 100644 --- a/man/sd_bus_message_skip.xml +++ b/man/sd_bus_message_skip.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_skip" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -102,12 +102,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_read_basic</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_message_verify_type.xml b/man/sd_bus_message_verify_type.xml index 9f3a347..0944079 100644 --- a/man/sd_bus_message_verify_type.xml +++ b/man/sd_bus_message_verify_type.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_message_verify_type" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -89,11 +89,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_append</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_negotiate_fds.xml b/man/sd_bus_negotiate_fds.xml index d7d3a51..fe34808 100644 --- a/man/sd_bus_negotiate_fds.xml +++ b/man/sd_bus_negotiate_fds.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_negotiate_fds" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -162,16 +162,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_new.xml b/man/sd_bus_new.xml index 1e61481..6d12a7e 100644 --- a/man/sd_bus_new.xml +++ b/man/sd_bus_new.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_new" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -197,15 +197,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_path_encode.xml b/man/sd_bus_path_encode.xml index e1b0dfc..be8a3b7 100644 --- a/man/sd_bus_path_encode.xml +++ b/man/sd_bus_path_encode.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_path_encode" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -151,11 +151,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_process.xml b/man/sd_bus_process.xml index 8e142dd..d9b49bd 100644 --- a/man/sd_bus_process.xml +++ b/man/sd_bus_process.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -118,21 +118,21 @@ <refsect1> <title>History</title> - <para><function>sd_bus_process()</function> was added in version 231.</para> + <para><function>sd_bus_process()</function> was added in version 221.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_query_sender_creds.xml b/man/sd_bus_query_sender_creds.xml index 52c1da3..f7c802b 100644 --- a/man/sd_bus_query_sender_creds.xml +++ b/man/sd_bus_query_sender_creds.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_query_sender_creds" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -135,14 +135,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_creds_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_reply_method_error.xml b/man/sd_bus_reply_method_error.xml index c9553a0..66a49fe 100644 --- a/man/sd_bus_reply_method_error.xml +++ b/man/sd_bus_reply_method_error.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_reply_method_error" @@ -166,11 +166,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_error</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_reply_method_return.xml b/man/sd_bus_reply_method_return.xml index 4810413..aca5554 100644 --- a/man/sd_bus_reply_method_return.xml +++ b/man/sd_bus_reply_method_return.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_reply_method_return" @@ -121,11 +121,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 4fa2e20..987eefa 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_request_name" @@ -213,12 +213,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_send.xml b/man/sd_bus_send.xml index 0f2f90c..8cdfff0 100644 --- a/man/sd_bus_send.xml +++ b/man/sd_bus_send.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_send" @@ -175,14 +175,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_set_destination</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_reply_method_return</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_service_reconnect.c b/man/sd_bus_service_reconnect.c index fdb18c3..fc7c3b1 100644 --- a/man/sd_bus_service_reconnect.c +++ b/man/sd_bus_service_reconnect.c @@ -1,6 +1,7 @@ /* SPDX-License-Identifier: MIT-0 */ -/* Implements a D-Bus service that automatically reconnects when the system bus is restarted. +/* A D-Bus service that automatically reconnects when the system bus is + * restarted. * * Compile with 'cc sd_bus_service_reconnect.c $(pkg-config --libs --cflags libsystemd)' * @@ -10,18 +11,18 @@ <?xml version="1.0"?> <!--*-nxml-*--> <!DOCTYPE busconfig PUBLIC "-//freedesktop//DTD D-BUS Bus Configuration 1.0//EN" - "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"> + "http://www.freedesktop.org/standards/dbus/1.0/busconfig.dtd"> <busconfig> - <policy user="root"> - <allow own="org.freedesktop.ReconnectExample"/> - <allow send_destination="org.freedesktop.ReconnectExample"/> - <allow receive_sender="org.freedesktop.ReconnectExample"/> - </policy> - - <policy context="default"> - <allow send_destination="org.freedesktop.ReconnectExample"/> - <allow receive_sender="org.freedesktop.ReconnectExample"/> - </policy> + <policy user="root"> + <allow own="org.freedesktop.ReconnectExample"/> + <allow send_destination="org.freedesktop.ReconnectExample"/> + <allow receive_sender="org.freedesktop.ReconnectExample"/> + </policy> + + <policy context="default"> + <allow send_destination="org.freedesktop.ReconnectExample"/> + <allow receive_sender="org.freedesktop.ReconnectExample"/> + </policy> </busconfig> * @@ -31,7 +32,7 @@ * /org/freedesktop/ReconnectExample \ * org.freedesktop.ReconnectExample \ * Example - * s "example" + * s "example" */ #include <errno.h> @@ -41,13 +42,10 @@ #define _cleanup_(f) __attribute__((cleanup(f))) -#define check(x) ({ \ - int _r = (x); \ - errno = _r < 0 ? -_r : 0; \ - printf(#x ": %m\n"); \ - if (_r < 0) \ - return EXIT_FAILURE; \ - }) +static int log_error(int r, const char *str) { + fprintf(stderr, "%s failed: %s\n", str, strerror(-r)); + return r; +} typedef struct object { const char *example; @@ -89,12 +87,24 @@ static const sd_bus_vtable vtable[] = { static int setup(object *o); static int on_disconnect(sd_bus_message *message, void *userdata, sd_bus_error *ret_error) { - check(setup((object *)userdata)); - return 0; + int r; + + r = setup((object *)userdata); + if (r < 0) { + object *o = userdata; + r = sd_event_exit(*o->event, r); + if (r < 0) + return log_error(r, "sd_event_exit()"); + } + + return 1; } -/* Ensure the event loop exits with a clear error if acquiring the well-known service name fails */ +/* Ensure the event loop exits with a clear error if acquiring the well-known + * service name fails */ static int request_name_callback(sd_bus_message *m, void *userdata, sd_bus_error *ret_error) { + int r; + if (!sd_bus_message_is_method_error(m, NULL)) return 1; @@ -103,27 +113,34 @@ static int request_name_callback(sd_bus_message *m, void *userdata, sd_bus_error if (sd_bus_error_has_names(error, SD_BUS_ERROR_TIMEOUT, SD_BUS_ERROR_NO_REPLY)) return 1; /* The bus is not available, try again later */ - printf("Failed to request name: %s\n", error->message); + fprintf(stderr, "Failed to request name: %s\n", error->message); object *o = userdata; - check(sd_event_exit(*o->event, -sd_bus_error_get_errno(error))); + r = sd_event_exit(*o->event, -sd_bus_error_get_errno(error)); + if (r < 0) + return log_error(r, "sd_event_exit()"); return 1; } static int setup(object *o) { - /* If we are reconnecting, then the bus object needs to be closed, detached from - * the event loop and recreated. + int r; + + /* If we are reconnecting, then the bus object needs to be closed, detached + * from the event loop and recreated. * https://www.freedesktop.org/software/systemd/man/sd_bus_detach_event.html * https://www.freedesktop.org/software/systemd/man/sd_bus_close_unref.html */ if (*o->bus) { - check(sd_bus_detach_event(*o->bus)); + r = sd_bus_detach_event(*o->bus); + if (r < 0) + return log_error(r, "sd_bus_detach_event()"); *o->bus = sd_bus_close_unref(*o->bus); } - /* Set up a new bus object for the system bus, configure it to wait for D-Bus to be available - * instead of failing if it is not, and start it. All the following operations are asyncronous - * and will not block waiting for D-Bus to be available. + /* Set up a new bus object for the system bus, configure it to wait for D-Bus + * to be available instead of failing if it is not, and start it. All the + * following operations are asynchronous and will not block waiting for D-Bus + * to be available. * https://www.freedesktop.org/software/systemd/man/sd_bus_new.html * https://www.freedesktop.org/software/systemd/man/sd_bus_set_address.html * https://www.freedesktop.org/software/systemd/man/sd_bus_set_bus_client.html @@ -132,62 +149,82 @@ static int setup(object *o) { * https://www.freedesktop.org/software/systemd/man/sd_bus_set_connected_signal.html * https://www.freedesktop.org/software/systemd/man/sd_bus_start.html */ - check(sd_bus_new(o->bus)); - check(sd_bus_set_address(*o->bus, "unix:path=/run/dbus/system_bus_socket")); - check(sd_bus_set_bus_client(*o->bus, 1)); - check(sd_bus_negotiate_creds(*o->bus, 1, SD_BUS_CREDS_UID|SD_BUS_CREDS_EUID|SD_BUS_CREDS_EFFECTIVE_CAPS)); - check(sd_bus_set_watch_bind(*o->bus, 1)); - check(sd_bus_start(*o->bus)); + r = sd_bus_new(o->bus); + if (r < 0) + return log_error(r, "sd_bus_new()"); + r = sd_bus_set_address(*o->bus, "unix:path=/run/dbus/system_bus_socket"); + if (r < 0) + return log_error(r, "sd_bus_set_address()"); + r = sd_bus_set_bus_client(*o->bus, 1); + if (r < 0) + return log_error(r, "sd_bus_set_bus_client()"); + r = sd_bus_negotiate_creds(*o->bus, 1, SD_BUS_CREDS_UID|SD_BUS_CREDS_EUID|SD_BUS_CREDS_EFFECTIVE_CAPS); + if (r < 0) + return log_error(r, "sd_bus_negotiate_creds()"); + r = sd_bus_set_watch_bind(*o->bus, 1); + if (r < 0) + return log_error(r, "sd_bus_set_watch_bind()"); + r = sd_bus_start(*o->bus); + if (r < 0) + return log_error(r, "sd_bus_start()"); /* Publish an interface on the bus, specifying our well-known object access * path and public interface name. * https://www.freedesktop.org/software/systemd/man/sd_bus_add_object.html * https://dbus.freedesktop.org/doc/dbus-tutorial.html */ - check(sd_bus_add_object_vtable(*o->bus, - NULL, - "/org/freedesktop/ReconnectExample", - "org.freedesktop.ReconnectExample", - vtable, - o)); - /* By default the service is only assigned an ephemeral name. Also add a well-known - * one, so that clients know whom to call. This needs to be asynchronous, as - * D-Bus might not be yet available. The callback will check whether the error is - * expected or not, in case it fails. + r = sd_bus_add_object_vtable(*o->bus, + NULL, + "/org/freedesktop/ReconnectExample", + "org.freedesktop.ReconnectExample", + vtable, + o); + if (r < 0) + return log_error(r, "sd_bus_add_object_vtable()"); + /* By default the service is only assigned an ephemeral name. Also add a + * well-known one, so that clients know whom to call. This needs to be + * asynchronous, as D-Bus might not be yet available. The callback will check + * whether the error is expected or not, in case it fails. * https://www.freedesktop.org/software/systemd/man/sd_bus_request_name.html */ - check(sd_bus_request_name_async(*o->bus, - NULL, - "org.freedesktop.ReconnectExample", - 0, - request_name_callback, - o)); - /* When D-Bus is disconnected this callback will be invoked, which will - * set up the connection again. This needs to be asynchronous, as D-Bus might not - * yet be available. + r = sd_bus_request_name_async(*o->bus, + NULL, + "org.freedesktop.ReconnectExample", + 0, + request_name_callback, + o); + if (r < 0) + return log_error(r, "sd_bus_request_name_async()"); + /* When D-Bus is disconnected this callback will be invoked, which will set up + * the connection again. This needs to be asynchronous, as D-Bus might not yet + * be available. * https://www.freedesktop.org/software/systemd/man/sd_bus_match_signal_async.html */ - check(sd_bus_match_signal_async(*o->bus, - NULL, - "org.freedesktop.DBus.Local", - NULL, - "org.freedesktop.DBus.Local", - "Disconnected", - on_disconnect, - NULL, - o)); - /* Attach the bus object to the event loop so that calls and signals are processed. + r = sd_bus_match_signal_async(*o->bus, + NULL, + "org.freedesktop.DBus.Local", + NULL, + "org.freedesktop.DBus.Local", + "Disconnected", + on_disconnect, + NULL, + o); + if (r < 0) + return log_error(r, "sd_bus_match_signal_async()"); + /* Attach the bus object to the event loop so that calls and signals are + * processed. * https://www.freedesktop.org/software/systemd/man/sd_bus_attach_event.html */ - check(sd_bus_attach_event(*o->bus, *o->event, 0)); + r = sd_bus_attach_event(*o->bus, *o->event, 0); + if (r < 0) + return log_error(r, "sd_bus_attach_event()"); return 0; } int main(int argc, char **argv) { /* The bus should be relinquished before the program terminates. The cleanup - * attribute allows us to do it nicely and cleanly whenever we exit the - * block. + * attribute allows us to do it nicely and cleanly whenever we exit the block. */ _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL; _cleanup_(sd_event_unrefp) sd_event *event = NULL; @@ -196,28 +233,42 @@ int main(int argc, char **argv) { .bus = &bus, .event = &event, }; + int r; /* Create an event loop data structure, with default parameters. * https://www.freedesktop.org/software/systemd/man/sd_event_default.html */ - check(sd_event_default(&event)); + r = sd_event_default(&event); + if (r < 0) + return log_error(r, "sd_event_default()"); - /* By default the event loop will terminate when all sources have disappeared, so - * we have to keep it 'occupied'. Register signal handling to do so. + /* By default the event loop will terminate when all sources have disappeared, + * so we have to keep it 'occupied'. Register signal handling to do so. * https://www.freedesktop.org/software/systemd/man/sd_event_add_signal.html */ - check(sd_event_add_signal(event, NULL, SIGINT|SD_EVENT_SIGNAL_PROCMASK, NULL, NULL)); - check(sd_event_add_signal(event, NULL, SIGTERM|SD_EVENT_SIGNAL_PROCMASK, NULL, NULL)); + r = sd_event_add_signal(event, NULL, SIGINT|SD_EVENT_SIGNAL_PROCMASK, NULL, NULL); + if (r < 0) + return log_error(r, "sd_event_add_signal(SIGINT)"); + + r = sd_event_add_signal(event, NULL, SIGTERM|SD_EVENT_SIGNAL_PROCMASK, NULL, NULL); + if (r < 0) + return log_error(r, "sd_event_add_signal(SIGTERM)"); - check(setup(&o)); + r = setup(&o); + if (r < 0) + return EXIT_FAILURE; /* Enter the main loop, it will exit only on sigint/sigterm. * https://www.freedesktop.org/software/systemd/man/sd_event_loop.html */ - check(sd_event_loop(event)); + r = sd_event_loop(event); + if (r < 0) + return log_error(r, "sd_event_loop()"); /* https://www.freedesktop.org/software/systemd/man/sd_bus_release_name.html */ - check(sd_bus_release_name(bus, "org.freedesktop.ReconnectExample")); + r = sd_bus_release_name(bus, "org.freedesktop.ReconnectExample"); + if (r < 0) + return log_error(r, "sd_bus_release_name()"); return 0; } diff --git a/man/sd_bus_set_address.xml b/man/sd_bus_set_address.xml index 558349d..603f153 100644 --- a/man/sd_bus_set_address.xml +++ b/man/sd_bus_set_address.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_address" @@ -101,7 +101,7 @@ If specified, the identifier returned by the peer after the connection is established will be checked and the connection will be rejected in case of a mismatch.</para> - <para>Note that the addresses passed to <function>sd_bus_set_address()</function> may not be verified + <para>Note that the addresses passed to <function>sd_bus_set_address()</function> might not be verified immediately. If they are invalid, an error may be returned e.g. from a subsequent call to <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>. </para> @@ -192,14 +192,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_close_on_exit.xml b/man/sd_bus_set_close_on_exit.xml index c467df8..43f6eff 100644 --- a/man/sd_bus_set_close_on_exit.xml +++ b/man/sd_bus_set_close_on_exit.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_close_on_exit" @@ -102,13 +102,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_connected_signal.xml b/man/sd_bus_set_connected_signal.xml index c8e5c44..70aeeee 100644 --- a/man/sd_bus_set_connected_signal.xml +++ b/man/sd_bus_set_connected_signal.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_connected_signal" @@ -103,13 +103,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_match_signal_async</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_is_ready</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_match_signal_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_watch_bind</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_is_ready</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_description.xml b/man/sd_bus_set_description.xml index 0b49ba3..913178e 100644 --- a/man/sd_bus_set_description.xml +++ b/man/sd_bus_set_description.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_description" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -255,14 +255,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_default_user</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_default_system</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_open_user</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_open_system</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_exit_on_disconnect.xml b/man/sd_bus_set_exit_on_disconnect.xml index de4105b..25b37fd 100644 --- a/man/sd_bus_set_exit_on_disconnect.xml +++ b/man/sd_bus_set_exit_on_disconnect.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_exit_on_disconnect" @@ -115,12 +115,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_fd.xml b/man/sd_bus_set_fd.xml index d05ed27..1fcec27 100644 --- a/man/sd_bus_set_fd.xml +++ b/man/sd_bus_set_fd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -124,12 +124,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_method_call_timeout.xml b/man/sd_bus_set_method_call_timeout.xml index 293bbcb..0ee6ce8 100644 --- a/man/sd_bus_set_method_call_timeout.xml +++ b/man/sd_bus_set_method_call_timeout.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_method_call_timeout" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -103,11 +103,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_property.xml b/man/sd_bus_set_property.xml index 2c39874..2294e08 100644 --- a/man/sd_bus_set_property.xml +++ b/man/sd_bus_set_property.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_property" @@ -173,11 +173,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_sender.xml b/man/sd_bus_set_sender.xml index e767df3..0f8e40d 100644 --- a/man/sd_bus_set_sender.xml +++ b/man/sd_bus_set_sender.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_sender" @@ -99,11 +99,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_set_sender</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_server.xml b/man/sd_bus_set_server.xml index cfea163..a0f9102 100644 --- a/man/sd_bus_set_server.xml +++ b/man/sd_bus_set_server.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_server" @@ -205,10 +205,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_set_watch_bind.xml b/man/sd_bus_set_watch_bind.xml index 02e5f8f..6619d3c 100644 --- a/man/sd_bus_set_watch_bind.xml +++ b/man/sd_bus_set_watch_bind.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_set_watch_bind" @@ -124,16 +124,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_is_ready</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_request_name</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_is_ready</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_set_connected_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_get_bus.xml b/man/sd_bus_slot_get_bus.xml index f24d944..b130cf0 100644 --- a/man/sd_bus_slot_get_bus.xml +++ b/man/sd_bus_slot_get_bus.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_get_bus" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -89,10 +89,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_ref.xml b/man/sd_bus_slot_ref.xml index 055bf00..1f925cd 100644 --- a/man/sd_bus_slot_ref.xml +++ b/man/sd_bus_slot_ref.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_ref" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -89,13 +89,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_message_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_method_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_set_description.xml b/man/sd_bus_slot_set_description.xml index b24f8e1..b8b5872 100644 --- a/man/sd_bus_slot_set_description.xml +++ b/man/sd_bus_slot_set_description.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_set_description" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -100,12 +100,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - <citerefentry><refentrytitle>sd_bus_slot_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_ref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_set_destroy_callback.xml b/man/sd_bus_slot_set_destroy_callback.xml index 404db6e..ac26789 100644 --- a/man/sd_bus_slot_set_destroy_callback.xml +++ b/man/sd_bus_slot_set_destroy_callback.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_set_destroy_callback" @@ -125,15 +125,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_track_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_track_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_set_floating.xml b/man/sd_bus_slot_set_floating.xml index df2cbc6..4143b1f 100644 --- a/man/sd_bus_slot_set_floating.xml +++ b/man/sd_bus_slot_set_floating.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_set_floating" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -112,12 +112,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_slot_set_userdata.xml b/man/sd_bus_slot_set_userdata.xml index 691ed2d..28e8773 100644 --- a/man/sd_bus_slot_set_userdata.xml +++ b/man/sd_bus_slot_set_userdata.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_slot_set_userdata" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -82,13 +82,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_slot_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_set_destroy_callback</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_slot_get_current_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_start.xml b/man/sd_bus_start.xml index bf693ce..67686ae 100644 --- a/man/sd_bus_start.xml +++ b/man/sd_bus_start.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_start" @@ -126,12 +126,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_track_add_name.xml b/man/sd_bus_track_add_name.xml index d52fb21..a7be6a2 100644 --- a/man/sd_bus_track_add_name.xml +++ b/man/sd_bus_track_add_name.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_track_add_name" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -232,11 +232,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_track_new.xml b/man/sd_bus_track_new.xml index de6b48d..7041e92 100644 --- a/man/sd_bus_track_new.xml +++ b/man/sd_bus_track_new.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_bus_track_new" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -234,11 +234,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry> - <citerefentry><refentrytitle>sd_bus_track_add_name</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_track_add_name</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_bus_wait.xml b/man/sd_bus_wait.xml index 04dd090..6bc8216 100644 --- a/man/sd_bus_wait.xml +++ b/man/sd_bus_wait.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -105,14 +105,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_process</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_bus_attach_event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_device_get_syspath.xml b/man/sd_device_get_syspath.xml index c8adacd..718da91 100644 --- a/man/sd_device_get_syspath.xml +++ b/man/sd_device_get_syspath.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_device_get_syspath" diff --git a/man/sd_device_ref.xml b/man/sd_device_ref.xml index e5fc18f..818edc2 100644 --- a/man/sd_device_ref.xml +++ b/man/sd_device_ref.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_device_ref" xmlns:xi="http://www.w3.org/2001/XInclude"> diff --git a/man/sd_event_add_child.xml b/man/sd_event_add_child.xml index ca6aa61..3406432 100644 --- a/man/sd_event_add_child.xml +++ b/man/sd_event_add_child.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_child" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -340,29 +340,29 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pthread_sigmask</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pidfd_open</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pidfd_send_signal</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>rt_sigqueueinfo</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pthread_sigmask</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pidfd_open</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pidfd_send_signal</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>rt_sigqueueinfo</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_defer.xml b/man/sd_event_add_defer.xml index de9125f..af43ef1 100644 --- a/man/sd_event_add_defer.xml +++ b/man/sd_event_add_defer.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_defer" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -188,23 +188,23 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_inotify.xml b/man/sd_event_add_inotify.xml index 7781d8e..ed26c8a 100644 --- a/man/sd_event_add_inotify.xml +++ b/man/sd_event_add_inotify.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_inotify" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -19,6 +19,7 @@ <refname>sd_event_add_inotify</refname> <refname>sd_event_add_inotify_fd</refname> <refname>sd_event_source_get_inotify_mask</refname> + <refname>sd_event_source_get_inotify_path</refname> <refname>sd_event_inotify_handler_t</refname> <refpurpose>Add an "inotify" file system inode event source to an event loop</refpurpose> @@ -60,7 +61,13 @@ <funcprototype> <funcdef>int <function>sd_event_source_get_inotify_mask</function></funcdef> <paramdef>sd_event_source *<parameter>source</parameter></paramdef> - <paramdef>uint32_t *<parameter>mask</parameter></paramdef> + <paramdef>uint32_t *<parameter>ret</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>int <function>sd_event_source_get_inotify_path</function></funcdef> + <paramdef>sd_event_source *<parameter>source</parameter></paramdef> + <paramdef>const char **<parameter>ret</parameter></paramdef> </funcprototype> </funcsynopsis> @@ -133,6 +140,12 @@ event source created previously with <function>sd_event_add_inotify()</function>. It takes the event source object as the <parameter>source</parameter> parameter and a pointer to a <type>uint32_t</type> variable to return the mask in.</para> + + <para><function>sd_event_source_get_inotify_path()</function> retrieves the target path of the configured + inotify watch of an event source created previously with <function>sd_event_add_inotify()</function>. It + takes the event source object as the <parameter>source</parameter> parameter and a pointer to a + <type>const char **</type> variable to return the path in. The caller must not free the returned path. + </para> </refsect1> <refsect1> @@ -163,7 +176,12 @@ <varlistentry> <term><constant>-ESTALE</constant></term> - <listitem><para>The event loop is already terminated.</para></listitem> + <listitem> + <para>Returned by <function>sd_event_source_add_inotify()</function> or + <function>sd_event_source_add_inotify_fd()</function> when the event loop is already terminated. + Returned by <function>sd_event_source_get_inotify_path()</function> when no active inode data is + assigned to the event source, e.g. when the event source is disabled.</para> + </listitem> </varlistentry> @@ -183,18 +201,19 @@ <varlistentry> <term><constant>-EBADF</constant></term> - <listitem><para>The passed file descriptor is not valid.</para> + <listitem><para>The passed file descriptor is not valid.</para></listitem> - <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> <varlistentry> <term><constant>-ENOSYS</constant></term> - <listitem><para><function>sd_event_add_inotify_fd()</function> was called without - <filename>/proc/</filename> mounted.</para> + <listitem> + <para><function>sd_event_add_inotify_fd()</function> or + <function>sd_event_source_get_inotify_path()</function> was called without + <filename>/proc/</filename> mounted.</para> + </listitem> - <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> </variablelist> @@ -219,28 +238,29 @@ <function>sd_event_add_inotify()</function>, and <function>sd_event_source_get_inotify_mask()</function> were added in version 239.</para> <para><function>sd_event_add_inotify_fd()</function> was added in version 250.</para> + <para><function>sd_event_source_get_inotify_path()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>waitid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_io.xml b/man/sd_event_add_io.xml index 9d4fd27..3a405f0 100644 --- a/man/sd_event_add_io.xml +++ b/man/sd_event_add_io.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_io" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -218,18 +218,17 @@ <para><function>sd_event_source_set_io_fd()</function> changes the UNIX file descriptor of an I/O event source created previously with <function>sd_event_add_io()</function>. It takes the event source object - and the new file descriptor. If the event source takes the ownership of the previous file descriptor, - that is, <function>sd_event_source_set_io_fd_own()</function> was called for the event source with a + and the new file descriptor as parameters. If the event source owned the previous file descriptor, that + is if <function>sd_event_source_set_io_fd_own()</function> had been called for the event source with a non-zero value, then the previous file descriptor will be closed and the event source will also take the ownership of the new file descriptor on success.</para> <para><function>sd_event_source_set_io_fd_own()</function> controls whether the file descriptor of the - event source shall be closed automatically when the event source is freed (or when the file descriptor - assigned to the event source is replaced by <function>sd_event_source_set_io_fd()</function>), i.e. - whether it shall be considered 'owned' by the event source object. By default it is not closed - automatically, and the application has to do this on its own. The <parameter>b</parameter> parameter is a - boolean parameter: if zero, the file descriptor is not closed automatically when the event source is - freed, otherwise it is closed.</para> + event source shall take ownership of the file descriptor. Takes a boolean parameter + <parameter>b</parameter>. When true (nonzero), the file descriptor will be closed automatically when the + event source is freed or when the file descriptor is replaced by + <function>sd_event_source_set_io_fd()</function>. By default the descriptor is not owned by the event + source, and the application has to do close it on its own if needed.</para> <para><function>sd_event_source_get_io_fd_own()</function> may be used to query the current setting of the file descriptor ownership boolean flag as set with <function>sd_event_source_set_io_fd_own()</function>. It returns @@ -315,25 +314,25 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_get_pending</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_get_pending</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_memory_pressure.xml b/man/sd_event_add_memory_pressure.xml index 25c166e..096f048 100644 --- a/man/sd_event_add_memory_pressure.xml +++ b/man/sd_event_add_memory_pressure.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_memory_pressure" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -282,20 +282,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_signal.xml b/man/sd_event_add_signal.xml index 6fb0d1b..ec8210b 100644 --- a/man/sd_event_add_signal.xml +++ b/man/sd_event_add_signal.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_signal" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -190,25 +190,25 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pthread_sigmask</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>signalfd</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sigprocmask</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pthread_sigmask</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_add_time.xml b/man/sd_event_add_time.xml index d3a7373..159d5c9 100644 --- a/man/sd_event_add_time.xml +++ b/man/sd_event_add_time.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_add_time" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -317,25 +317,25 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>timerfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_now</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_floating</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>timerfd_create</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_exit.xml b/man/sd_event_exit.xml index bea8acd..aa3bc29 100644 --- a/man/sd_event_exit.xml +++ b/man/sd_event_exit.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_exit" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -65,9 +65,11 @@ the exit code stored in the event loop object is updated, but otherwise no further operation is executed.</para> - <para><function>sd_event_get_exit_code()</function> may be used to - query the exit code passed into - <function>sd_event_exit()</function> earlier.</para> + <para><function>sd_event_get_exit_code()</function> may be used to query the exit code passed to an + earlier call of <function>sd_event_exit()</function>. The return parameter <parameter>code</parameter> + may be set to <constant>NULL</constant>, in order to simply check if <function>sd_event_exit()</function> + has been called before (as <function>sd_event_get_exit_code()</function> fails with + <constant>-ENODATA</constant> if that's not the case, see below).</para> <para>While the full positive and negative integer ranges may be used for the exit code, care should be taken not pick exit codes that @@ -122,7 +124,8 @@ <varlistentry> <term><constant>-ENODATA</constant></term> - <listitem><para>The event loop has not been requested to exit yet.</para></listitem> + <listitem><para>Returned by <function>sd_event_get_exit_code()</function> in case the event loop has not + been requested to exit yet.</para></listitem> </varlistentry> </variablelist> @@ -140,17 +143,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_get_fd.xml b/man/sd_event_get_fd.xml index e68b688..5c0ee8c 100644 --- a/man/sd_event_get_fd.xml +++ b/man/sd_event_get_fd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_get_fd" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -104,13 +104,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>epoll_ctl</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>epoll</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_new.xml b/man/sd_event_new.xml index a01cc78..57f448c 100644 --- a/man/sd_event_new.xml +++ b/man/sd_event_new.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_new" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -211,18 +211,18 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>gettid</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <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_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>gettid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_now.xml b/man/sd_event_now.xml index 100d39a..6f175a4 100644 --- a/man/sd_event_now.xml +++ b/man/sd_event_now.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_now" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -107,13 +107,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_run.xml b/man/sd_event_run.xml index 7df74ab..a6c74f7 100644 --- a/man/sd_event_run.xml +++ b/man/sd_event_run.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_run" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -150,21 +150,21 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <ulink url="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html">GLib Main Event Loop</ulink> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_exit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_wait</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><ulink url="https://developer.gnome.org/glib/unstable/glib-The-Main-Event-Loop.html">GLib Main Event Loop</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_set_signal_exit.xml b/man/sd_event_set_signal_exit.xml index 1ac208e..10b68a0 100644 --- a/man/sd_event_set_signal_exit.xml +++ b/man/sd_event_set_signal_exit.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_set_signal_exit" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -99,12 +99,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_set_watchdog.xml b/man/sd_event_set_watchdog.xml index a91ca64..9f3e3f8 100644 --- a/man/sd_event_set_watchdog.xml +++ b/man/sd_event_set_watchdog.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_set_watchdog" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -132,20 +132,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <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_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_get_event.xml b/man/sd_event_source_get_event.xml index 50d3a9b..5890229 100644 --- a/man/sd_event_source_get_event.xml +++ b/man/sd_event_source_get_event.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_get_event" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -64,16 +64,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_get_pending.xml b/man/sd_event_source_get_pending.xml index 62b718b..bc1354b 100644 --- a/man/sd_event_source_get_pending.xml +++ b/man/sd_event_source_get_pending.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_get_pending" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -127,16 +127,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_description.xml b/man/sd_event_source_set_description.xml index e4cd775..1e50f2f 100644 --- a/man/sd_event_source_set_description.xml +++ b/man/sd_event_source_set_description.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_description" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -131,16 +131,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_destroy_callback.xml b/man/sd_event_source_set_destroy_callback.xml index d276385..f19d5d1 100644 --- a/man/sd_event_source_set_destroy_callback.xml +++ b/man/sd_event_source_set_destroy_callback.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_destroy_callback" @@ -103,17 +103,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <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_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_enabled.xml b/man/sd_event_source_set_enabled.xml index 07c5322..625bf13 100644 --- a/man/sd_event_source_set_enabled.xml +++ b/man/sd_event_source_set_enabled.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_enabled" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -146,17 +146,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_ratelimit</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_unref</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_ratelimit</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_exit_on_failure.xml b/man/sd_event_source_set_exit_on_failure.xml index fd7f21f..1b6b4b9 100644 --- a/man/sd_event_source_set_exit_on_failure.xml +++ b/man/sd_event_source_set_exit_on_failure.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_exit_on_failure" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -104,15 +104,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_floating.xml b/man/sd_event_source_set_floating.xml index e2cc5d5..a751114 100644 --- a/man/sd_event_source_set_floating.xml +++ b/man/sd_event_source_set_floating.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_floating" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -112,17 +112,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_prepare.xml b/man/sd_event_source_set_prepare.xml index 8d78873..59ff0e6 100644 --- a/man/sd_event_source_set_prepare.xml +++ b/man/sd_event_source_set_prepare.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_prepare" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -131,18 +131,18 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_priority</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_userdata</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_priority.xml b/man/sd_event_source_set_priority.xml index 7b6f046..16394d5 100644 --- a/man/sd_event_source_set_priority.xml +++ b/man/sd_event_source_set_priority.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_priority" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -158,15 +158,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_ratelimit.xml b/man/sd_event_source_set_ratelimit.xml index cf45102..cc1ce81 100644 --- a/man/sd_event_source_set_ratelimit.xml +++ b/man/sd_event_source_set_ratelimit.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_ratelimit" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -174,15 +174,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_set_userdata.xml b/man/sd_event_source_set_userdata.xml index b1bd8d4..ce14ad4 100644 --- a/man/sd_event_source_set_userdata.xml +++ b/man/sd_event_source_set_userdata.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_set_userdata" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -84,16 +84,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_source_unref.xml b/man/sd_event_source_unref.xml index 22ce6f5..15148f9 100644 --- a/man/sd_event_source_unref.xml +++ b/man/sd_event_source_unref.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_source_unref" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -126,16 +126,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml index 0f635f6..95bb0be 100644 --- a/man/sd_event_wait.xml +++ b/man/sd_event_wait.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_event_wait" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -320,28 +320,28 @@ <refsect1> <title>History</title> <para><function>sd_event_prepare()</function>, - <function>sd_event_wait()</function>, and - <function>sd_event_dispatch()</function> were added in version 220.</para> - <para><function>sd_event_get_state()</function> was added in version 229.</para> + <function>sd_event_wait()</function>, + <function>sd_event_dispatch()</function>, and + <function>sd_event_get_state()</function> were added in version 221.</para> <para><function>sd_event_get_iteration()</function> was added in version 231.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_source_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_io</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_time</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_child</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_inotify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_add_defer</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_run</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_get_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_source_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_get_seats.xml b/man/sd_get_seats.xml index a19495c..f3fd3fb 100644 --- a/man/sd_get_seats.xml +++ b/man/sd_get_seats.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_get_seats" conditional='HAVE_PAM' @@ -113,11 +113,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_hwdb_get.xml b/man/sd_hwdb_get.xml index 4f2e701..839a59d 100644 --- a/man/sd_hwdb_get.xml +++ b/man/sd_hwdb_get.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_hwdb_get" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -160,12 +160,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_hwdb_new.xml b/man/sd_hwdb_new.xml index 4d02dea..56f922b 100644 --- a/man/sd_hwdb_new.xml +++ b/man/sd_hwdb_new.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_hwdb_new" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -134,12 +134,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_id128_get_machine.xml b/man/sd_id128_get_machine.xml index 43ee26d..59f3266 100644 --- a/man/sd_id128_get_machine.xml +++ b/man/sd_id128_get_machine.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_id128_get_machine" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -63,6 +63,12 @@ <paramdef>sd_id128_t *<parameter>ret</parameter></paramdef> </funcprototype> + <funcprototype> + <funcdef>int <function>sd_id128_get_invocation_app_specific</function></funcdef> + <paramdef>sd_id128_t <parameter>app_id</parameter></paramdef> + <paramdef>sd_id128_t *<parameter>ret</parameter></paramdef> + </funcprototype> + </funcsynopsis> </refsynopsisdiv> @@ -126,12 +132,16 @@ for details. The ID is cached internally. In future a different mechanism to determine the invocation ID may be added.</para> + <para><function>sd_id128_get_invocation_app_specific()</function> derives an application-specific ID from + the invocation ID.</para> + <para>Note that <function>sd_id128_get_machine_app_specific()</function>, - <function>sd_id128_get_boot()</function>, <function>sd_id128_get_boot_app_specific()</function>, and - <function>sd_id128_get_invocation()</function> always return UUID Variant 1 Version 4 compatible IDs. - <function>sd_id128_get_machine()</function> will also return a UUID Variant 1 Version 4 compatible ID on - new installations but might not on older. It is possible to convert the machine ID non-reversibly into a - UUID Variant 1 Version 4 compatible one. For more information, see + <function>sd_id128_get_boot()</function>, <function>sd_id128_get_boot_app_specific()</function>, + <function>sd_id128_get_invocation()</function> and + <function>sd_id128_get_invocation_app_specific</function> always return UUID Variant 1 Version 4 + compatible IDs. <function>sd_id128_get_machine()</function> will also return a UUID Variant 1 Version 4 + compatible ID on new installations but might not on older. It is possible to convert the machine ID + non-reversibly into a UUID Variant 1 Version 4 compatible one. For more information, see <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. It is hence guaranteed that these functions will never return the ID consisting of all zero or all one bits (<constant>SD_ID128_NULL</constant>, <constant>SD_ID128_ALLF</constant>) — with the possible exception of @@ -262,20 +272,21 @@ As man:sd-id128(3) macro: <para><function>sd_id128_get_machine_app_specific()</function> was added in version 233.</para> <para><function>sd_id128_get_boot_app_specific()</function> was added in version 240.</para> <para><function>sd_id128_get_app_specific()</function> was added in version 255.</para> + <para><function>sd_id128_get_invocation_app_specific()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-id128</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-id128</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_randomize</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_id128_randomize.xml b/man/sd_id128_randomize.xml index 54184f0..3fb88b4 100644 --- a/man/sd_id128_randomize.xml +++ b/man/sd_id128_randomize.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_id128_randomize" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -72,14 +72,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getrandom</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getrandom</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_id128_to_string.xml b/man/sd_id128_to_string.xml index da44a0d..b2f3030 100644 --- a/man/sd_id128_to_string.xml +++ b/man/sd_id128_to_string.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_id128_to_string" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -119,11 +119,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>printf</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_is_fifo.xml b/man/sd_is_fifo.xml index a00a2cc..8f6fa43 100644 --- a/man/sd_is_fifo.xml +++ b/man/sd_is_fifo.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_is_fifo" @@ -190,19 +190,19 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fifo</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>. - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>ip</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>ipv6</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fifo</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mq_overview</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_add_match.xml b/man/sd_journal_add_match.xml index 5329498..5d14be5 100644 --- a/man/sd_journal_add_match.xml +++ b/man/sd_journal_add_match.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_add_match" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -172,14 +172,14 @@ int add_matches(sd_journal *j) { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_enumerate_fields.xml b/man/sd_journal_enumerate_fields.xml index b2185b3..8298cb0 100644 --- a/man/sd_journal_enumerate_fields.xml +++ b/man/sd_journal_enumerate_fields.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_enumerate_fields" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -107,15 +107,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_catalog.xml b/man/sd_journal_get_catalog.xml index 6c82f05..6db9b8b 100644 --- a/man/sd_journal_get_catalog.xml +++ b/man/sd_journal_get_catalog.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_catalog" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -62,7 +62,7 @@ <para>For more information about the journal message catalog please refer to the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/catalog">Journal + url="https://systemd.io/CATALOG">Journal Message Catalogs</ulink> documentation page.</para> </refsect1> @@ -105,15 +105,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>malloc</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_cursor.xml b/man/sd_journal_get_cursor.xml index 29b8bc7..351c898 100644 --- a/man/sd_journal_get_cursor.xml +++ b/man/sd_journal_get_cursor.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_cursor" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -110,12 +110,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_seek_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_seek_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_cutoff_realtime_usec.xml b/man/sd_journal_get_cutoff_realtime_usec.xml index a39a656..7a267b3 100644 --- a/man/sd_journal_get_cutoff_realtime_usec.xml +++ b/man/sd_journal_get_cutoff_realtime_usec.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_cutoff_realtime_usec" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -107,14 +107,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_data.xml b/man/sd_journal_get_data.xml index ae0911f..61e9268 100644 --- a/man/sd_journal_get_data.xml +++ b/man/sd_journal_get_data.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_data" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -293,15 +293,15 @@ int print_fields(sd_journal *j) { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_query_unique</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_fd.xml b/man/sd_journal_get_fd.xml index 6e7e496..2f7afa8 100644 --- a/man/sd_journal_get_fd.xml +++ b/man/sd_journal_get_fd.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_fd" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -256,14 +256,14 @@ else { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_realtime_usec.xml b/man/sd_journal_get_realtime_usec.xml index 0d2b08e..37c21c2 100644 --- a/man/sd_journal_get_realtime_usec.xml +++ b/man/sd_journal_get_realtime_usec.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_realtime_usec" @@ -103,17 +103,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_seqnum</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_boot</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cutoff_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_seqnum.xml b/man/sd_journal_get_seqnum.xml index 5459d94..d558bd0 100644 --- a/man/sd_journal_get_seqnum.xml +++ b/man/sd_journal_get_seqnum.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_seqnum" @@ -97,14 +97,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_get_usage.xml b/man/sd_journal_get_usage.xml index e5fae28..c849d79 100644 --- a/man/sd_journal_get_usage.xml +++ b/man/sd_journal_get_usage.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_get_usage" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -66,11 +66,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_has_runtime_files.xml b/man/sd_journal_has_runtime_files.xml index 90110be..12870d7 100644 --- a/man/sd_journal_has_runtime_files.xml +++ b/man/sd_journal_has_runtime_files.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/man/sd_journal_next.xml b/man/sd_journal_next.xml index ea5cbef..1388822 100644 --- a/man/sd_journal_next.xml +++ b/man/sd_journal_next.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_next" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -163,14 +163,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_open.xml b/man/sd_journal_open.xml index 3b8fb1f..836a423 100644 --- a/man/sd_journal_open.xml +++ b/man/sd_journal_open.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_open" @@ -231,13 +231,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_print.xml b/man/sd_journal_print.xml index 8c515a4..ea766b2 100644 --- a/man/sd_journal_print.xml +++ b/man/sd_journal_print.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_print" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -274,17 +274,17 @@ sd_journal_send("MESSAGE=Hello World, this is PID %lu!", (unsigned long) getpid( <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_stream_fd</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>perror</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>errno</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>socket</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_query_unique.xml b/man/sd_journal_query_unique.xml index 005c8d5..fedee46 100644 --- a/man/sd_journal_query_unique.xml +++ b/man/sd_journal_query_unique.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_query_unique" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -170,15 +170,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_enumerate_fields</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_add_match</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_seek_head.xml b/man/sd_journal_seek_head.xml index 03aec1d..4e6fb94 100644 --- a/man/sd_journal_seek_head.xml +++ b/man/sd_journal_seek_head.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_seek_head" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -132,15 +132,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_open</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_next</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_data</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_cursor</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_get_realtime_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_journal_stream_fd.xml b/man/sd_journal_stream_fd.xml index cbaed06..ff0d2ee 100644 --- a/man/sd_journal_stream_fd.xml +++ b/man/sd_journal_stream_fd.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_journal_stream_fd" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -17,6 +17,7 @@ <refnamediv> <refname>sd_journal_stream_fd</refname> + <refname>sd_journal_stream_fd_with_namespace</refname> <refpurpose>Create log stream file descriptor to the journal</refpurpose> </refnamediv> @@ -31,26 +32,31 @@ <paramdef>int <parameter>level_prefix</parameter></paramdef> </funcprototype> + <funcprototype> + <funcdef>int <function>sd_journal_stream_fd_with_namespace</function></funcdef> + <paramdef>const char *<parameter>name_space</parameter></paramdef> + <paramdef>const char *<parameter>identifier</parameter></paramdef> + <paramdef>int <parameter>priority</parameter></paramdef> + <paramdef>int <parameter>level_prefix</parameter></paramdef> + </funcprototype> + </funcsynopsis> </refsynopsisdiv> <refsect1> <title>Description</title> - <para><function>sd_journal_stream_fd()</function> may be used to - create a log stream file descriptor. Log messages written to this - file descriptor as simple newline-separated text strings are - written to the journal. This file descriptor can be used - internally by applications or be made standard output or standard - error of other processes executed.</para> + <para><function>sd_journal_stream_fd()</function> may be used to create a log stream file descriptor. + Log messages written to this file descriptor as simple newline-separated text strings are written + to the journal. This file descriptor can be used internally by applications or be made standard output + or standard error of other processes executed.</para> - <para><function>sd_journal_stream_fd()</function> takes a short - program identifier string as first argument, which will be written - to the journal as SYSLOG_IDENTIFIER= field for each log entry + <para><function>sd_journal_stream_fd()</function> takes a short program identifier string as + first argument, which will be written to the journal as SYSLOG_IDENTIFIER= field for each log entry (see <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> - for more information). The second argument shall be the default - priority level for all messages. The priority level is one of + for more information). The second argument shall be the default priority level for all messages. + The priority level is one of <constant>LOG_EMERG</constant>, <constant>LOG_ALERT</constant>, <constant>LOG_CRIT</constant>, <constant>LOG_ERR</constant>, <constant>LOG_WARNING</constant>, <constant>LOG_NOTICE</constant>, @@ -63,25 +69,30 @@ <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry> for more information.</para> - <para>It is recommended that applications log UTF-8 messages only - with this API, but this is not enforced.</para> + <para><function>sd_journal_stream_fd_with_namespace()</function> is similar to + <function>sd_journal_stream_fd()</function>, but takes an additional <parameter>name_space</parameter> parameter + that specifies which journal namespace to operate on. If specified as <constant>NULL</constant> the call + is identical to <function>sd_journal_stream_fd()</function>. For details about journal namespaces, see + <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> - <para>Each invocation of <function>sd_journal_stream_fd()</function> allocates a new log stream file descriptor, - that is not shared with prior or later invocations. The file descriptor is write-only (its reading direction is - shut down), and <constant>O_NONBLOCK</constant> is turned off initially.</para> + <para>It is recommended that applications log UTF-8 messages only with this API, but this is not enforced.</para> + + <para>Each invocation of these functions allocates a new log stream file descriptor, + that is not shared with prior or later invocations. The file descriptor is write-only (its reading direction + is shut down), and <constant>O_NONBLOCK</constant> is turned off initially.</para> </refsect1> <refsect1> <title>Return Value</title> - <para>The call returns a valid write-only file descriptor on - success or a negative errno-style error code.</para> + <para>The call returns a valid write-only file descriptor on success or a negative errno-style error code.</para> </refsect1> <refsect1> <title>Signal safety</title> - <para><function>sd_journal_stream_fd()</function> is "async signal safe" in the meaning of <citerefentry + <para><function>sd_journal_stream_fd()</function> and <function>sd_journal_stream_fd_with_namespace()</function> + are "async signal safe" in the meaning of <citerefentry project='man-pages'><refentrytitle>signal-safety</refentrytitle><manvolnum>7</manvolnum></citerefentry>. </para> </refsect1> @@ -106,20 +117,21 @@ <refsect1> <title>History</title> <para><function>sd_journal_stream_fd()</function> was added in version 187.</para> + <para><function>sd_journal_stream_fd_with_namespace()</function> was added in version 256.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fprintf</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_listen_fds.xml b/man/sd_listen_fds.xml index 7cd744e..8a10677 100644 --- a/man/sd_listen_fds.xml +++ b/man/sd_listen_fds.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_listen_fds" @@ -230,18 +230,18 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_is_socket</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_is_socket_inet</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_is_socket_unix</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_pid_notify_with_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_is_fifo</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_is_socket</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_is_socket_inet</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_is_socket_unix</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_pid_notify_with_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_login_monitor_new.xml b/man/sd_login_monitor_new.xml index 5b59e09..b6b0bc4 100644 --- a/man/sd_login_monitor_new.xml +++ b/man/sd_login_monitor_new.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_login_monitor_new" conditional='HAVE_PAM' @@ -244,13 +244,13 @@ else { <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_get_seats</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>poll</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>clock_gettime</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_machine_get_class.xml b/man/sd_machine_get_class.xml index e09b8a9..bc50ea1 100644 --- a/man/sd_machine_get_class.xml +++ b/man/sd_machine_get_class.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_machine_get_class" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -111,12 +111,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_pid_get_machine_name</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_pid_get_machine_name</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_notify.xml b/man/sd_notify.xml index 1b96c83..35c450b 100644 --- a/man/sd_notify.xml +++ b/man/sd_notify.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_notify" @@ -104,8 +104,8 @@ <para>If the <parameter>unset_environment</parameter> parameter is non-zero, <function>sd_notify()</function> will unset the <varname>$NOTIFY_SOCKET</varname> environment variable before returning (regardless of whether the function call itself succeeded or not). Further calls to - <function>sd_notify()</function> will then fail, and the variable is no longer inherited by child - processes.</para> + <function>sd_notify()</function> will then silently do nothing, and the variable is no longer inherited + by child processes.</para> <para>The <parameter>state</parameter> parameter should contain a newline-separated list of variable assignments, similar in style to an environment block. A trailing newline is implied if none is @@ -270,7 +270,7 @@ <listitem><para>The exit status of a service or the manager itself. Note that <command>systemd</command> currently does not consume this value when sent by services, so this assignment is only informational. The manager will send this notification to <emphasis>its</emphasis> - notification socket, which may be used to to collect an exit status from the system (a container or + notification socket, which may be used to collect an exit status from the system (a container or VM) as it shuts down. For example, <citerefentry project='debian'><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry> makes use of this. The value to return may be set via the @@ -420,8 +420,8 @@ <term>FDPOLL=0</term> <listitem><para>When used in combination with <varname>FDSTORE=1</varname>, disables polling of the - stored file descriptors regardless of whether or not they are pollable. As this option disables - automatic cleanup of the stored file descriptors on EPOLLERR and EPOLLHUP, care must be taken to + submitted file descriptors regardless of whether or not they are pollable. As this option disables + automatic cleanup of the submitted file descriptors on EPOLLERR and EPOLLHUP, care must be taken to ensure proper manual cleanup. Use of this option is not generally recommended except for when automatic cleanup has unwanted behavior such as prematurely discarding file descriptors from the store.</para> @@ -446,9 +446,14 @@ </variablelist> <para>The notification messages sent by services are interpreted by the service manager. Unknown - assignments may be logged, but are otherwise ignored. Thus, it is not useful to send assignments which - are not in this list. The service manager also sends some messages to <emphasis>its</emphasis> - notification socket, which are then consumed by the machine or container manager.</para> + assignments are ignored. Thus, it is safe (but often without effect) to send assignments which are not + in this list. The protocol is extensible, but care should be taken to ensure private extensions are + recognizable as such. Specifically, it is recommend to prefix them with <literal>X_</literal> followed by + some namespace identifier. The service manager also sends some messages to <emphasis>its</emphasis> + notification socket, which may then consumed by a supervising machine or container manager further up the + stack. The service manager sends a number of extension fields, for example + <varname>X_SYSTEMD_UNIT_ACTIVE=</varname>, for details see + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> </refsect1> <refsect1> @@ -480,17 +485,29 @@ <constant>AF_VSOCK</constant> address, which is useful for hypervisors/VMMs or other processes on the host to receive a notification when a virtual machine has finished booting. Note that in case the hypervisor does not support <constant>SOCK_DGRAM</constant> over <constant>AF_VSOCK</constant>, - <constant>SOCK_SEQPACKET</constant> will be used instead. The address should be in the form: - <literal>vsock:CID:PORT</literal>. Note that unlike other uses of vsock, the CID is mandatory and cannot - be <literal>VMADDR_CID_ANY</literal>. Note that PID1 will send the VSOCK packets from a privileged port - (i.e.: lower than 1024), as an attempt to address concerns that unprivileged processes in the guest might - try to send malicious notifications to the host, driving it to make destructive decisions based on - them.</para> - - <para>Note that, while using this library should be preferred in order to avoid code duplication, it is - also possible to reimplement the simple readiness notification protocol without external dependencies, - as demonstrated in the following self-contained example: - <programlisting><xi:include href="notify-selfcontained-example.c" parse="text"/></programlisting></para> + <constant>SOCK_SEQPACKET</constant> will be used instead. <literal>vsock-stream</literal>, + <literal>vsock-dgram</literal> and <literal>vsock-seqpacket</literal> can be used instead of + <literal>vsock</literal> to force usage of the corresponding socket type. The address should be in the + form: <literal>vsock:CID:PORT</literal>. Note that unlike other uses of vsock, the CID is mandatory and + cannot be <literal>VMADDR_CID_ANY</literal>. Note that PID1 will send the VSOCK packets from a + privileged port (i.e.: lower than 1024), as an attempt to address concerns that unprivileged processes in + the guest might try to send malicious notifications to the host, driving it to make destructive decisions + based on them.</para> + + <refsect2> + <title>Standalone Implementations</title> + <para>Note that, while using this library should be preferred in order to avoid code duplication, it is + also possible to reimplement the simple readiness notification protocol without external dependencies, + as demonstrated in the following self-contained examples from several languages:</para> + <refsect3> + <title>C</title> + <programlisting><xi:include href="notify-selfcontained-example.c" parse="text"/></programlisting> + </refsect3> + <refsect3> + <title>Python</title> + <programlisting><xi:include href="notify-selfcontained-example.py" parse="text"/></programlisting> + </refsect3> + </refsect2> </refsect1> <refsect1> @@ -526,8 +543,8 @@ <programlisting> sd_notifyf(0, "READY=1\n" - "STATUS=Processing requests…\n" - "MAINPID=%lu", + "STATUS=Processing requests…\n" + "MAINPID=%lu", (unsigned long) getpid());</programlisting> </example> @@ -538,7 +555,7 @@ sd_notifyf(0, "READY=1\n" <programlisting> sd_notifyf(0, "STATUS=Failed to start up: %s\n" - "ERRNO=%i", + "ERRNO=%i", strerror_r(errnum, (char[1024]){}, 1024), errnum);</programlisting> </example> @@ -580,15 +597,15 @@ sd_notify_barrier(0, 5 * 1000000); <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_watchdog_enabled</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_path_lookup.xml b/man/sd_path_lookup.xml index cb07303..f557e4f 100644 --- a/man/sd_path_lookup.xml +++ b/man/sd_path_lookup.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_path_lookup" xmlns:xi="http://www.w3.org/2001/XInclude"> diff --git a/man/sd_pid_get_owner_uid.xml b/man/sd_pid_get_owner_uid.xml index 4667e28..0855ea7 100644 --- a/man/sd_pid_get_owner_uid.xml +++ b/man/sd_pid_get_owner_uid.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_pid_get_owner_uid" conditional='HAVE_PAM' @@ -397,14 +397,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_session_is_active</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>getsid</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_seat_get_active.xml b/man/sd_seat_get_active.xml index d5d7c04..b087211 100644 --- a/man/sd_seat_get_active.xml +++ b/man/sd_seat_get_active.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_seat_get_active" conditional='HAVE_PAM' @@ -151,11 +151,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_session_get_seat</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_session_is_active.xml b/man/sd_session_is_active.xml index 79cf8af..1cbef64 100644 --- a/man/sd_session_is_active.xml +++ b/man/sd_session_is_active.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_session_is_active" conditional='HAVE_PAM' @@ -214,14 +214,14 @@ <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after use.</para> - <para><function>sd_session_get_class()</function> may be used to - determine the class of the session identified by the specified - session identifier. The returned string is one of - <literal>user</literal>, <literal>greeter</literal>, - <literal>lock-screen</literal>, or <literal>background</literal> - and needs to be freed with the libc - <citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> - call after use.</para> + <para><function>sd_session_get_class()</function> may be used to determine the class of the session + identified by the specified session identifier. The returned string is one of <literal>user</literal>, + <literal>user-early</literal>, <literal>user-incomplete</literal>, <literal>greeter</literal>, + <literal>lock-screen</literal>, <literal>background</literal>, <literal>background-light</literal>, + <literal>manager</literal> or <literal>manager-early</literal> and needs to be freed with the libc + <citerefentry + project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry> call after + use.</para> <para><function>sd_session_get_desktop()</function> may be used to determine the brand of the desktop running on the session @@ -358,11 +358,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_pid_get_session</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_uid_get_state.xml b/man/sd_uid_get_state.xml index 4a78ed9..2a91686 100644 --- a/man/sd_uid_get_state.xml +++ b/man/sd_uid_get_state.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_uid_get_state" conditional='HAVE_PAM' @@ -205,11 +205,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_pid_get_owner_uid</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_watchdog_enabled.xml b/man/sd_watchdog_enabled.xml index 4a6bd6f..0f0f02c 100644 --- a/man/sd_watchdog_enabled.xml +++ b/man/sd_watchdog_enabled.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sd_watchdog_enabled" @@ -139,14 +139,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_event_set_watchdog</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/shutdown.xml b/man/shutdown.xml index d973704..b92e583 100644 --- a/man/shutdown.xml +++ b/man/shutdown.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="shutdown" @@ -147,12 +147,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>halt</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/smbios-type-11.xml b/man/smbios-type-11.xml index 18d17bd..2fc215e 100644 --- a/man/smbios-type-11.xml +++ b/man/smbios-type-11.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="smbios-type-11" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -64,16 +64,26 @@ <xi:include href="version-info.xml" xpointer="v254"/></listitem> </varlistentry> + + <varlistentry> + <term><varname>io.systemd.boot.kernel-cmdline-extra=</varname><replaceable>CMDLINE</replaceable></term> + + <listitem><para>This allows configuration of additional kernel command line options for Boot Loader + Specification Type 1 entries, and is read by <command>systemd-boot</command>. For details see + <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/standard-conf.xml b/man/standard-conf.xml index cc2b874..0ff71ec 100644 --- a/man/standard-conf.xml +++ b/man/standard-conf.xml @@ -1,5 +1,5 @@ <?xml version="1.0"?> -<!DOCTYPE refsection PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- @@ -7,8 +7,13 @@ Copyright © 2014 Josh Triplett --> -<refsection> - <refsection id='confd'> +<refentry xmlns:xi="http://www.w3.org/2001/XInclude"> + <refnamediv> + <refname/> + <refpurpose/> + </refnamediv> + + <refsect1 id='confd'> <title>Configuration Directories and Precedence</title> <para>Configuration files are read from directories in <filename>/etc/</filename>, @@ -27,29 +32,40 @@ that is ordered later).</para> <para>Packages should install their configuration files in <filename>/usr/lib/</filename> (distribution - packages) or <filename>/usr/local/lib/</filename> (local installs). Files in <filename>/etc/</filename> - are reserved for the local administrator, who may use this logic to override the configuration files - installed by vendor packages. It is recommended to prefix all filenames with a two-digit number and a - dash, to simplify the ordering of the files.</para> + packages) or <filename>/usr/local/lib/</filename> (local installs) + <xi:include xpointer="usr-local-footnote" />. + Files in <filename>/etc/</filename> are reserved for the local administrator, who may use this logic to + override the configuration files installed by vendor packages.</para> + + <para>It is recommended to prefix all filenames with a two-digit number and a dash to simplify the + ordering. It is recommended to use the range 10-40 for configuration files in <filename>/usr/</filename> + and the range 60-90 for configuration files in <filename>/etc/</filename> and <filename>/run/</filename>, + to make sure that local and transient configuration files will always take priority over configuration + files shipped by the OS vendor.</para> <para>If the administrator wants to disable a configuration file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in the configuration directory in <filename>/etc/</filename>, with the same filename as the vendor configuration file. If the vendor configuration file is included in the initrd image, the image has to be regenerated.</para> - </refsection> + </refsect1> - <refsection id='main-conf'> + <refsect1 id='main-conf'> <title>Configuration Directories and Precedence</title> <para>The default configuration is set during compilation, so configuration is only needed when it is - necessary to deviate from those defaults. The main configuration file is either in - <filename>/usr/lib/systemd/</filename> or <filename>/etc/systemd/</filename> and contains commented out - entries showing the defaults as a guide to the administrator. Local overrides can be created by creating - drop-ins, as described below. The main configuration file can also be edited for this purpose (or a copy - in <filename>/etc/</filename> if it's shipped in <filename>/usr/</filename>) however using drop-ins for - local configuration is recommended over modifications to the main configuration file.</para> - - <para>In addition to the "main" configuration file, drop-in configuration snippets are read from + necessary to deviate from those defaults. The main configuration file is loaded from one of the + listed directories in order of priority, only the first file found is used: + <filename>/etc/systemd/</filename>, + <filename>/run/systemd/</filename>, + <filename>/usr/local/lib/systemd/</filename> <xi:include xpointer="usr-local-footnote" />, + <filename>/usr/lib/systemd/</filename>. + The vendor version of the file contains commented out entries showing the defaults as a guide to the + administrator. Local overrides can also be created by creating drop-ins, as described below. The main + configuration file can also be edited for this purpose (or a copy in <filename>/etc/</filename> if it's + shipped under <filename>/usr/</filename>), however using drop-ins for local configuration is recommended + over modifications to the main configuration file.</para> + + <para>In addition to the main configuration file, drop-in configuration snippets are read from <filename>/usr/lib/systemd/*.conf.d/</filename>, <filename>/usr/local/lib/systemd/*.conf.d/</filename>, and <filename>/etc/systemd/*.conf.d/</filename>. Those drop-ins have higher precedence and override the main configuration file. Files in the <filename>*.conf.d/</filename> configuration subdirectories are @@ -63,12 +79,28 @@ who may use this logic to override the configuration files installed by vendor packages. Drop-ins have to be used to override package drop-ins, since the main configuration file has lower precedence. It is recommended to prefix all filenames in those subdirectories with a two-digit number and a dash, to - simplify the ordering of the files. This also defined a concept of drop-in priority to allow - distributions to ship drop-ins within a specific range lower than the range used by users. This should - lower the risk of package drop-ins overriding accidentally drop-ins defined by users.</para> + simplify the ordering. This also defines a concept of drop-in priorities to allow OS vendors to ship + drop-ins within a specific range lower than the range used by users. This should lower the risk of + package drop-ins overriding accidentally drop-ins defined by users. It is recommended to use the range + 10-40 for drop-ins in <filename>/usr/</filename> and the range 60-90 for drop-ins in + <filename>/etc/</filename> and <filename>/run/</filename>, to make sure that local and transient drop-ins + take priority over drop-ins shipped by the OS vendor.</para> <para>To disable a configuration file supplied by the vendor, the recommended way is to place a symlink to <filename>/dev/null</filename> in the configuration directory in <filename>/etc/</filename>, with the same filename as the vendor configuration file.</para> - </refsection> -</refsection> + </refsect1> + + <refsect1> + <title>Extras</title> + + <para><filename>/usr/local/lib/systemd</filename> + <footnote id='usr-local-footnote'> + <para>💣💥🧨💥💥💣 Please note that those configuration files must be available at all times. If + <filename>/usr/local/</filename> is a separate partition, it may not be available during early boot, + and must not be used for configuration.</para> + </footnote> + </para> + </refsect1> + +</refentry> diff --git a/man/standard-options.xml b/man/standard-options.xml index eb27f5c..d181f90 100644 --- a/man/standard-options.xml +++ b/man/standard-options.xml @@ -1,17 +1,15 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE variablelist 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 --> -<variablelist - xmlns:xi="http://www.w3.org/2001/XInclude"> - +<variablelist> <varlistentry id='help'> <term><option>-h</option></term> <term><option>--help</option></term> <listitem id='help-text'> - <para>Print a short help text and exit. + <para id='help-para'>Print a short help text and exit. </para></listitem> </varlistentry> @@ -31,16 +29,6 @@ </listitem> </varlistentry> - <varlistentry id='no-pager-255'> - <term><option>--no-pager</option></term> - - <listitem> - <para>Do not pipe output into a pager.</para> - - <xi:include href="version-info.xml" xpointer="v255"/> - </listitem> - </varlistentry> - <varlistentry id='no-ask-password'> <term><option>--no-ask-password</option></term> @@ -48,7 +36,7 @@ </varlistentry> <varlistentry id='legend'> - <term><option>--legend=</option><replaceable>BOOL</replaceable></term> + <term><option>--legend=<replaceable>BOOL</replaceable></option></term> <listitem> <para>Enable or disable printing of the legend, i.e. column headers and the footer with hints. The @@ -85,7 +73,7 @@ </varlistentry> <varlistentry id='json'> - <term><option>--json=</option><replaceable>MODE</replaceable></term> + <term><option>--json=<replaceable>MODE</replaceable></option></term> <listitem><para>Shows output formatted as JSON. Expects one of <literal>short</literal> (for the shortest possible output without any redundant whitespace or line breaks), <literal>pretty</literal> @@ -93,6 +81,13 @@ off JSON output, the default).</para></listitem> </varlistentry> + <varlistentry id='j'> + <term><option>-j</option></term> + + <listitem><para>Equivalent to <option>--json=pretty</option> if running on a terminal, and + <option>--json=short</option> otherwise.</para></listitem> + </varlistentry> + <varlistentry id='signal'> <term><option>-s</option></term> <term><option>--signal=</option></term> @@ -140,4 +135,13 @@ </listitem> </varlistentry> + <varlistentry id='option-P'> + <term><option>-P</option></term> + + <listitem> + <para>Equivalent to <option>--value</option> <option>--property=</option>, i.e. shows the value of the + property without the property name or <literal>=</literal>. Note that using <option>-P</option> once + will also affect all properties listed with <option>-p</option>/<option>--property=</option>.</para> + </listitem> + </varlistentry> </variablelist> diff --git a/man/standard-specifiers.xml b/man/standard-specifiers.xml index 7aa7aca..3a2c0b0 100644 --- a/man/standard-specifiers.xml +++ b/man/standard-specifiers.xml @@ -1,5 +1,5 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE tbody 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 --> diff --git a/man/supported-controllers.xml b/man/supported-controllers.xml index 61cdf46..3ec0693 100644 --- a/man/supported-controllers.xml +++ b/man/supported-controllers.xml @@ -1,14 +1,15 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> -<para id="controllers-text">The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>, -<option>cpuset</option>, <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>, -<option>pids</option>, <option>bpf-firewall</option>, and <option>bpf-devices</option>.</para> + <para id="controllers-text">The following controller names may be specified: <option>cpu</option>, <option>cpuacct</option>, + <option>cpuset</option>, <option>io</option>, <option>blkio</option>, <option>memory</option>, <option>devices</option>, + <option>pids</option>, <option>bpf-firewall</option>, and <option>bpf-devices</option>.</para> </refsect1> diff --git a/man/sysctl.d.xml b/man/sysctl.d.xml index 4d810e6..7e1ecfa 100644 --- a/man/sysctl.d.xml +++ b/man/sysctl.d.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sysctl.d" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -21,9 +21,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/sysctl.d/*.conf</filename></para> - <para><filename>/run/sysctl.d/*.conf</filename></para> - <para><filename>/usr/lib/sysctl.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/sysctl.d/*.conf</filename></member> + <member><filename>/run/sysctl.d/*.conf</filename></member> + <member><filename>/usr/local/lib/sysctl.d/*.conf</filename></member> + <member><filename>/usr/lib/sysctl.d/*.conf</filename></member> + </simplelist></para> <programlisting>key.name.under.proc.sys = some value key/name/under/proc/sys = some value @@ -180,14 +183,14 @@ net.ipv4.conf.hub0.rp_filter = 1 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sysctl.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sysctl.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/system-only.xml b/man/system-only.xml index afd3d32..944be55 100644 --- a/man/system-only.xml +++ b/man/system-only.xml @@ -1,16 +1,17 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> -<para id="singular">This option is only available for system services and is not supported for services -running in per-user instances of the service manager.</para> + <para id="singular">This option is only available for system services and is not supported for services + running in per-user instances of the service manager.</para> -<para id="plural">These options are only available for system services and are not supported for services -running in per-user instances of the service manager.</para> + <para id="plural">These options are only available for system services and are not supported for services + running in per-user instances of the service manager.</para> </refsect1> diff --git a/man/system-or-user-ns.xml b/man/system-or-user-ns.xml index 532c1ef..b0f4247 100644 --- a/man/system-or-user-ns.xml +++ b/man/system-or-user-ns.xml @@ -1,20 +1,21 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> -<para id="singular">This option is only available for system services, or for services running in per-user - instances of the service manager in which case <varname>PrivateUsers=</varname> is implicitly enabled - (requires unprivileged user namespaces support to be enabled in the kernel via the - <literal>kernel.unprivileged_userns_clone=</literal> sysctl).</para> + <para id="singular">This option is only available for system services, or for services running in per-user + instances of the service manager in which case <varname>PrivateUsers=</varname> is implicitly enabled + (requires unprivileged user namespaces support to be enabled in the kernel via the + <literal>kernel.unprivileged_userns_clone=</literal> sysctl).</para> -<para id="plural">These options are only available for system services, or for services running in per-user - instances of the service manager in which case <varname>PrivateUsers=</varname> is implicitly enabled - (requires unprivileged user namespaces support to be enabled in the kernel via the - <literal>kernel.unprivileged_userns_clone=</literal> sysctl).</para> + <para id="plural">These options are only available for system services, or for services running in per-user + instances of the service manager in which case <varname>PrivateUsers=</varname> is implicitly enabled + (requires unprivileged user namespaces support to be enabled in the kernel via the + <literal>kernel.unprivileged_userns_clone=</literal> sysctl).</para> </refsect1> diff --git a/man/systemctl.xml b/man/systemctl.xml index 9bdd882..70fd91f 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -350,7 +350,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err "fragment" and "drop-ins" (source files) of units. Each file is preceded by a comment which includes the file name. Note that this shows the contents of the backing files - on disk, which may not match the system manager's + on disk, which might not match the system manager's understanding of these units if any unit files were updated on disk and the <command>daemon-reload</command> command wasn't issued since.</para> @@ -513,7 +513,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <!-- Note that we don't document force-reload here, as that is just compatibility support, and we generally don't document that. --> - <xi:include href="version-info.xml" xpointer="v229"/> + <xi:include href="version-info.xml" xpointer="v229"/> </listitem> </varlistentry> <varlistentry> @@ -569,6 +569,51 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err these three types of resources are generally redundant and reproducible on the next invocation of the unit). Note that the specified units must be stopped to invoke this operation.</para> + <table> + <title> + Possible values for <option>--what=</option> + </title> + + <tgroup cols='2'> + <thead> + <row> + <entry>Value</entry> + <entry>Unit Setting</entry> + </row> + </thead> + <tbody> + <row> + <entry><literal>runtime</literal></entry> + <entry><varname>RuntimeDirectory=</varname></entry> + </row> + <row> + <entry><literal>state</literal></entry> + <entry><varname>StateDirectory=</varname></entry> + </row> + <row> + <entry><literal>cache</literal></entry> + <entry><varname>CacheDirectory=</varname></entry> + </row> + <row> + <entry><literal>logs</literal></entry> + <entry><varname>LogsDirectory=</varname></entry> + </row> + <row> + <entry><literal>configuration</literal></entry> + <entry><varname>ConfigurationDirectory=</varname></entry> + </row> + <row> + <entry><literal>fdstore</literal></entry> + <entry><varname>FileDescriptorStorePreserve=</varname></entry> + </row> + <row> + <entry><literal>all</literal></entry> + <entry>All of the above</entry> + </row> + </tbody> + </tgroup> + </table> + <xi:include href="version-info.xml" xpointer="v243"/> </listitem> </varlistentry> @@ -1066,8 +1111,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </tgroup> </table> - <xi:include href="version-info.xml" xpointer="v238"/> - + <xi:include href="version-info.xml" xpointer="v238"/> </listitem> </varlistentry> @@ -1171,7 +1215,6 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <command>enable</command>.</para> <xi:include href="version-info.xml" xpointer="v217"/> - </listitem> </varlistentry> @@ -1179,38 +1222,40 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><command>edit <replaceable>UNIT</replaceable>…</command></term> <listitem> - <para>Edit a drop-in snippet or a whole replacement file if - <option>--full</option> is specified, to extend or override the - specified unit.</para> + <para>Edit or replace a drop-in snippet or the main unit file, to extend or override the + definition of the specified unit.</para> - <para>Depending on whether <option>--system</option> (the default), - <option>--user</option>, or <option>--global</option> is specified, - this command creates a drop-in file for each unit either for the system, - for the calling user, or for all futures logins of all users. Then, - the editor (see the "Environment" section below) is invoked on - temporary files which will be written to the real location if the - editor exits successfully.</para> + <para>Depending on whether <option>--system</option> (the default), <option>--user</option>, or + <option>--global</option> is specified, this command will operate on the system unit files, unit + files for the calling user, or the unit files shared between all users.</para> + + <para>The editor (see the "Environment" section below) is invoked on temporary files which will + be written to the real location if the editor exits successfully. After the editing is finished, + configuration is reloaded, equivalent to <command>systemctl daemon-reload --system</command> or + <command>systemctl daemon-reload --user</command>. For <command>edit --global</command>, the + reload is not performed and the edits will take effect only for subsequent logins (or after a + reload is requested in a different way).</para> + + <para>If <option>--full</option> is specified, a replacement for the main unit file will be + created or edited. Otherwise, a drop-in file will be created or edited.</para> <para>If <option>--drop-in=</option> is specified, the given drop-in file name will be used instead of the default <filename>override.conf</filename>.</para> - <para>If <option>--full</option> is specified, this will copy the - original units instead of creating drop-in files.</para> - - <para>If <option>--force</option> is specified and any units do - not already exist, new unit files will be opened for editing.</para> + <para>The unit must exist, i.e. its main unit file must be present. If <option>--force</option> + is specified, this requirement is ignored and a new unit may be created (with + <option>--full</option>), or a drop-in for a nonexistent unit may be created.</para> <para>If <option>--runtime</option> is specified, the changes will be made temporarily in <filename>/run/</filename> and they will be lost on the next reboot.</para> + <para>If <option>--stdin</option> is specified, the new contents will be read from standard + input. In this mode, the old contents of the file are discarded.</para> + <para>If the temporary file is empty upon exit, the modification of the related unit is canceled.</para> - <para>After the units have been edited, systemd configuration is - reloaded (in a way that is equivalent to <command>daemon-reload</command>). - </para> - <para>Note that this command cannot be used to remotely edit units and that you cannot temporarily edit units which are in <filename>/etc/</filename>, since they take precedence over @@ -1583,7 +1628,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </tgroup> </table> - <xi:include href="version-info.xml" xpointer="v215"/> + <xi:include href="version-info.xml" xpointer="v215"/> </listitem> </varlistentry> @@ -1774,12 +1819,34 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </varlistentry> <varlistentry> + <term><command>sleep</command></term> + + <listitem> + <para>Put the system to sleep, through <command>suspend</command>, <command>hibernate</command>, + <command>hybrid-sleep</command>, or <command>suspend-then-hibernate</command>. The sleep operation + to use is automatically selected by <citerefentry> + <refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + By default, <command>suspend-then-hibernate</command> is used, and falls back to <command>suspend</command> + and then <command>hibernate</command> if not supported. Refer to <varname>SleepOperation=</varname> + setting in <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more details. This command is asynchronous, and will return after the sleep operation is + successfully enqueued. It will not wait for the sleep/resume cycle to complete.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><command>suspend</command></term> <listitem> <para>Suspend the system. This will trigger activation of the special target unit <filename>suspend.target</filename>. This command is asynchronous, and will return after the suspend operation is successfully enqueued. It will not wait for the suspend/resume cycle to complete.</para> + + <para>If <option>--force</option> is specified, and <command>systemd-logind</command> returned + error for the operation, the error will be ignored and the operation will be tried again directly + through starting the target unit.</para> </listitem> </varlistentry> @@ -1790,6 +1857,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <para>Hibernate the system. This will trigger activation of the special target unit <filename>hibernate.target</filename>. This command is asynchronous, and will return after the hibernation operation is successfully enqueued. It will not wait for the hibernate/thaw cycle to complete.</para> + + <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para> </listitem> </varlistentry> @@ -1801,6 +1870,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <filename>hybrid-sleep.target</filename>. This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued. It will not wait for the sleep/wake-up cycle to complete.</para> + <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para> + <xi:include href="version-info.xml" xpointer="v196"/> </listitem> </varlistentry> @@ -1809,12 +1880,15 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><command>suspend-then-hibernate</command></term> <listitem> - <para>Suspend the system and hibernate it after the delay specified in <filename>systemd-sleep.conf</filename>. - This will trigger activation of the special target unit <filename>suspend-then-hibernate.target</filename>. - This command is asynchronous, and will return after the hybrid sleep operation is successfully enqueued. + <para>Suspend the system and hibernate it when the battery is low, or when the delay specified + in <filename>systemd-sleep.conf</filename> elapsed. This will trigger activation of the special + target unit <filename>suspend-then-hibernate.target</filename>. This command is asynchronous, + and will return after the hybrid sleep operation is successfully enqueued. It will not wait for the sleep/wake-up or hibernate/thaw cycle to complete.</para> - <xi:include href="version-info.xml" xpointer="v240"/> + <para>This command honors <option>--force</option> in the same way as <command>suspend</command>.</para> + + <xi:include href="version-info.xml" xpointer="v240"/> </listitem> </varlistentry> </variablelist> @@ -1855,7 +1929,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err for more details. The patterns are matched against the primary names of units currently in memory, and patterns which do not match anything are silently skipped. For example: - <programlisting># systemctl stop sshd@*.service</programlisting> + <programlisting># systemctl stop "sshd@*.service"</programlisting> will stop all <filename>sshd@.service</filename> instances. Note that alias names of units, and units that aren't in memory are not considered for glob expansion. </para> @@ -1944,12 +2018,8 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><option>-P</option></term> <listitem> - <para>Equivalent to <option>--value</option> <option>--property=</option>, i.e. shows the - value of the property without the property name or <literal>=</literal>. Note that using - <option>-P</option> once will also affect all properties listed with - <option>-p</option>/<option>--property=</option>.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> + <xi:include href="standard-options.xml" xpointer="xpointer(//varlistentry[@id='option-P']/listitem/para)" /> + <xi:include href="version-info.xml" xpointer="v246"/> </listitem> </varlistentry> @@ -2091,7 +2161,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <para>When printing properties with <command>show</command>, only print the value, and skip the property name and <literal>=</literal>. Also see option <option>-P</option> above.</para> - <xi:include href="version-info.xml" xpointer="v230"/> + <xi:include href="version-info.xml" xpointer="v230"/> </listitem> </varlistentry> @@ -2101,7 +2171,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <listitem> <para>When showing sockets, show the type of the socket.</para> - <xi:include href="version-info.xml" xpointer="v202"/> + <xi:include href="version-info.xml" xpointer="v202"/> </listitem> </varlistentry> @@ -2109,72 +2179,72 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><option>--job-mode=</option></term> <listitem> - <para>When queuing a new job, this option controls how to deal with - already queued jobs. It takes one of <literal>fail</literal>, - <literal>replace</literal>, - <literal>replace-irreversibly</literal>, - <literal>isolate</literal>, - <literal>ignore-dependencies</literal>, - <literal>ignore-requirements</literal>, - <literal>flush</literal>, - <literal>triggering</literal>, or - <literal>restart-dependencies</literal>. Defaults to - <literal>replace</literal>, except when the - <command>isolate</command> command is used which implies the - <literal>isolate</literal> job mode.</para> - - <para>If <literal>fail</literal> is specified and a requested - operation conflicts with a pending job (more specifically: - causes an already pending start job to be reversed into a stop - job or vice versa), cause the operation to fail.</para> - - <para>If <literal>replace</literal> (the default) is - specified, any conflicting pending job will be replaced, as - necessary.</para> - - <para>If <literal>replace-irreversibly</literal> is specified, - operate like <literal>replace</literal>, but also mark the new - jobs as irreversible. This prevents future conflicting - transactions from replacing these jobs (or even being enqueued - while the irreversible jobs are still pending). Irreversible - jobs can still be cancelled using the <command>cancel</command> - command. This job mode should be used on any transaction which - pulls in <filename>shutdown.target</filename>.</para> - - <para><literal>isolate</literal> is only valid for start - operations and causes all other units to be stopped when the - specified unit is started. This mode is always used when the - <command>isolate</command> command is used.</para> - - <para><literal>flush</literal> will cause all queued jobs to - be canceled when the new job is enqueued.</para> - - <para>If <literal>ignore-dependencies</literal> is specified, - then all unit dependencies are ignored for this new job and - the operation is executed immediately. If passed, no required - units of the unit passed will be pulled in, and no ordering - dependencies will be honored. This is mostly a debugging and - rescue tool for the administrator and should not be used by - applications.</para> - - <para><literal>ignore-requirements</literal> is similar to - <literal>ignore-dependencies</literal>, but only causes the - requirement dependencies to be ignored, the ordering - dependencies will still be honored.</para> - - <para><literal>triggering</literal> may only be used with - <command>systemctl stop</command>. In this mode, the specified - unit and any active units that trigger it are stopped. See the - discussion of - <varname>Triggers=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> - for more information about triggering units.</para> - - <para><literal>restart-dependencies</literal> may only be used with - <command>systemctl start</command>. In this mode, dependencies of - the specified unit will receive restart propagation, as if a restart - job had been enqueued for the unit.</para> - - <xi:include href="version-info.xml" xpointer="v209"/> + <para>When queuing a new job, this option controls how to deal with + already queued jobs. It takes one of <literal>fail</literal>, + <literal>replace</literal>, + <literal>replace-irreversibly</literal>, + <literal>isolate</literal>, + <literal>ignore-dependencies</literal>, + <literal>ignore-requirements</literal>, + <literal>flush</literal>, + <literal>triggering</literal>, or + <literal>restart-dependencies</literal>. Defaults to + <literal>replace</literal>, except when the + <command>isolate</command> command is used which implies the + <literal>isolate</literal> job mode.</para> + + <para>If <literal>fail</literal> is specified and a requested + operation conflicts with a pending job (more specifically: + causes an already pending start job to be reversed into a stop + job or vice versa), cause the operation to fail.</para> + + <para>If <literal>replace</literal> (the default) is + specified, any conflicting pending job will be replaced, as + necessary.</para> + + <para>If <literal>replace-irreversibly</literal> is specified, + operate like <literal>replace</literal>, but also mark the new + jobs as irreversible. This prevents future conflicting + transactions from replacing these jobs (or even being enqueued + while the irreversible jobs are still pending). Irreversible + jobs can still be cancelled using the <command>cancel</command> + command. This job mode should be used on any transaction which + pulls in <filename>shutdown.target</filename>.</para> + + <para><literal>isolate</literal> is only valid for start + operations and causes all other units to be stopped when the + specified unit is started. This mode is always used when the + <command>isolate</command> command is used.</para> + + <para><literal>flush</literal> will cause all queued jobs to + be canceled when the new job is enqueued.</para> + + <para>If <literal>ignore-dependencies</literal> is specified, + then all unit dependencies are ignored for this new job and + the operation is executed immediately. If passed, no required + units of the unit passed will be pulled in, and no ordering + dependencies will be honored. This is mostly a debugging and + rescue tool for the administrator and should not be used by + applications.</para> + + <para><literal>ignore-requirements</literal> is similar to + <literal>ignore-dependencies</literal>, but only causes the + requirement dependencies to be ignored, the ordering + dependencies will still be honored.</para> + + <para><literal>triggering</literal> may only be used with + <command>systemctl stop</command>. In this mode, the specified + unit and any active units that trigger it are stopped. See the + discussion of + <varname>Triggers=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more information about triggering units.</para> + + <para><literal>restart-dependencies</literal> may only be used with + <command>systemctl start</command>. In this mode, dependencies of + the specified unit will receive restart propagation, as if a restart + job had been enqueued for the unit.</para> + + <xi:include href="version-info.xml" xpointer="v209"/> </listitem> </varlistentry> @@ -2190,7 +2260,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err run as effect of the enqueued jobs might request further jobs to be pulled in. This means that completion of the listed jobs might ultimately entail more jobs than the listed ones.</para> - <xi:include href="version-info.xml" xpointer="v242"/> + <xi:include href="version-info.xml" xpointer="v242"/> </listitem> </varlistentry> @@ -2237,7 +2307,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <listitem> <para>Shortcut for <option>--check-inhibitors=no</option>.</para> - <xi:include href="version-info.xml" xpointer="v198"/> + <xi:include href="version-info.xml" xpointer="v198"/> </listitem> </varlistentry> @@ -2289,7 +2359,10 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </listitem> <listitem> <para>when a <command>stop</command>-ped, <command>disable</command>-d, or <command>mask</command>-ed - unit still has active triggering units.</para> + unit still has active triggering units,</para> + </listitem> + <listitem> + <para>when a unit file is changed and requires <command>daemon-reload</command>.</para> </listitem> </itemizedlist> </para> @@ -2315,14 +2388,16 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><option>--wait</option></term> <listitem> - <para>Synchronously wait for started units to terminate again. - This option may not be combined with <option>--no-block</option>. - Note that this will wait forever if any given unit never terminates - (by itself or by getting stopped explicitly); particularly services - which use <literal>RemainAfterExit=yes</literal>.</para> + <para>When used with <command>start</command> or <command>restart</command>, synchronously wait for + started units to terminate again. This option may not be combined with <option>--no-block</option>. + Note that this will wait forever if any given unit never terminates (by itself or by getting + stopped explicitly); particularly services which use <literal>RemainAfterExit=yes</literal>.</para> - <para>When used with <command>is-system-running</command>, wait - until the boot process is completed before returning.</para> + <para>When used with <command>is-system-running</command>, wait until the boot process is completed + before returning.</para> + + <para>When used with <command>kill</command>, wait until the signalled units terminate. Note that + this will wait forever if any given unit never terminates.</para> <xi:include href="version-info.xml" xpointer="v232"/> </listitem> @@ -2414,12 +2489,12 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <filename>&UMOUNT_PATH;</filename>), but no main process is defined. If omitted, defaults to <option>all</option>.</para> - <xi:include href="version-info.xml" xpointer="v252"/> + <xi:include href="version-info.xml" xpointer="v252"/> </listitem> </varlistentry> <varlistentry> - <term><option>--kill-value=</option><replaceable>INT</replaceable></term> + <term><option>--kill-value=<replaceable>INT</replaceable></option></term> <listitem><para>If used with the <command>kill</command> command, enqueues a signal along with the specified integer value parameter to the specified process(es). This operation is only available for @@ -2458,7 +2533,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <varname>FileDescriptorStorePreserve=</varname> option is enabled, since the file descriptor store is otherwise cleaned automatically when the unit is stopped.</para> - <xi:include href="version-info.xml" xpointer="v243"/> + <xi:include href="version-info.xml" xpointer="v243"/> </listitem> </varlistentry> @@ -2467,22 +2542,28 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><option>--force</option></term> <listitem> - <para>When used with <command>enable</command>, overwrite - any existing conflicting symlinks.</para> - - <para>When used with <command>edit</command>, create all of the - specified units which do not already exist.</para> - - <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command> or - <command>kexec</command>, execute the selected operation without shutting down all units. However, all - processes will be killed forcibly and all file systems are unmounted or remounted read-only. This is hence a - drastic but relatively safe option to request an immediate reboot. If <option>--force</option> is specified - twice for these operations (with the exception of <command>kexec</command>), they will be executed - immediately, without terminating any processes or unmounting any file systems. Warning: specifying - <option>--force</option> twice with any of these operations might result in data loss. Note that when - <option>--force</option> is specified twice the selected operation is executed by - <command>systemctl</command> itself, and the system manager is not contacted. This means the command should - succeed even when the system manager has crashed.</para> + <para>When used with <command>enable</command>, overwrite any existing conflicting symlinks.</para> + + <para>When used with <command>edit</command>, create all of the specified units which do not already exist.</para> + + <para>When used with <command>suspend</command>, <command>hibernate</command>, <command>hybrid-sleep</command>, + or <command>suspend-then-hibernate</command>, the error returned by <command>systemd-logind</command> + will be ignored, and the operation will be performed directly through starting the corresponding units. + </para> + + <para>When used with <command>halt</command>, <command>poweroff</command>, <command>reboot</command>, + or <command>kexec</command>, execute the selected operation without shutting down all units. However, + all processes will be killed forcibly and all file systems are unmounted or remounted read-only. + This is hence a drastic but relatively safe option to request an immediate reboot. If <option>--force</option> + is specified twice for these operations (with the exception of <command>kexec</command>), they will + be executed immediately, without terminating any processes or unmounting any file systems.</para> + + <warning> + <para>Specifying <option>--force</option> twice with any of these operations might result in data loss. + Note that when <option>--force</option> is specified twice the selected operation is executed by + <command>systemctl</command> itself, and the system manager is not contacted. This means the command + should succeed even when the system manager has crashed.</para> + </warning> </listitem> </varlistentry> @@ -2494,7 +2575,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err short message explaining the reason for the operation. The message will be logged together with the default shutdown message.</para> - <xi:include href="version-info.xml" xpointer="v225"/> + <xi:include href="version-info.xml" xpointer="v225"/> </listitem> </varlistentry> @@ -2508,7 +2589,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err or stop operation is only carried out when the respective enable or disable operation has been successful.</para> - <xi:include href="version-info.xml" xpointer="v220"/> + <xi:include href="version-info.xml" xpointer="v220"/> </listitem> </varlistentry> @@ -2575,7 +2656,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err enabled according to the preset rules, or only enabled, or only disabled.</para> - <xi:include href="version-info.xml" xpointer="v215"/> + <xi:include href="version-info.xml" xpointer="v215"/> </listitem> </varlistentry> @@ -2612,7 +2693,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err setup interface for the next boot. Note that this functionality is not available on all systems. </para> - <xi:include href="version-info.xml" xpointer="v220"/> + <xi:include href="version-info.xml" xpointer="v220"/> </listitem> </varlistentry> @@ -2626,7 +2707,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err in order to disable the menu timeout. Note that not all boot loaders support this functionality. </para> - <xi:include href="version-info.xml" xpointer="v242"/> + <xi:include href="version-info.xml" xpointer="v242"/> </listitem> </varlistentry> @@ -2640,7 +2721,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err or <literal>help</literal> in order to list available entries. Note that not all boot loaders support this functionality.</para> - <xi:include href="version-info.xml" xpointer="v242"/> + <xi:include href="version-info.xml" xpointer="v242"/> </listitem> </varlistentry> @@ -2648,11 +2729,12 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <term><option>--reboot-argument=</option></term> <listitem> - <para>This switch is used with <command>reboot</command>. The value is architecture and firmware specific. As an example, <literal>recovery</literal> - might be used to trigger system recovery, and <literal>fota</literal> might be used to trigger a - <quote>firmware over the air</quote> update.</para> + <para>This switch is used with <command>reboot</command>. The value is architecture and firmware + specific. As an example, <literal>recovery</literal> might be used to trigger system recovery, and + <literal>fota</literal> might be used to trigger a <quote>firmware over the air</quote> + update.</para> - <xi:include href="version-info.xml" xpointer="v246"/> + <xi:include href="version-info.xml" xpointer="v246"/> </listitem> </varlistentry> @@ -2665,7 +2747,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err the output is printed as a list instead of a tree, and the bullet circles are omitted.</para> - <xi:include href="version-info.xml" xpointer="v203"/> + <xi:include href="version-info.xml" xpointer="v203"/> </listitem> </varlistentry> @@ -2723,7 +2805,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </varlistentry> </variablelist> - <xi:include href="version-info.xml" xpointer="v247"/> + <xi:include href="version-info.xml" xpointer="v247"/> </listitem> </varlistentry> @@ -2762,7 +2844,7 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err </varlistentry> <varlistentry> - <term><option>--drop-in=</option><replaceable>NAME</replaceable></term> + <term><option>--drop-in=<replaceable>NAME</replaceable></option></term> <listitem><para>When used with <command>edit</command>, use <replaceable>NAME</replaceable> as the drop-in file name instead of <filename>override.conf</filename>.</para> @@ -2782,12 +2864,34 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err section "PARSING TIMESTAMPS". Specially, if <literal>show</literal> is given, the currently scheduled action will be shown, which can be canceled by passing an empty string or <literal>cancel</literal>.</para> - <xi:include href="version-info.xml" xpointer="v254"/> + <xi:include href="version-info.xml" xpointer="v254"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--stdin</option></term> + + <listitem> + <para>When used with <command>edit</command>, the contents of the file will be read from standard + input and the editor will not be launched. In this mode, the old contents of the file are + completely replaced. This is useful to "edit" unit files from scripts:</para> + + <programlisting>$ systemctl edit --drop-in=limits.conf --stdin some-service.service <<EOF +[Unit] +AllowedCPUs=7,11 +EOF + </programlisting> + + <para>Multiple drop-ins may be "edited" in this mode; the same contents will be written to all of + them.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> + <xi:include href="user-system-options.xml" xpointer="capsule" /> <xi:include href="standard-options.xml" xpointer="no-pager" /> <xi:include href="standard-options.xml" xpointer="legend" /> @@ -2888,19 +2992,19 @@ Jan 12 10:46:45 example.com bluetoothd[8900]: gatt-time-server: Input/output err <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-ac-power.xml b/man/systemd-ac-power.xml index 58aa706..cbf7279 100644 --- a/man/systemd-ac-power.xml +++ b/man/systemd-ac-power.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-ac-power" xmlns:xi="http://www.w3.org/2001/XInclude"> diff --git a/man/systemd-analyze.xml b/man/systemd-analyze.xml index 35ad843..9a4b0ca 100644 --- a/man/systemd-analyze.xml +++ b/man/systemd-analyze.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-analyze" conditional='ENABLE_ANALYZE' @@ -177,7 +177,14 @@ <cmdsynopsis> <command>systemd-analyze</command> <arg choice="opt" rep="repeat">OPTIONS</arg> - <arg choice="plain">srk</arg> ><arg choice="plain"><replaceable>FILE</replaceable></arg> + <arg choice="plain">srk</arg> + <arg choice="opt"><replaceable>>FILE</replaceable></arg> + </cmdsynopsis> + <cmdsynopsis> + <command>systemd-analyze</command> + <arg choice="opt" rep="repeat">OPTIONS</arg> + <arg choice="plain">architectures</arg> + <arg choice="opt" rep="repeat"><replaceable>NAME</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> @@ -933,12 +940,43 @@ NR NAME SHA256 </refsect2> <refsect2> - <title><command>systemd-analyze srk > <replaceable>FILE</replaceable></command></title> + <title><command>systemd-analyze srk <optional>><replaceable>FILE</replaceable></optional></command></title> <para>This command reads the Storage Root Key (SRK) from the TPM2 device, and writes it in marshalled - TPM2B_PUBLIC format to stdout. Example:</para> + TPM2B_PUBLIC format to stdout. The output is non-printable data, so it should be redirected to a file + or into a pipe.</para> + + <example> + <title>Save the Storage Root Key to <filename>srk.tpm2b_public</filename></title> + + <programlisting>systemd-analyze srk >srk.tpm2b_public</programlisting> + </example> + </refsect2> + + <refsect2> + <title><command>systemd-analyze architectures <optional><replaceable>NAME</replaceable>...</optional></command></title> + + <para>Lists all known CPU architectures, and which ones are native. The listed architecture names are + those <varname>ConditionArchitecture=</varname> supports, see + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details. If architecture names are specified only those specified are listed.</para> - <programlisting>systemd-analyze srk > srk.tpm2b_public</programlisting> + <example> + <title>Table output</title> + <programlisting>$ systemd-analyze architectures +NAME SUPPORT +alpha foreign +arc foreign +arc-be foreign +arm foreign +arm64 foreign +… +sparc foreign +sparc64 foreign +tilegx foreign +x86 secondary +x86-64 native</programlisting> + </example> </refsect2> </refsect1> @@ -980,16 +1018,12 @@ NR NAME SHA256 <term><option>--order</option></term> <term><option>--require</option></term> - <listitem><para>When used in conjunction with the - <command>dot</command> command (see above), selects which - dependencies are shown in the dependency graph. If - <option>--order</option> is passed, only dependencies of type - <varname>After=</varname> or <varname>Before=</varname> are - shown. If <option>--require</option> is passed, only - dependencies of type <varname>Requires=</varname>, - <varname>Requisite=</varname>, - <varname>Wants=</varname> and <varname>Conflicts=</varname> - are shown. If neither is passed, this shows dependencies of + <listitem><para>When used in conjunction with the <command>dot</command> command (see above), + selects which dependencies are shown in the dependency graph. If <option>--order</option> is passed, + only dependencies of type <varname>After=</varname> or <varname>Before=</varname> are shown. + If <option>--require</option> is passed, only dependencies of type <varname>Requires=</varname>, + <varname>Requisite=</varname>, <varname>BindsTo=</varname>, <varname>Wants=</varname>, and + <varname>Conflicts=</varname> are shown. If neither is passed, this shows dependencies of all these types.</para> <xi:include href="version-info.xml" xpointer="v198"/></listitem> @@ -1022,7 +1056,7 @@ NR NAME SHA256 </varlistentry> <varlistentry> - <term><option>--fuzz=</option><replaceable>timespan</replaceable></term> + <term><option>--fuzz=<replaceable>timespan</replaceable></option></term> <listitem><para>When used in conjunction with the <command>critical-chain</command> command (see above), also @@ -1075,8 +1109,10 @@ NR NAME SHA256 <varlistentry> <term><option>--root=<replaceable>PATH</replaceable></option></term> - <listitem><para>With <command>cat-files</command> and <command>verify</command>, - operate on files underneath the specified root path <replaceable>PATH</replaceable>.</para> + <listitem><para>With <command>cat-config</command>, <command>verify</command>, + <command>condition</command> and <command>security</command> when used with + <option>--offline=</option>, operate on files underneath the specified root path + <replaceable>PATH</replaceable>.</para> <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> @@ -1084,8 +1120,10 @@ NR NAME SHA256 <varlistentry> <term><option>--image=<replaceable>PATH</replaceable></option></term> - <listitem><para>With <command>cat-files</command> and <command>verify</command>, - operate on files inside the specified image path <replaceable>PATH</replaceable>.</para> + <listitem><para>With <command>cat-config</command>, <command>verify</command>, + <command>condition</command> and <command>security</command> when used with + <option>--offline=</option>, operate on files inside the specified image path + <replaceable>PATH</replaceable>.</para> <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> @@ -1585,10 +1623,10 @@ NR NAME SHA256 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-ask-password-console.service.xml b/man/systemd-ask-password-console.service.xml index 03b7317..d103cff 100644 --- a/man/systemd-ask-password-console.service.xml +++ b/man/systemd-ask-password-console.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-ask-password-console.service"> @@ -25,10 +25,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>systemd-ask-password-console.service</filename></para> - <para><filename>systemd-ask-password-console.path</filename></para> - <para><filename>systemd-ask-password-wall.service</filename></para> - <para><filename>systemd-ask-password-wall.path</filename></para> + <para><simplelist> + <member><filename>systemd-ask-password-console.service</filename></member> + <member><filename>systemd-ask-password-console.path</filename></member> + <member><filename>systemd-ask-password-wall.service</filename></member> + <member><filename>systemd-ask-password-wall.path</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -57,11 +59,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-ask-password.xml b/man/systemd-ask-password.xml index 5bae448..91bc6f7 100644 --- a/man/systemd-ask-password.xml +++ b/man/systemd-ask-password.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-ask-password" @@ -23,7 +23,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-ask-password <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg></command> + <command>systemd-ask-password</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt">MESSAGE</arg> </cmdsynopsis> </refsynopsisdiv> @@ -255,14 +255,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-tty-ask-password-agent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>keyctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-backlight@.service.xml b/man/systemd-backlight@.service.xml index 431b27b..bb7f2b6 100644 --- a/man/systemd-backlight@.service.xml +++ b/man/systemd-backlight@.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-backlight@.service" conditional='ENABLE_BACKLIGHT' +<refentry id="systemd-backlight_.service" conditional='ENABLE_BACKLIGHT' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -31,13 +31,22 @@ <refsect1> <title>Description</title> - <para><filename>systemd-backlight@.service</filename> is a service that restores the display backlight - brightness at early boot and saves it at shutdown. On disk, the backlight brightness is stored in - <filename>/var/lib/systemd/backlight/</filename>. During loading, if the udev property - <option>ID_BACKLIGHT_CLAMP</option> is not set to false, the brightness is clamped to a value of at least - 1 or 5% of maximum brightness, whichever is greater. The percentage can be adjusted by specifying a - percentage (needs to be suffixed with <literal>%</literal>, e.g. <literal>30%</literal>) to the property - <option>ID_BACKLIGHT_CLAMP</option>.</para> + <para><filename>systemd-backlight@.service</filename> is a service that restores the brightness of + a display backlight or LED (e.g. keyboard backlight) device at early boot, and saves it at shutdown. + The brightness is stored in <filename>/var/lib/systemd/backlight/</filename>.</para> + + <para>On restoring brightness of a display backlight device, <command>systemd-backlight</command> reads + <varname>ID_BACKLIGHT_CLAMP</varname> udev property, that takes a boolean value or a percentage (needs to + be suffixed with <literal>%</literal>, e.g. <literal>30%</literal>). When a percentage is specified, the + saved brightness is clamped to a value of at least 1 or the specified percentage of the maximum + brightness, whichever is greater. When unset or set to true, the brightness is clamped in the same way + with percentage 5%. When false, the saved brightness will not be clamped, and loaded as is.</para> + + <para>On restoring brightness of a LED device, <command>systemd-backlight</command> reads + <varname>ID_LEDS_CLAMP</varname> udev property, that also takes a boolean value or a percentage. When a + percentage is specified, the saved brightness is clamped to the specified percentage of the maximum + brightness. When set to true, the brightness is clamped in the same way with percentage 5%. When unset or + set to false, the saved brightness will not be clamped, and loaded as is.</para> </refsect1> <refsect1> diff --git a/man/systemd-battery-check.service.xml b/man/systemd-battery-check.service.xml index 8be5484..a5f564b 100644 --- a/man/systemd-battery-check.service.xml +++ b/man/systemd-battery-check.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-battery-check.service" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -66,7 +66,7 @@ <variablelist class='kernel-commandline-options'> <varlistentry> - <term><varname>systemd.battery-check=<replaceable>BOOL</replaceable></varname></term> + <term><varname>systemd.battery_check=<replaceable>BOOL</replaceable></varname></term> <listitem> <para>Takes a boolean. If specified with false, <command>systemd-battery-check</command> command diff --git a/man/systemd-binfmt.service.xml b/man/systemd-binfmt.service.xml index 15453fa..68e770c 100644 --- a/man/systemd-binfmt.service.xml +++ b/man/systemd-binfmt.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-binfmt.service" conditional='ENABLE_BINFMT' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -61,11 +61,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>binfmt.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>wine</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-bless-boot-generator.xml b/man/systemd-bless-boot-generator.xml index 173d5ae..81743b9 100644 --- a/man/systemd-bless-boot-generator.xml +++ b/man/systemd-bless-boot-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-bless-boot-generator" conditional='ENABLE_BOOTLOADER'> @@ -38,11 +38,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-bless-boot.service.xml b/man/systemd-bless-boot.service.xml index c39f248..7ace770 100644 --- a/man/systemd-bless-boot.service.xml +++ b/man/systemd-bless-boot.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-bless-boot.service" conditional='ENABLE_BOOTLOADER' +<refentry id="systemd-bless-boot.service" conditional='ENABLE_BOOTLOADER HAVE_BLKID' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -111,11 +111,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-boot-check-no-failures.service.xml b/man/systemd-boot-check-no-failures.service.xml index 39a2aa8..dac5037 100644 --- a/man/systemd-boot-check-no-failures.service.xml +++ b/man/systemd-boot-check-no-failures.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-boot-check-no-failures.service" @@ -43,10 +43,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-boot-random-seed.service.xml b/man/systemd-boot-random-seed.service.xml index 87e2e27..2e7aff5 100644 --- a/man/systemd-boot-random-seed.service.xml +++ b/man/systemd-boot-random-seed.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-boot-random-seed.service" conditional='ENABLE_BOOTLOADER' @@ -88,14 +88,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index 2b0ea9b..cc45049 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-boot" conditional='ENABLE_BOOTLOADER' @@ -380,7 +380,7 @@ similar, to extend the native firmware support.</para> <para>Enrollment of Secure Boot variables can be performed manually or automatically if files are available - under <filename>/loader/keys/<replaceable>NAME</replaceable>/{db,KEK,PK}.auth</filename>, <replaceable>NAME</replaceable> + under <filename>/loader/keys/<replaceable>NAME</replaceable>/{db,dbx,KEK,PK}.auth</filename>, <replaceable>NAME</replaceable> being the display name for the set of variables in the menu. If one of the sets is named <filename>auto</filename> then it might be enrolled automatically depending on whether <literal>secure-boot-enroll</literal> is set to force or not.</para> @@ -562,6 +562,27 @@ </refsect1> <refsect1> + <title>SMBIOS Type 11 Strings</title> + + <para><command>systemd-boot</command> can be configured using SMBIOS Type 11 strings. Applicable strings + consist of a name, followed by <literal>=</literal>, followed by the value. Unless + <command>systemd-boot</command> detects it is running inside a confidential computing environment, + <command>systemd-boot</command> will search the table for a string with a specific name, and if found, + use its value. The following strings are read:</para> + + <variablelist> + <varlistentry> + <term><varname>io.systemd.boot.kernel-cmdline-extra</varname></term> + <listitem><para>If set, the value of this string is added to the list of kernel command line + arguments for Boot Loader Specification Type 1 entries that are measured in PCR12 and passed to the + kernel.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Boot Counting</title> <para><command>systemd-boot</command> implements a simple boot counting mechanism on top of the <ulink @@ -635,16 +656,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-install</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>, - <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, - <ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>loader.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-bless-boot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-install</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member> + <member><ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink></member> + <member><ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-bsod.service.xml b/man/systemd-bsod.service.xml index 502d239..5ef10c2 100644 --- a/man/systemd-bsod.service.xml +++ b/man/systemd-bsod.service.xml @@ -1,9 +1,10 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-bsod.service" conditional='HAVE_QRENCODE' xmlns:xi="http://www.w3.org/2001/XInclude"> +<refentry id="systemd-bsod.service" conditional='HAVE_QRENCODE ENABLE_INITRD' + xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-bsod</title> @@ -24,7 +25,7 @@ <refsynopsisdiv> <para><filename>systemd-bsod.service</filename></para> <cmdsynopsis> - <command>systemd-bsod</command> + <command>/usr/lib/systemd/systemd-bsod</command> <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> </refsynopsisdiv> @@ -55,6 +56,17 @@ <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> + + <varlistentry> + <term><option>--tty=<replaceable></replaceable></option></term> + + <listitem><para>Specify the TTY to output to. By default <command>systemd-bsod</command> will + automatically find a free VT to display the message on. If this option is specified a TTY may be + selected explicitly. Use <option>--tty=/dev/tty</option> to direct output to the terminal the command + is invoked on.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index 8d59ce2..280492d 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-cat" @@ -23,10 +23,10 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-cat <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg></command> + <command>systemd-cat</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-cat <arg choice="opt" rep="repeat">OPTIONS</arg></command> + <command>systemd-cat</command> <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> </refsynopsisdiv> @@ -123,6 +123,17 @@ boolean argument.</para></listitem> </varlistentry> + <varlistentry> + <term><option>--namespace=</option></term> + + <listitem><para>Specifies the journal namespace to which the standard IO should be connected. + For details about journal namespaces, see + <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> </refsect1> @@ -130,8 +141,7 @@ <refsect1> <title>Exit status</title> - <para>On success, 0 is returned, a non-zero failure code - otherwise.</para> + <para>On success, 0 is returned, a non-zero failure code otherwise.</para> </refsect1> <refsect1> @@ -163,11 +173,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>logger</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-cgls.xml b/man/systemd-cgls.xml index 27332c5..5280992 100644 --- a/man/systemd-cgls.xml +++ b/man/systemd-cgls.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-cgls" @@ -150,13 +150,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cgtop</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>ps</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-cgtop.xml b/man/systemd-cgtop.xml index ddad82e..5b5ab5b 100644 --- a/man/systemd-cgtop.xml +++ b/man/systemd-cgtop.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-cgtop" @@ -365,13 +365,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cgls</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cgls</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>top</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-coredump.xml b/man/systemd-coredump.xml index 762873a..82f1bcd 100644 --- a/man/systemd-coredump.xml +++ b/man/systemd-coredump.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-coredump" conditional='ENABLE_COREDUMP' @@ -484,15 +484,15 @@ user.coredump.exe="/usr/lib64/firefox/firefox" <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://systemd.io/COREDUMP">systemd Coredump Handling</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>coredump.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>core</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysctl.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/COREDUMP">systemd Coredump Handling</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-creds.xml b/man/systemd-creds.xml index 0c9a985..c8419d3 100644 --- a/man/systemd-creds.xml +++ b/man/systemd-creds.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-creds" @@ -215,6 +215,36 @@ </varlistentry> <varlistentry> + <term><option>--user</option></term> + + <listitem><para>When specified with the <command>encrypt</command> and <command>decrypt</command> + commands encrypts a user-scoped (rather than a system-scoped) credential. Use <option>--uid=</option> + to select which user the credential is from. Such credentials may only be decrypted from the + specified user's context, except if privileges can be acquired. Generally, when an encrypted + credential shall be used in the per-user service manager it should be encrypted with this option set, + when it shall be used in the system service manager it should be encrypted without.</para> + + <para>Internally, this ensures that the selected user's numeric UID and username, as well as the + system's + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> are + incorporated into the encryption key.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--uid=</option></term> + + <listitem><para>Specifies the user to encrypt the credential for. Takes a user name or numeric + UID. If set, implies <option>--user</option>. If set to the special string <literal>self</literal> + sets the user to the user of the calling process. If <option>--user</option> is used without + <option>--uid=</option> then <option>--uid=self</option> is implied, i.e. the credential is encrypted + for the calling user.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--transcode=</option></term> <listitem><para>When specified with the <command>cat</command> or <command>decrypt</command> @@ -253,7 +283,7 @@ </varlistentry> <varlistentry> - <term><option>--name=</option><replaceable>name</replaceable></term> + <term><option>--name=<replaceable>name</replaceable></option></term> <listitem><para>When specified with the <command>encrypt</command> command controls the credential name to embed in the encrypted credential data. If not specified the name is chosen automatically @@ -276,7 +306,7 @@ </varlistentry> <varlistentry> - <term><option>--timestamp=</option><replaceable>timestamp</replaceable></term> + <term><option>--timestamp=<replaceable>timestamp</replaceable></option></term> <listitem><para>When specified with the <command>encrypt</command> command controls the timestamp to embed into the encrypted credential. Defaults to the current time. Takes a timestamp specification in @@ -291,7 +321,7 @@ </varlistentry> <varlistentry> - <term><option>--not-after=</option><replaceable>timestamp</replaceable></term> + <term><option>--not-after=<replaceable>timestamp</replaceable></option></term> <listitem><para>When specified with the <command>encrypt</command> command controls the time when the credential shall not be used anymore. This embeds the specified timestamp in the encrypted @@ -310,7 +340,7 @@ <listitem><para>When specified with the <command>encrypt</command> command controls the encryption/signature key to use. Takes one of <literal>host</literal>, <literal>tpm2</literal>, - <literal>host+tpm2</literal>, <literal>tpm2-absent</literal>, <literal>auto</literal>, + <literal>host+tpm2</literal>, <literal>null</literal>, <literal>auto</literal>, <literal>auto-initrd</literal>. See above for details on the three key types. If set to <literal>auto</literal> (which is the default) the TPM2 key is used if a TPM2 device is found and not running in a container. The host key is used if <filename>/var/lib/systemd/</filename> is on @@ -318,13 +348,13 @@ chip and the OS installation, and both need to be available to decrypt the credential again. If <literal>auto</literal> is selected but neither TPM2 is available (or running in container) nor <filename>/var/lib/systemd/</filename> is on persistent media, encryption will fail. If set to - <literal>tpm2-absent</literal> a fixed zero length key is used (thus, in this mode no confidentiality + <literal>null</literal> a fixed zero length key is used (thus, in this mode no confidentiality nor authenticity are provided!). This logic is useful to cover for systems that lack a TPM2 chip but where credentials shall be generated. Note that decryption of such credentials is refused on systems that have a TPM2 chip and where UEFI SecureBoot is enabled (this is done so that such a locked down system cannot be tricked into loading a credential generated this way that lacks authentication information). If set to <literal>auto-initrd</literal> a TPM2 key is used if a TPM2 is found. If not - a fixed zero length key is used, equivalent to <literal>tpm2-absent</literal> mode. This option is + a fixed zero length key is used, equivalent to <literal>null</literal> mode. This option is particularly useful to generate credentials files that are encrypted/authenticated against TPM2 where available but still work on systems lacking support for this.</para> @@ -342,7 +372,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--tpm2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Controls the TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. <filename>/dev/tpmrm0</filename>). Alternatively the special value <literal>auto</literal> @@ -354,7 +384,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-pcrs=</option><arg rep="repeat">PCR</arg></term> + <term><option>--tpm2-pcrs=<replaceable>PCR<optional>+PCR...</optional></replaceable></option></term> <listitem><para>Configures the TPM2 PCRs (Platform Configuration Registers) to bind the encryption key to. Takes a <literal>+</literal> separated list of numeric PCR indexes in the range 0…23. If not @@ -366,8 +396,8 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-public-key=</option><arg>PATH</arg></term> - <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term> + <term><option>--tpm2-public-key=<replaceable>PATH</replaceable></option></term> + <term><option>--tpm2-public-key-pcrs=<replaceable>PCR<optional>+PCR...</optional></replaceable></option></term> <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to, for use with the <command>encrypt</command> command. The <option>--tpm2-public-key=</option> option accepts a path to @@ -389,7 +419,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-signature=</option><arg>PATH</arg></term> + <term><option>--tpm2-signature=<replaceable>PATH</replaceable></option></term> <listitem><para>Takes a path to a TPM2 PCR signature file as generated by the <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -404,6 +434,14 @@ </varlistentry> <varlistentry> + <term><option>--allow-null</option></term> + + <listitem><para>Allow decrypting credentials that use an empty key.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--quiet</option></term> <term><option>-q</option></term> @@ -483,11 +521,11 @@ SetCredentialEncrypted=mysql-password: \ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-cryptenroll.xml b/man/systemd-cryptenroll.xml index 8fd885c..a47866b 100644 --- a/man/systemd-cryptenroll.xml +++ b/man/systemd-cryptenroll.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-cryptenroll" xmlns:xi="http://www.w3.org/2001/XInclude" conditional='HAVE_LIBCRYPTSETUP'> @@ -36,8 +36,8 @@ supports tokens and credentials of the following kind to be enrolled:</para> <orderedlist> - <listitem><para>PKCS#11 security tokens and smartcards that may carry an RSA key pair (e.g. various - YubiKeys)</para></listitem> + <listitem><para>PKCS#11 security tokens and smartcards that may carry an RSA or EC key pair (e.g. + various YubiKeys)</para></listitem> <listitem><para>FIDO2 security tokens that implement the <literal>hmac-secret</literal> extension (most FIDO2 keys, including YubiKeys)</para></listitem> @@ -61,6 +61,11 @@ <para>The tool supports only LUKS2 volumes, as it stores token meta-information in the LUKS2 JSON token area, which is not available in other encryption formats.</para> + <para><command>systemd-cryptsetup</command> operates on the device backing <filename>/var/</filename> if + no device is specified explicitly, and no wipe operation is requested. (Note that in the typical case + where <filename>/var/</filename> is on the same file system as the root file system, this hence enrolls a + key into the backing device of the root file system.)</para> + <refsect2> <title>TPM2 PCRs and policies</title> @@ -222,13 +227,13 @@ <title>Limitations</title> <para>Note that currently when enrolling a new key of one of the five supported types listed above, it is - required to first provide a passphrase, a recovery key or a FIDO2 token. It's currently not supported to - unlock a device with a TPM2/PKCS#11 key in order to enroll a new TPM2/PKCS#11 key. Thus, if in future key - roll-over is desired it's generally recommended to ensure a passphrase, a recovery key or a FIDO2 token - is always enrolled.</para> + required to first provide a passphrase, a recovery key, a FIDO2 token, or a TPM2 key. It's currently not + supported to unlock a device with a PKCS#11 key in order to enroll a new PKCS#11 key. Thus, if in future + key roll-over is desired it's generally recommended to ensure a passphrase, a recovery key, a FIDO2 + token, or a TPM2 key is always enrolled.</para> <para>Also note that support for enrolling multiple FIDO2 tokens is currently limited. When multiple FIDO2 - tokens are enrolled, <command>systemd-cryptseup</command> will perform pre-flight requests to attempt to + tokens are enrolled, <command>systemd-cryptsetup</command> will perform pre-flight requests to attempt to identify which of the enrolled tokens are currently plugged in. However, this is not possible for FIDO2 tokens with user verification (UV, usually via biometrics), in which case it will fall back to attempting each enrolled token one by one. This will result in multiple prompts for PIN and user verification. This @@ -287,7 +292,7 @@ </varlistentry> <varlistentry> - <term><option>--unlock-key-file=</option><replaceable>PATH</replaceable></term> + <term><option>--unlock-key-file=<replaceable>PATH</replaceable></option></term> <listitem><para>Use a file instead of a password/passphrase read from stdin to unlock the volume. Expects the PATH to the file containing your key to unlock the volume. Currently there is nothing like @@ -298,7 +303,7 @@ </varlistentry> <varlistentry> - <term><option>--unlock-fido2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--unlock-fido2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Use a FIDO2 device instead of a password/passphrase read from stdin to unlock the volume. Expects a <filename>hidraw</filename> device referring to the FIDO2 device (e.g. @@ -311,15 +316,36 @@ </varlistentry> <varlistentry> - <term><option>--pkcs11-token-uri=</option><replaceable>URI</replaceable></term> + <term><option>--unlock-tpm2-device=<replaceable>PATH</replaceable></option></term> - <listitem><para>Enroll a PKCS#11 security token or smartcard (e.g. a YubiKey). Expects a PKCS#11 - smartcard URI referring to the token. Alternatively the special value <literal>auto</literal> may - be specified, in order to automatically determine the URI of a currently plugged in security token - (of which there must be exactly one). The special value <literal>list</literal> may be used to - enumerate all suitable PKCS#11 tokens currently plugged in. The security token must contain an RSA - key pair which is used to encrypt the randomly generated key that is used to unlock the LUKS2 - volume. The encrypted key is then stored in the LUKS2 JSON token header area.</para> + <listitem><para>Use a TPM2 device instead of a password/passhprase read from stdin to unlock the + volume. Expects a device node path referring to the TPM2 chip (e.g. <filename>/dev/tpmrm0</filename>). + Alternatively the special value <literal>auto</literal> may be specified, in order to automatically + determine the device node of a currently discovered TPM2 device (of which there must be exactly one). + </para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--pkcs11-token-uri=<replaceable>URI</replaceable></option></term> + + <listitem><para>Enroll a PKCS#11 security token or smartcard (e.g. a YubiKey). Expects a PKCS#11 URI + that allows finding an X.509 certificate or a public key on the token. The URI must also be suitable + to find a related private key after changing the type of object in it. Alternatively the special + value <literal>auto</literal> may be specified, in order to automatically determine the suitable URI + if a single security token containing a single key pair is plugged in. The special value + <literal>list</literal> may be used to enumerate all suitable PKCS#11 tokens currently plugged in. + </para> + + <para>The PKCS#11 token must contain an RSA or EC key pair which will be used to unlock a LUKS2 volume. + For RSA, a randomly generated volume key is encrypted with a public key in the token, and stored in + the LUKS2 JSON token header area. To unlock a volume, the stored encrypted volume key will be decrypted + with a private key in the token. For ECC, ECDH algorithm is used: we generate a pair of EC keys in + the same EC group, then derive a shared secret using the generated private key and the public key + in the token. The derived shared secret is used as a volume key. The generated public key is + stored in the LUKS2 JSON token header area. The generated private key is erased. To unlock a volume, + we derive the shared secret with the stored public key and a private key in the token.</para> <para>In order to unlock a LUKS2 volume with an enrolled PKCS#11 security token, specify the <option>pkcs11-uri=</option> option in the respective <filename>/etc/crypttab</filename> line:</para> @@ -335,7 +361,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-credential-algorithm=</option><replaceable>STRING</replaceable></term> + <term><option>--fido2-credential-algorithm=<replaceable>STRING</replaceable></option></term> <listitem><para>Specify COSE algorithm used in credential generation. The default value is <literal>es256</literal>. Supported values are <literal>es256</literal>, <literal>rs256</literal> and <literal>eddsa</literal>.</para> @@ -344,13 +370,13 @@ denotes 2048-bit RSA with PKCS#1.5 padding and SHA-256. <literal>eddsa</literal> denotes EDDSA over Curve25519 with SHA-512.</para> - <para>Note that your authenticator may not support some algorithms.</para> + <para>Note that your authenticator may choose not to support some algorithms.</para> <xi:include href="version-info.xml" xpointer="v251"/></listitem> </varlistentry> <varlistentry> - <term><option>--fido2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--fido2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Enroll a FIDO2 security token that implements the <literal>hmac-secret</literal> extension (e.g. a YubiKey). Expects a <filename>hidraw</filename> device referring to the FIDO2 @@ -376,7 +402,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-client-pin=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-client-pin=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require the user to enter a PIN when unlocking the volume (the FIDO2 <literal>clientPin</literal> feature). Defaults to @@ -388,7 +414,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-user-presence=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-user-presence=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require the user to verify presence (tap the token, the FIDO2 <literal>up</literal> feature) when unlocking the volume. @@ -400,7 +426,7 @@ </varlistentry> <varlistentry> - <term><option>--fido2-with-user-verification=</option><replaceable>BOOL</replaceable></term> + <term><option>--fido2-with-user-verification=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a FIDO2 security token, controls whether to require user verification when unlocking the volume (the FIDO2 <literal>uv</literal> feature). Defaults to @@ -411,7 +437,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--tpm2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Enroll a TPM2 security chip. Expects a device node path referring to the TPM2 chip (e.g. <filename>/dev/tpmrm0</filename>). Alternatively the special value <literal>auto</literal> may @@ -436,7 +462,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-device-key=</option><replaceable>PATH</replaceable></term> + <term><option>--tpm2-device-key=<replaceable>PATH</replaceable></option></term> <listitem><para>Enroll a TPM2 security chip using its public key. Expects a path referring to the TPM2 public key in TPM2B_PUBLIC format. This cannot be used with <option>--tpm2-device=</option>, as @@ -464,7 +490,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-seal-key-handle=</option><replaceable>HANDLE</replaceable></term> + <term><option>--tpm2-seal-key-handle=<replaceable>HANDLE</replaceable></option></term> <listitem><para>Configures which parent key to use for sealing, using the TPM handle (index) of the key. This is used to "seal" (encrypt) a secret and must be used later to "unseal" (decrypt) the @@ -486,7 +512,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-pcrs=</option><arg rep="repeat">PCR</arg></term> + <term><option>--tpm2-pcrs=<replaceable>PCR<optional>+PCR...</optional></replaceable></option></term> <listitem><para>Configures the TPM2 PCRs (Platform Configuration Registers) to bind to when enrollment is requested via <option>--tpm2-device=</option>. Takes a list of PCR entries, where each @@ -511,7 +537,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-with-pin=</option><replaceable>BOOL</replaceable></term> + <term><option>--tpm2-with-pin=<replaceable>BOOL</replaceable></option></term> <listitem><para>When enrolling a TPM2 device, controls whether to require the user to enter a PIN when unlocking the volume in addition to PCR binding, based on TPM2 policy authentication. Defaults @@ -532,9 +558,9 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-public-key=</option><arg>PATH</arg></term> - <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term> - <term><option>--tpm2-signature=</option><arg>PATH</arg></term> + <term><option>--tpm2-public-key=<replaceable>PATH</replaceable></option></term> + <term><option>--tpm2-public-key-pcrs=<replaceable>PCR<optional>+PCR...</optional></replaceable></option></term> + <term><option>--tpm2-signature=<replaceable>PATH</replaceable></option></term> <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to. The <option>--tpm2-public-key=</option> option accepts a path to a PEM encoded RSA public key, to bind @@ -572,7 +598,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-pcrlock=</option><arg>PATH</arg></term> + <term><option>--tpm2-pcrlock=<replaceable>PATH</replaceable></option></term> <listitem><para>Configures a TPM2 pcrlock policy to bind encryption to. Expects a path to a pcrlock policy file as generated by the @@ -586,7 +612,7 @@ </varlistentry> <varlistentry> - <term><option>--wipe-slot=</option><arg rep="repeat">SLOT</arg></term> + <term><option>--wipe-slot=<replaceable>SLOT<optional>,SLOT...</optional></replaceable></option></term> <listitem><para>Wipes one or more LUKS2 key slots. Takes a comma separated list of numeric slot indexes, or the special strings <literal>all</literal> (for wiping all key slots), @@ -630,6 +656,51 @@ </refsect1> <refsect1> + <title>Credentials</title> + + <para><command>systemd-cryptenroll</command> supports the service credentials logic as implemented by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>cryptenroll.passphrase</varname></term> + <term><varname>cryptenroll.new-passphrase</varname></term> + + <listitem><para>May contain the passphrase to unlock the volume with/to newly enroll.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptenroll.tpm2-pin</varname></term> + <term><varname>cryptenroll.new-tpm2-pin</varname></term> + + <listitem><para>May contain the TPM2 PIN to unlock the volume with/to newly enroll.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptenroll.fido2-pin</varname></term> + + <listitem><para>If a FIDO2 token is enrolled this may contain the PIN of the token.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptenroll.pkcs11-pin</varname></term> + + <listitem><para>If a PKCS#11 token is enrolled this may contain the PIN of the token.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Exit status</title> <para>On success, 0 is returned, a non-zero failure code otherwise.</para> @@ -645,13 +716,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-cryptsetup-generator.xml b/man/systemd-cryptsetup-generator.xml index 43f6363..da722f9 100644 --- a/man/systemd-cryptsetup-generator.xml +++ b/man/systemd-cryptsetup-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-cryptsetup-generator" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -226,14 +226,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-cryptsetup.xml b/man/systemd-cryptsetup.xml index fb7861c..676a38a 100644 --- a/man/systemd-cryptsetup.xml +++ b/man/systemd-cryptsetup.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-cryptsetup" conditional='HAVE_LIBCRYPTSETUP'> +<refentry id="systemd-cryptsetup" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-cryptsetup</title> @@ -51,7 +51,7 @@ <para><filename>systemd-cryptsetup</filename> is used to set up (with <command>attach</command>) and tear down (with <command>detach</command>) access to an encrypted block device. It is primarily used via - <filename>systemd-cryptsetup@.service</filename> during early boot, but may also be be called manually. + <filename>systemd-cryptsetup@.service</filename> during early boot, but may also be called manually. The positional arguments <parameter>VOLUME</parameter>, <parameter>SOURCE-DEVICE</parameter>, <parameter>KEY-FILE</parameter>, and <parameter>CRYPTTAB-OPTIONS</parameter> have the same meaning as the fields in <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. @@ -105,15 +105,67 @@ </refsect1> <refsect1> + <title>Credentials</title> + + <para><command>systemd-cryptsetup</command> supports the service credentials logic as implemented by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used by <literal>systemd-crypsetup@root.service</literal> + (generated by <command>systemd-gpt-auto-generator</command>) when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>cryptsetup.passphrase</varname></term> + + <listitem><para>This credential specifies the passphrase of the LUKS volume.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.tpm2-pin</varname></term> + + <listitem><para>This credential specifies the TPM pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.fido2-pin</varname></term> + + <listitem><para>This credential specifies the FIDO2 token pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.pkcs11-pin</varname></term> + + <listitem><para>This credential specifies the PKCS11 token pin.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.luks2-pin</varname></term> + + <listitem><para>This credential specifies the PIN requested by generic LUKS2 token modules.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-debug-generator.xml b/man/systemd-debug-generator.xml index 65de9ca..744fcb9 100644 --- a/man/systemd-debug-generator.xml +++ b/man/systemd-debug-generator.xml @@ -1,12 +1,12 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-debug-generator"> +<refentry id="systemd-debug-generator" xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-debug-generator</title> @@ -55,31 +55,60 @@ RAM disk (initrd) while <option>systemd.wants=</option> is honored only in the main system.</para> - <para>If the <option>systemd.debug_shell</option> or - <option>rd.systemd.debug_shell</option> option is - specified, the debug shell service - <literal>debug-shell.service</literal> is pulled into the boot - transaction and a debug shell will be spawned during early boot. - By default, <filename>&DEBUGTTY;</filename> is used, but a specific tty can also be set, - either with or without the <filename>/dev/</filename> prefix. - Note that the shell may also be turned on persistently by enabling it with - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s - <command>enable</command> command. - <option>rd.systemd.debug_shell=</option> is honored only by initial - RAM disk (initrd) while <option>systemd.debug_shell</option> is - honored only in the main system.</para> + <para>If the <option>systemd.debug_shell</option> or <option>rd.systemd.debug_shell</option> option is + specified, the debug shell service <literal>debug-shell.service</literal> is pulled into the boot + transaction and a debug shell will be spawned during early boot. By default, + <filename>&DEBUGTTY;</filename> is used, but a specific tty can also be specified, either with or without + the <filename>/dev/</filename> prefix. To set the tty to use without enabling the debug shell, the + <option>systemd.default_debug_tty=</option> option can be used which also takes a tty with or without the + <filename>/dev/</filename> prefix. Note that the shell may also be turned on persistently by enabling it + with <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s + <command>enable</command> command. <option>rd.systemd.debug_shell</option> is honored only by initial + RAM disk (initrd) while <option>systemd.debug_shell</option> is honored only in the main system.</para> <para><filename>systemd-debug-generator</filename> implements <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> </refsect1> <refsect1> + <title>System Credentials</title> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>systemd.extra-unit.*</varname></term> + + <listitem><para>Credentials prefixed with <literal>systemd.extra-unit.</literal> specify additional + units to add to the final system. Note that these additional units are added to both the initrd and + the final system. <varname>ConditionPathExists=!/etc/initrd-release</varname> can be used to make + sure the unit is conditioned out in the initrd. Note that this can also be used to mask units, by + simply specifying an empty value.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.unit-dropin.*</varname></term> + + <listitem><para>Credentials prefixed with <literal>systemd.unit-dropin.</literal> add drop-ins for + the corresponding units in the final system. Each credential must be suffixed with the full unit name + including the unit extension. Its contents must be a valid unit drop-in file. Optionally, the unit + name may be followed with <literal>~</literal>, followed by the drop-in name without the + <literal>.conf</literal> suffix. If not specified, the name of the generated drop-in will be + <literal>50-credential.conf</literal>. Note that these additional drop-ins are added to both the + initrd and the final system.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-delta.xml b/man/systemd-delta.xml index dd72061..793c02f 100644 --- a/man/systemd-delta.xml +++ b/man/systemd-delta.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-delta" @@ -25,7 +25,11 @@ <cmdsynopsis> <command>systemd-delta</command> <arg choice="opt" rep="repeat">OPTIONS</arg> - <arg choice="opt" rep="repeat"><replaceable>PREFIX</replaceable><optional>/<replaceable>SUFFIX</replaceable></optional>|<replaceable>SUFFIX</replaceable></arg> + <group choice="opt" rep="repeat"> + <arg choice="plain"><replaceable>PREFIX</replaceable></arg> + <arg choice="plain"><replaceable>PREFIX</replaceable>/<replaceable>SUFFIX</replaceable></arg> + <arg choice="plain"><replaceable>SUFFIX</replaceable></arg> + </group> </cmdsynopsis> </refsynopsisdiv> @@ -171,10 +175,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-detect-virt.xml b/man/systemd-detect-virt.xml index e1caa4f..2239294 100644 --- a/man/systemd-detect-virt.xml +++ b/man/systemd-detect-virt.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-detect-virt" @@ -317,12 +317,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-dissect.xml b/man/systemd-dissect.xml index a17111c..b65a2c3 100644 --- a/man/systemd-dissect.xml +++ b/man/systemd-dissect.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-dissect" conditional='HAVE_BLKID' @@ -24,40 +24,43 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--mount</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--mount</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--umount</option> <arg choice="plain"><replaceable>PATH</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--umount</arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--attach</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--attach</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--detach</option> <arg choice="plain"><replaceable>PATH</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--detach</arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--list</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--list</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--mtree</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--mtree</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--with</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt" rep="repeat"><replaceable>COMMAND</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--with</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt" rep="repeat"><replaceable>COMMAND</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--copy-from</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> <arg choice="opt"><replaceable>TARGET</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--copy-from</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> <arg choice="opt"><replaceable>TARGET</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--copy-to</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt"><replaceable>SOURCE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--copy-to</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt"><replaceable>SOURCE</replaceable></arg> <arg choice="plain"><replaceable>PATH</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--discover</option></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--make-archive</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> <arg choice="opt"><replaceable>TARGET</replaceable></arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-dissect <arg choice="opt" rep="repeat">OPTIONS</arg> <option>--validate</option> <arg choice="plain"><replaceable>IMAGE</replaceable></arg></command> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--discover</arg> + </cmdsynopsis> + <cmdsynopsis> + <command>systemd-dissect</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--validate</arg> <arg choice="plain"><replaceable>IMAGE</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> @@ -120,6 +123,8 @@ mounted directly by <command>mount</command> and <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For details see below.</para> + + <xi:include href="vpick.xml" xpointer="image"/> </refsect1> <refsect1> @@ -302,6 +307,21 @@ </varlistentry> <varlistentry> + <term><option>--make-archive</option></term> + + <listitem><para>Generates an archive file from the specified disk image. Expects two arguments: the + path to the disk image and optionally the output archive file path. If the latter is omitted the + archive is written to standard output. The archive file format is determined automatically from the + specified output archive file name, e.g. any path suffixed with <literal>.tar.xz</literal> will + result in an xz compressed UNIX tarball (if the path is omitted an uncompressed UNIX tarball is + created). See + <citerefentry><refentrytitle>libarchive</refentrytitle><manvolnum>3</manvolnum></citerefentry> for a + list of supported archive formats and compression schemes.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--discover</option></term> <listitem><para>Show a list of DDIs in well-known directories. This will show machine, portable @@ -531,23 +551,32 @@ <title>Examples</title> <example> - <title>Generate a tarball from an OS disk image</title> + <title>Generate a tarball from an OS disk image (<option>--with</option>)</title> <programlisting># systemd-dissect --with foo.raw tar cz . >foo.tar.gz</programlisting> </example> + + <para>or alternatively just:</para> + + <example> + <title>Generate a tarball from an OS disk image (<option>--make-archive</option>)</title> + + <programlisting># systemd-dissect --make-archive foo.raw foo.tar.gz</programlisting> + </example> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>, - <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink></member> + <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>umount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fdisk</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-environment-d-generator.xml b/man/systemd-environment-d-generator.xml index a85ef49..686c4c4 100644 --- a/man/systemd-environment-d-generator.xml +++ b/man/systemd-environment-d-generator.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -42,12 +42,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-escape.xml b/man/systemd-escape.xml index 4e4130f..df35115 100644 --- a/man/systemd-escape.xml +++ b/man/systemd-escape.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-escape" @@ -188,11 +188,11 @@ My Container 1</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-firstboot.xml b/man/systemd-firstboot.xml index e07e157..ded7048 100644 --- a/man/systemd-firstboot.xml +++ b/man/systemd-firstboot.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-firstboot" conditional='ENABLE_FIRSTBOOT' @@ -34,12 +34,23 @@ <refsect1> <title>Description</title> - <para><command>systemd-firstboot</command> initializes basic system settings interactively during the - first boot, or non-interactively on an offline system image. The service is started during boot if - <varname>ConditionFirstBoot=yes</varname> is met, which essentially means that <filename>/etc/</filename> - is unpopulated, see + <para>The <command>systemd-firstboot.service</command> unit is one of the units which are used to + initialize the machine configuration during "First Boot", i.e. when the system is freshly installed or + after a factory reset. The + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> manager + itself will initialize + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> and preset + all units, enabling or disabling them according to the + <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry> + settings. <filename>systemd-firstboot.service</filename> is started later to interactively initialize + basic system configuration. It is started only if <varname>ConditionFirstBoot=yes</varname> is met, which + essentially means that <filename>/etc/</filename> is unpopulated, see <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for - details.</para> + details. System credentials may be used to inject configuration; those settings are not queried + interactively.</para> + + <para>The <command>systemd-firstboot</command> command can also be used to non-interactively initialize + an offline system image.</para> <para>The following settings may be configured:</para> @@ -415,8 +426,8 @@ <para><programlisting># systemd-nspawn --image=… --set-credential=firstboot.locale:de_DE.UTF-8 …</programlisting></para> - <para>Note that these credentials are only read and applied during the first boot process. Once they are - applied they remain applied for subsequent boots, and the credentials are not considered anymore.</para> + <para>Note that these credentials are only read and applied during the first boot. Once they are applied + they remain applied for subsequent boots, and the credentials are not considered anymore.</para> </refsect1> <refsect1> @@ -444,19 +455,19 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>shadow</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-fsck@.service.xml b/man/systemd-fsck@.service.xml index 78c661b..1c5e59f 100644 --- a/man/systemd-fsck@.service.xml +++ b/man/systemd-fsck@.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-fsck@.service" xmlns:xi="http://www.w3.org/2001/XInclude"> +<refentry id="systemd-fsck_.service" xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-fsck@.service</title> @@ -24,10 +24,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>systemd-fsck@.service</filename></para> - <para><filename>systemd-fsck-root.service</filename></para> - <para><filename>systemd-fsck-usr.service</filename></para> - <para><filename>/usr/lib/systemd/systemd-fsck</filename></para> + <para><simplelist> + <member><filename>systemd-fsck@.service</filename></member> + <member><filename>systemd-fsck-root.service</filename></member> + <member><filename>systemd-fsck-usr.service</filename></member> + <member><filename>/usr/lib/systemd/systemd-fsck</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -107,19 +109,19 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/fsck.btrfs.html'>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-quotacheck.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/fsck.btrfs.html'>fsck.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fsck.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-fstab-generator.xml b/man/systemd-fstab-generator.xml index d767f38..42c6d27 100644 --- a/man/systemd-fstab-generator.xml +++ b/man/systemd-fstab-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-fstab-generator" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -319,15 +319,15 @@ systemd.swap-extra=/dev/sda2:x-systemd.makefs</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <ulink url="https://systemd.io/ENVIRONMENT/">Known Environment Variables</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/ENVIRONMENT/">Known Environment Variables</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-getty-generator.xml b/man/systemd-getty-generator.xml index 91751c3..574bf9f 100644 --- a/man/systemd-getty-generator.xml +++ b/man/systemd-getty-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-getty-generator" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -110,12 +110,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>agetty</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-gpt-auto-generator.xml b/man/systemd-gpt-auto-generator.xml index db51076..0893b3f 100644 --- a/man/systemd-gpt-auto-generator.xml +++ b/man/systemd-gpt-auto-generator.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-gpt-auto-generator" conditional='HAVE_BLKID' @@ -32,18 +32,22 @@ <para><filename>systemd-gpt-auto-generator</filename> is a unit generator that automatically discovers the root partition, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, - <filename>/var/tmp/</filename>, the EFI System Partition, the Extended Boot Loader Partition, and swap - partitions and creates mount and swap units for them, based on the partition type GUIDs of GUID partition - tables (GPT). See <ulink url="https://uefi.org/specifications">UEFI Specification</ulink>, chapter 5 for - more details. It implements the <ulink + <filename>/var/tmp/</filename>, the EFI System Partition (ESP), the Extended Boot Loader Partition + (XBOOTLDR), and swap partitions and creates mount and swap units for them, based on the partition type + GUIDs of GUID partition tables (GPT). See <ulink url="https://uefi.org/specifications">UEFI + Specification</ulink>, chapter 5 for more details. It implements the <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</para> <para>Note that this generator has no effect on non-GPT systems. It will also not create mount point configuration for directories which already contain files or if the mount point is explicitly configured in <citerefentry - project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If - the units this generator creates are overridden, for example by units in directories with higher + project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Additionally + no unit will be created for the ESP or the XBOOTLDR partition if mount entries are found in the + <filename>/boot/</filename> or <filename>/efi/</filename> hierarchies in <citerefentry + project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <para>If the units this generator creates are overridden, for example by units in directories with higher precedence, drop-ins and additional dependencies created by this generator might still be used.</para> <para>This generator will only look for the root partition on the same physical disk where the EFI System @@ -69,14 +73,16 @@ <table> <title>Partition Type GUIDs</title> - <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname="type" /> <colspec colname="guid" /> <colspec colname="name" /> <colspec colname="where" /> <colspec colname="explanation" /> <thead> <row> - <entry>Partition Type GUID</entry> + <entry>Partition Type</entry> + <entry>GUID</entry> <entry>Name</entry> <entry>Mount Point</entry> <entry>Explanation</entry> @@ -84,63 +90,71 @@ </thead> <tbody> <row> - <entry><constant>SD_GPT_ROOT_X86_64</constant> <constant>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</constant></entry> + <entry><constant>SD_GPT_ROOT_X86_64</constant></entry> + <entry><constant>4f68bce3-e8cd-4db1-96e7-fbcaf984b709</constant></entry> <entry><filename>Root Partition (x86-64)</filename></entry> <entry><filename>/</filename></entry> - <entry>The first partition with this type UUID, located on the same disk as the ESP, is used as the root file system <filename>/</filename> on AMD64 / 64-bit x86 systems.</entry> + <entry>The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename> on AMD64 / 64-bit x86 systems.</entry> </row> <row> - <entry><constant>SD_GPT_ROOT_ARM64</constant> <constant>b921b045-1df0-41c3-af44-4c6f280d3fae</constant></entry> + <entry><constant>SD_GPT_ROOT_ARM64</constant></entry> + <entry><constant>b921b045-1df0-41c3-af44-4c6f280d3fae</constant></entry> <entry><filename>Root Partition (64-bit ARM)</filename></entry> <entry><filename>/</filename></entry> - <entry>The first partition with this type UUID, located on the same disk as the ESP, is used as the root file system <filename>/</filename> on AArch64 / 64-bit ARM systems.</entry> + <entry>The first partition with this type UUID, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename> on AArch64 / 64-bit ARM systems.</entry> </row> <row> - <entry> - <constant>SD_GPT_ROOT_ALPHA</constant> <constant>SD_GPT_ROOT_ARC</constant> <constant>SD_GPT_ROOT_ARM</constant> <constant>SD_GPT_ROOT_ARM64</constant> <constant>SD_GPT_ROOT_IA64</constant> <constant>SD_GPT_ROOT_LOONGARCH64</constant> <constant>SD_GPT_ROOT_MIPS</constant> <constant>SD_GPT_ROOT_MIPS64</constant> <constant>SD_GPT_ROOT_MIPS_LE</constant> <constant>SD_GPT_ROOT_MIPS64_LE</constant> <constant>SD_GPT_ROOT_PARISC</constant> <constant>SD_GPT_ROOT_PPC</constant> <constant>SD_GPT_ROOT_PPC64</constant> <constant>SD_GPT_ROOT_PPC64_LE</constant> <constant>SD_GPT_ROOT_RISCV32</constant> <constant>SD_GPT_ROOT_RISCV64</constant> <constant>SD_GPT_ROOT_S390</constant> <constant>SD_GPT_ROOT_S390X</constant> <constant>SD_GPT_ROOT_TILEGX</constant> <constant>SD_GPT_ROOT_X86</constant> <constant>SD_GPT_ROOT_X86_64</constant> <constant>SD_GPT_USR_ALPHA</constant> <constant>SD_GPT_USR_ARC</constant> <constant>SD_GPT_USR_ARM</constant> <constant>SD_GPT_USR_IA64</constant> <constant>SD_GPT_USR_LOONGARCH64</constant> <constant>SD_GPT_USR_MIPS_LE</constant> <constant>SD_GPT_USR_MIPS64_LE</constant> <constant>SD_GPT_USR_PARISC</constant> <constant>SD_GPT_USR_PPC</constant> <constant>SD_GPT_USR_PPC64</constant> <constant>SD_GPT_USR_PPC64_LE</constant> <constant>SD_GPT_USR_RISCV32</constant> <constant>SD_GPT_USR_RISCV64</constant> <constant>SD_GPT_USR_S390</constant> <constant>SD_GPT_USR_S390X</constant> <constant>SD_GPT_USR_TILEGX</constant> <constant>SD_GPT_USR_X86</constant> - </entry> - <entry>root partitions for other architectures</entry> + <entry><constant>SD_GPT_ROOT_ALPHA</constant> <constant>SD_GPT_ROOT_ARC</constant> <constant>SD_GPT_ROOT_ARM</constant> <constant>SD_GPT_ROOT_ARM64</constant> <constant>SD_GPT_ROOT_IA64</constant> <constant>SD_GPT_ROOT_LOONGARCH64</constant> <constant>SD_GPT_ROOT_MIPS</constant> <constant>SD_GPT_ROOT_MIPS64</constant> <constant>SD_GPT_ROOT_MIPS_LE</constant> <constant>SD_GPT_ROOT_MIPS64_LE</constant> <constant>SD_GPT_ROOT_PARISC</constant> <constant>SD_GPT_ROOT_PPC</constant> <constant>SD_GPT_ROOT_PPC64</constant> <constant>SD_GPT_ROOT_PPC64_LE</constant> <constant>SD_GPT_ROOT_RISCV32</constant> <constant>SD_GPT_ROOT_RISCV64</constant> <constant>SD_GPT_ROOT_S390</constant> <constant>SD_GPT_ROOT_S390X</constant> <constant>SD_GPT_ROOT_TILEGX</constant> <constant>SD_GPT_ROOT_X86</constant> <constant>SD_GPT_ROOT_X86_64</constant> <constant>SD_GPT_USR_ALPHA</constant> <constant>SD_GPT_USR_ARC</constant> <constant>SD_GPT_USR_ARM</constant> <constant>SD_GPT_USR_IA64</constant> <constant>SD_GPT_USR_LOONGARCH64</constant> <constant>SD_GPT_USR_MIPS_LE</constant> <constant>SD_GPT_USR_MIPS64_LE</constant> <constant>SD_GPT_USR_PARISC</constant> <constant>SD_GPT_USR_PPC</constant> <constant>SD_GPT_USR_PPC64</constant> <constant>SD_GPT_USR_PPC64_LE</constant> <constant>SD_GPT_USR_RISCV32</constant> <constant>SD_GPT_USR_RISCV64</constant> <constant>SD_GPT_USR_S390</constant> <constant>SD_GPT_USR_S390X</constant> <constant>SD_GPT_USR_TILEGX</constant> <constant>SD_GPT_USR_X86</constant></entry> + <entry>…</entry> + <entry>Root partitions for other architectures</entry> <entry><filename>/</filename></entry> - <entry>The first partition with the type UUID matching the architecture, located on the same disk as the ESP, is used as the root file system <filename>/</filename>. For the full list and constant values, see <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</entry> + <entry>The first partition with the type UUID matching the architecture, located on the same disk as the ESP used for booting, is used as the root file system <filename>/</filename>. For the full list and constant values, see <ulink url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification">Discoverable Partitions Specification</ulink>.</entry> </row> <row> - <entry><constant>SD_GPT_HOME</constant> <constant>933ac7e1-2eb4-4f13-b844-0e14e2aef915</constant></entry> + <entry><constant>SD_GPT_HOME</constant></entry> + <entry><constant>933ac7e1-2eb4-4f13-b844-0e14e2aef915</constant></entry> <entry>Home Partition</entry> <entry><filename>/home/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/home/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/home/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_SRV</constant> <constant>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</constant></entry> + <entry><constant>SD_GPT_SRV</constant></entry> + <entry><constant>3b8f8425-20e0-4f3b-907f-1a25a76f98e8</constant></entry> <entry>Server Data Partition</entry> <entry><filename>/srv/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/srv/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/srv/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_VAR</constant> <constant>4d21b016-b534-45c2-a9fb-5c16e091fd2d</constant></entry> + <entry><constant>SD_GPT_VAR</constant></entry> + <entry><constant>4d21b016-b534-45c2-a9fb-5c16e091fd2d</constant></entry> <entry>Variable Data Partition</entry> <entry><filename>/var/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/var/</filename> — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/var/</filename> — under the condition its partition UUID matches the first 128 bit of the HMAC-SHA256 of the GPT type uuid of this partition keyed by the machine ID of the installation stored in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</entry> </row> <row> - <entry><constant>SD_GPT_TMP</constant> <constant>7ec6f557-3bc5-4aca-b293-16ef5df639d1</constant></entry> + <entry><constant>SD_GPT_TMP</constant></entry> + <entry><constant>7ec6f557-3bc5-4aca-b293-16ef5df639d1</constant></entry> <entry>Temporary Data Partition</entry> <entry><filename>/var/tmp/</filename></entry> - <entry>The first partition with this type UUID on the same disk as the ESP is mounted to <filename>/var/tmp/</filename>.</entry> + <entry>The first partition with this type UUID on the same disk as the root partition is mounted to <filename>/var/tmp/</filename>.</entry> </row> <row> - <entry><constant>SD_GPT_SWAP</constant> <constant>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</constant></entry> + <entry><constant>SD_GPT_SWAP</constant></entry> + <entry><constant>0657fd6d-a4ab-43c4-84e5-0933c84b4f4f</constant></entry> <entry>Swap</entry> <entry>n/a</entry> - <entry>All partitions with this type UUID on the same disk as the ESP are used as swap.</entry> + <entry>All partitions with this type UUID on the same disk as the root partition are used as swap.</entry> </row> <row> - <entry><constant>SD_GPT_ESP</constant> <constant>c12a7328-f81f-11d2-ba4b-00a0c93ec93b</constant></entry> + <entry><constant>SD_GPT_ESP</constant></entry> + <entry><constant>c12a7328-f81f-11d2-ba4b-00a0c93ec93b</constant></entry> <entry>EFI System Partition (ESP)</entry> <entry><filename>/efi/</filename> or <filename>/boot/</filename></entry> <entry>The first partition with this type UUID located on the same disk as the root partition is mounted to <filename>/boot/</filename> or <filename>/efi/</filename>, see below.</entry> </row> <row> - <entry><constant>SD_GPT_XBOOTLDR</constant> <constant>bc13c2ff-59e6-4262-a352-b275fd6f7172</constant></entry> + <entry><constant>SD_GPT_XBOOTLDR</constant></entry> + <entry><constant>bc13c2ff-59e6-4262-a352-b275fd6f7172</constant></entry> <entry>Extended Boot Loader Partition</entry> <entry><filename>/boot/</filename></entry> <entry>The first partition with this type UUID located on the same disk as the root partition is mounted to <filename>/boot/</filename>, see below.</entry> @@ -153,32 +167,37 @@ <table> <title>Partition Attribute Flags</title> - <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> <colspec colname="flag" /> + <colspec colname="value" /> <colspec colname="where" /> <colspec colname="explanation" /> <thead> <row> <entry>Flag</entry> + <entry>Value</entry> <entry>Applicable to</entry> <entry>Explanation</entry> </row> </thead> <tbody> <row> - <entry><constant>SD_GPT_FLAG_READ_ONLY</constant> <constant>0x1000000000000000</constant></entry> + <entry><constant>SD_GPT_FLAG_READ_ONLY</constant></entry> + <entry><constant>0x1000000000000000</constant></entry> <entry><filename>/</filename>, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, <filename>/var/tmp/</filename>, Extended Boot Loader Partition</entry> <entry>Partition is mounted read-only</entry> </row> <row> - <entry><constant>SD_GPT_FLAG_NO_AUTO</constant> <constant>0x8000000000000000</constant></entry> + <entry><constant>SD_GPT_FLAG_NO_AUTO</constant></entry> + <entry><constant>0x8000000000000000</constant></entry> <entry><filename>/</filename>, <filename>/home/</filename>, <filename>/srv/</filename>, <filename>/var/</filename>, <filename>/var/tmp/</filename>, Extended Boot Loader Partition</entry> <entry>Partition is not mounted automatically</entry> </row> <row> - <entry><constant>SD_GPT_FLAG_NO_BLOCK_IO_PROTOCOL</constant> <constant>0x0000000000000002</constant></entry> + <entry><constant>SD_GPT_FLAG_NO_BLOCK_IO_PROTOCOL</constant></entry> + <entry><constant>0x0000000000000002</constant></entry> <entry>EFI System Partition (ESP)</entry> <entry>Partition is not mounted automatically</entry> </row> @@ -312,18 +331,18 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrfs@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrfs@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-hibernate-resume-generator.xml b/man/systemd-hibernate-resume-generator.xml index 9483cd9..5adc14e 100644 --- a/man/systemd-hibernate-resume-generator.xml +++ b/man/systemd-hibernate-resume-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-hibernate-resume-generator" conditional='ENABLE_HIBERNATE' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -87,11 +87,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hibernate-resume.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-hibernate-resume.service.xml b/man/systemd-hibernate-resume.service.xml index c9c8014..c0c545c 100644 --- a/man/systemd-hibernate-resume.service.xml +++ b/man/systemd-hibernate-resume.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-hibernate-resume.service" conditional='ENABLE_HIBERNATE'> @@ -17,12 +17,14 @@ <refnamediv> <refname>systemd-hibernate-resume.service</refname> + <refname>systemd-hibernate-clear.service</refname> <refname>systemd-hibernate-resume</refname> <refpurpose>Resume from hibernation</refpurpose> </refnamediv> <refsynopsisdiv> <para><filename>systemd-hibernate-resume.service</filename></para> + <para><filename>systemd-hibernate-clear.service</filename></para> <para><filename>/usr/lib/systemd/systemd-hibernate-resume</filename></para> </refsynopsisdiv> @@ -37,6 +39,12 @@ <filename>/sys/power/resume</filename>, along with the offset in memory pages (<filename>/sys/power/resume_offset</filename>) if supported.</para> + <para>The resume device node is either passed directly through arguments, or automatically acquired + from kernel command line options and/or <varname>HibernateLocation</varname> EFI variable. The latter + will normally be cleared by <filename>systemd-hibernate-resume.service</filename> on resumption. + If a stale variable is detected, it would be cleared by + <filename>systemd-hibernate-clear.service</filename>.</para> + <para>Failing to initiate a resume is not an error condition. It may mean that there was no resume image (e. g. if the system has been simply powered off and not hibernated). In such cases, the boot is ordinarily continued.</para> @@ -44,10 +52,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-homed.service.xml b/man/systemd-homed.service.xml index e14752b..42e5780 100644 --- a/man/systemd-homed.service.xml +++ b/man/systemd-homed.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-homed.service" conditional='ENABLE_HOMED' @@ -46,6 +46,10 @@ url="https://systemd.io/USER_GROUP_API">User/Group Record Lookup API via Varlink</ulink>, and thus may be browsed with <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <para><filename>systemd-homed.service</filename> also manages blob directories for each home directory + it manages. See <ulink url="https://systemd.io/USER_RECORD_BLOB_DIRS">User Record Blob Directories</ulink> + for more details.</para> </refsect1> <refsect1> @@ -105,13 +109,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>pam_systemd_home</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>org.freedesktop.home1</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homed.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>pam_systemd_home</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.home1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index 0e42f67..c2a4015 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-hostnamed.service" conditional='ENABLE_HOSTNAMED'> @@ -70,13 +70,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostname</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-info</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sethostname</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-hwdb.xml b/man/systemd-hwdb.xml index de71f1d..3c6feb2 100644 --- a/man/systemd-hwdb.xml +++ b/man/systemd-hwdb.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-hwdb" conditional="ENABLE_HWDB" @@ -67,15 +67,15 @@ </variablelist> <refsect2><title>systemd-hwdb - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> update</title> <para>Update the binary database.</para> </refsect2> <refsect2><title>systemd-hwdb - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> query - <arg><replaceable>MODALIAS</replaceable></arg> + <replaceable>MODALIAS</replaceable> </title> <para>Query database and print result.</para> </refsect2> diff --git a/man/systemd-id128.xml b/man/systemd-id128.xml index d9378b6..e23532d 100644 --- a/man/systemd-id128.xml +++ b/man/systemd-id128.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-id128" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -144,6 +144,10 @@ <xi:include href="version-info.xml" xpointer="v244"/></listitem> </varlistentry> + <xi:include href="standard-options.xml" xpointer="no-pager" /> + <xi:include href="standard-options.xml" xpointer="no-legend" /> + <xi:include href="standard-options.xml" xpointer="json" /> + <xi:include href="standard-options.xml" xpointer="j" /> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> </variablelist> @@ -201,11 +205,11 @@ $ systemd-id128 -Pu show 3a9d668b-4db7-4939-8a4a-5e78a03bffb7 \ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_id128_get_machine</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-importd.service.xml b/man/systemd-importd.service.xml index 1e3c17b..dfeaff4 100644 --- a/man/systemd-importd.service.xml +++ b/man/systemd-importd.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-importd.service" conditional='ENABLE_IMPORTD'> @@ -29,12 +29,12 @@ <refsect1> <title>Description</title> - <para><command>systemd-importd</command> is a system service that allows importing, exporting and downloading of - system images suitable for running as VM or containers. It is a companion service for - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, and provides the implementation for - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s + <para><command>systemd-importd</command> is a system service that allows importing, exporting and + downloading of disk images. It provides the implementation for + <citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s <command>pull-raw</command>, <command>pull-tar</command>, <command>import-raw</command>, - <command>import-tar</command>, <command>import-fs</command>, <command>export-raw</command>, and <command>export-tar</command> commands.</para> + <command>import-tar</command>, <command>import-fs</command>, <command>export-raw</command>, and + <command>export-tar</command> commands.</para> <para>See <citerefentry><refentrytitle>org.freedesktop.import1</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -45,12 +45,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machined.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml index 72276b2..a6dbb06 100644 --- a/man/systemd-inhibit.xml +++ b/man/systemd-inhibit.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-inhibit" @@ -23,10 +23,10 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-inhibit <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg></command> + <command>systemd-inhibit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-inhibit <arg choice="opt" rep="repeat">OPTIONS</arg> --list</command> + <command>systemd-inhibit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--list</arg> </cmdsynopsis> </refsynopsisdiv> @@ -44,9 +44,8 @@ an optical disc is being recorded, or similar operations that should not be interrupted.</para> - <para>For more information see the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor - Lock Developer Documentation</ulink>.</para> + <para>For more information see + <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>.</para> </refsect1> <refsect1> @@ -145,10 +144,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-initctl.service.xml b/man/systemd-initctl.service.xml index b435800..af092b8 100644 --- a/man/systemd-initctl.service.xml +++ b/man/systemd-initctl.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-initctl.service" conditional='HAVE_SYSV_COMPAT'> diff --git a/man/systemd-integritysetup-generator.xml b/man/systemd-integritysetup-generator.xml index 3e788f1..e7cc5a3 100644 --- a/man/systemd-integritysetup-generator.xml +++ b/man/systemd-integritysetup-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-integritysetup-generator" conditional='HAVE_LIBCRYPTSETUP'> @@ -38,11 +38,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-integritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-integritysetup@.service.xml b/man/systemd-integritysetup@.service.xml index 5a37858..dc188b5 100644 --- a/man/systemd-integritysetup@.service.xml +++ b/man/systemd-integritysetup@.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-integritysetup@.service" conditional='HAVE_LIBCRYPTSETUP' +<refentry id="systemd-integritysetup_.service" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -94,12 +94,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>integritytab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-integritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>integritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-journal-gatewayd.service.xml b/man/systemd-journal-gatewayd.service.xml index 45adc2a..38adfe6 100644 --- a/man/systemd-journal-gatewayd.service.xml +++ b/man/systemd-journal-gatewayd.service.xml @@ -1,9 +1,9 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-journal-gatewayd.service" conditional='HAVE_MICROHTTPD' +<refentry id="systemd-journal-gatewayd.service" conditional='ENABLE_REMOTE HAVE_MICROHTTPD' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -277,9 +277,13 @@ <para> <option>Range: entries=<replaceable>cursor</replaceable>[[:<replaceable>num_skip</replaceable>]:<replaceable>num_entries</replaceable>]</option> </para> + <para> + <option>Range: realtime=[<replaceable>since</replaceable>]:[<replaceable>until</replaceable>][[:<replaceable>num_skip</replaceable>]:<replaceable>num_entries</replaceable>]</option> + </para> <para>where <replaceable>cursor</replaceable> is a cursor string, + <replaceable>since</replaceable> and <replaceable>until</replaceable> are timestamps (seconds since 1970-01-01 00:00:00 UTC), <replaceable>num_skip</replaceable> is an integer, <replaceable>num_entries</replaceable> is an unsigned integer. </para> @@ -349,14 +353,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-journal-remote.service.xml b/man/systemd-journal-remote.service.xml index aa96e52..a49ca12 100644 --- a/man/systemd-journal-remote.service.xml +++ b/man/systemd-journal-remote.service.xml @@ -1,12 +1,12 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-journal-remote" conditional='HAVE_MICROHTTPD' +<refentry id="systemd-journal-remote" conditional='ENABLE_REMOTE HAVE_MICROHTTPD' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -87,7 +87,7 @@ <variablelist> <varlistentry> - <term><arg choice="opt" rep="repeat">SOURCES</arg></term> + <term><optional>SOURCES</optional></term> <listitem><para>When <option>-</option> is given as a positional argument, events will be read from standard input. @@ -113,7 +113,7 @@ </varlistentry> <varlistentry> - <term><option>--getter='<replaceable>PROG</replaceable> <arg choice="opt" rep="repeat">OPTIONS</arg>'</option></term> + <term><option>--getter='<replaceable>PROG</replaceable> <optional>OPTIONS</optional>'</option></term> <listitem><para>Program to invoke to retrieve data. The journal event stream must be generated on standard output.</para> @@ -367,12 +367,12 @@ systemd-journal-remote --url http://some.host:19531/entries?boot&follow <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>journal-remote.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>journal-remote.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-upload.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-journal-upload.service.xml b/man/systemd-journal-upload.service.xml index fead24c..5bc843c 100644 --- a/man/systemd-journal-upload.service.xml +++ b/man/systemd-journal-upload.service.xml @@ -1,12 +1,12 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-journal-upload" conditional='HAVE_MICROHTTPD' +<refentry id="systemd-journal-upload" conditional='ENABLE_REMOTE HAVE_LIBCURL' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -318,12 +318,12 @@ openssl ca -batch -config ca.conf -notext -in $CLIENT.csr -out $CLIENT.pem <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>journal-upload.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>journal-upload.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-remote.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journal-gatewayd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-journald.service.xml b/man/systemd-journald.service.xml index 7e252ae..cb06b3b 100644 --- a/man/systemd-journald.service.xml +++ b/man/systemd-journald.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-journald.service" @@ -29,14 +29,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>systemd-journald.service</filename></para> - <para><filename>systemd-journald.socket</filename></para> - <para><filename>systemd-journald-dev-log.socket</filename></para> - <para><filename>systemd-journald-audit.socket</filename></para> - <para><filename>systemd-journald@.service</filename></para> - <para><filename>systemd-journald@.socket</filename></para> - <para><filename>systemd-journald-varlink@.socket</filename></para> - <para><filename>/usr/lib/systemd/systemd-journald</filename></para> + <para><simplelist> + <member><filename>systemd-journald.service</filename></member> + <member><filename>systemd-journald.socket</filename></member> + <member><filename>systemd-journald-dev-log.socket</filename></member> + <member><filename>systemd-journald-audit.socket</filename></member> + <member><filename>systemd-journald@.service</filename></member> + <member><filename>systemd-journald@.socket</filename></member> + <member><filename>systemd-journald-varlink@.socket</filename></member> + <member><filename>/usr/lib/systemd/systemd-journald</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -219,6 +221,37 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting> </refsect1> <refsect1> + <title>Credentials</title> + + <para><command>systemd-journald</command> supports the service credentials logic as implemented by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>journal.forward_to_socket</varname></term> + + <listitem><para>May contain a socket address to which logs should be forwarded. See + <varname>ForwardToSocket=</varname> in + <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>journal.storage</varname></term> + + <listitem><para>May be used to specify where journal files should be stored. See + <varname>Storage=</varname> in + <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> <title>Kernel Command Line</title> <para>A few configuration parameters from @@ -376,17 +409,17 @@ systemd-tmpfiles --create --prefix /var/log/journal</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <command>pydoc systemd.journal</command> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-coredump</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><command>pydoc systemd.journal</command></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index b0a4a9f..ef597de 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-localed.service" conditional='ENABLE_LOCALED'> @@ -49,13 +49,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 622ad95..4ecd700 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-logind.service" conditional='ENABLE_LOGIND'> @@ -84,28 +84,27 @@ <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry> for information about the D-Bus APIs <filename>systemd-logind</filename> provides.</para> - <para>For more information on the inhibition logic see the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor - Lock Developer Documentation</ulink>.</para> + <para>For more information see + <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>.</para> <para>If you are interested in writing a display manager that makes use of logind, please have look at - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/writing-display-managers">Writing Display + <ulink url="https://systemd.io/WRITING_DISPLAY_MANAGERS">Writing Display Managers</ulink>. If you are interested in writing a desktop environment that makes use of logind, please have look at - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/writing-desktop-environments">Writing + <ulink url="https://systemd.io/WRITING_DESKTOP_ENVIRONMENTS">Writing Desktop Environments</ulink>.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-user-sessions.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>pam_systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-machine-id-commit.service.xml b/man/systemd-machine-id-commit.service.xml index cffc3e5..2288e16 100644 --- a/man/systemd-machine-id-commit.service.xml +++ b/man/systemd-machine-id-commit.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -63,12 +63,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machine-id-setup</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-machine-id-setup.xml b/man/systemd-machine-id-setup.xml index d1a77bd..bb53cc7 100644 --- a/man/systemd-machine-id-setup.xml +++ b/man/systemd-machine-id-setup.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-machine-id-setup" @@ -43,24 +43,31 @@ ID will be acquired in the following fashion:</para> <orderedlist> - <listitem><para>If a valid D-Bus machine ID is already - configured for the system, the D-Bus machine ID is copied and - used to initialize the machine ID in - <filename>/etc/machine-id</filename>.</para></listitem> - - <listitem><para>If run inside a KVM virtual machine and a UUID - is configured (via the <option>-uuid</option> - option), this UUID is used to initialize the machine ID. The - caller must ensure that the UUID passed is sufficiently unique - and is different for every booted instance of the - VM.</para></listitem> + <listitem><para>If a valid machine ID is stored in <filename>/run/machine-id</filename>, the machine ID + is copied and used to initialize the machine ID in <filename>/etc/machine-id</filename>. This step is + skipped if <option>--root=</option> is specified or running in a chroot environment.</para></listitem> + + <listitem><para>If a valid D-Bus machine ID is already configured for the system, the D-Bus machine ID + is copied and used to initialize the machine ID in <filename>/etc/machine-id</filename>. + </para></listitem> + + <listitem><para>If a valid machine ID is provided through <option>system.machine_id</option> credential, + the machine ID is copied and used to initialize the machine ID in <filename>/etc/machine-id</filename>. + This step is skipped if <option>--root=</option> is specified or running in a chroot environment. + </para></listitem> + + <listitem><para>If run inside a KVM virtual machine and a UUID is configured (via the + <option>-uuid</option> option), this UUID is used to initialize the machine ID. The caller must ensure + that the UUID passed is sufficiently unique and is different for every booted instance of the VM. This + step is skipped if <option>--root=</option> is specified or running in a chroot environment. + </para></listitem> <listitem><para>Similarly, if run inside a Linux container environment and a UUID is configured for the container, this is used to initialize the machine ID. For details, see the documentation of the <ulink - url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink>.</para></listitem> + url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink>. This step is skipped if + <option>--root=</option> is specified or running in a chroot environment.</para></listitem> - <listitem><para>Otherwise, a new ID is randomly - generated.</para></listitem> + <listitem><para>Otherwise, a new ID is randomly generated.</para></listitem> </orderedlist> <para>The <option>--commit</option> switch may be used to commit a @@ -152,13 +159,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-machine-id-commit.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='dbus'><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-machine-id-commit.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='dbus'><refentrytitle>dbus-uuidgen</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index 48bf6c5..bb931ac 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-machined.service" conditional='ENABLE_MACHINED'> @@ -93,17 +93,19 @@ for some examples on how to run containers with OS tools.</para> <para>If you are interested in writing a VM or container manager that makes use of machined, please have - look at <ulink url="https://www.freedesktop.org/wiki/Software/systemd/writing-vm-managers">Writing + look at <ulink url="https://systemd.io/WRITING_VM_AND_CONTAINER_MANAGERS">Writing Virtual Machine or Container Managers</ulink>. Also see the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New Control Group + url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group Interfaces</ulink>.</para> <para>The daemon provides both a C library interface (which is shared with <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>) - as well as a D-Bus interface. + as well as a D-Bus interface and a Varlink interface. The library interface may be used to introspect and watch the state of virtual machines/containers. The bus interface provides the same but in addition may also be used to register or terminate - machines. + machines. The Varlink interface may be used to register machines with optional extensions, e.g. with an + SSH key / address; it can be queried with + <command>varlinkctl introspect /run/systemd/machine/io.systemd.Machine io.systemd.Machine</command>. For more information please consult <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry> and @@ -127,13 +129,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-mymachines</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-makefs@.service.xml b/man/systemd-makefs@.service.xml index 51409ba..c5b3d85 100644 --- a/man/systemd-makefs@.service.xml +++ b/man/systemd-makefs@.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-makefs@.service"> +<refentry id="systemd-makefs_.service"> <refentryinfo> <title>systemd-makefs@.service</title> @@ -84,20 +84,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/mkfs.btrfs.html'>mkfs.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkfs.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/mkfs.btrfs.html'>mkfs.btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.cramfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.ext4</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.fat</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.hfsplus</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.minix</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.ntfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkfs.xfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-measure.xml b/man/systemd-measure.xml index ff3abc4..8ea6674 100644 --- a/man/systemd-measure.xml +++ b/man/systemd-measure.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-measure" xmlns:xi="http://www.w3.org/2001/XInclude" conditional='ENABLE_BOOTLOADER'> +<refentry id="systemd-measure" xmlns:xi="http://www.w3.org/2001/XInclude" conditional='HAVE_TPM2 HAVE_BLKID HAVE_OPENSSL'> <refentryinfo> <title>systemd-measure</title> @@ -22,7 +22,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-measure <arg choice="opt" rep="repeat">OPTIONS</arg></command> + <command>/usr/lib/systemd/systemd-measure</command> <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> </refsynopsisdiv> @@ -75,9 +75,9 @@ <listitem><para>Pre-calculate the expected values seen in PCR register 11 after boot-up of a unified kernel image consisting of the components specified with <option>--linux=</option>, <option>--osrel=</option>, <option>--cmdline=</option>, <option>--initrd=</option>, - <option>--splash=</option>, <option>--dtb=</option>, <option>--uname=</option>, - <option>--sbat=</option>, <option>--pcrpkey=</option> see below. Only <option>--linux=</option> is - mandatory. (Alternatively, specify <option>--current</option> to use the current values of PCR + <option>--ucode=</option>, <option>--splash=</option>, <option>--dtb=</option>, + <option>--uname=</option>, <option>--sbat=</option>, <option>--pcrpkey=</option> see below. + Only <option>--linux=</option> is mandatory. (Alternatively, specify <option>--current</option> to use the current values of PCR register 11 instead.)</para> <xi:include href="version-info.xml" xpointer="v252"/> @@ -118,6 +118,7 @@ <term><option>--osrel=<replaceable>PATH</replaceable></option></term> <term><option>--cmdline=<replaceable>PATH</replaceable></option></term> <term><option>--initrd=<replaceable>PATH</replaceable></option></term> + <term><option>--ucode=<replaceable>PATH</replaceable></option></term> <term><option>--splash=<replaceable>PATH</replaceable></option></term> <term><option>--dtb=<replaceable>PATH</replaceable></option></term> <term><option>--uname=<replaceable>PATH</replaceable></option></term> @@ -158,6 +159,7 @@ <varlistentry> <term><option>--private-key=<replaceable>PATH</replaceable></option></term> <term><option>--public-key=<replaceable>PATH</replaceable></option></term> + <term><option>--certificate=<replaceable>PATH</replaceable></option></term> <listitem><para>These switches take paths to a pair of PEM encoded RSA key files, for use with the <command>sign</command> command.</para> @@ -172,11 +174,28 @@ <para>If the <option>--public-key=</option> is not specified but <option>--private-key=</option> is specified the public key is automatically derived from the private key.</para> + <para><option>--certificate=</option> can be used to specify an X.509 certificate as an alternative + to <option>--public-key=</option> since v256.</para> + <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> <varlistentry> - <term><option>--tpm2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--private-key=<replaceable>PATH/URI</replaceable></option></term> + <term><option>--private-key-source=<replaceable>TYPE[:NAME]</replaceable></option></term> + <term><option>--certificate=<replaceable>PATH</replaceable></option></term> + + <listitem><para>As an alternative to <option>--public-key=</option> for the + <command>sign</command> command, these switches can be used to sign with an hardware token. The + private key option can take a path or a URI that will be passed to the OpenSSL engine or + provider, as specified by <option>--private-key-source=</option> as a type:name tuple, such as + engine:pkcs11. The specified OpenSSL signing engine or provider will be used to sign.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--tpm2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Controls which TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. <filename>/dev/tpmrm0</filename>). Alternatively the special value <literal>auto</literal> @@ -188,7 +207,7 @@ </varlistentry> <varlistentry> - <term><option>--phase=</option><replaceable>PHASE</replaceable></term> + <term><option>--phase=<replaceable>PHASE</replaceable></option></term> <listitem><para>Controls which boot phases to calculate expected PCR 11 values for. This takes a series of colon-separated strings that encode boot "paths" for entering a specific phase of the boot @@ -214,7 +233,7 @@ </varlistentry> <varlistentry> - <term><option>--append=</option><replaceable>PATH</replaceable></term> + <term><option>--append=<replaceable>PATH</replaceable></option></term> <listitem><para>When generating a PCR JSON signature (via the <command>sign</command> command), combine it with a previously generated PCR JSON signature, and output it as one. The specified path @@ -375,14 +394,14 @@ Wrote unsigned vmlinux-1.2.3.efi <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrphase.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrphase.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-modules-load.service.xml b/man/systemd-modules-load.service.xml index fc51716..683e7f8 100644 --- a/man/systemd-modules-load.service.xml +++ b/man/systemd-modules-load.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-modules-load.service" conditional='HAVE_KMOD' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -64,10 +64,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>modules-load.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>modules-load.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-mount.xml b/man/systemd-mount.xml index d92ef18..558fd03 100644 --- a/man/systemd-mount.xml +++ b/man/systemd-mount.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-mount" @@ -394,15 +394,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-mountfsd.service.xml b/man/systemd-mountfsd.service.xml new file mode 100644 index 0000000..25c1568 --- /dev/null +++ b/man/systemd-mountfsd.service.xml @@ -0,0 +1,70 @@ +<?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="systemd-mountfsd.service" conditional='ENABLE_MOUNTFSD'> + + <refentryinfo> + <title>systemd-mountfsd.service</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-mountfsd.service</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-mountfsd.service</refname> + <refname>systemd-mountfsd</refname> + <refpurpose>Disk Image File System Mount Service</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>systemd-mountfsd.service</filename></para> + <para><filename>/usr/lib/systemd/systemd-mountfsd</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-mountfsd</command> is a system service that dissects disk images, and returns mount + file descriptors for the file systems contained therein to clients, via a Varlink IPC API.</para> + + <para>The disk images provided must contain a raw file system image or must follow the <ulink + url="https://uapi-group.org/specifications/specs/discoverable_partitions_specification/">Discoverable + Partitions Specification</ulink>. Before mounting any file systems authenticity of the disk image is + established in one or a combination of the following ways:</para> + + <orderedlist> + <listitem><para>If the disk image is located in a regular file in one of the directories + <filename>/var/lib/machines/</filename>, <filename>/var/lib/portables/</filename>, + <filename>/var/lib/extensions/</filename>, <filename>/var/lib/confexts/</filename> or their + counterparts in the <filename>/etc/</filename>, <filename>/run/</filename>, + <filename>/usr/lib/</filename> it is assumed to be trusted.</para></listitem> + + <listitem><para>If the disk image contains a Verity enabled disk image, along with a signature + partition with a key in the kernel keyring or in <filename>/etc/verity.d/</filename> (and related + directories) the disk image is considered trusted.</para></listitem> + </orderedlist> + + <para>This service provides one <ulink url="https://varlink.org/">Varlink</ulink> service: + <constant>io.systemd.MountFileSystem</constant> which accepts a file descriptor to a regular file or + block device, and returns a number of file descriptors referring to an <function>fsmount()</function> + file descriptor the client may then attach to a path of their choice.</para> + + <para>The returned mounts are automatically allowlisted in the per-user-namespace allowlist maintained by + <citerefentry><refentrytitle>systemd-nsresourced.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <para>The file systems are automatically fsck'ed before mounting.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-nsresourced.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/systemd-network-generator.service.xml b/man/systemd-network-generator.service.xml index c01f701..8962f1a 100644 --- a/man/systemd-network-generator.service.xml +++ b/man/systemd-network-generator.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-network-generator.service" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -76,7 +76,7 @@ <varlistentry> <term><varname>ifname=</varname></term> - <term><varname>net.ifname-policy=</varname></term> + <term><varname>net.ifname_policy=</varname></term> <listitem> <para>Translated into <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry> @@ -118,12 +118,49 @@ </refsect1> <refsect1> + <title>Credentials</title> + + <para><command>systemd-network-generator</command> supports the service credentials logic as implemented + by + <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details). The following credentials are used when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>network.conf.*</varname></term> + <term><varname>network.link.*</varname></term> + <term><varname>network.netdev.*</varname></term> + <term><varname>network.network.*</varname></term> + + <listitem><para>These credentials should contain valid + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration data. From each matching credential a separate file is created. Example: a passed + credential <filename>network.link.50-foobar</filename> will be copied into a configuration file + <filename>50-foobar.link</filename>.</para> + + <para>Note that the resulting files are created world-readable, it's hence recommended to not include + secrets in these credentials, but supply them via separate credentials directly to + <filename>systemd-networkd.service</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + + <para>Note that by default the <filename>systemd-network-generator.service</filename> unit file is set up + to inherit the these credentials from the service manager.</para> + </refsect1> + + <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>dracut</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-networkd-wait-online.service.xml b/man/systemd-networkd-wait-online.service.xml index 06f837a..e696a2b 100644 --- a/man/systemd-networkd-wait-online.service.xml +++ b/man/systemd-networkd-wait-online.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-networkd-wait-online.service" conditional='ENABLE_NETWORKD' @@ -61,7 +61,7 @@ <variablelist> <varlistentry> <term><option>-i</option> <replaceable>INTERFACE</replaceable><optional>:<replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></optional></term> - <term><option>--interface=</option><replaceable>INTERFACE</replaceable><optional>:<replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></optional></term> + <term><option>--interface=<replaceable>INTERFACE</replaceable><optional>:<replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></optional></option></term> <listitem><para>Network interface to wait for before deciding if the system is online. This is useful when a system has several interfaces which will be configured, but a particular @@ -80,7 +80,7 @@ </varlistentry> <varlistentry> - <term><option>--ignore=</option><replaceable>INTERFACE</replaceable></term> + <term><option>--ignore=<replaceable>INTERFACE</replaceable></option></term> <listitem><para>Network interfaces to be ignored when deciding if the system is online. By default, only the loopback @@ -92,7 +92,7 @@ <varlistentry> <term><option>-o</option> <replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></term> - <term><option>--operational-state=</option><replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></term> + <term><option>--operational-state=<replaceable>MIN_OPERSTATE</replaceable><optional>:<replaceable>MAX_OPERSTATE</replaceable></optional></option></term> <listitem><para>Takes a minimum operational state and an optional maximum operational state. Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -158,7 +158,7 @@ </varlistentry> <varlistentry> - <term><option>--timeout=</option><replaceable>SECS</replaceable></term> + <term><option>--timeout=<replaceable>SECS</replaceable></option></term> <listitem><para>Fail the service if the network is not online by the time the timeout elapses. A timeout of 0 disables the @@ -183,12 +183,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml index 12cd4c3..b33a7f6 100644 --- a/man/systemd-networkd.service.xml +++ b/man/systemd-networkd.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-networkd.service" conditional='ENABLE_NETWORKD'> @@ -83,15 +83,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-notify.xml b/man/systemd-notify.xml index 0222978..55bb8c5 100644 --- a/man/systemd-notify.xml +++ b/man/systemd-notify.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-notify" @@ -23,10 +23,10 @@ <refsynopsisdiv> <cmdsynopsis> - <command>systemd-notify <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg></command> + <command>systemd-notify</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg> </cmdsynopsis> <cmdsynopsis> - <command>systemd-notify --exec <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg> ; <arg rep="repeat">CMDLINE</arg></command> + <command>systemd-notify</command> <arg>--exec</arg> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">VARIABLE=VALUE</arg> <arg>;</arg> <arg rep="repeat">CMDLINE</arg> </cmdsynopsis> </refsynopsisdiv> @@ -119,12 +119,12 @@ <varlistentry> <term><option>--pid=</option></term> - <listitem><para>Inform the service manager about the main PID of the service. Takes a PID as - argument. If the argument is specified as <literal>auto</literal> or omitted, the PID of the process - that invoked <command>systemd-notify</command> is used, except if that's the service manager. If the + <listitem><para>Inform the service manager about the main PID of the service. Takes a PID as argument. + If the argument is specified as <literal>auto</literal> or omitted, the PID of the process that + invoked <command>systemd-notify</command> is used, except if that's the service manager. If the argument is specified as <literal>self</literal>, the PID of the <command>systemd-notify</command> command itself is used, and if <literal>parent</literal> is specified the calling process' PID is - used — even if it is the service manager. The latter is equivalent to <command>systemd-notify + used — even if it is the service manager. <option>--pid=auto</option> is equivalent to <command>systemd-notify MAINPID=$PID</command>. For details about the semantics of this option see <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> @@ -138,7 +138,7 @@ </varlistentry> <varlistentry> - <term><option>--uid=</option><replaceable>USER</replaceable></term> + <term><option>--uid=<replaceable>USER</replaceable></option></term> <listitem><para>Set the user ID to send the notification from. Takes a UNIX user name or numeric UID. When specified the notification message will be sent with the specified UID as sender, in place of the user the @@ -270,13 +270,13 @@ done</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_booted</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml index 349bc8a..2645a6b 100644 --- a/man/systemd-nspawn.xml +++ b/man/systemd-nspawn.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -119,6 +119,28 @@ </refsect1> <refsect1> + <title>Unprivileged Operation</title> + + <para><command>systemd-nspawn</command> may be invoked with or without privileges. The full functionality + is currently only available when invoked with privileges. When invoked without privileges, various + limitations apply, including, but not limited to:</para> + + <itemizedlist> + <listitem><para>Only disk image based containers are supported (i.e. <option>--image=</option>). + Directory based ones (i.e. <option>--directory=</option>) are not supported.</para></listitem> + + <listitem><para>Machine registration via <option>--machine=</option> is not supported.</para></listitem> + + <listitem><para>Only <option>--private-network</option> and <option>--network-veth</option> networking modes are supported.</para></listitem> + </itemizedlist> + + <para>When running in unprivileged mode, some needed functionality is provided via + <citerefentry><refentrytitle>systemd-mountfsd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>systemd-nsresourced.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></para> + </refsect1> + + <refsect1> <title>Options</title> <para>If option <option>--boot</option> is specified, the arguments @@ -146,7 +168,7 @@ </varlistentry> <varlistentry> - <term><option>--settings=</option><replaceable>MODE</replaceable></term> + <term><option>--settings=<replaceable>MODE</replaceable></option></term> <listitem><para>Controls whether <command>systemd-nspawn</command> shall search for and use @@ -209,21 +231,19 @@ <term><option>-D</option></term> <term><option>--directory=</option></term> - <listitem><para>Directory to use as file system root for the - container.</para> + <listitem><para>Directory to use as file system root for the container.</para> - <para>If neither <option>--directory=</option>, nor - <option>--image=</option> is specified the directory is - determined by searching for a directory named the same as the - machine name specified with <option>--machine=</option>. See + <para>If neither <option>--directory=</option>, nor <option>--image=</option> is specified the + directory is determined by searching for a directory named the same as the machine name specified + with <option>--machine=</option>. See <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> section "Files and Directories" for the precise search path.</para> - <para>If neither <option>--directory=</option>, - <option>--image=</option>, nor <option>--machine=</option> - are specified, the current directory will - be used. May not be specified together with - <option>--image=</option>.</para></listitem> + <xi:include href="vpick.xml" xpointer="directory"/> + + <para>If neither <option>--directory=</option>, <option>--image=</option>, nor + <option>--machine=</option> are specified, the current directory will be used. May not be specified + together with <option>--image=</option>.</para></listitem> </varlistentry> <varlistentry> @@ -317,6 +337,8 @@ <para>Any other partitions, such as foreign partitions or swap partitions are not mounted. May not be specified together with <option>--directory=</option>, <option>--template=</option>.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="version-info.xml" xpointer="v211"/></listitem> </varlistentry> @@ -357,7 +379,7 @@ <varlistentry> <term><option>--volatile</option></term> - <term><option>--volatile=</option><replaceable>MODE</replaceable></term> + <term><option>--volatile=<replaceable>MODE</replaceable></option></term> <listitem><para>Boots the container in volatile mode. When no mode parameter is passed or when mode is specified as <option>yes</option>, full volatile mode is enabled. This means the root directory is mounted as a @@ -584,7 +606,14 @@ <listitem><para>After transitioning into the container, change to the specified user defined in the container's user database. Like all other systemd-nspawn features, this is not a security feature and - provides protection against accidental destructive operations only.</para></listitem> + provides protection against accidental destructive operations only.</para> + + <para>Note that if credentials are used in combination with a non-root <option>--user=</option> + (e.g.: <option>--set-credential=</option>, <option>--load-credential=</option> or + <option>--import-credential=</option>), then <option>--no-new-privileges=yes</option> must be used, and + <option>--boot</option> or <option>--as-pid2</option> must not be used, as the credentials would + otherwise be unreadable by the container due to missing privileges after switching to the specified + user.</para></listitem> </varlistentry> <varlistentry> @@ -1487,12 +1516,12 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <para>Mount options are comma-separated. <option>rbind</option> and <option>norbind</option> control whether to create a recursive or a regular bind mount. Defaults to <option>rbind</option>. <option>noidmap</option>, - <option>idmap</option>, and <option>rootidmap</option> control ID mapping.</para> + <option>idmap</option>, <option>rootidmap</option> and <option>owneridmap</option> control ID mapping.</para> - <para>Using <option>idmap</option> or <option>rootidmap</option> requires support by the source filesystem - for user/group ID mapped mounts. Defaults to <option>noidmap</option>. With <option>x</option> being the container's UID range - offset, <option>y</option> being the length of the container's UID range, and <option>p</option> being the - owner UID of the bind mount source inode on the host: + <para>Using <option>idmap</option>, <option>rootidmap</option> or <option>owneridmap</option> requires support + by the source filesystem for user/group ID mapped mounts. Defaults to <option>noidmap</option>. With + <option>x</option> being the container's UID range offset, <option>y</option> being the length of the + container's UID range, and <option>p</option> being the owner UID of the bind mount source inode on the host: <itemizedlist> <listitem><para>If <option>noidmap</option> is used, any user <option>z</option> in the range @@ -1508,10 +1537,15 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <listitem><para>If <option>rootidmap</option> is used, the user <option>0</option> seen from inside of the container is mapped to <option>p</option> on the host. Other host users are mapped to <option>nobody</option> inside the container.</para></listitem> + + <listitem><para>If <option>owneridmap</option> is used, the owner of the target directory inside of the + container is mapped to <option>p</option> on the host. Other host users are mapped to + <option>nobody</option> inside the container.</para></listitem> </itemizedlist></para> <para>Whichever ID mapping option is used, the same mapping will be used for users and groups IDs. If - <option>rootidmap</option> is used, the group owning the bind mounted directory will have no effect.</para> + <option>rootidmap</option> or <option>owneridmap</option> are used, the group owning the bind mounted directory + will have no effect.</para> <para>Note that when this option is used in combination with <option>--private-users</option>, the resulting mount points will be owned by the <constant>nobody</constant> user. That's because the mount and its files and @@ -1665,7 +1699,7 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <variablelist> <varlistentry> - <term><option>--console=</option><replaceable>MODE</replaceable></term> + <term><option>--console=<replaceable>MODE</replaceable></option></term> <listitem><para>Configures how to set up standard input, output and error output for the container payload, as well as the <filename>/dev/console</filename> device for the container. Takes one of @@ -1708,6 +1742,21 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <xi:include href="version-info.xml" xpointer="v242"/></listitem> </varlistentry> + + <varlistentry> + <term><option>--background=<replaceable>COLOR</replaceable></option></term> + + <listitem><para>Change the terminal background color to the specified ANSI color as long as the + container runs. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such + as <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>, + <literal>48;5;…</literal>. See <ulink + url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI + Escape Code (Wikipedia)</ulink> for details. Assign an empty string to disable any coloring.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> </refsect2> @@ -1716,8 +1765,8 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <variablelist> <varlistentry> - <term><option>--load-credential=</option><replaceable>ID</replaceable>:<replaceable>PATH</replaceable></term> - <term><option>--set-credential=</option><replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></term> + <term><option>--load-credential=<replaceable>ID</replaceable>:<replaceable>PATH</replaceable></option></term> + <term><option>--set-credential=<replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></option></term> <listitem><para>Pass a credential to the container. These two options correspond to the <varname>LoadCredential=</varname> and <varname>SetCredential=</varname> settings in unit files. See @@ -1780,19 +1829,7 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <refsect1> <title>Examples</title> - <example> - <title>Download a - <ulink url="https://getfedora.org">Fedora</ulink> image and start a shell in it</title> - - <programlisting># machinectl pull-raw --verify=no \ - https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz \ - Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64 -# systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86-64</programlisting> - - <para>This downloads an image using - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - and opens a shell in it.</para> - </example> + <xi:include href="importctl.xml" xpointer="example-import-tar" /> <example> <title>Build and boot a minimal Fedora distribution in a container</title> @@ -1891,18 +1928,21 @@ After=sys-subsystem-net-devices-ens1.device</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>zypper</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.nspawn</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>dnf</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='archlinux'><refentrytitle>pacman</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>zypper</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-mountfsd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nsresourced.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs.html'>btrfs</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-nsresourced.service.xml b/man/systemd-nsresourced.service.xml new file mode 100644 index 0000000..d0a561e --- /dev/null +++ b/man/systemd-nsresourced.service.xml @@ -0,0 +1,81 @@ +<?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="systemd-nsresourced.service" conditional='ENABLE_NSRESOURCED'> + + <refentryinfo> + <title>systemd-nsresourced.service</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-nsresourced.service</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-nsresourced.service</refname> + <refname>systemd-nsresourced</refname> + <refpurpose>User Namespace Resource Delegation Service</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>systemd-nsresourced.service</filename></para> + <para><filename>/usr/lib/systemd/systemd-nsresourced</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-nsresourced</command> is a system service that permits transient delegation of a a + UID/GID range to a user namespace (see <citerefentry + project='man-pages'><refentrytitle>user_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry>) + allocated by a client, via a Varlink IPC API.</para> + + <para>Unprivileged clients may allocate a user namespace, and then request a UID/GID range to be assigned + to it via this service. The user namespace may then be used to run containers and other sandboxes, and/or + apply it to an id-mapped mount.</para> + + <para>Allocations of UIDs/GIDs this way are transient: when a user namespace goes away, its UID/GID range + is returned to the pool of available ranges. In order to ensure that clients cannot gain persistency in + their transient UID/GID range a BPF-LSM based policy is enforced that ensures that user namespaces set up + this way can only write to file systems they allocate themselves or that are explicitly allowlisted via + <command>systemd-nsresourced</command>.</para> + + <para><command>systemd-nsresourced</command> automatically ensures that any registered UID ranges show up + in the system's NSS database via the <ulink url="https://systemd.io/USER_GROUP_API">User/Group Record + Lookup API via Varlink</ulink>.</para> + + <para>Currently, only UID/GID ranges consisting of either exactly 1 or exactly 65536 UIDs/GIDs can be + registered with this service. Moreover, UIDs and GIDs are always allocated together, and + symmetrically.</para> + + <para>The service provides API calls to allowlist mounts (referenced via their mount file descriptors as + per Linux <function>fsmount()</function> API), to pass ownership of a cgroup subtree to the user + namespace and to delegate a virtual Ethernet device pair to the user namespace. When used in combination + this is sufficient to implement fully unprivileged container environments, as implemented by + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, fully + unprivileged <varname>RootImage=</varname> (see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>) or + fully unprivileged disk image tools such as + <citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <para>This service provides one <ulink url="https://varlink.org/">Varlink</ulink> service: + <constant>io.systemd.NamespaceResource</constant> allows registering user namespaces, and assign mounts, + cgroups and network interfaces to it.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-mountfsd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry project='man-pages'><refentrytitle>user_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/systemd-oomd.service.xml b/man/systemd-oomd.service.xml index d8ecfde..51a9377 100644 --- a/man/systemd-oomd.service.xml +++ b/man/systemd-oomd.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-oomd.service" conditional='ENABLE_OOMD' @@ -115,20 +115,20 @@ <xi:include href="version-info.xml" xpointer="v253"/></listitem> </varlistentry> - </variablelist> - <xi:include href="standard-options.xml" xpointer="help" /> - <xi:include href="standard-options.xml" xpointer="version" /> + <xi:include href="standard-options.xml" xpointer="help" /> + <xi:include href="standard-options.xml" xpointer="version" /> + </variablelist> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>oomctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>oomctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-path.xml b/man/systemd-path.xml index b1d566e..153a9bd 100644 --- a/man/systemd-path.xml +++ b/man/systemd-path.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-path" @@ -59,7 +59,7 @@ <xi:include href="version-info.xml" xpointer="v215"/></listitem> </varlistentry> - <xi:include href="standard-options.xml" xpointer="no-pager-255"/> + <xi:include href="standard-options.xml" xpointer="no-pager"/> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> </variablelist> @@ -75,10 +75,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>file-hierarchy</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-pcrlock.xml b/man/systemd-pcrlock.xml index a364dd3..19ba4c4 100644 --- a/man/systemd-pcrlock.xml +++ b/man/systemd-pcrlock.xml @@ -1,9 +1,10 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-pcrlock" xmlns:xi="http://www.w3.org/2001/XInclude" conditional='ENABLE_BOOTLOADER'> +<refentry id="systemd-pcrlock" conditional='ENABLE_BOOTLOADER HAVE_OPENSSL HAVE_TPM2' + xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> <title>systemd-pcrlock</title> @@ -29,7 +30,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>/usr/lib/systemd/systemd-pcrlock <arg choice="opt" rep="repeat">OPTIONS</arg></command> + <command>/usr/lib/systemd/systemd-pcrlock</command> <arg choice="opt" rep="repeat">OPTIONS</arg> </cmdsynopsis> </refsynopsisdiv> @@ -61,7 +62,7 @@ <filename>*.pcrlock.d/*.pcrlock</filename>, see <citerefentry><refentrytitle>systemd.pcrlock</refentrytitle><manvolnum>5</manvolnum></citerefentry>) that each define expected measurements for one component of the boot process, permitting alternative - variants for each. (Variants may be used used to bless multiple kernel versions or boot loader versions + variants for each. (Variants may be used to bless multiple kernel versions or boot loader versions at the same time.)</para></listitem> </itemizedlist> @@ -104,7 +105,7 @@ <term><command>cel</command></term> <listitem><para>This reads the combined TPM2 event log and writes it to STDOUT in <ulink - url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Common Event Log + url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Canonical Event Log Format (CEL-JSON)</ulink> format.</para> <xi:include href="version-info.xml" xpointer="v255"/></listitem> @@ -155,6 +156,19 @@ <para>If the new prediction matches the old this command terminates quickly and executes no further operation. (Unless <option>--force</option> is specified, see below.)</para> + <para>Starting with v256, a copy of the <filename>/var/lib/systemd/pcrlock.json</filename> policy + file is encoded in a credential (see + <citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry> for + details) and written to the EFI System Partition or XBOOTLDR partition, in the + <filename>/loader/credentials/</filename> subdirectory. There it is picked up at boot by + <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry> and + passed to the invoked initrd, where it can be used to unlock the root file system (which typically + contains <filename>/var/</filename>, which is where the primary copy of the policy is located, which + hence cannot be used to unlock the root file system). The credential file is named after the boot + entry token of the installation (see + <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>), which + is configurable via the <option>--entry-token=</option> switch, see below.</para> + <xi:include href="version-info.xml" xpointer="v255"/> </listitem> </varlistentry> @@ -266,7 +280,7 @@ </varlistentry> <varlistentry> - <term><command>lock-gpt</command> <arg choice="opt"><replaceable>DEVICE</replaceable></arg></term> + <term><command>lock-gpt</command> <optional><replaceable>DEVICE</replaceable></optional></term> <term><command>unlock-gpt</command></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the GPT partition @@ -282,7 +296,7 @@ </varlistentry> <varlistentry> - <term><command>lock-pe</command> <arg choice="opt"><replaceable>BINARY</replaceable></arg></term> + <term><command>lock-pe</command> <optional><replaceable>BINARY</replaceable></optional></term> <term><command>unlock-pe</command></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the specified PE @@ -301,7 +315,7 @@ </varlistentry> <varlistentry> - <term><command>lock-uki</command> <arg choice="opt"><replaceable>UKI</replaceable></arg></term> + <term><command>lock-uki</command> <optional><replaceable>UKI</replaceable></optional></term> <term><command>unlock-uki</command></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on the specified UKI PE @@ -336,8 +350,8 @@ </varlistentry> <varlistentry> - <term><command>lock-file-system</command> <arg choice="opt"><replaceable>PATH</replaceable></arg></term> - <term><command>unlock-file-system</command> <arg choice="opt"><replaceable>PATH</replaceable></arg></term> + <term><command>lock-file-system</command> <optional><replaceable>PATH</replaceable></optional></term> + <term><command>unlock-file-system</command> <optional><replaceable>PATH</replaceable></optional></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on file system identity. This is useful for predicting measurements @@ -353,7 +367,7 @@ </varlistentry> <varlistentry> - <term><command>lock-kernel-cmdline</command> <arg choice="opt"><replaceable>FILE</replaceable></arg></term> + <term><command>lock-kernel-cmdline</command> <optional><replaceable>FILE</replaceable></optional></term> <term><command>unlock-kernel-cmdline</command></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on @@ -384,7 +398,7 @@ </varlistentry> <varlistentry> - <term><command>lock-raw</command> <arg choice="opt"><replaceable>FILE</replaceable></arg></term> + <term><command>lock-raw</command> <optional><replaceable>FILE</replaceable></optional></term> <term><command>unlock-raw</command></term> <listitem><para>Generates/removes a <filename>.pcrlock</filename> file based on raw binary data. The @@ -490,13 +504,16 @@ <varlistentry> <term><option>--recovery-pin=</option></term> - <listitem><para>Takes a boolean. Defaults to false. Honoured by <command>make-policy</command>. If - true, will query the user for a PIN to unlock the TPM2 NV index with. If no policy was created before - this PIN is used to protect the newly allocated NV index. If a policy has been created before the PIN - is used to unlock write access to the NV index. If this option is not used a PIN is automatically - generated. Regardless if user supplied or automatically generated, it is stored in encrypted form in - the policy metadata file. The recovery PIN may be used to regain write access to an NV index in case - the access policy became out of date.</para> + <listitem><para>Takes one of <literal>hide</literal>, <literal>show</literal> or + <literal>query</literal>. Defaults to <literal>hide</literal>. Honoured by + <command>make-policy</command>. If <literal>query</literal>, will query the user for a PIN to unlock + the TPM2 NV index with. If no policy was created before, this PIN is used to protect the newly + allocated NV index. If a policy has been created before, the PIN is used to unlock write access to + the NV index. If either <literal>hide</literal> or <literal>show</literal> is used, a PIN is + automatically generated, and — only in case of <literal>show</literal> — displayed on + screen. Regardless if user supplied or automatically generated, it is stored in encrypted form in the + policy metadata file. The recovery PIN may be used to regain write access to an NV index in case the + access policy became out of date.</para> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> @@ -531,6 +548,18 @@ <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> + <varlistentry> + <term><option>--entry-token=</option></term> + + <listitem><para>Sets the boot entry token to use for the file name for the pcrlock policy credential + in the EFI System Partition or XBOOTLDR partition. See the + <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> option of + the same regarding expected values. This switch has an effect on the + <command>make-policy</command> command only.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="json" /> <xi:include href="standard-options.xml" xpointer="no-pager" /> <xi:include href="standard-options.xml" xpointer="help" /> @@ -546,14 +575,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.pcrlock</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrmachine.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.pcrlock</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrmachine.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-pcrphase.service.xml b/man/systemd-pcrphase.service.xml index 2d711e4..2dc9c8a 100644 --- a/man/systemd-pcrphase.service.xml +++ b/man/systemd-pcrphase.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-pcrphase.service" conditional='ENABLE_BOOTLOADER' +<refentry id="systemd-pcrphase.service" conditional='ENABLE_BOOTLOADER HAVE_OPENSSL HAVE_TPM2' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -158,7 +158,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-device=</option><replaceable>PATH</replaceable></term> + <term><option>--tpm2-device=<replaceable>PATH</replaceable></option></term> <listitem><para>Controls which TPM2 device to use. Expects a device node path referring to the TPM2 chip (e.g. <filename>/dev/tpmrm0</filename>). Alternatively the special value <literal>auto</literal> @@ -215,7 +215,7 @@ <filename>/run/log/systemd/tpm2-measure.log</filename>, which contains a <ulink url="https://www.rfc-editor.org/rfc/rfc7464.html">JSON-SEQ</ulink> series of objects that follow the general structure of the <ulink - url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Common Event Log + url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Canonical Event Log Format (CEL-JSON)</ulink> event objects (but lack the <literal>recnum</literal> field).</para> @@ -232,14 +232,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-portabled.service.xml b/man/systemd-portabled.service.xml index cb8cea6..abf42cf 100644 --- a/man/systemd-portabled.service.xml +++ b/man/systemd-portabled.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-portabled.service" conditional='ENABLE_PORTABLED'> @@ -41,11 +41,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-poweroff.service.xml b/man/systemd-poweroff.service.xml index 1484a45..ec7ffde 100644 --- a/man/systemd-poweroff.service.xml +++ b/man/systemd-poweroff.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-poweroff.service"> @@ -76,15 +76,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-pstore.service.xml b/man/systemd-pstore.service.xml index 66ad557..12c5459 100644 --- a/man/systemd-pstore.service.xml +++ b/man/systemd-pstore.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-pstore" conditional='ENABLE_PSTORE' diff --git a/man/systemd-quotacheck.service.xml b/man/systemd-quotacheck.service.xml index 7d9ff0e..034d13a 100644 --- a/man/systemd-quotacheck.service.xml +++ b/man/systemd-quotacheck.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-quotacheck.service" conditional='ENABLE_QUOTACHECK' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -62,11 +62,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-random-seed.service.xml b/man/systemd-random-seed.service.xml index 48928ed..b55e5de 100644 --- a/man/systemd-random-seed.service.xml +++ b/man/systemd-random-seed.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-random-seed.service" conditional='ENABLE_RANDOMSEED' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -85,14 +85,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>4</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>random</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootctl</refentrytitle><manvolnum>4</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot-random-seed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-rc-local-generator.xml b/man/systemd-rc-local-generator.xml index f0e38ea..cc6068a 100644 --- a/man/systemd-rc-local-generator.xml +++ b/man/systemd-rc-local-generator.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -53,8 +53,8 @@ Wants=network-online.target After=network-online.target </programlisting> - <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific System - V systems only. However, it is strongly recommended to avoid making use of this script today, and instead + <para>Support for <filename>&RC_LOCAL_PATH;</filename> is provided for compatibility with specific + System V systems only. However, it is strongly recommended to avoid using this script today, and instead provide proper unit files with appropriate dependencies for any scripts to run during the boot process. Note that the path to the script is set at compile time and varies between distributions.</para> @@ -63,10 +63,18 @@ After=network-online.target </refsect1> <refsect1> - <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <title>Notes</title> + + <para>On systems with SELinux, when creating the file, make sure to set the appropriate context, e.g. + with "<command>sudo restorecon -v &RC_LOCAL_PATH;</command>". </para> </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/systemd-remount-fs.service.xml b/man/systemd-remount-fs.service.xml index 266db88..1a4c402 100644 --- a/man/systemd-remount-fs.service.xml +++ b/man/systemd-remount-fs.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-remount-fs.service"> @@ -45,7 +45,7 @@ the partition table does not contain relevant entries).</para> <para>For a longer discussion of kernel API file systems see - <ulink url="https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API + <ulink url="https://systemd.io/API_FILE_SYSTEMS">API File Systems</ulink>.</para> <para>Note: <filename>systemd-remount-fs.service</filename> is usually pulled in by @@ -58,13 +58,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-repart.xml b/man/systemd-repart.xml index 27fa257..8f48081 100644 --- a/man/systemd-repart.xml +++ b/man/systemd-repart.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-repart" conditional='ENABLE_REPART' @@ -355,6 +355,18 @@ </varlistentry> <varlistentry> + <term><option>--private-key-source=</option></term> + + <listitem><para>Takes one of <literal>file</literal>, <literal>engine</literal> or + <literal>provider</literal>. In the latter two cases, it is followed by the name of a provider or + engine, separated by colon, that will be passed to OpenSSL's "engine" or "provider" logic. + Configures the signing mechanism to use when creating verity signature partitions with the + <varname>Verity=signature</varname> setting in partition files.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--certificate=</option></term> <listitem><para>Takes a file system path. Configures the PEM encoded X.509 certificate to use when @@ -378,8 +390,8 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-device-key=</option><arg>PATH</arg></term> - <term><option>--tpm2-seal-key-handle=</option><arg>HANDLE</arg></term> + <term><option>--tpm2-device-key=<replaceable>PATH</replaceable></option></term> + <term><option>--tpm2-seal-key-handle=<replaceable>HANDLE</replaceable></option></term> <listitem><para>Configures a TPM2 SRK key to bind encryption to. See <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -389,8 +401,8 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-public-key=</option><arg>PATH</arg></term> - <term><option>--tpm2-public-key-pcrs=</option><arg rep="repeat">PCR</arg></term> + <term><option>--tpm2-public-key=<replaceable>PATH</replaceable></option></term> + <term><option>--tpm2-public-key-pcrs=<replaceable>PCR<optional>+PCR...</optional></replaceable></option></term> <listitem><para>Configures a TPM2 signed PCR policy to bind encryption to. See <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -400,7 +412,7 @@ </varlistentry> <varlistentry> - <term><option>--tpm2-pcrlock=</option><arg>PATH</arg></term> + <term><option>--tpm2-pcrlock=<replaceable>PATH</replaceable></option></term> <listitem><para>Configures a TPM2 pcrlock policy to bind encryption to. See <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry> @@ -410,7 +422,7 @@ </varlistentry> <varlistentry> - <term><option>--split=</option><arg>BOOL</arg></term> + <term><option>--split=<replaceable>BOOL</replaceable></option></term> <listitem><para>Enables generation of split artifacts from partitions configured with <varname>SplitName=</varname>. If enabled, for each partition with <varname>SplitName=</varname> set, @@ -427,8 +439,8 @@ </varlistentry> <varlistentry> - <term><option>--include-partitions=</option><arg rep="repeat">PARTITION</arg></term> - <term><option>--exclude-partitions=</option><arg rep="repeat">PARTITION</arg></term> + <term><option>--include-partitions=<replaceable>PARTITIONS</replaceable></option></term> + <term><option>--exclude-partitions=<replaceable>PARTITIONS</replaceable></option></term> <listitem><para>These options specify which partition types <command>systemd-repart</command> should operate on. If <option>--include-partitions=</option> is used, all partitions that aren't specified @@ -442,7 +454,7 @@ </varlistentry> <varlistentry> - <term><option>--defer-partitions=</option><arg rep="repeat">PARTITION</arg></term> + <term><option>--defer-partitions=<replaceable>PARTITIONS</replaceable></option></term> <listitem><para>This option specifies for which partition types <command>systemd-repart</command> should defer. All partitions that are deferred using this option are still taken into account when @@ -455,7 +467,7 @@ </varlistentry> <varlistentry> - <term><option>--sector-size=</option><arg>BYTES</arg></term> + <term><option>--sector-size=<replaceable>BYTES</replaceable></option></term> <listitem><para>This option allows configuring the sector size of the image produced by <command>systemd-repart</command>. It takes a value that is a power of <literal>2</literal> between @@ -466,7 +478,7 @@ </varlistentry> <varlistentry> - <term><option>--architecture=</option><arg>ARCH</arg></term> + <term><option>--architecture=<replaceable>ARCH</replaceable></option></term> <listitem><para>This option allows overriding the architecture used for architecture specific partition types. For example, if set to <literal>arm64</literal> a partition type of @@ -496,7 +508,7 @@ </varlistentry> <varlistentry> - <term><option>--offline=</option><arg>BOOL</arg></term> + <term><option>--offline=<replaceable>BOOL</replaceable></option></term> <listitem><para>Instructs <command>systemd-repart</command> to build the image offline. Takes a boolean or <literal>auto</literal>. Defaults to <literal>auto</literal>. If enabled, the image is @@ -510,7 +522,7 @@ </varlistentry> <varlistentry> - <term><option>--copy-from=</option><arg>IMAGE</arg></term> + <term><option>--copy-from=<replaceable>IMAGE</replaceable></option></term> <listitem><para>Instructs <command>systemd-repart</command> to synthesize partition definitions from the partition table in the given image. This option can be specified multiple times to synthesize @@ -525,7 +537,7 @@ </varlistentry> <varlistentry> - <term><option>--copy-source=</option><replaceable>PATH</replaceable></term> + <term><option>--copy-source=<replaceable>PATH</replaceable></option></term> <term><option>-s</option> <replaceable>PATH</replaceable></term> <listitem><para>Specifies a source directory all <varname>CopyFiles=</varname> source paths shall be @@ -538,7 +550,7 @@ </varlistentry> <varlistentry> - <term><option>--make-ddi=</option><replaceable>TYPE</replaceable></term> + <term><option>--make-ddi=<replaceable>TYPE</replaceable></option></term> <listitem><para>Takes one of <literal>sysext</literal>, <literal>confext</literal> or <literal>portable</literal>. Generates a Discoverable Disk Image (DDI) for a system extension @@ -578,6 +590,28 @@ <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> + <varlistentry> + <term><option>--generate-fstab=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Specifies a path where to write fstab entries for the mountpoints configured with + <option>MountPoint=</option> in the root directory specified with <option>--copy-source=</option> or + <option>--root=</option> or in the host's root directory if neither is specified. Disabled by + default.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--generate-crypttab=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Specifies a path where to write crypttab entries for the encrypted volumes configured + with <option>EncryptedVolume=</option> in the root directory specified with + <option>--copy-source=</option> or <option>--root=</option> or in the host's root directory if + neither is specified. Disabled by default.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> <xi:include href="standard-options.xml" xpointer="no-pager" /> @@ -616,18 +650,39 @@ systemd-confext refresh</programlisting> <citerefentry><refentrytitle>systemd-confext</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> </example> + <example> + <title>Generate a system extension image and sign it via PKCS11</title> + + <para>The following creates a system extension DDI (sysext) for an + <filename>/usr/foo</filename> update and signs it with a hardware token via PKCS11.</para> + + <programlisting>mkdir tree tree/usr tree/usr/lib/extension-release.d +echo "Hello World" > tree/usr/foo +cat > tree/usr/lib/extension-release.d/extension-release.my-foo <<EOF +ID=fedora +VERSION_ID=38 +IMAGE_ID=my-foo +IMAGE_VERSION=7 +EOF +systemd-repart --make-ddi=sysext --private-key-source=engine:pkcs11 --private-key="pkcs11:model=PKCS%2315%20emulated;manufacturer=piv_II;serial=0123456789abcdef;token=Some%20Cert" --certificate=cert.crt -s tree/ /var/lib/extensions/my-foo.sysext.raw +systemd-sysext refresh</programlisting> + + <para>The DDI generated that way may be applied to the system with + <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + </example> + </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>repart.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>repart.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptenroll</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 85c857d..13c0da9 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-resolved.service" conditional='ENABLE_RESOLVE' @@ -36,7 +36,7 @@ via three interfaces:</para> <itemizedlist> - <listitem><para>The native, fully-featured API <command>systemd-resolved</command> exposes on the bus, + <listitem><para>The native, fully-featured API <command>systemd-resolved</command> exposes via D-Bus, see <citerefentry><refentrytitle>org.freedesktop.resolve1</refentrytitle><manvolnum>5</manvolnum></citerefentry> and @@ -45,6 +45,11 @@ featured (for example, properly returns DNSSEC validation status and interface scope for addresses as necessary for supporting link-local networking).</para></listitem> + <listitem><para>The native API <command>systemd-resolved</command> exposes via Varlink on the + <filename>/run/systemd/resolve/io.systemd.Resolve</filename> AF_UNIX socket. This provides similar + functionality as the D-Bus interface, but is available during the entire runtime, without requiring a + running D-Bus system bus broker service.</para></listitem> + <listitem><para>The glibc <citerefentry project='man-pages'><refentrytitle>getaddrinfo</refentrytitle><manvolnum>3</manvolnum></citerefentry> API as defined by <ulink url="https://tools.ietf.org/html/rfc3493">RFC3493</ulink> and its related @@ -416,6 +421,16 @@ search foobar.com barbar.com <xi:include href="version-info.xml" xpointer="v235"/></listitem> </varlistentry> + + <varlistentry> + <term><constant>SIGHUP</constant></term> + + <listitem><para>Upon reception of the <constant>SIGHUP</constant> process signal + <command>systemd-resolved</command> will flush all caches it maintains, drop all open TCP + connections (if any), and reload its configuration files.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> </refsect1> @@ -489,17 +504,17 @@ search foobar.com barbar.com <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>hosts</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>resolved.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>dnssec-trust-anchors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-resolve</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>resolv.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>hosts</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-rfkill.service.xml b/man/systemd-rfkill.service.xml index f2ff486..9449a04 100644 --- a/man/systemd-rfkill.service.xml +++ b/man/systemd-rfkill.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-rfkill.service" conditional='ENABLE_RFKILL' xmlns:xi="http://www.w3.org/2001/XInclude"> diff --git a/man/systemd-run-generator.xml b/man/systemd-run-generator.xml index 02924b4..a78c189 100644 --- a/man/systemd-run-generator.xml +++ b/man/systemd-run-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-run-generator"> @@ -68,14 +68,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-run.xml b/man/systemd-run.xml index 5be9823..e1986c1 100644 --- a/man/systemd-run.xml +++ b/man/systemd-run.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-run" @@ -64,8 +64,8 @@ other service, and thus shows up in the output of <command>systemctl list-units</command> like any other unit. It will run in a clean and detached execution environment, with the service manager as its parent process. In this mode, <command>systemd-run</command> will start the service asynchronously in the background and return after the - command has begun execution (unless <option>--no-block</option> or <option>--wait</option> are specified, see - below).</para> + command has begun execution (unless <option>--no-block</option>, <option>--wait</option>, <option>--pipe</option>, + or <option>--pty</option> are specified, see below).</para> <para>If a command is run as transient scope unit, it will be executed by <command>systemd-run</command> itself as parent process and will thus inherit the execution environment of the caller. However, the @@ -176,11 +176,14 @@ <term><option>--slice-inherit</option></term> <listitem><para>Make the new <filename>.service</filename> or <filename>.scope</filename> unit part - of the inherited slice. This option can be combined with <option>--slice=</option>.</para> - - <para>An inherited slice is located within <command>systemd-run</command> slice. Example: if - <command>systemd-run</command> slice is <filename>foo.slice</filename>, and the - <option>--slice=</option> argument is <filename>bar</filename>, the unit will be placed under the + of the slice the <command>systemd-run</command> itself has been invoked in. This option may be + combined with <option>--slice=</option>, in which case the slice specified via + <option>--slice=</option> is placed within the slice the <command>systemd-run</command> command is + invoked in.</para> + + <para>Example: consider <command>systemd-run</command> being invoked in the slice + <filename>foo.slice</filename>, and the <option>--slice=</option> argument is + <filename>bar</filename>. The unit will then be placed under <filename>foo-bar.slice</filename>.</para> <xi:include href="version-info.xml" xpointer="v246"/> @@ -322,6 +325,11 @@ to the terminal <command>systemd-run</command> is invoked on, via a pseudo TTY device. This allows running programs that expect interactive user input/output as services, such as interactive command shells.</para> + <para>This option will result in <command>systemd-run</command> synchronously waiting for + the transient service to terminate, similar to specifying <option>--wait</option>. If specified + along with <option>--wait</option>, <command>systemd-run</command> won't exit when manually disconnecting + from the pseudo TTY device.</para> + <para>Note that <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>'s <command>shell</command> command is usually a better alternative for requesting a new, interactive login @@ -338,21 +346,25 @@ <listitem><para>If specified, standard input, output, and error of the transient service are inherited from the <command>systemd-run</command> command itself. This allows <command>systemd-run</command> - to be used within shell pipelines. - Note that this mode is not suitable for interactive command shells and similar, as the - service process will not become a TTY controller when invoked on a terminal. Use <option>--pty</option> instead - in that case.</para> + to be used within shell pipelines.</para> + + <para>Note that this mode is not suitable for interactive command shells and similar, as the + service process will not become a TTY controller when invoked on a terminal. Use <option>--pty</option> + instead in that case.</para> <para>When both <option>--pipe</option> and <option>--pty</option> are used in combination the more appropriate option is automatically determined and used. Specifically, when invoked with standard input, output and error connected to a TTY <option>--pty</option> is used, and otherwise <option>--pipe</option>.</para> + <para>This option will result in <command>systemd-run</command> synchronously waiting for + the transient service to terminate, similar to specifying <option>--wait</option>.</para> + <para>When this option is used the original file descriptors <command>systemd-run</command> receives are passed to the service processes as-is. If the service runs with different privileges than - <command>systemd-run</command>, this means the service might not be able to re-open the passed file + <command>systemd-run</command>, this means the service might not be able to reopen the passed file descriptors, due to normal file descriptor access restrictions. If the invoked process is a shell script that uses the <command>echo "hello" >/dev/stderr</command> construct for writing messages to stderr, this might - cause problems, as this only works if stderr can be re-opened. To mitigate this use the construct <command>echo + cause problems, as this only works if stderr can be reopened. To mitigate this use the construct <command>echo "hello" >&2</command> instead, which is mostly equivalent and avoids this pitfall.</para> <xi:include href="version-info.xml" xpointer="v235"/></listitem> @@ -485,10 +497,36 @@ <xi:include href="version-info.xml" xpointer="v236"/></listitem> </varlistentry> + <varlistentry> + <term><option>--ignore-failure</option></term> + + <listitem><para>By default, if the specified command fails the invoked unit will be marked failed + (though possibly still unloaded, see <option>--collect=</option>, above), and this is reported in the + logs. If this switch is specified this is suppressed and any non-success exit status/code of the + command is treated as success.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--background=<replaceable>COLOR</replaceable></option></term> + + <listitem><para>Change the terminal background color to the specified ANSI color as long as the + session lasts. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such as + <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>, + <literal>48;5;…</literal>. See <ulink + url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI + Escape Code (Wikipedia)</ulink> for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <xi:include href="user-system-options.xml" xpointer="user" /> <xi:include href="user-system-options.xml" xpointer="system" /> <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> + <xi:include href="user-system-options.xml" xpointer="capsule" /> <xi:include href="standard-options.xml" xpointer="help" /> <xi:include href="standard-options.xml" xpointer="version" /> @@ -666,19 +704,20 @@ $ systemd-run --user --wait -p SuccessExitStatus=SIGUSR1 --expand-environment=no <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>run0</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index 7c2adb0..623e614 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-sleep.conf" @@ -22,10 +22,14 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/sleep.conf</filename></para> - <para><filename>/etc/systemd/sleep.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/sleep.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/sleep.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/sleep.conf</filename></member> + <member><filename>/run/systemd/sleep.conf</filename></member> + <member><filename>/usr/lib/systemd/sleep.conf</filename></member> + <member><filename>/etc/systemd/sleep.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/sleep.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/sleep.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -150,48 +154,66 @@ </varlistentry> <varlistentry> - <term><varname>HibernateMode=</varname></term> + <term><varname>SuspendState=</varname></term> - <listitem><para>The string to be written to <filename>/sys/power/disk</filename> by <citerefentry> - <refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + <listitem><para>The string to be written to <filename>/sys/power/state</filename> by <citerefentry> + <refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. More than one value can be specified by separating multiple values with whitespace. They will be tried in turn, until one is written without error. If none of the writes succeed, the operation will be aborted.</para> <para>The allowed set of values is determined by the kernel and is shown in the file itself (use - <command>cat /sys/power/disk</command> to display). See the kernel documentation page - <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation"> + <command>cat /sys/power/state</command> to display). See <ulink + url="https://docs.kernel.org/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation"> Basic sysfs Interfaces for System Suspend and Hibernation</ulink> for more details.</para> <para> <citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - uses the value of <varname>HibernateMode=</varname> when hibernating.</para> + uses this value when suspending.</para> <xi:include href="version-info.xml" xpointer="v203"/></listitem> </varlistentry> <varlistentry> - <term><varname>SuspendState=</varname></term> + <term><varname>HibernateMode=</varname></term> - <listitem><para>The string to be written to <filename>/sys/power/state</filename> by <citerefentry> - <refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + <listitem><para>The string to be written to <filename>/sys/power/disk</filename> by <citerefentry> + <refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. More than one value can be specified by separating multiple values with whitespace. They will be tried in turn, until one is written without error. If none of the writes succeed, the operation will be aborted.</para> <para>The allowed set of values is determined by the kernel and is shown in the file itself (use - <command>cat /sys/power/state</command> to display). See <ulink - url="https://www.kernel.org/doc/html/latest/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation"> + <command>cat /sys/power/disk</command> to display). See the kernel documentation page + <ulink url="https://docs.kernel.org/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation"> Basic sysfs Interfaces for System Suspend and Hibernation</ulink> for more details.</para> <para> <citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - uses this value when suspending.</para> + uses the value of <varname>HibernateMode=</varname> when hibernating.</para> <xi:include href="version-info.xml" xpointer="v203"/></listitem> </varlistentry> <varlistentry> + <term><varname>MemorySleepMode=</varname></term> + + <listitem><para>The string to be written to <filename>/sys/power/mem_sleep</filename> + when <option>SuspendState=mem</option> or <command>hybrid-sleep</command> is used. + More than one value can be specified by separating multiple values with whitespace. They will be + tried in turn, until one is written without error. If none of the writes succeed, the operation will + be aborted. Defaults to empty, i.e. the kernel default or kernel command line option + <varname>mem_sleep_default=</varname> is respected.</para> + + <para>The allowed set of values is determined by the kernel and is shown in the file itself (use + <command>cat /sys/power/mem_sleep</command> to display). See the kernel documentation page + <ulink url="https://docs.kernel.org/admin-guide/pm/sleep-states.html#basic-sysfs-interfaces-for-system-suspend-and-hibernation"> + Basic sysfs Interfaces for System Suspend and Hibernation</ulink> for more details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>HibernateDelaySec=</varname></term> <listitem> @@ -232,15 +254,15 @@ SuspendState=freeze</programlisting></para> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-sleep</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-sleep</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hybrid-sleep.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-suspend-then-hibernate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-socket-activate.xml b/man/systemd-socket-activate.xml index 1250725..4c29fa2 100644 --- a/man/systemd-socket-activate.xml +++ b/man/systemd-socket-activate.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-socket-activate" @@ -122,7 +122,7 @@ </varlistentry> <varlistentry> - <term><option>--fdname=</option><replaceable>NAME</replaceable><optional>:<replaceable>NAME</replaceable>…</optional></term> + <term><option>--fdname=<replaceable>NAME</replaceable><optional>:<replaceable>NAME</replaceable>…</optional></option></term> <listitem><para>Specify names for the file descriptors passed. This is equivalent to setting <varname>FileDescriptorName=</varname> in socket unit files, and enables use of @@ -187,14 +187,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>cat</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-socket-proxyd.xml b/man/systemd-socket-proxyd.xml index 59a1073..dde6d88 100644 --- a/man/systemd-socket-proxyd.xml +++ b/man/systemd-socket-proxyd.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-socket-proxyd" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -182,14 +182,14 @@ $ curl http://localhost:80/]]></programlisting> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>nginx</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>curl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>socat</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>nginx</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>curl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-soft-reboot.service.xml b/man/systemd-soft-reboot.service.xml index c4ee207..34dd5aa 100644 --- a/man/systemd-soft-reboot.service.xml +++ b/man/systemd-soft-reboot.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-soft-reboot.service" @@ -109,28 +109,28 @@ also have to be configured manually for correct ordering and conflicting. For example:</para> <programlisting>[Unit] -Description=My surviving service +Description=My Surviving Service SurviveFinalKillSignal=yes IgnoreOnIsolate=yes DefaultDependencies=no After=basic.target -Conflicts=reboot.target -Before=reboot.target -Conflicts=kexec.target -Before=kexec.target -Conflicts=poweroff.target -Before=poweroff.target -Conflicts=halt.target -Before=halt.target -Conflicts=rescue.target -Before=rescue.target -Conflicts=emergency.target -Before=emergency.target +Conflicts=reboot.target kexec.target poweroff.target halt.target rescue.target emergency.target +Before=shutdown.target rescue.target emergency.target [Service] Type=oneshot -ExecStart=sleep infinity - </programlisting> +ExecStart=sleep infinity</programlisting> + </listitem> + + <listitem><para>On top of the above, templated units also need a configuration file for their slice, as + they by default use a slice named after the non-templated part of the unit. For example, for a + <filename>foo@test.service</filename> instance, a <filename>system-foo.slice</filename> unit may be + added with the following content:</para> + + <programlisting>[Unit] +SurviveFinalKillSignal=yes +IgnoreOnIsolate=yes +DefaultDependencies=no</programlisting> </listitem> <listitem><para>File system mounts may remain mounted during the transition, and complex storage @@ -179,14 +179,14 @@ ExecStart=sleep infinity <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-poweroff.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-poweroff.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-suspend.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-ssh-generator.xml b/man/systemd-ssh-generator.xml new file mode 100644 index 0000000..98efc74 --- /dev/null +++ b/man/systemd-ssh-generator.xml @@ -0,0 +1,146 @@ +<?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" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> +<refentry id="systemd-ssh-generator" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>systemd-ssh-generator</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-ssh-generator</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-ssh-generator</refname> + <refpurpose>Generator for binding a socket-activated SSH server to local <constant>AF_VSOCK</constant> + and <constant>AF_UNIX</constant> sockets</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>/usr/lib/systemd/system-generators/systemd-ssh-generator</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-ssh-generator</command> binds a socket-activated SSH server to local + <constant>AF_VSOCK</constant> and <constant>AF_UNIX</constant> sockets under certain conditions. It only + has an effect if the <citerefentry + project="man-pages"><refentrytitle>sshd</refentrytitle><manvolnum>8</manvolnum></citerefentry> binary is + installed. Specifically, it does the following:</para> + + <itemizedlist> + <listitem><para>If invoked in a VM with <constant>AF_VSOCK</constant> support, a socket-activated SSH + per-connection service is bound to <constant>AF_VSOCK</constant> port 22.</para></listitem> + + <listitem><para>If invoked in a container environment with a writable directory + <filename>/run/host/unix-export/</filename> pre-mounted it binds SSH to an <constant>AF_UNIX</constant> + socket <filename>/run/host/unix-export/ssh</filename>. The assumption is that this directory is bind + mounted to the host side as well, and can be used to connect to the container from there. See <ulink + url="https://systemd.io/CONTAINER_INTERFACE">Container Interface</ulink> for more information about + this interface.</para></listitem> + + <listitem><para>A local <constant>AF_UNIX</constant> socket + <filename>/run/ssh-unix-local/socket</filename> is also bound, unconditionally. This may be used for + SSH communication from the host to itself, without involving networking, for example to traverse + security boundaries safely and with secure authentication.</para></listitem> + + <listitem><para>Additional <constant>AF_UNIX</constant> and <constant>AF_VSOCK</constant> sockets are + optionally bound, based on the <varname>systemd.ssh_listen=</varname> kernel command line option or the + <filename>ssh.listen</filename> system credential (see below).</para></listitem> + </itemizedlist> + + <para>See + <citerefentry><refentrytitle>systemd-ssh-proxy</refentrytitle><manvolnum>1</manvolnum></citerefentry> for + details on how to connect to these sockets via the <command>ssh</command> client.</para> + + <para>The <varname>ssh.authorized_keys.root</varname> credential can be used to allow specific public keys + to log in over SSH. See + <citerefentry><refentrytitle>systemd.systemd-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for more information.</para> + + <para>The generator will use a packaged <filename>sshd@.service</filename> service template file if one + exists, and otherwise generate a suitable service template file.</para> + + <para><filename>systemd-ssh-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>Kernel Command Line</title> + + <para><filename>systemd-ssh-generator</filename> understands the following + <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> + parameters:</para> + + <variablelist class='kernel-commandline-options'> + <varlistentry> + <term><varname>systemd.ssh_auto=</varname></term> + + <listitem><para>This option takes an optional boolean argument, and defaults to yes. If enabled, the + automatic binding to the <constant>AF_VSOCK</constant> and <constant>AF_UNIX</constant> sockets + listed above is done. If disable, this is not done, except for those explicitly requested via + <varname>systemd.ssh_listen=</varname> on the kernel command line or via the + <varname>ssh.listen</varname> system credential.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.ssh_listen=</varname></term> + + <listitem><para>This option configures an additional socket to bind SSH to. It may be used multiple + times to bind multiple sockets. The syntax should follow the one of <varname>ListenStream=</varname>, + see + <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details. This functionality supports all socket families systemd supports, including + <constant>AF_INET</constant> and <constant>AF_INET6</constant>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>Credentials</title> + + <para><command>systemd-ssh-generator</command> supports the system credentials logic. The following + credentials are used when passed in:</para> + + <variablelist class='system-credentials'> + <varlistentry> + <term><varname>ssh.listen</varname></term> + + <listitem><para>This credential should be a text file, with each line referencing one additional + socket to bind SSH to. The syntax should follow the one of <varname>ListenStream=</varname>, see + <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details. This functionality supports all socket families systemd supports, including + <constant>AF_INET</constant> and <constant>AF_INET6</constant>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>vsock</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>sshd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> diff --git a/man/systemd-ssh-proxy.xml b/man/systemd-ssh-proxy.xml new file mode 100644 index 0000000..d9615ff --- /dev/null +++ b/man/systemd-ssh-proxy.xml @@ -0,0 +1,116 @@ +<?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="systemd-ssh-proxy" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>systemd-ssh-proxy</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-ssh-proxy</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-ssh-proxy</refname> + <refpurpose>SSH client plugin for connecting to <constant>AF_VSOCK</constant> and + <constant>AF_UNIX</constant> sockets</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <programlisting> +Host unix/* vsock/* + ProxyCommand /usr/lib/systemd/systemd-ssh-proxy %h %p + ProxyUseFdpass yes +</programlisting> + <cmdsynopsis> + <command>/usr/lib/systemd/systemd-ssh-proxy</command> <arg>ADDRESS</arg> <arg>PORT</arg> + </cmdsynopsis> + </refsynopsisdiv> + + + <refsect1> + <title>Description</title> + + <para><command>systemd-ssh-proxy</command> is a small "proxy" plugin for the <citerefentry + project="man-pages"><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry> + tool that allows connecting to <constant>AF_UNIX</constant> and <constant>AF_VSOCK</constant> sockets. It + implements the interface defined by <filename>ssh</filename>'s <varname>ProxyCommand</varname> + configuration option. It's supposed to be used with an <citerefentry + project="man-pages"><refentrytitle>ssh_config</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration fragment like the following:</para> + + <programlisting> +Host unix/* vsock/* + ProxyCommand /usr/lib/systemd/systemd-ssh-proxy %h %p + ProxyUseFdpass yes + CheckHostIP no + +Host .host + ProxyCommand /usr/lib/systemd/systemd-ssh-proxy unix/run/ssh-unix-local/socket %p + ProxyUseFdpass yes + CheckHostIP no +</programlisting> + + <para>A configuration fragment along these lines is by default installed into + <filename>/etc/ssh/ssh_config.d/20-systemd-ssh-proxy.conf.in</filename>.</para> + + <para>With this in place, SSH connections to host string <literal>unix/</literal> followed by an absolute + <constant>AF_UNIX</constant> file system path to a socket will be directed to the specified socket, which + must be of type <constant>SOCK_STREAM</constant>. Similar, SSH connections to <literal>vsock/</literal> + followed by an <constant>AF_VSOCK</constant> CID will result in an SSH connection made to that + CID. Moreover connecting to <literal>.host</literal> will connect to the local host via SSH, without + involving networking.</para> + + <para>This tool is supposed to be used together with + <citerefentry><refentrytitle>systemd-ssh-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> + which when run inside a VM or container will bind SSH to suitable + addresses. <command>systemd-ssh-generator</command> is supposed to run in the container of VM guest, and + <command>systemd-ssh-proxy</command> is run on the host, in order to connect to the container or VM + guest.</para> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success, 0 is returned, a non-zero failure code + otherwise.</para> + </refsect1> + + <refsect1> + <title>Examples</title> + + <example> + <title>Talk to a local VM with CID 4711</title> + + <programlisting>ssh vsock/4711</programlisting> + </example> + + <example> + <title>Talk to the local host via ssh</title> + + <programlisting>ssh .host</programlisting> + + <para>or equivalent:</para> + + <programlisting>ssh unix/run/ssh-unix-local/socket</programlisting> + </example> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-ssh-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>vsock</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>unix</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>ssh</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project="man-pages"><refentrytitle>sshd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> diff --git a/man/systemd-stdio-bridge.xml b/man/systemd-stdio-bridge.xml index f96dbf8..ab5926c 100644 --- a/man/systemd-stdio-bridge.xml +++ b/man/systemd-stdio-bridge.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-stdio-bridge" @@ -82,12 +82,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='dbus'><refentrytitle>dbus-broker</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry project='dbus'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='dbus'><refentrytitle>dbus-broker</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://www.freedesktop.org/wiki/Software/dbus">D-Bus</ulink></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-storagetm.service.xml b/man/systemd-storagetm.service.xml index 1834f85..6fdbc3d 100644 --- a/man/systemd-storagetm.service.xml +++ b/man/systemd-storagetm.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-storagetm.service" conditional='ENABLE_STORAGETM' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -39,9 +39,11 @@ NVMe-TCP mass storage devices. Its primary use-case is to be invoked by the <filename>storage-target-mode.target</filename> unit that can be booted into.</para> - <para>Warning: the NVMe disks are currently exposed without authentication or encryption, in read/write - mode. This means network peers may read from and write to the device without any restrictions. This - functionality should hence only be used in a local setup.</para> + <warning> + <para>The NVMe disks are currently exposed without authentication or encryption, in read/write + mode. This means network peers may read from and write to the device without any restrictions. This + functionality should hence only be used in a local setup.</para> + </warning> <para>Note that to function properly networking must be configured too. The recommended mechanism to boot into a storage target mode is by adding <literal>rd.systemd.unit=storage-target-mode.target @@ -95,10 +97,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-stub.xml b/man/systemd-stub.xml index 6e85333..2724c57 100644 --- a/man/systemd-stub.xml +++ b/man/systemd-stub.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-stub" conditional='ENABLE_BOOTLOADER' @@ -25,14 +25,18 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/usr/lib/systemd/boot/efi/linuxx64.efi.stub</filename></para> - <para><filename>/usr/lib/systemd/boot/efi/linuxia32.efi.stub</filename></para> - <para><filename>/usr/lib/systemd/boot/efi/linuxaa64.efi.stub</filename></para> - <para><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.addon.efi</filename></para> - <para><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.cred</filename></para> - <para><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.raw</filename></para> - <para><filename><replaceable>ESP</replaceable>/loader/addons/*.addon.efi</filename></para> - <para><filename><replaceable>ESP</replaceable>/loader/credentials/*.cred</filename></para> + <para><simplelist> + <member><filename>/usr/lib/systemd/boot/efi/linuxx64.efi.stub</filename></member> + <member><filename>/usr/lib/systemd/boot/efi/linuxia32.efi.stub</filename></member> + <member><filename>/usr/lib/systemd/boot/efi/linuxaa64.efi.stub</filename></member> + <member><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.addon.efi</filename></member> + <member><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.cred</filename></member> + <member><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.raw</filename></member> + <member><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.sysext.raw</filename></member> + <member><filename><replaceable>ESP</replaceable>/.../<replaceable>foo</replaceable>.efi.extra.d/*.confext.raw</filename></member> + <member><filename><replaceable>ESP</replaceable>/loader/addons/*.addon.efi</filename></member> + <member><filename><replaceable>ESP</replaceable>/loader/credentials/*.cred</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -66,6 +70,9 @@ <listitem><para>An <literal>.initrd</literal> section with the initrd.</para></listitem> + <listitem><para>A <literal>.ucode</literal> section with an initrd containing microcode, to be handed + to the kernel before any other initrd. This initrd must not be compressed.</para></listitem> + <listitem><para>A <literal>.splash</literal> section with an image (in the Windows <filename>.BMP</filename> format) to show on screen before invoking the kernel.</para></listitem> @@ -85,7 +92,7 @@ specific key.</para></listitem> <listitem><para>A <literal>.pcrpkey</literal> section with a public key in the PEM format matching the - signature data in the the <literal>.pcrsig</literal> section.</para></listitem> + signature data in the <literal>.pcrsig</literal> section.</para></listitem> </itemizedlist> <para>If UEFI SecureBoot is enabled and the <literal>.cmdline</literal> section is present in the executed @@ -151,14 +158,28 @@ details on encrypted credentials. The generated <command>cpio</command> archive is measured into TPM PCR 12 (if a TPM is present).</para></listitem> - <listitem><para>Similarly, files <filename><replaceable>foo</replaceable>.efi.extra.d/*.raw</filename> - are packed up in a <command>cpio</command> archive and placed in the <filename>/.extra/sysext/</filename> - directory in the initrd file hierarchy. This is supposed to be used to pass additional system extension - images to the initrd. See + <listitem><para>Similarly, files + <filename><replaceable>foo</replaceable>.efi.extra.d/*.sysext.raw</filename> are packed up in a + <command>cpio</command> archive and placed in the <filename>/.extra/sysext/</filename> directory in the + initrd file hierarchy. This is supposed to be used to pass additional system extension images to the + initrd. See <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details on system extension images. The generated <command>cpio</command> archive containing these system extension images is measured into TPM PCR 13 (if a TPM is present).</para></listitem> + <!-- Note: the actual suffix we look for for sysexts is just *.raw (not *.sysext.raw), for + compatibility reasons with old versions. But we want people to name their system extensions + properly, hence we document the *.sysext.raw suffix only. --> + + <listitem><para>Similarly, files + <filename><replaceable>foo</replaceable>.efi.extra.d/*.confext.raw</filename> are packed up in a + <command>cpio</command> archive and placed in the <filename>/.extra/confext/</filename> directory in + the initrd file hierarchy. This is supposed to be used to pass additional configuration extension + images to the initrd. See + <citerefentry><refentrytitle>systemd-confext</refentrytitle><manvolnum>8</manvolnum></citerefentry> for + details on configuration extension images. The generated <command>cpio</command> archive containing + these system extension images is measured into TPM PCR 12 (if a TPM is present).</para></listitem> + <listitem><para>Similarly, files <filename><replaceable>foo</replaceable>.efi.extra.d/*.addon.efi</filename> are loaded and verified as PE binaries, and a <literal>.cmdline</literal> section is parsed from them. Addons are supposed to be @@ -167,7 +188,7 @@ configuration.</para> <para>In case Secure Boot is enabled, these files will be validated using keys in UEFI DB, Shim's DB or - Shim's MOK, and will be rejected otherwise. Additionally, if the both the addon and the UKI contain a a + Shim's MOK, and will be rejected otherwise. Additionally, if both the addon and the UKI contain a <literal>.uname</literal> section, the addon will be rejected if they do not match exactly. It is recommended to always add a <literal>.sbat</literal> section to all signed addons, so that they may be revoked with a SBAT policy update, without requiring blocklisting via DBX/MOKX. The @@ -215,10 +236,11 @@ core kernel, the embedded initrd and kernel command line (see above for a full list).</para> <para>Also note that the Linux kernel will measure all initrds it receives into TPM PCR 9. This means - every type of initrd will be measured two or three times: the initrd embedded in the kernel image will be - measured to PCR 4, PCR 9 and PCR 11; the initrd synthesized from credentials will be measured to both PCR - 9 and PCR 12; the initrd synthesized from system extensions will be measured to both PCR 4 and PCR - 9. Let's summarize the OS resources and the PCRs they are measured to:</para> + every type of initrd will be measured two or three times: the initrds embedded in the kernel image will be + measured to PCR 4, PCR 9 and PCR 11; the initrd synthesized from credentials (and the one synthesized + from configuration extensions) will be measured to both PCR 9 and PCR 12; the initrd synthesized from + system extensions will be measured to both PCR 4 and PCR 9. Let's summarize the OS resources and the PCRs + they are measured to:</para> <table> <title>OS Resource PCR Summary</title> @@ -256,6 +278,11 @@ </row> <row> + <entry>Microcode initrd (embedded in unified PE binary)</entry> + <entry>4 + 9 + 11</entry> + </row> + + <row> <entry>Default kernel command line (embedded in unified PE binary)</entry> <entry>4 + 11</entry> </row> @@ -289,6 +316,11 @@ <entry>System Extensions (synthesized initrd from companion files)</entry> <entry>9 + 13</entry> </row> + + <row> + <entry>Configuration Extensions (synthesized initrd from companion files)</entry> + <entry>9 + 12</entry> + </row> </tbody> </tgroup> </table> @@ -369,13 +401,24 @@ <varlistentry> <term><varname>StubPcrInitRDSysExts</varname></term> - <listitem><para>The PCR register index the systemd extensions for the initrd, which are picked up - from the file system the kernel image is located on. Formatted as decimal ASCII string (e.g. + <listitem><para>The PCR register index the system extensions for the initrd, which are picked up from + the file system the kernel image is located on. Formatted as decimal ASCII string (e.g. <literal>13</literal>). This variable is set if a measurement was successfully completed, and remains unset otherwise.</para> <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> + + <varlistentry> + <term><varname>StubPcrInitRDConfExts</varname></term> + + <listitem><para>The PCR register index the configuration extensions for the initrd, which are picked + up from the file system the kernel image is located on. Formatted as decimal ASCII string (e.g. + <literal>12</literal>). This variable is set if a measurement was successfully completed, and remains + unset otherwise.</para> + + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> </variablelist> <para>Note that some of the variables above may also be set by the boot loader. The stub will only set @@ -420,15 +463,24 @@ </varlistentry> <varlistentry> - <term><filename>/.extra/sysext/*.raw</filename></term> - <listitem><para>System extension image files (suffix <literal>.raw</literal>) that are placed next to - the unified kernel image (as described above) are copied into the + <term><filename>/.extra/sysext/*.sysext.raw</filename></term> + <listitem><para>System extension image files (suffix <literal>.sysext.raw</literal>) that are placed + next to the unified kernel image (as described above) are copied into the <filename>/.extra/sysext/</filename> directory in the initrd execution environment.</para> <xi:include href="version-info.xml" xpointer="v252"/></listitem> </varlistentry> <varlistentry> + <term><filename>/.extra/confext/*.confext.raw</filename></term> + <listitem><para>Configuration extension image files (suffix <literal>.confext.raw</literal>) that are + placed next to the unified kernel image (as described above) are copied into the + <filename>/.extra/confext/</filename> directory in the initrd execution environment.</para> + + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> + + <varlistentry> <term><filename>/.extra/tpm2-pcr-signature.json</filename></term> <listitem><para>The TPM2 PCR signature JSON object included in the <literal>.pcrsig</literal> PE section of the unified kernel image is copied into the @@ -459,7 +511,8 @@ <title>SMBIOS Type 11 Strings</title> <para><command>systemd-stub</command> can be configured using SMBIOS Type 11 strings. Applicable strings - consist of a name, followed by <literal>=</literal>, followed by the value. + consist of a name, followed by <literal>=</literal>, followed by the value. Unless + <command>systemd-stub</command> detects it is running inside a confidential computing environment, <command>systemd-stub</command> will search the table for a string with a specific name, and if found, use its value. The following strings are read:</para> @@ -483,16 +536,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink>, - <ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink>, - <citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-creds</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member> + <member><ulink url="https://systemd.io/BOOT_LOADER_INTERFACE">Boot Loader Interface</ulink></member> + <member><citerefentry><refentrytitle>ukify</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/TPM2_PCR_MEASUREMENTS">TPM2 PCR Measurements Made by systemd</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-suspend.service.xml b/man/systemd-suspend.service.xml index 02daecf..c5833b2 100644 --- a/man/systemd-suspend.service.xml +++ b/man/systemd-suspend.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-suspend.service" @@ -26,11 +26,13 @@ </refnamediv> <refsynopsisdiv> - <para><filename>systemd-suspend.service</filename></para> - <para><filename>systemd-hibernate.service</filename></para> - <para><filename>systemd-hybrid-sleep.service</filename></para> - <para><filename>systemd-suspend-then-hibernate.service</filename></para> - <para><filename>/usr/lib/systemd/system-sleep</filename></para> + <para><simplelist> + <member><filename>systemd-suspend.service</filename></member> + <member><filename>systemd-hibernate.service</filename></member> + <member><filename>systemd-hybrid-sleep.service</filename></member> + <member><filename>systemd-suspend-then-hibernate.service</filename></member> + <member><filename>/usr/lib/systemd/system-sleep</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -64,15 +66,15 @@ same executables are run, but the first argument is now <literal>post</literal>. All executables in this directory are executed in parallel, and execution of the action is not continued - until all executables have finished.</para> + until all executables have finished. Note that <filename>user.slice</filename> will + be frozen while the executables are running, so they should not attempt to + communicate with any user services expecting a reply.</para> <para>Note that scripts or binaries dropped in <filename>/usr/lib/systemd/system-sleep/</filename> are intended for local use only and should be considered hacks. If applications - want to react to system suspend/hibernation and resume, - they should rather use the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor - interface</ulink>.</para> + want to react to system suspend/hibernation and resume, they should rather use the + <ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>.</para> <para>Note that <filename>systemd-suspend.service</filename>, <filename>systemd-hibernate.service</filename>, <filename>systemd-hybrid-sleep.service</filename>, and @@ -88,6 +90,11 @@ <filename>sleep.conf.d</filename> file. See <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> + + <para>Note that by default these services freeze <filename>user.slice</filename> while they run. This prevents + the execution of any process in any of the user sessions while the system is entering into and resuming from + sleep. Thus, this prevents the hooks in <filename>/usr/lib/systemd/system-sleep/</filename>, or any other process + for that matter, from communicating with any user session process during sleep.</para> </refsect1> <refsect1> @@ -117,13 +124,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-sleep.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-halt.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysctl.service.xml b/man/systemd-sysctl.service.xml index cce3284..720beed 100644 --- a/man/systemd-sysctl.service.xml +++ b/man/systemd-sysctl.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-sysctl.service" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -158,11 +158,11 @@ kernel.core_pattern = |/usr/libexec/abrt-hook-ccpp %s %c %p %u %g %t %P %I <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sysctl.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>sysctl</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysext.xml b/man/systemd-sysext.xml index 3f0a0c2..c9bbf49 100644 --- a/man/systemd-sysext.xml +++ b/man/systemd-sysext.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-sysext" +<refentry id="systemd-sysext" conditional='ENABLE_SYSEXT' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -31,7 +31,7 @@ <arg choice="plain">COMMAND</arg> </cmdsynopsis> - <para><literallayout><filename>systemd-sysext.service</filename></literallayout></para> + <para><filename>systemd-sysext.service</filename></para> <cmdsynopsis> <command>systemd-confext</command> @@ -39,8 +39,7 @@ <arg choice="plain">COMMAND</arg> </cmdsynopsis> - <para><literallayout><filename>systemd-confext.service</filename></literallayout></para> - + <para><filename>systemd-confext.service</filename></para> </refsynopsisdiv> <refsect1> @@ -70,8 +69,10 @@ <filename>/var/</filename> included in a system extension image will <emphasis>not</emphasis> appear in the respective hierarchies after activation.</para> - <para>System extension images are strictly read-only, and the host <filename>/usr/</filename> and - <filename>/opt/</filename> hierarchies become read-only too while they are activated.</para> + <para>System extension images are strictly read-only by default. On mutable host file systems, + <filename>/usr/</filename> and <filename>/opt/</filename> hierarchies become read-only while extensions + are merged, unless mutability is enabled. Mutability may be enabled via the <option>--mutable=</option> + option; see "Mutability" below for more information.</para> <para>System extensions are supposed to be purely additive, i.e. they are supposed to include only files that do not exist in the underlying basic OS image. However, the underlying mechanism (overlayfs) also @@ -159,6 +160,11 @@ same as sysext images. The merged hierarchy will be mounted with <literal>nosuid</literal> and (if not disabled via <option>--noexec=false</option>) <literal>noexec</literal>.</para> + <para>Just like sysexts, confexts are strictly read-only by default. Merging confexts on mutable host + file systems will result in <filename>/etc/</filename> becoming read-only. As with sysexts, mutability + can be enabled via the <option>--mutable=</option> option. Refer to "Mutability" below for more + information.</para> + <para>Confexts are looked for in the directories <filename>/run/confexts/</filename>, <filename>/var/lib/confexts/</filename>, <filename>/usr/lib/confexts/</filename> and <filename>/usr/local/lib/confexts/</filename>. The first listed directory is not suitable for @@ -200,11 +206,72 @@ the underlying host <filename>/usr/</filename> is managed as immutable disk image or is a traditional package manager controlled (i.e. writable) tree.</para> - <para>For the confext case, the OSConfig project aims to perform runtime reconfiguration of OS services. + <para>With systemd-confext one can perform runtime reconfiguration of OS services. Sometimes, there is a need to swap certain configuration parameter values or restart only a specific service without deployment of new code or a complete OS deployment. In other words, we want to be able to tie the most frequently configured options to runtime updateable flags that can be changed without a - system reboot. This will help reduce servicing times when there is a need for changing the OS configuration.</para></refsect1> + system reboot. This will help reduce servicing times when there is a need for changing the OS configuration. + It also provides a reliable tool for managing configuration because all old configuration files disappear when + the systemd-confext image is removed.</para></refsect1> + + <refsect1> + <title>Mutability</title> + <para>By default, merging system extensions on mutable host file systems will render <filename>/usr/</filename> + and <filename>/opt/</filename> hierarchies read-only. Merging configuration extensions will have the same + effect on <filename>/etc/</filename>. Mutable mode allows writes to these locations when extensions are + merged.</para> + + <para>The following modes are supported: + <orderedlist> + <listitem><para><option>disabled</option>: Force immutable mode even if write routing directories exist + below <filename>/var/lib/extensions.mutable/</filename>. This is the default.</para></listitem> + <listitem><para><option>auto</option>: Automatic mode. Mutability is disabled by default and only + enabled if a corresponding write routing directory exists below + <filename>/var/lib/extensions.mutable/</filename>.</para></listitem> + <listitem><para><option>enabled</option>: Force mutable mode and automatically create write routing + directories below <filename>/var/lib/extensions.mutable/</filename> when required.</para></listitem> + <listitem><para><option>import</option>: Force immutable mode like <option>disabled</option> above, but + merge the contents of directories below <filename>/var/lib/extensions.mutable/</filename> into the host + file system.</para></listitem> + <listitem><para><option>ephemeral</option>: Force mutable mode like <option>enabled</option> above, but + instead of using write routing directory below <filename>/var/lib/extensions.mutable/</filename>, + <command>systemd-sysext</command> will use empty ephemeral directories. This means that the + modifications made in the merged hierarchies will be gone when the hierarchies are + unmerged.</para></listitem> + <listitem><para><option>ephemeral-import</option>: Force mutable mode like <option>ephemeral</option> + above, but instead of ignoring the contents of write routing directories under + <filename>/var/lib/extensions.mutable/</filename>, merge them into the host file system, like + <option>import</option> does.</para></listitem> + </orderedlist> + See "Options" below on specifying modes using the <option>--mutable=</option> command line option.</para> + + <para>With exception of the ephemeral mode, the mutable mode routes writes to subdirectories in + <filename>/var/lib/extensions.mutable/</filename>. + <simplelist type="horiz"> + <member>Writes to <filename>/usr/</filename> are directed to <filename>/var/lib/extensions.mutable/usr/</filename></member>, + <member>writes to <filename>/opt/</filename> are directed to <filename>/var/lib/extensions.mutable/opt/</filename>, and</member> + <member>writes to <filename>/etc/</filename> land in <filename>/var/lib/extensions.mutable/etc/</filename>.</member> + </simplelist></para> + + <para>If <filename>usr/</filename>, <filename>opt/</filename>, or <filename>etc/</filename> + in <filename>/var/lib/extensions.mutable/</filename> are symlinks, then writes are directed to the + symlinks' targets. + Consequently, to retain mutability of a host file system, create symlinks + <simplelist type="horiz"> + <member><filename>/var/lib/extensions.mutable/etc/</filename> → <filename>/etc/</filename></member> + <member><filename>/var/lib/extensions.mutable/usr/</filename> → <filename>/usr/</filename></member> + <member><filename>/var/lib/extensions.mutable/opt/</filename> → <filename>/opt/</filename></member> + </simplelist> + to route writes back to the original base directory hierarchy.</para> + + <para>Alternatively, a temporary file system may be mounted to + <filename>/var/lib/extensions.mutable/</filename>, or symlinks in + <filename>/var/lib/extensions.mutable/</filename> may point to sub-directories on a temporary file system + (e.g. below <filename>/tmp/</filename>) to only allow ephemeral changes. Note that this is not the same + as ephemeral mode, because the temporary file system will still exist after unmerging.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </refsect1> <refsect1> <title>Commands</title> @@ -315,7 +382,62 @@ </varlistentry> <varlistentry> - <term><option>--noexec=</option><replaceable>BOOL</replaceable></term> + <term><option>--mutable=<replaceable>BOOL</replaceable>|<replaceable>auto</replaceable>|<replaceable>import</replaceable></option></term> + <listitem><para>Set mutable mode.</para> + + <variablelist> + <varlistentry> + <term><option>no</option></term> + <listitem><para>force immutable mode even with write routing directories present. + This is the default.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>auto</option></term> + <listitem><para>enable mutable mode individually for <filename>/usr/</filename>, + <filename>/opt/</filename>, and <filename>/etc/</filename> if write routing sub-directories + or symlinks are present in <filename>/var/lib/extensions.mutable/</filename>; disable otherwise. + See "Mutability" above for more information on write routing.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>yes</option></term> + <listitem><para>force mutable mode. Write routing directories will be created in + <filename>/var/lib/extensions.mutable/</filename> if not present.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>import</option></term> + <listitem><para>immutable mode, but with contents of write routing directories in + <filename>/var/lib/extensions.mutable/</filename> also merged into the host file system.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>ephemeral</option></term> + <listitem><para>force mutable mode, but with contents of write routing directories in + <filename>/var/lib/extensions.mutable/</filename> being ignored, and modifications of the host + file system being discarded after unmerge.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>ephemeral-import</option></term> + <listitem><para>force mutable mode, with contents of write routing directories in + <filename>/var/lib/extensions.mutable/</filename> being merged into the host file system, but + with the modifications made to the host file system being discarded after unmerge.</para> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--noexec=<replaceable>BOOL</replaceable></option></term> <listitem><para>When merging configuration extensions into <filename>/etc/</filename> the <literal>MS_NOEXEC</literal> mount flag is used by default. This option can be used to disable @@ -351,11 +473,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-system-update-generator.xml b/man/systemd-system-update-generator.xml index 1611a71..67f5dac 100644 --- a/man/systemd-system-update-generator.xml +++ b/man/systemd-system-update-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-system-update-generator"> @@ -41,10 +41,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 3c06b65..ae5b61b 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -28,12 +28,16 @@ <refsynopsisdiv> <para><filename>/etc/systemd/system.conf</filename>, + <filename>/run/systemd/system.conf</filename>, + <filename>/usr/lib/systemd/system.conf</filename>, <filename>/etc/systemd/system.conf.d/*.conf</filename>, <filename>/run/systemd/system.conf.d/*.conf</filename>, <filename>/usr/lib/systemd/system.conf.d/*.conf</filename></para> <para><filename>~/.config/systemd/user.conf</filename>, <filename>/etc/systemd/user.conf</filename>, + <filename>/run/systemd/user.conf</filename>, + <filename>/usr/lib/systemd/user.conf</filename>, <filename>/etc/systemd/user.conf.d/*.conf</filename>, <filename>/run/systemd/user.conf.d/*.conf</filename>, <filename>/usr/lib/systemd/user.conf.d/*.conf</filename></para> @@ -44,9 +48,10 @@ <para>When run as a system instance, <command>systemd</command> interprets the configuration file <filename>system.conf</filename> and the files in <filename>system.conf.d</filename> directories; when - run as a user instance, it interprets the configuration file <filename>user.conf</filename> (either in - the home directory of the user, or if not found, under <filename>/etc/systemd/</filename>) and the files - in <filename>user.conf.d</filename> directories. These configuration files contain a few settings + run as a user instance, it interprets the configuration file <filename>user.conf</filename> (in order of + priority, in the home directory of the user and under <filename>/etc/systemd/</filename>, + <filename>/run/systemd/</filename>, and <filename>/usr/lib/systemd/</filename>) and the files in + <filename>user.conf.d</filename> directories. These configuration files contain a few settings controlling basic manager operations.</para> <para>See @@ -73,7 +78,7 @@ <term><varname>DumpCore=yes</varname></term> <term><varname>CrashChangeVT=no</varname></term> <term><varname>CrashShell=no</varname></term> - <term><varname>CrashReboot=no</varname></term> + <term><varname>CrashAction=freeze</varname></term> <term><varname>ShowStatus=yes</varname></term> <term><varname>DefaultStandardOutput=journal</varname></term> <term><varname>DefaultStandardError=inherit</varname></term> @@ -290,6 +295,20 @@ </varlistentry> <varlistentry> + <term><varname>ProtectSystem=</varname></term> + + <listitem><para>Takes a boolean argument or the string <literal>auto</literal>. If set to true this + will remount <filename>/usr/</filename> read-only. If set to <literal>auto</literal> (the default) + and running in an initrd equivalent to true, otherwise false. This implements a restricted subset of + the per-unit setting of the same name, see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details: currently, the <literal>full</literal> or <literal>struct</literal> values are not + supported.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>SystemCallArchitectures=</varname></term> <listitem><para>Takes a space-separated list of architecture @@ -605,10 +624,12 @@ <term><varname>ReloadLimitIntervalSec=</varname></term> <term><varname>ReloadLimitBurst=</varname></term> - <listitem><para>Rate limiting for daemon-reload requests. Default to unset, and any number of daemon-reload - operations can be requested at any time. <varname>ReloadLimitIntervalSec=</varname> takes a value in seconds - to configure the rate limit window, and <varname>ReloadLimitBurst=</varname> takes a positive integer to - configure the maximum allowed number of reloads within the configured time window.</para> + <listitem><para>Rate limiting for daemon-reload and (since v256) daemon-reexec requests. The setting + applies to both operations, but the rate limits are tracked separately. Defaults to unset, and any + number of operations can be requested at any time. <varname>ReloadLimitIntervalSec=</varname> takes + a value in seconds to configure the rate limit window, and <varname>ReloadLimitBurst=</varname> + takes a positive integer to configure the maximum allowed number of operations within the configured + time window.</para> <xi:include href="version-info.xml" xpointer="v253"/></listitem> </varlistentry> @@ -714,14 +735,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysupdate.xml b/man/systemd-sysupdate.xml index 65848b8..8c1228c 100644 --- a/man/systemd-sysupdate.xml +++ b/man/systemd-sysupdate.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-sysupdate" conditional='ENABLE_SYSUPDATE' @@ -309,11 +309,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysupdate.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sysupdate.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysusers.xml b/man/systemd-sysusers.xml index 88645aa..8954227 100644 --- a/man/systemd-sysusers.xml +++ b/man/systemd-sysusers.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-sysusers" @@ -40,17 +40,17 @@ <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> - <para>If invoked with no arguments, it applies all directives from all files found in the directories + <para>If invoked with no arguments, directives from the configuration files found in the directories specified by <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. When invoked with positional arguments, if option <option>--replace=<replaceable>PATH</replaceable></option> is specified, arguments specified on the command line are used instead of the configuration file <replaceable>PATH</replaceable>. Otherwise, just the configuration specified by the command line - arguments is executed. The string <literal>-</literal> may be specified instead of a filename to instruct - <command>systemd-sysusers</command> to read the configuration from standard input. If the argument is a - relative path, all configuration directories are searched for a matching file and the file found that has - the highest priority is executed. If the argument is an absolute path, that file is used directly without - searching of the configuration directories.</para> + arguments is executed. If the string <literal>-</literal> is specified instead of a filename, the + configuration is read from standard input. If the argument is a file name (without any slashes), all + configuration directories are searched for a matching file and the file found that has the highest + priority is executed. If the argument is a path, that file is used directly without searching the + configuration directories for any other matching file.</para> </refsect1> <refsect1> @@ -151,7 +151,7 @@ <para><command>systemd-sysusers</command> supports the service credentials logic as implemented by <varname>ImportCredential=</varname>/<varname>LoadCredential=</varname>/<varname>SetCredential=</varname> - (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry> for + (see <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The following credentials are used when passed in:</para> <variablelist class='system-credentials'> @@ -226,13 +226,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <ulink url="https://systemd.io/UIDS-GIDS">Users, Groups, UIDs and GIDs on systemd systems</ulink>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mkpasswd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sysusers.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/UIDS-GIDS">Users, Groups, UIDs and GIDs on systemd systems</ulink></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mkpasswd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysv-generator.xml b/man/systemd-sysv-generator.xml index 2172e09..e198c2b 100644 --- a/man/systemd-sysv-generator.xml +++ b/man/systemd-sysv-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-sysv-generator" conditional="HAVE_SYSV_COMPAT"> @@ -47,8 +47,7 @@ more details.</para> <para>Note that compatibility is quite comprehensive but not 100%, for more details see <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities with - SysV</ulink>.</para> + url="https://systemd.io/INCOMPATIBILITIES">Compatibility with SysV</ulink>.</para> <para>SysV runlevels have corresponding systemd targets (<filename>runlevel<replaceable>X</replaceable>.target</filename>). The wrapper unit that is generated @@ -63,11 +62,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-time-wait-sync.service.xml b/man/systemd-time-wait-sync.service.xml index fe7ef17..0a0b64e 100644 --- a/man/systemd-time-wait-sync.service.xml +++ b/man/systemd-time-wait-sync.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-time-wait-sync.service" conditional='ENABLE_TIMESYNCD' @@ -63,11 +63,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-timedated.service.xml b/man/systemd-timedated.service.xml index c0314d5..eb4fc18 100644 --- a/man/systemd-timedated.service.xml +++ b/man/systemd-timedated.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-timedated.service" conditional='ENABLE_TIMEDATED'> @@ -93,13 +93,13 @@ systemd-timesyncd.service <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timesyncd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timesyncd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-timesyncd.service.xml b/man/systemd-timesyncd.service.xml index 87625ac..25b236d 100644 --- a/man/systemd-timesyncd.service.xml +++ b/man/systemd-timesyncd.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-timesyncd.service" conditional='ENABLE_TIMESYNCD' @@ -118,17 +118,17 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-time-wait-sync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timesyncd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-time-wait-sync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timedatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-tmpfiles.xml b/man/systemd-tmpfiles.xml index d0f8ed3..008bff6 100644 --- a/man/systemd-tmpfiles.xml +++ b/man/systemd-tmpfiles.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-tmpfiles" @@ -23,8 +23,7 @@ <refname>systemd-tmpfiles-setup-dev.service</refname> <refname>systemd-tmpfiles-clean.service</refname> <refname>systemd-tmpfiles-clean.timer</refname> - <refpurpose>Creates, deletes and cleans up volatile - and temporary files and directories</refpurpose> + <refpurpose>Create, delete, and clean up files and directories</refpurpose> </refnamediv> <refsynopsisdiv> @@ -35,16 +34,22 @@ </cmdsynopsis> <para>System units: -<literallayout><filename>systemd-tmpfiles-setup.service</filename> -<filename>systemd-tmpfiles-setup-dev-early.service</filename> -<filename>systemd-tmpfiles-setup-dev.service</filename> -<filename>systemd-tmpfiles-clean.service</filename> -<filename>systemd-tmpfiles-clean.timer</filename></literallayout></para> + <simplelist> + <member><filename>systemd-tmpfiles-setup.service</filename></member> + <member><filename>systemd-tmpfiles-setup-dev-early.service</filename></member> + <member><filename>systemd-tmpfiles-setup-dev.service</filename></member> + <member><filename>systemd-tmpfiles-clean.service</filename></member> + <member><filename>systemd-tmpfiles-clean.timer</filename></member> + </simplelist> + </para> <para>User units: -<literallayout><filename>systemd-tmpfiles-setup.service</filename> -<filename>systemd-tmpfiles-clean.service</filename> -<filename>systemd-tmpfiles-clean.timer</filename></literallayout></para> + <simplelist> + <member><filename>systemd-tmpfiles-setup.service</filename></member> + <member><filename>systemd-tmpfiles-clean.service</filename></member> + <member><filename>systemd-tmpfiles-clean.timer</filename></member> + </simplelist> + </para> </refsynopsisdiv> <refsect1> @@ -53,17 +58,20 @@ <para><command>systemd-tmpfiles</command> creates, deletes, and cleans up volatile and temporary files and directories, using the configuration file format and location specified in <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. It must - be invoked with one or more options <option>--create</option>, <option>--remove</option>, and + be invoked with one or more commands <option>--create</option>, <option>--remove</option>, and <option>--clean</option>, to select the respective subset of operations.</para> - <para>By default, directives from all configuration files are applied. When invoked with - <option>--replace=<replaceable>PATH</replaceable></option>, arguments specified on the command line are - used instead of the configuration file <replaceable>PATH</replaceable>. Otherwise, if one or more - absolute filenames are passed on the command line, only the directives in these files are applied. If - <literal>-</literal> is specified instead of a filename, directives are read from standard input. If only - the basename of a configuration file is specified, all configuration directories as specified in - <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> are - searched for a matching file and the file found that has the highest priority is executed.</para> + <para>If invoked with no arguments, directives from the configuration files found in the directories + specified by + <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. When + invoked with positional arguments, if option <option>--replace=<replaceable>PATH</replaceable></option> + is specified, arguments specified on the command line are used instead of the configuration file + <replaceable>PATH</replaceable>. Otherwise, just the configuration specified by the command line + arguments is executed. If the string <literal>-</literal> is specified instead of a filename, the + configuration is read from standard input. If the argument is a file name (without any slashes), all + configuration directories are searched for a matching file and the file found that has the highest + priority is executed. If the argument is a path, that file is used directly without searching the + configuration directories for any other matching file.</para> <para>System services (<filename>systemd-tmpfiles-setup.service</filename>, <filename>systemd-tmpfiles-setup-dev-early.service</filename>, @@ -90,14 +98,14 @@ </refsect1> <refsect1> - <title>Options</title> + <title>Commands and options</title> - <para>The following options are understood:</para> + <para>The following commands are understood:</para> <variablelist> <varlistentry> <term><option>--create</option></term> - <listitem><para>If this option is passed, all files and + <listitem><para>If this command is passed, all files and directories marked with <varname>f</varname>, <varname>F</varname>, @@ -123,14 +131,14 @@ <varlistentry> <term><option>--clean</option></term> - <listitem><para>If this option is passed, all files and + <listitem><para>If this command is passed, all files and directories with an age parameter configured will be cleaned up.</para></listitem> </varlistentry> <varlistentry> <term><option>--remove</option></term> - <listitem><para>If this option is passed, the contents of + <listitem><para>If this command is passed, the contents of directories marked with <varname>D</varname> or <varname>R</varname>, and files or directories themselves marked with <varname>r</varname> or <varname>R</varname> are @@ -140,6 +148,14 @@ </varlistentry> <varlistentry> + <term><option>--purge</option></term> + <listitem><para>If this option is passed, all files and directories created by a + <filename>tmpfiles.d/</filename> entry will be deleted.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--user</option></term> <listitem><para>Execute "user" configuration, i.e. <filename>tmpfiles.d</filename> files in user configuration directories.</para> @@ -166,6 +182,14 @@ </varlistentry> <varlistentry> + <term><option>--dry-run</option></term> + <listitem><para>Process the configuration and print what operations would be performed, but don't + actually change anything in the file system.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--prefix=<replaceable>path</replaceable></option></term> <listitem><para>Only apply rules with paths that start with the specified prefix. This option can be specified multiple @@ -340,10 +364,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-tpm2-generator.xml b/man/systemd-tpm2-generator.xml new file mode 100644 index 0000000..51950ee --- /dev/null +++ b/man/systemd-tpm2-generator.xml @@ -0,0 +1,60 @@ +<?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" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> +<refentry id="systemd-tpm2-generator"> + + <refentryinfo> + <title>systemd-tpm2-generator</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-tpm2-generator</refentrytitle> + <manvolnum>8</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-tpm2-generator</refname> + <refpurpose>Generator for inserting TPM2 synchronization point in the boot process</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>/usr/lib/systemd/system-generators/systemd-tpm2-generator</filename></para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><filename>systemd-tpm2-generator</filename> is a generator that adds a <varname>Wants=</varname> + dependency from <filename>sysinit.target</filename> to <filename>tpm2.target</filename> when it detects + that the firmware discovered a TPM2 device but the OS kernel so far did + not. <filename>tpm2.target</filename> is supposed to act as synchronization point for all services that + require TPM2 device access. See + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details.</para> + + <para>The <option>systemd.tpm2_wait=</option> kernel command line option may be used to override + behaviour of the generator. It accepts a boolean value: if true then <filename>tpm2.target</filename> + will be added as synchronization point even if the firmware has not detected a TPM2 device. If false, the + target will not be inserted even if firmware reported a device but the OS kernel doesn't expose a device + for it yet. The latter might be useful in environments where a suitable TPM2 driver for the available + hardware is not available.</para> + + <para><filename>systemd-tpm2-generator</filename> implements + <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> diff --git a/man/systemd-tpm2-setup.service.xml b/man/systemd-tpm2-setup.service.xml index 505183a..3fa3490 100644 --- a/man/systemd-tpm2-setup.service.xml +++ b/man/systemd-tpm2-setup.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-tpm2-setup.service" conditional='ENABLE_BOOTLOADER' xmlns:xi="http://www.w3.org/2001/XInclude"> diff --git a/man/systemd-tty-ask-password-agent.xml b/man/systemd-tty-ask-password-agent.xml index 864dff3..423fdef 100644 --- a/man/systemd-tty-ask-password-agent.xml +++ b/man/systemd-tty-ask-password-agent.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-tty-ask-password-agent" @@ -126,13 +126,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-ask-password-console.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-udev-settle.service.xml b/man/systemd-udev-settle.service.xml index 2852f31..8aa6aa1 100644 --- a/man/systemd-udev-settle.service.xml +++ b/man/systemd-udev-settle.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-udev-settle.service" @@ -43,9 +43,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml index 27d0e02..c781765 100644 --- a/man/systemd-udevd.service.xml +++ b/man/systemd-udevd.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-udevd.service" @@ -236,7 +236,7 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>net.naming-scheme=</varname></term> + <term><varname>net.naming_scheme=</varname></term> <listitem> <para>Network interfaces are renamed to give them predictable names when possible (unless <varname>net.ifnames=0</varname> is specified, see above). With this kernel command line option it @@ -255,7 +255,7 @@ </listitem> </varlistentry> <varlistentry> - <term><varname>net.ifname-policy=<replaceable>policy1</replaceable>[,<replaceable>policy2</replaceable>,…][,<replaceable>MAC</replaceable>]</varname></term> + <term><varname>net.ifname_policy=<replaceable>policy1</replaceable>[,<replaceable>policy2</replaceable>,…][,<replaceable>MAC</replaceable>]</varname></term> <listitem> <para>Specifies naming policies applied when renaming network interfaces. Takes a list of policies and an optional MAC address separated with comma. Each policy value must be one of @@ -273,8 +273,8 @@ enabled.</para> <para>Example: - <programlisting>net.ifname-policy=keep,kernel,path,slot,onboard,01:23:45:67:89:ab -net.ifname-policy=keep,kernel,path,slot,onboard,mac</programlisting> + <programlisting>net.ifname_policy=keep,kernel,path,slot,onboard,01:23:45:67:89:ab +net.ifname_policy=keep,kernel,path,slot,onboard,mac</programlisting> This is mostly equivalent to creating the following .link files: <programlisting># 91-name-policy-with-mac.link [Match] @@ -302,10 +302,10 @@ AlternativeNamePolicy=path slot onboard mac</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-update-done.service.xml b/man/systemd-update-done.service.xml index 3393010..6b863ec 100644 --- a/man/systemd-update-done.service.xml +++ b/man/systemd-update-done.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-update-done.service"> @@ -58,7 +58,7 @@ <citerefentry project='man-pages'><refentrytitle>touch</refentrytitle><manvolnum>1</manvolnum></citerefentry> on it.</para> - <para>Note that if the <varname>systemd.condition-needs-update=</varname> kernel command line option is + <para>Note that if the <varname>systemd.condition_needs_update=</varname> kernel command line option is used it overrides the <varname>ConditionNeedsUpdate=</varname> unit condition checks. In that case <filename>systemd-update-done.service</filename> will not reset the condition state until a follow-up reboot where the kernel switch is not specified anymore.</para> @@ -66,11 +66,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>touch</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>touch</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-update-utmp.service.xml b/man/systemd-update-utmp.service.xml index ff01893..2d7dee9 100644 --- a/man/systemd-update-utmp.service.xml +++ b/man/systemd-update-utmp.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-update-utmp.service" conditional="ENABLE_UTMP"> @@ -41,11 +41,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>auditd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>utmp</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>auditd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-user-sessions.service.xml b/man/systemd-user-sessions.service.xml index f05e4e3..a8c9b77 100644 --- a/man/systemd-user-sessions.service.xml +++ b/man/systemd-user-sessions.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-user-sessions.service" conditional='HAVE_PAM'> @@ -40,11 +40,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam_nologin</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam_nologin</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-userdbd.service.xml b/man/systemd-userdbd.service.xml index 71a5dff..16f1110 100644 --- a/man/systemd-userdbd.service.xml +++ b/man/systemd-userdbd.service.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-userdbd.service" conditional='ENABLE_USERDB'> @@ -64,11 +64,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>userdbctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-vconsole-setup.service.xml b/man/systemd-vconsole-setup.service.xml index 0962dc9..87cb9e4 100644 --- a/man/systemd-vconsole-setup.service.xml +++ b/man/systemd-vconsole-setup.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-vconsole-setup.service" conditional='ENABLE_VCONSOLE' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -97,13 +97,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>vconsole.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-veritysetup-generator.xml b/man/systemd-veritysetup-generator.xml index b1efed5..f583468 100644 --- a/man/systemd-veritysetup-generator.xml +++ b/man/systemd-veritysetup-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-veritysetup-generator" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -126,12 +126,12 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-veritysetup@.service.xml b/man/systemd-veritysetup@.service.xml index d6131a8..c715dac 100644 --- a/man/systemd-veritysetup@.service.xml +++ b/man/systemd-veritysetup@.service.xml @@ -1,9 +1,9 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="systemd-veritysetup@.service" conditional='HAVE_LIBCRYPTSETUP' +<refentry id="systemd-veritysetup_.service" conditional='HAVE_LIBCRYPTSETUP' xmlns:xi="http://www.w3.org/2001/XInclude"> <refentryinfo> @@ -94,11 +94,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-vmspawn.xml b/man/systemd-vmspawn.xml index 9bec440..19dce8a 100644 --- a/man/systemd-vmspawn.xml +++ b/man/systemd-vmspawn.xml @@ -1,6 +1,9 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "custom-entities.ent" > +%entities; +]> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-vmspawn" conditional="ENABLE_VMSPAWN" @@ -31,11 +34,19 @@ <refsect1> <title>Description</title> - <para><command>systemd-vmspawn</command> may be used to start a virtual machine from an OS image. In many ways it is similar to <citerefentry - project='man-pages'><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, but it + <para><command>systemd-vmspawn</command> may be used to start a virtual machine from an OS image. In many ways it is similar to <citerefentry> + <refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, but launches a full virtual machine instead of using namespaces.</para> - <para>Note: on Ubuntu/Debian derivatives systemd-vmspawn requires the user to be in the <literal>kvm</literal> group to use the VSock options.</para> + <para>File descriptors for <filename>/dev/kvm</filename> and <filename>/dev/vhost-vsock</filename> can be + passed to <command>systemd-vmspawn</command> via systemd's native socket passing interface (see + <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry> for + details about the precise protocol used and the order in which the file descriptors are passed), these + file descriptors must be passed with the names <literal>kvm</literal> and <literal>vhost-vsock</literal> + respectively.</para> + + <para>Note: on Ubuntu/Debian derivatives systemd-vmspawn requires the user to be in the + <literal>kvm</literal> group to use the VSOCK options.</para> </refsect1> <refsect1> @@ -45,11 +56,43 @@ <para>The following options are understood:</para> + <variablelist> + + <varlistentry> + <term><option>-q</option></term> + <term><option>--quiet</option></term> + + <listitem><para>Turns off any status output by the tool + itself. When this switch is used, the only output from vmspawn + will be the console output of the Virtual Machine OS itself.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + </variablelist> + <refsect2> <title>Image Options</title> <variablelist> <varlistentry> + <term><option>-D</option></term> + <term><option>--directory=</option></term> + + <listitem><para>Directory to use as file system root for the virtual machine.</para> + + <para>One of either <option>--directory=</option> or <option>--image=</option> must be specified. + If neither are specified <option>--directory=.</option> is assumed.</para> + + <para>Note: If mounting a non-root owned directory you may require <option>--private-users=</option> + to map into the user's subuid namespace. An example of how to use <constant>/etc/subuid</constant> + for this is given later.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><option>-i</option></term> <term><option>--image=</option></term> @@ -66,9 +109,9 @@ <variablelist> <varlistentry> - <term><option>--qemu-smp=</option><replaceable>SMP</replaceable></term> + <term><option>--cpus=<replaceable>CPUS</replaceable></option></term> - <listitem><para>Configures the number of CPUs to start the virtual machine with. + <listitem><para>The number of CPUs to start the virtual machine with. Defaults to 1.</para> <xi:include href="version-info.xml" xpointer="v255"/> @@ -76,68 +119,156 @@ </varlistentry> <varlistentry> - <term><option>--qemu-mem=</option><replaceable>MEM</replaceable></term> + <term><option>--ram=<replaceable>BYTES</replaceable></option></term> - <listitem><para>Configures the amount of memory to start the virtual machine with. + <listitem><para>The amount of memory to start the virtual machine with. Defaults to 2G.</para> <xi:include href="version-info.xml" xpointer="v255"/> </listitem> </varlistentry> - <varlistentry> - <term><option>--qemu-kvm=</option><replaceable>BOOL</replaceable></term> + <varlistentry> + <term><option>--kvm=<replaceable>BOOL</replaceable></option></term> - <listitem><para>Configures whether to use KVM. If the option is not specified KVM support will be - detected automatically. If true, KVM is always used, and if false, KVM is never used.</para> + <listitem><para>If <option>--kvm=</option> is not specified KVM support will be + detected automatically. If true, KVM is always used, and if false, KVM is never used.</para> - <xi:include href="version-info.xml" xpointer="v255"/></listitem> - </varlistentry> + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> - <varlistentry> - <term><option>--qemu-vsock=</option><replaceable>BOOL</replaceable></term> + <varlistentry> + <term><option>--vsock=<replaceable>BOOL</replaceable></option></term> - <listitem> - <para>Configure whether to use VSock networking.</para> - <para>If the option is not specified VSock support will be detected automatically. - If yes is specified VSocks are always used, and vice versa if no is set VSocks are never used.</para> - <xi:include href="version-info.xml" xpointer="v255"/> - </listitem> - </varlistentry> + <listitem><para>If <option>--vsock=</option> is not specified VSOCK networking support will be + detected automatically. If true, VSOCK networking is always used, and if false, VSOCK networking is never used.</para> - <varlistentry> - <term><option>--vsock-cid=</option><replaceable>CID</replaceable></term> + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> - <listitem> - <para>Configure vmspawn to use a specific CID for the guest.</para> - <para>If the option is not specified or an empty argument is supplied the guest will be assigned a random CID.</para> - <para>Valid CIDs are in the range <constant>3</constant> to <constant>4294967294</constant> (<constant>0xFFFF_FFFE</constant>). - CIDs outside of this range are reserved.</para> - <xi:include href="version-info.xml" xpointer="v255"/> - </listitem> - </varlistentry> + <varlistentry> + <term><option>--vsock-cid=<replaceable>CID</replaceable></option></term> - <varlistentry> - <term><option>--qemu-gui</option></term> + <listitem> + <para>Sets the specific CID to use for the guest. + Valid CIDs are in the range <constant>3</constant> to <constant>4294967294</constant> (<constant>0xFFFF_FFFE</constant>). + CIDs outside of this range are reserved. By default vmspawn will attempt to derive a CID for the guest derived from the machine name, + falling back to a random CID if this CID is taken.</para> - <listitem><para>Start QEMU in graphical mode.</para> + <xi:include href="version-info.xml" xpointer="v255"/> + </listitem> + </varlistentry> - <xi:include href="version-info.xml" xpointer="v255"/></listitem> - </varlistentry> + <varlistentry> + <term><option>--tpm=<replaceable>BOOL</replaceable></option></term> - <varlistentry> - <term><option>--secure-boot=</option><replaceable>BOOL</replaceable></term> + <listitem> + <para>If <option>--tpm=</option> is not specified vmspawn will detect the presence of <citerefentry project='debian'> + <refentrytitle>swtpm</refentrytitle><manvolnum>8</manvolnum></citerefentry> and use it if available. + If yes is specified <citerefentry project='debian'><refentrytitle>swtpm</refentrytitle><manvolnum>8</manvolnum></citerefentry> + is always used, and if no is set <citerefentry project='debian'><refentrytitle>swtpm</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> is never used.</para> - <listitem><para>Configure whether to search for firmware which supports Secure Boot.</para> - <para>If the option is not specified the first firmware which is detected will be used. - If the option is set to yes then the first firmware with Secure Boot support will be selected. - If no is specified then the first firmware without Secure Boot will be selected.</para> + <para>Note: the virtual TPM used may change in future.</para> - <xi:include href="version-info.xml" xpointer="v255"/></listitem> - </varlistentry> - </variablelist> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> - </refsect2><refsect2> + <varlistentry> + <term><option>--linux=<replaceable>PATH</replaceable></option></term> + + <listitem> + <para>Set the linux kernel image to use for direct kernel boot. + If a directory type image is used and <option>--linux=</option> was omitted, vmspawn will search for boot loader entries + according to the + <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> assuming + XBOOTLDR to be located at /boot and ESP to be /efi respectively. + If no kernel was installed into the image then the image will fail to boot.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--initrd=<replaceable>PATH</replaceable></option></term> + + <listitem> + <para>Set the initrd to use for direct kernel boot. + If the <option>--linux=</option> supplied is a + <ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink> + Type #2 entry, then this argument is not required. + If no initrd was installed into the image then the image will fail to boot.</para> + + <para><option>--initrd=</option> can be specified multiple times and vmspawn will merge them together.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-n</option></term> + <term><option>--network-tap</option></term> + + <listitem> + <para>Create a TAP device to network with the virtual machine.</para> + + <para>Note: root privileges are required to use TAP networking. + Additionally, + <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry> + must be running and correctly set up on the host to provision the host interface. The relevant + <literal>.network</literal> file can be found at + <filename>/usr/lib/systemd/network/80-vm-vt.network</filename>. + </para> + + <xi:include href="version-info.xml" xpointer="v255"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--network-user-mode</option></term> + + <listitem><para>Use user mode networking.</para> + + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--firmware=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Takes an absolute path, or a relative path beginning with + <filename>./</filename>. Specifies a JSON firmware definition file, which allows selecting the + firmware to boot in the VM. If not specified a suitable firmware is automatically discovered. If the + special string <literal>list</literal> is specified lists all discovered firmwares.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--discard-disk=<replaceable>BOOL</replaceable></option></term> + + <listitem><para>Controls whether qemu processes discard requests from the VM. + This prevents long running VMs from using more disk space than required. + This is enabled by default.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--secure-boot=<replaceable>BOOL</replaceable></option></term> + + <listitem><para>Configure whether to search for firmware which supports Secure Boot.</para> + + <para>If the option is not specified the first firmware which is detected will be used. + If the option is set to yes then the first firmware with Secure Boot support will be selected. + If no is specified then the first firmware without Secure Boot will be selected.</para> + + <xi:include href="version-info.xml" xpointer="v255"/></listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2> <title>System Identity Options</title> <variablelist> @@ -145,25 +276,203 @@ <term><option>-M</option></term> <term><option>--machine=</option></term> - <listitem><para>Sets the machine name for this container. This - name may be used to identify this container during its runtime + <listitem><para>Sets the machine name for this virtual machine. This + name may be used to identify this virtual machine during its runtime (for example in tools like <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> and similar).</para> + <xi:include href="version-info.xml" xpointer="v255"/> </listitem> </varlistentry> + + <varlistentry> + <term><option>--uuid=</option></term> + + <listitem><para>Set the specified UUID for the virtual machine. The + init system will initialize + <filename>/etc/machine-id</filename> from this if this file is + not set yet. Note that this option takes effect only if + <filename>/etc/machine-id</filename> in the virtual machine is + unpopulated.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> </variablelist> + </refsect2> - </refsect2><refsect2> + <refsect2> + <title>Property Options</title> + + <variablelist> + <varlistentry> + <term><option>--register=</option></term> + + <listitem><para>Controls whether the virtual machine is registered with + <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Takes a + boolean argument, which defaults to <literal>yes</literal> when running as root, and <literal>no</literal> when + running as a regular user. This ensures that the virtual machine is accessible via + <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <para>Note: root privileges are required to use this option as registering with + <citerefentry><refentrytitle>systemd-machined</refentrytitle><manvolnum>8</manvolnum></citerefentry> + requires privileged D-Bus method calls.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2> + <title>User Namespacing Options</title> + + <variablelist> + <varlistentry> + <term><option>--private-users=<replaceable>UID_SHIFT[:UID_RANGE]</replaceable></option></term> + + <listitem><para>Controls user namespacing under <option>--directory=</option>. + If enabled, + <citerefentry><refentrytitle>virtiofsd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + is instructed to map user and group ids (UIDs and GIDs). + This involves mapping the private UIDs/GIDs used in the virtual machine (starting with the virtual machine's + root user 0 and up) to a range of UIDs/GIDs on the host that are not used for other purposes (usually in the + range beyond the host's UID/GID 65536).</para> + + <para>If one or two colon-separated numbers are specified, user namespacing is turned on. <replaceable>UID_SHIFT</replaceable> + specifies the first host UID/GID to map, <replaceable>UID_RANGE</replaceable> is optional and specifies number of host + UIDs/GIDs to assign to the virtual machine. If <replaceable>UID_RANGE</replaceable> is omitted, 65536 UIDs/GIDs are assigned.</para> + + <para>When user namespaces are used, the GID range assigned to each virtual machine is always chosen identical to the + UID range.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2> + <title>Mount Options</title> + + <variablelist> + + <varlistentry> + <term><option>--bind=<replaceable>PATH</replaceable></option></term> + <term><option>--bind-ro=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Mount a directory from the host into the virtual machine. Takes one of: a path + argument — in which case the specified path will be mounted from the host to the same path in the virtual machine, or + a colon-separated pair of paths — in which case the first specified path is the source in the host, and the + second path is the destination in the virtual machine. If the source path is not absolute, it is resolved + relative to the current working directory. The <option>--bind-ro=</option> option creates read-only bind mounts. + Backslash escapes are interpreted, so <literal>\:</literal> may be used to embed colons in either path. + This option may be specified multiple times for creating multiple independent bind mount points.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--extra-drive=<replaceable>PATH</replaceable></option></term> + + <listitem><para>Takes a disk image or block device on the host and supplies it to the virtual machine as another drive.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + </variablelist> + </refsect2> + + <refsect2> + <title>Integration Options</title> + + <variablelist> + <varlistentry> + <term><option>--forward-journal=<replaceable>FILE|DIR</replaceable></option></term> + + <listitem><para>Forward the virtual machine's journal to the host. + <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry> + is currently used to receive the guest VM's forwarded journal entries. This option determines where + this journal is saved on the host and has the same semantics as + <option>-o</option>/<option>--output</option> described in + <citerefentry><refentrytitle>systemd-journal-remote</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--pass-ssh-key=<replaceable>BOOL</replaceable></option></term> + + <listitem><para>By default an SSH key is generated to allow <command>systemd-vmspawn</command> to open + a D-Bus connection to the VM's systemd bus. Setting this to "no" will disable SSH key generation.</para> + + <para>The generated keys are ephemeral. That is they are valid only for the current invocation of <command>systemd-vmspawn</command>, + and are typically not persisted.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--ssh-key-type=<replaceable>TYPE</replaceable></option></term> + + <listitem><para>Configures the type of SSH key to generate, see + <citerefentry project="man-pages"><refentrytitle>ssh-keygen</refentrytitle><manvolnum>1</manvolnum></citerefentry> + for more information.</para> + + <para>By default <literal>ed25519</literal> keys are generated, however <literal>rsa</literal> keys + may also be useful if the VM has a particularly old version of <command>sshd</command>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2> + <title>Input/Output Options</title> + + <variablelist> + <varlistentry> + <term><option>--console=<replaceable>MODE</replaceable></option></term> + + <listitem><para>Configures how to set up the console of the VM. Takes one of + <literal>interactive</literal>, <literal>read-only</literal>, <literal>native</literal>, + <literal>gui</literal>. Defaults to <literal>interactive</literal>. <literal>interactive</literal> + provides an interactive terminal interface to the VM. <literal>read-only</literal> is similar, but + is strictly read-only, i.e. does not accept any input from the user. <literal>native</literal> also + provides a TTY-based interface, but uses qemu native implementation (which means the qemu monitor + is available). <literal>gui</literal> shows the qemu graphical UI.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--background=<replaceable>COLOR</replaceable></option></term> + + <listitem><para>Change the terminal background color to the specified ANSI color as long as the VM + runs. The color specified should be an ANSI X3.64 SGR background color, i.e. strings such as + <literal>40</literal>, <literal>41</literal>, …, <literal>47</literal>, <literal>48;2;…</literal>, + <literal>48;5;…</literal>. See <ulink + url="https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters">ANSI + Escape Code (Wikipedia)</ulink> for details. Assign an empty string to disable any coloring. This + only has an effect in <option>--console=interactive</option> and + <option>--console=read-only</option> modes.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> + </refsect2> + + <refsect2> <title>Credentials</title> <variablelist> <varlistentry> - <term><option>--load-credential=</option><replaceable>ID</replaceable>:<replaceable>PATH</replaceable></term> - <term><option>--set-credential=</option><replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></term> + <term><option>--load-credential=<replaceable>ID</replaceable>:<replaceable>PATH</replaceable></option></term> + <term><option>--set-credential=<replaceable>ID</replaceable>:<replaceable>VALUE</replaceable></option></term> - <listitem><para>Pass a credential to the container. These two options correspond to the + <listitem><para>Pass a credential to the virtual machine. These two options correspond to the <varname>LoadCredential=</varname> and <varname>SetCredential=</varname> settings in unit files. See <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details about these concepts, as well as the syntax of the option's arguments.</para> @@ -201,6 +510,53 @@ $ mkosi -d arch -p systemd -p linux --autologin -o image.raw -f build $ systemd-vmspawn --image=image.raw </programlisting> </example> + + <example> + <title>Import and run a Fedora 39 Cloud image using machinectl</title> + + <programlisting> +$ curl -L \ + -O https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz \ + -O https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-&fedora_latest_version;-&fedora_cloud_release;-x86_64-CHECKSUM \ + -O https://fedoraproject.org/fedora.gpg +$ gpgv --keyring ./fedora.gpg Fedora-Cloud-&fedora_latest_version;-&fedora_cloud_release;-x86_64-CHECKSUM +$ sha256sum -c Fedora-Cloud-&fedora_latest_version;-&fedora_cloud_release;-x86_64-CHECKSUM +# machinectl import-raw Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz fedora-&fedora_latest_version;-cloud +# systemd-vmspawn -M fedora-&fedora_latest_version;-cloud + </programlisting> + </example> + + <example> + <title>Build and run systemd's system image and forward the VM's journal to a local file</title> + + <programlisting> +$ mkosi build +$ systemd-vmspawn \ + -D mkosi.output/system \ + --private-users $(grep $(whoami) /etc/subuid | cut -d: -f2) \ + --linux mkosi.output/system.efi \ + --forward-journal=vm.journal \ + enforcing=0 + </programlisting> + + <para>Note: this example also uses a kernel command line argument to ensure SELinux isn't started in enforcing mode.</para> + </example> + + <example> + <title>SSH into a running VM using <command>systemd-ssh-proxy</command></title> + + <programlisting> +$ mkosi build +$ my_vsock_cid=3735928559 +$ systemd-vmspawn \ + -D mkosi.output/system \ + --private-users $(grep $(whoami) /etc/subuid | cut -d: -f2) \ + --linux mkosi.output/system.efi \ + --vsock-cid $my_vsock_cid \ + enforcing=0 +$ ssh root@vsock/$my_vsock_cid -i /run/user/$UID/systemd/vmspawn/machine-*-system-ed25519 + </programlisting> + </example> </refsect1> <refsect1> @@ -213,9 +569,12 @@ $ systemd-vmspawn --image=image.raw <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='debian'><refentrytitle>mkosi</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://uapi-group.org/specifications/specs/boot_loader_specification">Boot Loader Specification</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-volatile-root.service.xml b/man/systemd-volatile-root.service.xml index 0d3b402..b1a9f6e 100644 --- a/man/systemd-volatile-root.service.xml +++ b/man/systemd-volatile-root.service.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-volatile-root.service"> @@ -45,11 +45,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-vpick.xml b/man/systemd-vpick.xml new file mode 100644 index 0000000..95f946a --- /dev/null +++ b/man/systemd-vpick.xml @@ -0,0 +1,198 @@ +<?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="systemd-vpick" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>systemd-vpick</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd-vpick</refentrytitle> + <manvolnum>1</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd-vpick</refname> + <refpurpose>Resolve paths to <literal>.v/</literal> versioned directories</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>systemd-vpick <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="opt" rep="repeat">PATH</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><command>systemd-vpick</command> resolves a file system path referencing a <literal>.v/</literal> + versioned directory to a path to the newest (by version) file contained therein. This tool provides a + command line interface for the + <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry> + logic.</para> + + <para>The tool expects a path to a <literal>.v/</literal> directory as argument (either directly, or with + a triple underscore pattern as final component). It then determines the newest file contained in that + directory, and writes its path to standard output.</para> + + <para>Unless the triple underscore pattern is passed as last component of the path, it is typically + necessary to at least specify the <option>--suffix=</option> switch to configure the file suffix to look + for.</para> + + <para>If the specified path does not reference a <literal>.v/</literal> path (i.e. neither the final + component ends in <literal>.v</literal>, nor the penultimate does or the final one does contain a triple + underscore) it specified path is written unmodified to standard output.</para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>--basename=</option></term> + <term><option>-B</option></term> + + <listitem><para>Overrides the "basename" of the files to look for, i.e. the part to the left of the + variable part of the filenames. Normally this is derived automatically from the filename of the + <literal>.v</literal> component of the specified path, or from the triple underscore pattern in the + last component of the specified path.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>-V</option></term> + + <listitem><para>Explicitly configures the version to select. If specified, a filename with the + specified version string will be looked for, instead of the newest version + available.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>-A</option></term> + + <listitem><para>Explicitly configures the architecture to select. If specified, a filename with the + specified architecture identifier will be looked for. If not specified only filenames with a locally + supported architecture are considered, or those without any architecture identifier.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--suffix=</option></term> + <term><option>-S</option></term> + + <listitem><para>Configures the suffix of the filenames to consider. For the <literal>.v/</literal> + logic it is necessary to specify the suffix to look for, and the <literal>.v/</literal> component + must also carry the suffix immediately before <literal>.v</literal> in its name.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--type=</option></term> + <term><option>-t</option></term> + + <listitem><para>Configures the inode type to look for in the <literal>.v/</literal> directory. Takes + one of <literal>reg</literal>, <literal>dir</literal>, <literal>sock</literal>, + <literal>fifo</literal>, <literal>blk</literal>, <literal>chr</literal>, <literal>lnk</literal> as + argument, each identifying an inode type. See <citerefentry + project='man-pages'><refentrytitle>inode</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details about inode types. If this option is used inodes not matching the specified type are filtered + and not taken into consideration.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--print=</option></term> + <term><option>-p</option></term> + + <listitem><para>Configures what precisely to write to standard output. If not specified prints the + full, resolved path of the newest matching file in the <literal>.v/</literal> directory. This switch can be set to one of the following:</para> + + <itemizedlist> + <listitem><para>If set to <literal>filename</literal>, will print only the filename instead of the full path of the resolved file.</para></listitem> + <listitem><para>If set to <literal>version</literal>, will print only the version of the resolved file.</para></listitem> + <listitem><para>If set to <literal>type</literal>, will print only the inode type of the resolved + file (i.e. a string such as <literal>reg</literal> for regular files, or <literal>dir</literal> for + directories).</para></listitem> + <listitem><para>If set to <literal>arch</literal>, will print only the architecture of the resolved + file.</para></listitem> + <listitem><para>If set to <literal>tries</literal>, will print only the tries left/tries done of the + resolved file.</para></listitem> + <listitem><para>If set to <literal>all</literal>, will print all of the above in a simple tabular + output.</para></listitem> + </itemizedlist> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><option>--resolve=</option></term> + + <listitem><para>Takes a boolean argument. If true the path to the versioned file is fully + canonicalized (i.e. symlinks resolved, and redundant path components removed) before it is shown. If + false (the default) this is not done, and the path is shown without canonicalization.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <xi:include href="standard-options.xml" xpointer="help" /> + <xi:include href="standard-options.xml" xpointer="version" /> + </variablelist> + </refsect1> + + <refsect1> + <title>Examples</title> + + <para>Use a command like the following to automatically pick the newest raw disk image from a + <literal>.v/</literal> directory:</para> + + <programlisting>$ systemd-vpick --suffix=.raw --type=reg /var/lib/machines/quux.raw.v/</programlisting> + + <para>This will enumerate all regular files matching + <filename>/var/lib/machines/quux.raw.v/quux*.raw</filename>, filter and sort them according to the rules + described in + <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry>, and then + write the path to the newest (by version) file to standard output.</para> + + <para>Use a command like the following to automatically pick the newest OS directory tree from a + <literal>.v/</literal> directory:</para> + + <programlisting>$ systemd-vpick --type=dir /var/lib/machines/waldo.v/</programlisting> + + <para>This will enumerate all directory inodes matching + <filename>/var/lib/machines/waldo.v/waldo*</filename>, filter and sort them according to the rules + described in + <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry>, and then + write the path to the newest (by version) directory to standard output.</para> + + <para>For further examples see + <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>Exit status</title> + + <para>On success, 0 is returned, a non-zero failure code + otherwise.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> diff --git a/man/systemd-xdg-autostart-generator.xml b/man/systemd-xdg-autostart-generator.xml index bafe6e9..7faaba2 100644 --- a/man/systemd-xdg-autostart-generator.xml +++ b/man/systemd-xdg-autostart-generator.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd-xdg-autostart-generator" conditional="ENABLE_XDG_AUTOSTART"> @@ -96,11 +96,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.automount.xml b/man/systemd.automount.xml index 0bbd4e8..20ae3c7 100644 --- a/man/systemd.automount.xml +++ b/man/systemd.automount.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.automount" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -180,15 +180,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>automount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.device.xml b/man/systemd.device.xml index 529552e..9e53a46 100644 --- a/man/systemd.device.xml +++ b/man/systemd.device.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.device"> @@ -159,13 +159,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.dnssd.xml b/man/systemd.dnssd.xml index 5bf9375..a2641e8 100644 --- a/man/systemd.dnssd.xml +++ b/man/systemd.dnssd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.dnssd" @@ -119,6 +119,16 @@ </listitem> </varlistentry> <varlistentry> + <term><varname>SubType=</varname></term> + <listitem> + <para>A subtype of the network service as defined in the section 7.1 of <ulink + url="https://tools.ietf.org/html/rfc6763">RFC 6763</ulink>, e.g. <literal>_printer</literal>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> <term><varname>Port=</varname></term> <listitem> <para>An IP port number of the network service.</para> @@ -231,11 +241,11 @@ meteo._http._tcp.local: meteo.local:80 [priority=0, weight=0] <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>resolvectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.environment-generator.xml b/man/systemd.environment-generator.xml index 856f6a6..98acbcb 100644 --- a/man/systemd.environment-generator.xml +++ b/man/systemd.environment-generator.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -31,19 +31,19 @@ <command>&USER_ENV_GENERATOR_DIR;/some-generator</command> </cmdsynopsis> - <para> - <literallayout><filename>/run/systemd/system-environment-generators/*</filename> -<filename>/etc/systemd/system-environment-generators/*</filename> -<filename>/usr/local/lib/systemd/system-environment-generators/*</filename> -<filename>&SYSTEM_ENV_GENERATOR_DIR;/*</filename></literallayout> - </para> - - <para> - <literallayout><filename>/run/systemd/user-environment-generators/*</filename> -<filename>/etc/systemd/user-environment-generators/*</filename> -<filename>/usr/local/lib/systemd/user-environment-generators/*</filename> -<filename>&USER_ENV_GENERATOR_DIR;/*</filename></literallayout> - </para> + <para><simplelist> + <member><filename>/run/systemd/system-environment-generators/*</filename></member> + <member><filename>/etc/systemd/system-environment-generators/*</filename></member> + <member><filename>/usr/local/lib/systemd/system-environment-generators/*</filename></member> + <member><filename>&SYSTEM_ENV_GENERATOR_DIR;/*</filename></member> + </simplelist></para> + + <para><simplelist> + <member><filename>/run/systemd/user-environment-generators/*</filename></member> + <member><filename>/etc/systemd/user-environment-generators/*</filename></member> + <member><filename>/usr/local/lib/systemd/user-environment-generators/*</filename></member> + <member><filename>&USER_ENV_GENERATOR_DIR;/*</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -61,11 +61,12 @@ above. System and user environment generators are loaded from directories with names ending in <filename>system-environment-generators/</filename> and <filename>user-environment-generators/</filename>, respectively. Generators found in directories - listed earlier override the ones with the same name in directories lower in the list. A symlink - to <filename>/dev/null</filename> or an empty file can be used to mask a generator, thereby - preventing it from running. Please note that the order of the two directories with the highest - priority is reversed with respect to the unit load path, and generators in - <filename>/run/</filename> overwrite those in <filename>/etc/</filename>.</para> + listed earlier override the ones with the same name in directories lower in the list + <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />. + A symlink to <filename>/dev/null</filename> or an empty file can be used to mask a generator, + thereby preventing it from running. Please note that the order of the two directories with the highest + priority is reversed with respect to the unit load path, and generators in <filename>/run/</filename> + overwrite those in <filename>/etc/</filename>.</para> <para>After installing new generators or updating the configuration, <command>systemctl daemon-reload</command> may be executed. This will re-run all generators, updating environment @@ -122,13 +123,13 @@ </refsect1> <refsect1> - <title>See also</title> - - <para> - <citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <title>See Also</title> + + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-environment-d-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 1e95a94..56eb6af 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.exec" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -125,9 +125,10 @@ <listitem><para>Takes a directory path relative to the host's root directory (i.e. the root of the system running the service manager). Sets the root directory for executed processes, with the <citerefentry - project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system - call. If this is used, it must be ensured that the process binary and all its auxiliary files are available in - the <function>chroot()</function> jail. Note that setting this parameter might result in additional + project='man-pages'><refentrytitle>pivot_root</refentrytitle><manvolnum>2</manvolnum></citerefentry> + or <citerefentry project='man-pages'><refentrytitle>chroot</refentrytitle><manvolnum>2</manvolnum></citerefentry> + system call. If this is used, it must be ensured that the process binary and all its auxiliary files + are available in the new root. Note that setting this parameter might result in additional dependencies to be added to the unit (see above).</para> <para>The <varname>MountAPIVFS=</varname> and <varname>PrivateUsers=</varname> settings are particularly useful @@ -155,6 +156,8 @@ <programlisting>BindReadOnlyPaths=/dev/log /run/systemd/journal/socket /run/systemd/journal/stdout</programlisting> </example> + <xi:include href="vpick.xml" xpointer="directory"/> + <xi:include href="system-or-user-ns.xml" xpointer="singular"/></listitem> </varlistentry> @@ -191,6 +194,8 @@ <citerefentry><refentrytitle>systemd-soft-reboot.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>), in case the service is configured to survive it.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="system-only.xml" xpointer="singular"/> <xi:include href="version-info.xml" xpointer="v233"/></listitem> @@ -439,6 +444,9 @@ that in this case both read-only and regular bind mounts are reset, regardless which of the two settings is used.</para> + <para>Using this option implies that a mount namespace is allocated for the unit, i.e. it implies the + effect of <varname>PrivateMounts=</varname> (see below).</para> + <para>This option is particularly useful when <varname>RootDirectory=</varname>/<varname>RootImage=</varname> is used. In this case the source path refers to a path on the host file system, while the destination path refers to a path below the root directory of the unit.</para> @@ -547,6 +555,8 @@ <varname>PrivateDevices=</varname> below, as it may change the setting of <varname>DevicePolicy=</varname>.</para> + <xi:include href="vpick.xml" xpointer="image"/> + <xi:include href="system-only.xml" xpointer="singular"/> <xi:include href="version-info.xml" xpointer="v248"/></listitem> @@ -582,6 +592,8 @@ <para>Note that usage from user units requires overlayfs support in unprivileged user namespaces, which was first introduced in kernel v5.11.</para> + <xi:include href="vpick.xml" xpointer="directory"/> + <xi:include href="system-or-user-ns.xml" xpointer="singular"/> <xi:include href="version-info.xml" xpointer="v251"/></listitem> @@ -703,12 +715,15 @@ <varlistentry> <term><varname>SetLoginEnvironment=</varname></term> - <listitem><para>Takes a boolean parameter that controls whether to set <varname>$HOME</varname>, - <varname>$LOGNAME</varname>, and <varname>$SHELL</varname> environment variables. If unset, this is - controlled by whether <varname>User=</varname> is set. If true, they will always be set for system services, - i.e. even when the default user <literal>root</literal> is used. If false, the mentioned variables are not set - by systemd, no matter whether <varname>User=</varname> is used or not. This option normally has no effect - on user services, since these variables are typically inherited from user manager's own environment anyway.</para> + <listitem><para>Takes a boolean parameter that controls whether to set the <varname>$HOME</varname>, + <varname>$LOGNAME</varname>, and <varname>$SHELL</varname> environment variables. If not set, this + defaults to true if <varname>User=</varname>, <varname>DynamicUser=</varname> or + <varname>PAMName=</varname> are set, false otherwise. If set to true, the variables will always be + set for system services, i.e. even when the default user <literal>root</literal> is used. If set to + false, the mentioned variables are not set by the service manager, no matter whether + <varname>User=</varname>, <varname>DynamicUser=</varname>, or <varname>PAMName=</varname> are used or + not. This option normally has no effect on services of the per-user service manager, since in that + case these variables are typically inherited from user manager's own environment anyway.</para> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> @@ -1372,7 +1387,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> <para>Note that the various options that turn directories read-only (such as <varname>ProtectSystem=</varname>, <varname>ReadOnlyPaths=</varname>, …) do not affect the ability for programs to connect to and communicate with <constant>AF_UNIX</constant> sockets in these - directores. These options cannot be used to lock down access to IPC services hence.</para> + directories. These options cannot be used to lock down access to IPC services hence.</para> <variablelist class='unit-directives'> @@ -2365,12 +2380,13 @@ RestrictNamespaces=~cgroup net</programlisting> units, it only enables sharing of the <filename>/tmp/</filename> and <filename>/var/tmp/</filename> directories.</para> - <para>Other file system namespace unit settings — <varname>PrivateMounts=</varname>, - <varname>PrivateTmp=</varname>, <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, - <varname>ProtectHome=</varname>, <varname>ReadOnlyPaths=</varname>, <varname>InaccessiblePaths=</varname>, - <varname>ReadWritePaths=</varname>, … — also enable file system namespacing in a fashion equivalent to this - option. Hence it is primarily useful to explicitly request this behaviour if none of the other settings are - used.</para> + <para>Other file system namespace unit settings — <varname>PrivateTmp=</varname>, + <varname>PrivateDevices=</varname>, <varname>ProtectSystem=</varname>, + <varname>ProtectHome=</varname>, <varname>ReadOnlyPaths=</varname>, + <varname>InaccessiblePaths=</varname>, <varname>ReadWritePaths=</varname>, + <varname>BindPaths=</varname>, <varname>BindReadOnlyPaths=</varname>, … — also enable file system + namespacing in a fashion equivalent to this option. Hence it is primarily useful to explicitly + request this behaviour if none of the other settings are used.</para> <xi:include href="system-or-user-ns.xml" xpointer="singular"/> @@ -2968,8 +2984,8 @@ SystemCallErrorNumber=EPERM</programlisting> <para>The <option>file:<replaceable>path</replaceable></option> option may be used to connect a specific file system object to standard output. The semantics are similar to the same option of <varname>StandardInput=</varname>, see above. If <replaceable>path</replaceable> refers to a regular file - on the filesystem, it is opened (created if it doesn't exist yet) for writing at the beginning of the file, - but without truncating it. + on the filesystem, it is opened (created if it doesn't exist yet using privileges of the user executing the + systemd process) for writing at the beginning of the file, but without truncating it. If standard input and output are directed to the same file path, it is opened only once — for reading as well as writing — and duplicated. This is particularly useful when the specified path refers to an <constant>AF_UNIX</constant> socket in the file system, as in that case only a @@ -3013,7 +3029,7 @@ SystemCallErrorNumber=EPERM</programlisting> the kernel log buffer, the unit will implicitly gain a dependency of type <varname>After=</varname> on <filename>systemd-journald.socket</filename> (also see the "Implicit Dependencies" section above). Also note that in this case stdout (or stderr, see below) will be an - <constant>AF_UNIX</constant> stream socket, and not a pipe or FIFO that can be re-opened. This means + <constant>AF_UNIX</constant> stream socket, and not a pipe or FIFO that can be reopened. This means when executing shell scripts the construct <command>echo "hello" > /dev/stderr</command> for writing text to stderr will not work. To mitigate this use the construct <command>echo "hello" >&2</command> instead, which is mostly equivalent and avoids this pitfall.</para> @@ -3174,8 +3190,8 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX <literal>\x7efoobar</literal> would add a pattern matching <literal>~foobar</literal> to the allow list.</para> <para>Log messages are tested against denied patterns (if any), then against allowed patterns - (if any). If a log message matches any of the denied patterns, it will be discarded, whatever the - allowed patterns. Then, remaining log messages are tested against allowed patterns. Messages matching + (if any). If a log message matches any of the denied patterns, it is discarded immediately without considering + allowed patterns. Remaining log messages are tested against allowed patterns. Messages matching against none of the allowed pattern are discarded. If no allowed patterns are defined, then all messages are processed directly after going through denied filters.</para> @@ -3369,6 +3385,9 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX a terse way to declare credentials to inherit from the service manager into a service. This option may be used multiple times, each time defining an additional credential to pass to the unit.</para> + <para>Note that if the path is not specified or a valid credential identifier is given, i.e. + in the above two cases, a missing credential is not considered fatal.</para> + <para>If an absolute path referring to a directory is specified, every file in that directory (recursively) will be loaded as a separate credential. The ID for each credential will be the provided ID suffixed with <literal>_$FILENAME</literal> (e.g., <literal>Key_file1</literal>). When @@ -3398,6 +3417,12 @@ StandardInputData=V2XigLJyZSBubyBzdHJhbmdlcnMgdG8gbG92ZQpZb3Uga25vdyB0aGUgcnVsZX <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the details about <varname>DevicePolicy=</varname> or <varname>DeviceAllow=</varname>.</para> + <para>Note that encrypted credentials targeted for services of the per-user service manager must be + encrypted with <command>systemd-creds encrypt --user</command>, and those for the system service + manager without the <option>--user</option> switch. Encrypted credentials are always targeted to a + specific user or the system as a whole, and it is ensured that per-user service managers cannot + decrypt secrets intended for the system or for other users.</para> + <para>The credential files/IPC sockets must be accessible to the service manager, but don't have to be directly accessible to the unit's processes: the credential data is read and copied into separate, read-only copies for the unit that are accessible to appropriately privileged processes. This is @@ -4623,25 +4648,25 @@ MONITOR_UNIT=mysuccess.service <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>tmpfiles.d</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>exec</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.generator.xml b/man/systemd.generator.xml index b216ef9..ae4c2c5 100644 --- a/man/systemd.generator.xml +++ b/man/systemd.generator.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -26,23 +26,23 @@ <cmdsynopsis> <command index='false'>/path/to/generator</command> <arg choice="plain"><replaceable>normal-dir</replaceable></arg> - <arg choice="option"><replaceable>early-dir</replaceable></arg> - <arg choice="option"><replaceable>late-dir</replaceable></arg> + <arg choice="opt"><replaceable>early-dir</replaceable></arg> + <arg choice="opt"><replaceable>late-dir</replaceable></arg> </cmdsynopsis> - <para> - <literallayout><filename>/run/systemd/system-generators/*</filename> -<filename>/etc/systemd/system-generators/*</filename> -<filename>/usr/local/lib/systemd/system-generators/*</filename> -<filename>&SYSTEM_GENERATOR_DIR;/*</filename></literallayout> - </para> - - <para> - <literallayout><filename>/run/systemd/user-generators/*</filename> -<filename>/etc/systemd/user-generators/*</filename> -<filename>/usr/local/lib/systemd/user-generators/*</filename> -<filename>&USER_GENERATOR_DIR;/*</filename></literallayout> - </para> + <para><simplelist> + <member><filename>/run/systemd/system-generators/*</filename></member> + <member><filename>/etc/systemd/system-generators/*</filename></member> + <member><filename>/usr/local/lib/systemd/system-generators/*</filename></member> + <member><filename>&SYSTEM_GENERATOR_DIR;/*</filename></member> + </simplelist></para> + + <para><simplelist> + <member><filename>/run/systemd/user-generators/*</filename></member> + <member><filename>/etc/systemd/user-generators/*</filename></member> + <member><filename>/usr/local/lib/systemd/user-generators/*</filename></member> + <member><filename>&USER_GENERATOR_DIR;/*</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -77,10 +77,11 @@ and user generators are loaded from directories with names ending in <filename>system-generators/</filename> and <filename>user-generators/</filename>, respectively. Generators found in directories listed earlier override the ones with the same name in - directories lower in the list. A symlink to <filename>/dev/null</filename> or an empty file can be used - to mask a generator, thereby preventing it from running. Please note that the order of the two - directories with the highest priority is reversed with respect to the unit load path, and generators in - <filename>/run/</filename> overwrite those in <filename>/etc/</filename>.</para> + directories lower in the list <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />. + A symlink to <filename>/dev/null</filename> or an empty file can be used to mask a generator, thereby + preventing it from running. Please note that the order of the two directories with the highest priority + is reversed with respect to the unit load path, and generators in <filename>/run/</filename> overwrite + those in <filename>/etc/</filename>.</para> <para>After installing new generators or updating the configuration, <command>systemctl daemon-reload</command> may be executed. This will delete the previous configuration created by @@ -380,24 +381,24 @@ find $dir</programlisting> </refsect1> <refsect1> - <title>See also</title> - - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-getty-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-rc-local-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysv-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-xdg-autostart-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <title>See Also</title> + + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-cryptsetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-getty-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hibernate-resume-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-rc-local-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysv-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-xdg-autostart-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.environment-generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.image-policy.xml b/man/systemd.image-policy.xml index 7a4453d..f26aeb5 100644 --- a/man/systemd.image-policy.xml +++ b/man/systemd.image-policy.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.image-policy"> @@ -179,13 +179,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-gpt-auto-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysext</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.journal-fields.xml b/man/systemd.journal-fields.xml index 365f61e..7beee9d 100644 --- a/man/systemd.journal-fields.xml +++ b/man/systemd.journal-fields.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.journal-fields" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -546,8 +546,7 @@ <varlistentry> <term><varname>OBJECT_PID=<replaceable>PID</replaceable></varname></term> <listitem> - <para>PID of the program that this message pertains to. - </para> + <para>PID of the program that this message pertains to.</para> <xi:include href="version-info.xml" xpointer="v205"/> </listitem> @@ -567,9 +566,8 @@ <term><varname>OBJECT_SYSTEMD_UNIT=</varname></term> <term><varname>OBJECT_SYSTEMD_USER_UNIT=</varname></term> <listitem> - <para>These are additional fields added automatically by - <command>systemd-journald</command>. Their meaning is the - same as + <para>These are additional fields added automatically by <command>systemd-journald</command>. + Their meaning is the same as <varname>_UID=</varname>, <varname>_GID=</varname>, <varname>_COMM=</varname>, @@ -589,6 +587,17 @@ <xi:include href="version-info.xml" xpointer="v205"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>OBJECT_SYSTEMD_INVOCATION_ID=</varname></term> + <listitem> + <para>An additional field added automatically by <command>systemd-journald</command>. The meaning + is mostly the same as <varname>_SYSTEMD_INVOCATION_ID=</varname>, with the difference described + above.</para> + + <xi:include href="version-info.xml" xpointer="v235"/> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -665,15 +674,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>coredumpctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml index e5441bb..f0279b4 100644 --- a/man/systemd.kill.xml +++ b/man/systemd.kill.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.kill" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -190,20 +190,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kill</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>signal</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.link.xml b/man/systemd.link.xml index 063f8e3..3991d91 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.link" @@ -35,7 +35,9 @@ <para>The <filename>.link</filename> files are read from the files located in the system network directory <filename>/usr/lib/systemd/network</filename> and - <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory + <filename>/usr/local/lib/systemd/network</filename> + <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />, + the volatile runtime network directory <filename>/run/systemd/network</filename>, and the local administration network directory <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and processed in alphanumeric order, regardless of the directories in which they live. However, files @@ -361,7 +363,60 @@ <listitem> <para>A description of the device.</para> - <xi:include href="version-info.xml" xpointer="v211"/> + <xi:include href="version-info.xml" xpointer="v211"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Property=</varname></term> + <listitem> + <para>Set specified udev properties. This takes space separated list of key-value pairs + concatenated with equal sign (<literal>=</literal>). Example: + <programlisting>Property=HOGE=foo BAR=baz</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + + <para>This setting is useful to configure the <literal>ID_NET_MANAGED_BY=</literal> property which + declares which network management service shall manage the interface, which is respected by + systemd-networkd and others. Use + <programlisting>Property=ID_NET_MANAGED_BY=io.systemd.Network</programlisting> + to declare explicitly that <command>systemd-networkd</command> shall manage the interface, or set + the property to something else to declare explicitly it shall not do so. See + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for details how this property is used to match interface names.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ImportProperty=</varname></term> + <listitem> + <para>Import specified udev properties from the saved database. This takes space separated list of + property names. Example: <programlisting>ImportProperty=HOGE BAR</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + <para>If the same property is also set in <varname>Property=</varname> in the above, then the + imported property value will be overridden by the value specified in <varname>Property=</varname>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UnsetProperty=</varname></term> + <listitem> + <para>Unset specified udev properties. This takes space separated list of + property names. Example: <programlisting>ImportProperty=HOGE BAR</programlisting> + This option supports simple specifier expansion, see the Specifiers section below. + This option can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + <para>This setting is applied after <varname>ImportProperty=</varname> and + <varname>Property=</varname> are applied. Hence, if the same property is specified in + <varname>ImportProperty=</varname> or <varname>Property=</varname>, then the imported or specified + property value will be ignored, and the property will be unset.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> <varlistentry> @@ -369,7 +424,7 @@ <listitem> <para>The <varname>ifalias</varname> interface property is set to this value.</para> - <xi:include href="version-info.xml" xpointer="v211"/> + <xi:include href="version-info.xml" xpointer="v211"/> </listitem> </varlistentry> <varlistentry> @@ -552,7 +607,7 @@ an allowed character, it's recommended to avoid it when naming interfaces as various tools (such as <citerefentry><refentrytitle>resolvconf</refentrytitle><manvolnum>1</manvolnum></citerefentry>) use it as separator character. Also, fully numeric interface names are not allowed (in order to avoid - ambiguity with interface specification by numeric indexes), as are the special strings + ambiguity with interface specification by numeric indexes), nor are the special strings <literal>.</literal>, <literal>..</literal>, <literal>all</literal> and <literal>default</literal>.</para> @@ -915,6 +970,21 @@ </listitem> </varlistentry> <varlistentry> + <term><varname>ReceivePacketSteeringCPUMask=</varname></term> + <listitem> + <para>Configures Receive Packet Steering (RPS) list of CPUs to which RPS may forward traffic. + Takes a list of CPU indices or ranges separated by either whitespace or commas. Alternatively, + takes the special value <literal>all</literal> in which will include all available CPUs in the mask. + CPU ranges are specified by the lower and upper CPU indices separated by a dash (e.g. <literal>2-6</literal>). + This option may be specified more than once, in which case the specified CPU affinity masks are merged. + If an empty string is assigned, the mask is reset, all assignments prior to this will have no effect. + Defaults to unset and RPS CPU list is unchanged. To disable RPS when it was previously enabled, use the + special value <literal>disable</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> <term><varname>ReceiveVLANCTAGHardwareAcceleration=</varname></term> <listitem> <para>Takes a boolean. If set to true, receive VLAN CTAG hardware acceleration is enabled. @@ -1261,6 +1331,47 @@ </refsect1> <refsect1> + <title>Specifiers</title> + + <para>Some settings resolve specifiers which may be used to write generic unit files referring to runtime + or unit parameters that are replaced when the unit files are loaded. Specifiers must be known and + resolvable for the setting to be valid. The following specifiers are understood:</para> + + <table class='specifiers'> + <title>Specifiers available in unit files</title> + <tgroup cols='3' align='left' colsep='1' rowsep='1'> + <colspec colname="spec" /> + <colspec colname="mean" /> + <colspec colname="detail" /> + <thead> + <row> + <entry>Specifier</entry> + <entry>Meaning</entry> + <entry>Details</entry> + </row> + </thead> + <tbody> + <xi:include href="standard-specifiers.xml" xpointer="a"/> + <xi:include href="standard-specifiers.xml" xpointer="A"/> + <xi:include href="standard-specifiers.xml" xpointer="b"/> + <xi:include href="standard-specifiers.xml" xpointer="B"/> + <xi:include href="standard-specifiers.xml" xpointer="H"/> + <xi:include href="standard-specifiers.xml" xpointer="l"/> + <xi:include href="standard-specifiers.xml" xpointer="m"/> + <xi:include href="standard-specifiers.xml" xpointer="M"/> + <xi:include href="standard-specifiers.xml" xpointer="o"/> + <xi:include href="standard-specifiers.xml" xpointer="q"/> + <xi:include href="standard-specifiers.xml" xpointer="T"/> + <xi:include href="standard-specifiers.xml" xpointer="v"/> + <xi:include href="standard-specifiers.xml" xpointer="V"/> + <xi:include href="standard-specifiers.xml" xpointer="w"/> + <xi:include href="standard-specifiers.xml" xpointer="W"/> + </tbody> + </tgroup> + </table> + </refsect1> + + <refsect1> <title>Examples</title> <example> @@ -1403,23 +1514,23 @@ MACAddress=cb:a9:87:65:43:21</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry> + <para><simplelist type="inline"> + <member><citerefentry> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry> - </para> + </citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index c2e470e..d061736 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.mount" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -82,7 +82,7 @@ for kernel-to-userspace and userspace-to-userspace interfaces. Some of them may not be changed via mount units, and cannot be disabled. For a longer discussion see <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems">API + url="https://systemd.io/API_FILE_SYSTEMS">API File Systems</ulink>.</para> <para>The @@ -104,19 +104,18 @@ system hierarchy, both a requirement dependency and an ordering dependency between both units are created automatically.</para></listitem> - <listitem><para>Block device backed file systems automatically gain - <varname>BindsTo=</varname> and <varname>After=</varname> type - dependencies on the device unit encapsulating the block - device (see below).</para></listitem> + <listitem><para>Block device backed file systems automatically gain <varname>Requires=</varname>, + <varname>StopPropagatedFrom=</varname>, and <varname>After=</varname> type dependencies on the + device unit encapsulating the block device (see <varname>x-systemd.device-bound=</varname> for details). + </para></listitem> - <listitem><para>If traditional file system quota is enabled for a mount - unit, automatic <varname>Wants=</varname> and - <varname>Before=</varname> dependencies on - <filename>systemd-quotacheck.service</filename> and - <filename>quotaon.service</filename> are added.</para></listitem> + <listitem><para>If traditional file system quota is enabled for a mount unit, automatic + <varname>Wants=</varname> and <varname>Before=</varname> dependencies on + <filename>systemd-quotacheck.service</filename> and <filename>quotaon.service</filename> + are added.</para></listitem> - <listitem><para>Additional implicit dependencies may be added as result of - execution and resource control parameters as documented in + <listitem><para>Additional implicit dependencies may be added as result of execution and + resource control parameters as documented in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> and <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. @@ -135,15 +134,20 @@ <listitem><para>Mount units referring to local file systems automatically gain an <varname>After=</varname> dependency on <filename>local-fs-pre.target</filename>, and a - <varname>Before=</varname> dependency on <filename>local-fs.target</filename> unless - <option>nofail</option> mount option is set.</para></listitem> - - <listitem><para>Network mount units - automatically acquire <varname>After=</varname> dependencies on <filename>remote-fs-pre.target</filename>, - <filename>network.target</filename> and <filename>network-online.target</filename>, and gain a - <varname>Before=</varname> dependency on <filename>remote-fs.target</filename> unless - <option>nofail</option> mount option is set. Towards the latter a - <varname>Wants=</varname> unit is added as well.</para></listitem> + <varname>Before=</varname> dependency on <filename>local-fs.target</filename> unless one or more + mount options among <option>nofail</option>, <option>x-systemd.wanted-by=</option>, + and <option>x-systemd.required-by=</option> is set. See below for detailed information.</para> + + <para>Additionally, an <varname>After=</varname> dependency on <filename>swap.target</filename> + is added when the file system type is <literal>tmpfs</literal>.</para> + </listitem> + + <listitem><para>Network mount units automatically acquire <varname>After=</varname> dependencies on + <filename>remote-fs-pre.target</filename>, <filename>network.target</filename>, + plus <varname>After=</varname> and <varname>Wants=</varname> dependencies on <filename>network-online.target</filename>, + and a <varname>Before=</varname> dependency on <filename>remote-fs.target</filename>, unless + one or more mount options among <option>nofail</option>, <option>x-systemd.wanted-by=</option>, + and <option>x-systemd.required-by=</option> is set.</para></listitem> </itemizedlist> <para>Mount units referring to local and network file systems are distinguished by their file system type @@ -241,13 +245,13 @@ <term><option>x-systemd.wanted-by=</option></term> <term><option>x-systemd.required-by=</option></term> - <listitem><para>In the created mount unit, configures a - <varname>WantedBy=</varname> or <varname>RequiredBy=</varname> - dependency on another unit. This option may be - specified more than once. If this is specified, the normal - automatic dependencies on the created mount unit, e.g., - <filename>local-fs.target</filename>, are not automatically - created. See <varname>WantedBy=</varname> and <varname>RequiredBy=</varname> in + <listitem><para>In the created mount unit, configures a <varname>WantedBy=</varname> or + <varname>RequiredBy=</varname> dependency on another unit. This option may be specified more than once. + If this is specified, the default dependencies (see above) other than <filename>umount.target</filename> + on the created mount unit, e.g. <filename>local-fs.target</filename>, are not automatically created. + Hence it is likely that some ordering dependencies need to be set up manually through + <option>x-systemd.before=</option> and <option>x-systemd.after=</option>. See <varname>WantedBy=</varname> + and <varname>RequiredBy=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> @@ -255,13 +259,14 @@ </varlistentry> <varlistentry> + <term><option>x-systemd.wants-mounts-for=</option></term> <term><option>x-systemd.requires-mounts-for=</option></term> <listitem><para>Configures a - <varname>RequiresMountsFor=</varname> dependency between the - created mount unit and other mount units. The argument must be - an absolute path. This option may be specified more than once. - See <varname>RequiresMountsFor=</varname> in + <varname>RequiresMountsFor=</varname> or <varname>WantsMountsFor=</varname> + dependency between the created mount unit and other mount units. The + argument must be an absolute path. This option may be specified more than + once. See <varname>RequiresMountsFor=</varname> or <varname>WantsMountsFor=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> @@ -501,9 +506,9 @@ information about the file system mount points it supervises. A number of options that may be used in this section are shared with other unit types. These options are documented in - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> - and - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The options specific to the [Mount] section of mount units are the following:</para> @@ -511,8 +516,8 @@ <varlistentry> <term><varname>What=</varname></term> - <listitem><para>Takes an absolute path of a device node, file or other resource to mount. See - <citerefentry + <listitem><para>Takes an absolute path or a fstab-style identifier of a device node, file or + other resource to mount. See <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. If this refers to a device node, a dependency on the respective device unit is automatically created. (See @@ -537,7 +542,11 @@ <term><varname>Type=</varname></term> <listitem><para>Takes a string for the file system type. See <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry> - for details. This setting is optional.</para></listitem> + for details. This setting is optional.</para> + + <para>If the type is <literal>overlay</literal>, and <literal>upperdir=</literal> or + <literal>workdir=</literal> are specified as options and they don't exist, they will be created. + </para></listitem> </varlistentry> <varlistentry> @@ -637,22 +646,22 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>mount</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-mount</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.net-naming-scheme.xml b/man/systemd.net-naming-scheme.xml index e9c00c9..ff811c2 100644 --- a/man/systemd.net-naming-scheme.xml +++ b/man/systemd.net-naming-scheme.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.net-naming-scheme" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -38,7 +38,7 @@ implemented version, but it is also possible to set one of the older versions to preserve compatibility. This may be useful for example for distributions, which may introduce new versions of systemd in stable releases without changing the naming scheme. The naming scheme may also be overridden - using the <varname>net.naming-scheme=</varname> kernel command line switch, see + using the <varname>net.naming_scheme=</varname> kernel command line switch, see <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. Available naming schemes are described below.</para> @@ -97,8 +97,8 @@ <variablelist> <varlistentry> - <term><varname>ID_NET_NAME_ONBOARD=<replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></varname></term> - <term><varname>ID_NET_NAME_ONBOARD=<replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></varname></term> + <term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>o</constant><replaceable>number</replaceable></term> + <term><varname>ID_NET_NAME_ONBOARD=</varname><replaceable>prefix</replaceable><constant>d</constant><replaceable>number</replaceable></term> <listitem><para>This name is set based on the numeric ordering information given by the firmware for on-board devices. Different schemes are used depending on the firmware type, as described in @@ -135,7 +135,7 @@ </varlistentry> <varlistentry> - <term><varname>ID_NET_LABEL_ONBOARD=<replaceable>prefix</replaceable> <replaceable>label</replaceable></varname></term> + <term><varname>ID_NET_LABEL_ONBOARD=</varname><replaceable>prefix</replaceable> <replaceable>label</replaceable></term> <listitem><para>This property is set based on textual label given by the firmware for on-board devices. The name consists of the prefix concatenated with the label. This is only available for @@ -147,7 +147,7 @@ </varlistentry> <varlistentry> - <term><varname>ID_NET_NAME_MAC=<replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></varname></term> + <term><varname>ID_NET_NAME_MAC=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>AABBCCDDEEFF</replaceable></term> <listitem><para>This name consists of the prefix, letter <constant>x</constant>, and 12 hexadecimal digits of the MAC address. It is available if the device has a fixed MAC address. Because this name @@ -159,13 +159,13 @@ </varlistentry> <varlistentry> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable><constant>v</constant><replaceable>slot</replaceable></varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable><constant>x</constant><replaceable>slot</replaceable></varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>v</constant><replaceable>slot</replaceable></varname></term> - <term><varname>ID_NET_NAME_SLOT=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>r</constant><replaceable>slot</replaceable></varname></term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>v</constant><replaceable>slot</replaceable></term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable><constant>x</constant><replaceable>slot</replaceable></term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>v</constant><replaceable>slot</replaceable></term> + <term><varname>ID_NET_NAME_SLOT=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>r</constant><replaceable>slot</replaceable></term> <listitem><para>This property describes the slot position. Different schemes are used depending on the bus type, as described in the table below. In case of USB, BCMA, and SR-VIO devices, the full @@ -223,7 +223,7 @@ </table> <para>The PCI domain is only prepended when it is not 0. All multi-function PCI devices will carry - the <constant>f<replaceable>function</replaceable></constant> number in the device name, including + the <constant>f</constant><replaceable>function</replaceable> number in the device name, including the function 0 device. For non-multi-function devices, the number is suppressed if 0. The port name <replaceable>port_name</replaceable> is used, or the port number <constant>d</constant><replaceable>dev_port</replaceable> if the name is not known.</para> @@ -251,13 +251,13 @@ </varlistentry> <varlistentry> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable><constant>u</constant><replaceable>port</replaceable>…</varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></varname></term> - <term><varname>ID_NET_NAME_PATH=<replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</varname></term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>c</constant><replaceable>bus_id</replaceable></term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>a</constant><replaceable>vendor</replaceable><replaceable>model</replaceable><constant>i</constant><replaceable>instance</replaceable></term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>i</constant><replaceable>address</replaceable><constant>n</constant><replaceable>port_name</replaceable></term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable><constant>u</constant><replaceable>port</replaceable>…</term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]</term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>b</constant><replaceable>number</replaceable></term> + <term><varname>ID_NET_NAME_PATH=</varname><replaceable>prefix</replaceable>[<constant>P</constant><replaceable>domain</replaceable>]<constant>p</constant><replaceable>bus</replaceable><constant>s</constant><replaceable>slot</replaceable>[<constant>f</constant><replaceable>function</replaceable>][<constant>n</constant><replaceable>phys_port_name</replaceable>|<constant>d</constant><replaceable>dev_port</replaceable>]<constant>u</constant><replaceable>port</replaceable>…[<constant>c</constant><replaceable>config</replaceable>][<constant>i</constant><replaceable>interface</replaceable>]</term> <listitem><para>This property describes the device installation location. Different schemes are used depending on the bus type, as described in the table below. For BCMA and USB devices, PCI path @@ -326,7 +326,7 @@ <title>History</title> <para>The following "naming schemes" have been defined (which may be chosen at system boot-up time via - the <varname>net.naming-scheme=</varname> kernel command line switch, see above):</para> + the <varname>net.naming_scheme=</varname> kernel command line switch, see above):</para> <variablelist> <varlistentry> @@ -508,7 +508,7 @@ <listitem><para>Naming was changed for SR-IOV virtual device representors, optionally settable at compilation time. The <literal>r<replaceable>slot</replaceable></literal> suffix was added to differentiate SR-IOV virtual device representors attached to a single physical device interface. - Because of a mistake, this scheme was <emphasis>not the the default scheme for systemd version + Because of a mistake, this scheme was <emphasis>not the default scheme for systemd version 254</emphasis>.</para> <xi:include href="version-info.xml" xpointer="v255"/> @@ -532,6 +532,47 @@ </refsect1> <refsect1> + <title>Limiting the use of specific sysfs attributes</title> + + <para>When creating names for network cards, some naming schemes use data from sysfs populated + by the kernel. This means that although a specific naming scheme in udev is picked, + the network card's name can still change when a new kernel version adds a new sysfs attribute. + For example if kernel starts setting the <constant>phys_port_name</constant>, udev will append the + "<constant>n</constant><replaceable>phys_port_name</replaceable>" suffix to the device name.</para> + + <variablelist> + <varlistentry> + <term><varname>ID_NET_NAME_ALLOW=</varname><replaceable>BOOL</replaceable></term> + + <listitem><para>This udev property sets a fallback policy for reading a sysfs attribute. + If set to <constant>0</constant> udev will not read any sysfs attribute by default, unless it is + explicitly allowlisted, see below. If set to <constant>1</constant> udev can use any sysfs attribute + unless it is explicitly forbidden. The default value is <constant>1</constant>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=<replaceable>BOOL</replaceable></varname></term> + + <listitem><para>This udev property explicitly states if udev shall use the specified + <replaceable>sysfsattr</replaceable>, when composing the device name.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> + + <para>With these options, users can set an allowlist or denylist for sysfs attributes. To create + an allowlist, the user needs to set <varname>ID_NET_NAME_ALLOW=0</varname> for the device and then list + the allowed attributes with the + <varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=1</varname> + options. In case of a denylist, the user needs to provide the list of denied attributes with + the <varname>ID_NET_NAME_ALLOW_<replaceable>sysfsattr</replaceable>=0</varname> options.</para> + </refsect1> + + <refsect1> <title>Examples</title> <example> @@ -617,16 +658,46 @@ ID_NET_NAME_PATH=enp0s29u1u2</programlisting> ID_NET_NAME_MAC=enx026d3c00000a ID_NET_NAME_PATH=encf5f0</programlisting> </example> + + <example> + <title>Set an allowlist for reading sysfs attributes for network card naming</title> + + <programlisting><filename>/etc/udev/hwdb.d/50-net-naming-allowlist.hwdb</filename> +net:naming:drvirtio_net:* + ID_NET_NAME_ALLOW=0 + ID_NET_NAME_ALLOW_ACPI_INDEX=1 + ID_NET_NAME_ALLOW_ADDR_ASSIGN_TYPE=1 + ID_NET_NAME_ALLOW_ADDRESS=1 + ID_NET_NAME_ALLOW_ARI_ENABLED=1 + ID_NET_NAME_ALLOW_DEV_PORT=1 + ID_NET_NAME_ALLOW_FUNCTION_ID=1 + ID_NET_NAME_ALLOW_IFLINK=1 + ID_NET_NAME_ALLOW_INDEX=1 + ID_NET_NAME_ALLOW_LABEL=1 + ID_NET_NAME_ALLOW_PHYS_PORT_NAME=1 + ID_NET_NAME_ALLOW_TYPE=1</programlisting> + </example> + + <example> + <title>Set a denylist so that specified sysfs attribute are ignored</title> + + <programlisting><filename>/etc/udev/hwdb.d/50-net-naming-denylist.hwdb</filename> +net:naming:drvirtio_net:* + ID_NET_NAME_ALLOW=1 + ID_NET_NAME_ALLOW_DEV_PORT=0 + ID_NET_NAME_ALLOW_PHYS_PORT_NAME=0 + </programlisting> + </example> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <ulink url="https://systemd.io/PREDICTABLE_INTERFACE_NAMES">Predictable Network Interface Names</ulink>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><ulink url="https://systemd.io/PREDICTABLE_INTERFACE_NAMES">Predictable Network Interface Names</ulink></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index 9cad358..4fba788 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.netdev" conditional='ENABLE_NETWORKD' @@ -571,6 +571,19 @@ <xi:include href="version-info.xml" xpointer="v248"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>BroadcastQueueThreshold=</varname></term> + <listitem> + <para>Controls the threshold for broadcast queueing of the macvlan device. Takes the special value + <literal>no</literal>, or an integer in the range 0…2147483647. When <literal>no</literal> is + specified, the broadcast queueing is disabled altogether. When an integer is specified, a multicast + address will be queued as broadcast if the number of devices using it is greater than the given + value. Defaults to unset, and the kernel default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -1891,13 +1904,22 @@ <varlistentry> <term><varname>PrivateKey=</varname></term> <listitem> - <para>The Base64 encoded private key for the interface. It can be - generated using the <command>wg genkey</command> command - (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>). - This option or <varname>PrivateKeyFile=</varname> is mandatory to use WireGuard. - Note that because this information is secret, you may want to set - the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal> - with a <literal>0640</literal> file mode.</para> + <para>The Base64 encoded private key for the interface. It can be generated using + the <command>wg genkey</command> command + (see <citerefentry project='man-pages'><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>). + Specially, if the specified key is prefixed with <literal>@</literal>, it is interpreted as + the name of the credential from which the actual key shall be read. <command>systemd-networkd.service</command> + automatically imports credentials matching <literal>network.wireguard.*</literal>. For more details + on credentials, refer to + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + A private key is mandatory to use WireGuard. If not set, the credential + <literal>network.wireguard.private.<replaceable>netdev</replaceable></literal> is used if exists. + I.e. for <filename>50-foobar.netdev</filename>, <literal>network.wireguard.private.50-foobar</literal> + is tried.</para> + + <para>Note that because this information is secret, it's strongly recommended to use an (encrypted) + credential. Alternatively, you may want to set the permissions of the .netdev file to be owned + by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para> <xi:include href="version-info.xml" xpointer="v237"/> </listitem> @@ -1975,10 +1997,10 @@ <term><varname>PublicKey=</varname></term> <listitem> <para>Sets a Base64 encoded public key calculated by <command>wg pubkey</command> - (see <citerefentry project="wireguard"><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>) - from a private key, and usually transmitted out of band to the - author of the configuration file. This option is mandatory for this - section.</para> + (see <citerefentry project='man-pages'><refentrytitle>wg</refentrytitle><manvolnum>8</manvolnum></citerefentry>) + from a private key, and usually transmitted out of band to the author of the configuration file. + This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option> + setting of the <option>[WireGuard]</option> section. This option is mandatory for this section.</para> <xi:include href="version-info.xml" xpointer="v237"/> </listitem> @@ -1986,14 +2008,15 @@ <varlistentry> <term><varname>PresharedKey=</varname></term> <listitem> - <para>Optional preshared key for the interface. It can be generated - by the <command>wg genpsk</command> command. This option adds an - additional layer of symmetric-key cryptography to be mixed into the - already existing public-key cryptography, for post-quantum - resistance. - Note that because this information is secret, you may want to set - the permissions of the .netdev file to be owned by <literal>root:systemd-network</literal> - with a <literal>0640</literal> file mode.</para> + <para>Optional preshared key for the interface. It can be generated by the <command>wg genpsk</command> + command. This option adds an additional layer of symmetric-key cryptography to be mixed into the + already existing public-key cryptography, for post-quantum resistance. + This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option> + setting of the <option>[WireGuard]</option> section.</para> + + <para>Note that because this information is secret, it's strongly recommended to use an (encrypted) + credential. Alternatively, you may want to set the permissions of the .netdev file to be owned + by <literal>root:systemd-network</literal> with a <literal>0640</literal> file mode.</para> <xi:include href="version-info.xml" xpointer="v237"/> </listitem> @@ -2034,13 +2057,15 @@ <varlistentry> <term><varname>Endpoint=</varname></term> <listitem> - <para>Sets an endpoint IP address or hostname, followed by a colon, and then - a port number. IPv6 address must be in the square brackets. For example, - <literal>111.222.333.444:51820</literal> for IPv4 and <literal>[1111:2222::3333]:51820</literal> - for IPv6 address. This endpoint will be updated automatically once to - the most recent source IP address and port of correctly + <para>Sets an endpoint IP address or hostname, followed by a colon, and then a port number. + IPv6 address must be in the square brackets. For example, <literal>111.222.333.444:51820</literal> + for IPv4 and <literal>[1111:2222::3333]:51820</literal> for IPv6 address. This endpoint will be + updated automatically once to the most recent source IP address and port of correctly authenticated packets from the peer at configuration time.</para> + <para>This option honors the <literal>@</literal> prefix in the same way as the <option>PrivateKey=</option> + setting of the <option>[WireGuard]</option> section.</para> + <xi:include href="version-info.xml" xpointer="v237"/> </listitem> </varlistentry> @@ -2158,6 +2183,19 @@ </varlistentry> <varlistentry> + <term><varname>PeerNotifyDelaySec=</varname></term> + <listitem> + <para>Specifies the number of seconds the delay between each peer notification + (gratuitous ARP and unsolicited IPv6 Neighbor Advertisement) when they are issued + after a failover event. This delay should be a multiple of the MII link monitor + interval (miimon). The valid range is 0...300s. The default value is 0, + which means to match the value of the <varname>MIIMonitorSec=</varname>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>UpDelaySec=</varname></term> <listitem> <para>Specifies the delay before a link is enabled after a @@ -2408,6 +2446,18 @@ <xi:include href="version-info.xml" xpointer="v220"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>ARPMissedMax=</varname></term> + <listitem> + <para>Specify the maximum number of arp interval monitor cycle + for missed ARP replies. If this number is exceeded, link is reported as + down. Defaults to unset. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> <para>For more detail information see @@ -2884,13 +2934,13 @@ Independent=yes</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.network.xml b/man/systemd.network.xml index 5f0a703..b0efd62 100644 --- a/man/systemd.network.xml +++ b/man/systemd.network.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.network" conditional='ENABLE_NETWORKD' @@ -39,13 +39,14 @@ <para>The <filename>.network</filename> files are read from the files located in the system network directories <filename>/usr/lib/systemd/network</filename> and - <filename>/usr/local/lib/systemd/network</filename>, the volatile runtime network directory - <filename>/run/systemd/network</filename> and the local administration network directory - <filename>/etc/systemd/network</filename>. All configuration files are collectively sorted and - processed in alphanumeric order, regardless of the directories in which they live. However, files - with identical filenames replace each other. It is recommended that each filename is prefixed with - a number smaller than <literal>70</literal> (e.g. <filename>10-eth0.network</filename>). Otherwise, the - default <filename>.network</filename> files or those generated by + <filename>/usr/local/lib/systemd/network</filename> + <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />, + the volatile runtime network directory <filename>/run/systemd/network</filename> and the local + administration network directory <filename>/etc/systemd/network</filename>. All configuration files are + collectively sorted and processed in alphanumeric order, regardless of the directories in which they + live. However, files with identical filenames replace each other. It is recommended that each filename is + prefixed with a number smaller than <literal>70</literal> (e.g. <filename>10-eth0.network</filename>). + Otherwise, the default <filename>.network</filename> files or those generated by <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> may take precedence over user configured files. Files in <filename>/etc/</filename> have the highest priority, files in <filename>/run/</filename> take precedence over files with the same name under @@ -259,16 +260,16 @@ <varlistentry> <term><varname>RequiredForOnline=</varname></term> <listitem> - <para>Takes a boolean or a minimum operational state and an optional maximum operational - state. Please see + <para>Takes a boolean, a minimum operational state (e.g., <literal>carrier</literal>), or a range + of operational state separated with a colon (e.g., <literal>degraded:routable</literal>). + Please see <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> for possible operational states. When <literal>yes</literal>, the network is deemed required when determining whether the system is online (including when running <command>systemd-networkd-wait-online</command>). When <literal>no</literal>, the network is ignored when determining the online state. When a minimum operational state and an optional - maximum operational state are set, <literal>yes</literal> is implied, and this controls the - minimum and maximum operational state required for the network interface to be considered - online.</para> + maximum operational state are set, <command>systemd-networkd-wait-online</command> deems that the + interface is online when the operational state is in the specified range.</para> <para>Defaults to <literal>yes</literal> when <varname>ActivationPolicy=</varname> is not set, or set to <literal>up</literal>, <literal>always-up</literal>, or @@ -283,6 +284,44 @@ skipped automatically by <command>systemd-networkd-wait-online</command> if <literal>RequiredForOnline=no</literal>.</para> + <para>The boolean value <literal>yes</literal> is translated as follows; + <variablelist> + <varlistentry> + <term><option>CAN devices</option></term> + <listitem> + <para><literal>carrier</literal>,</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><option>Master devices, e.g. bond or bridge</option></term> + <listitem> + <para><literal>degraded-carrier</literal> with <varname>RequiredFamilyForOnline=any</varname>,</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><option>Bonding port interfaces</option></term> + <listitem> + <para><literal>enslaved</literal>,</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><option>Other interfaces</option></term> + <listitem> + <para><literal>degraded</literal>.</para> + <xi:include href="version-info.xml" xpointer="v236"/> + </listitem> + </varlistentry> + </variablelist> + </para> + + <para>This setting can be overridden by the command line option for + <command>systemd-networkd-wait-online</command>. See + <citerefentry><refentrytitle>systemd-networkd-wait-online.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + for more details.</para> + <xi:include href="version-info.xml" xpointer="v236"/> </listitem> </varlistentry> @@ -390,20 +429,28 @@ Defaults to <literal>no</literal>. Further settings for the DHCP server may be set in the [DHCPServer] section described below.</para> - <xi:include href="version-info.xml" xpointer="v215"/> + <para>Even if this is enabled, the DHCP server will not be started automatically and wait for the + persistent storage being ready to load/save leases in the storage, unless + <varname>RelayTarget=</varname> or <varname>PersistLeases=no</varname> are specified in the + [DHCPServer] section. It will be started after + <filename>systemd-networkd-persistent-storage.service</filename> is started, which calls + <command>networkctl persistent-storage yes</command>. See + <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> + for more details.</para> + + <xi:include href="version-info.xml" xpointer="v215"/> </listitem> </varlistentry> <varlistentry> <term><varname>LinkLocalAddressing=</varname></term> <listitem> - <para>Enables link-local address autoconfiguration. Accepts <option>yes</option>, - <option>no</option>, <option>ipv4</option>, and <option>ipv6</option>. An IPv6 link-local - address is configured when <option>yes</option> or <option>ipv6</option>. An IPv4 link-local - address is configured when <option>yes</option> or <option>ipv4</option> and when DHCPv4 - autoconfiguration has been unsuccessful for some time. (IPv4 link-local address - autoconfiguration will usually happen in parallel with repeated attempts to acquire a DHCPv4 - lease).</para> + <para>Enables link-local address autoconfiguration. Accepts a boolean, <option>ipv4</option>, + and <option>ipv6</option>. An IPv6 link-local address is configured when <option>yes</option> + or <option>ipv6</option>. An IPv4 link-local address is configured when <option>yes</option> + or <option>ipv4</option> and when DHCPv4 autoconfiguration has been unsuccessful for some time. + (IPv4 link-local address autoconfiguration will usually happen in parallel with repeated attempts + to acquire a DHCPv4 lease).</para> <para>Defaults to <option>no</option> when <varname>KeepMaster=</varname> or <varname>Bridge=</varname> is set or when the specified @@ -661,6 +708,9 @@ Table=1234</programlisting></para> number of dynamically created network interfaces with the same network configuration and automatic address range assignment.</para> + <para>If an empty string is specified, then the all previous assignments in both [Network] and + [Address] sections are cleared.</para> + <xi:include href="version-info.xml" xpointer="v211"/> </listitem> </varlistentry> @@ -698,6 +748,17 @@ Table=1234</programlisting></para> </varlistentry> <varlistentry> + <term><varname>UseDomains=</varname></term> + <listitem> + <para>Specifies the protocol-independent default value for the same settings in + [IPv6AcceptRA], [DHCPv4], and [DHCPv6] sections below. Takes a boolean, or the special value + <option>route</option>. See also the same setting in [DHCPv4] below. Defaults to unset.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>Domains=</varname></term> <listitem> <para>A whitespace-separated list of domains which should be resolved using the DNS servers @@ -762,26 +823,43 @@ Table=1234</programlisting></para> </varlistentry> <varlistentry> - <term><varname>IPForward=</varname></term> + <term><varname>IPv4Forwarding=</varname></term> <listitem> - <para>Configures IP packet forwarding for the system. If enabled, incoming packets on any - network interface will be forwarded to any other interfaces according to the routing table. - Takes a boolean, or the values <literal>ipv4</literal> or <literal>ipv6</literal>, which only - enable IP packet forwarding for the specified address family. This controls the - <filename>net.ipv4.ip_forward</filename> and <filename>net.ipv6.conf.all.forwarding</filename> - sysctl options of the network interface (see + <para>Configures IPv4 packet forwarding for the interface. Takes a boolean value. This controls the + <filename>net.ipv4.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of + the network interface. See <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> - for details about sysctl options). Defaults to <literal>no</literal>.</para> + for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is + enabled for IPv4, otherwise the value specified to the same setting in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + will be used. If none of them are specified, the sysctl option will not be changed.</para> + + <para>To control the global setting, use the same setting in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para> - <para>Note: this setting controls a global kernel option, and does so one way only: if a - network that has this setting enabled is set up the global setting is turned on. However, - it is never turned off again, even after all networks with this setting enabled are shut - down again.</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> - <para>To allow IP packet forwarding only between specific network interfaces use a firewall. + <varlistentry> + <term><varname>IPv6Forwarding=</varname></term> + <listitem> + <para>Configures IPv6 packet forwarding for the interface. Takes a boolean value. This controls the + <filename>net.ipv6.conf.<replaceable>INTERFACE</replaceable>.forwarding</filename> sysctl option of + the network interface. See + <ulink url="https://docs.kernel.org/networking/ip-sysctl.html">IP Sysctl</ulink> + for more details about the sysctl option. Defaults to true if <varname>IPMasquerade=</varname> is + enabled for IPv6 or <varname>IPv6SendRA=</varname> is enabled, otherwise the value specified to the + same setting in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + will be used. If none of them are specified, the sysctl option will not be changed.</para> + + <para>To control the global setting, use the same setting in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> - <xi:include href="version-info.xml" xpointer="v219"/> + <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> @@ -789,13 +867,20 @@ Table=1234</programlisting></para> <term><varname>IPMasquerade=</varname></term> <listitem> <para>Configures IP masquerading for the network interface. If enabled, packets forwarded - from the network interface will be appear as coming from the local host. Takes one of - <literal>ipv4</literal>, <literal>ipv6</literal>, <literal>both</literal>, or - <literal>no</literal>. Defaults to <literal>no</literal>. If enabled, this automatically sets - <varname>IPForward=</varname> to one of <literal>ipv4</literal>, <literal>ipv6</literal> or - <literal>yes</literal>.</para> - <para>Note. Any positive boolean values such as <literal>yes</literal> or - <literal>true</literal> are now deprecated. Please use one of the values above.</para> + from the network interface will be appear as coming from the local host. Typically, this should be + enabled on the downstream interface of routers. Takes one of <literal>ipv4</literal>, + <literal>ipv6</literal>, <literal>both</literal>, or <literal>no</literal>. Defaults to + <literal>no</literal>. Note. Any positive boolean values such as <literal>yes</literal> or + <literal>true</literal> are now deprecated. Please use one of the values above. Specifying + <literal>ipv4</literal> or <literal>both</literal> implies <varname>IPv4Forwarding=</varname>, + unless it is explicitly specified. Similarly for <varname>IPv6Forwarding=</varname> when + <literal>ipv6</literal> or <literal>both</literal> is specified. These implications are only on + this interface. Hence, to make the IP packet forwarding works, + <varname>IPv4Forwarding=</varname>/<varname>IPv6Forwarding=</varname> need to be enabled on an + upstream interface, or globally enabled by specifying them in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + See <varname>IPv4Forwarding=</varname>/<varname>IPv6Forwarding=</varname> in the above for more + details.</para> <xi:include href="version-info.xml" xpointer="v219"/> </listitem> @@ -823,12 +908,13 @@ Table=1234</programlisting></para> <varlistentry> <term><varname>IPv6AcceptRA=</varname></term> <listitem> - <para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the - interface. If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they - may trigger the start of the DHCPv6 client if the relevant flags are set in the RA data, or - if no routers are found on the link. The default is to disable RA reception for bridge - devices or when IP forwarding is enabled, and to enable it otherwise. Cannot be enabled on - devices aggregated in a bond device or when link-local addressing is disabled.</para> + <para>Takes a boolean. Controls IPv6 Router Advertisement (RA) reception support for the interface. + If true, RAs are accepted; if false, RAs are ignored. When RAs are accepted, they may trigger the + start of the DHCPv6 client if the relevant flags are set in the RA data, or if no routers are found + on the link. Defaults to false for bridge devices, when IP forwarding is enabled, + <varname>IPv6SendRA=</varname> or <varname>KeepMaster=</varname> is enabled. Otherwise, enabled by + default. Cannot be enabled on devices aggregated in a bond device or when link-local addressing is + disabled.</para> <para>Further settings for the IPv6 RA support may be configured in the [IPv6AcceptRA] section, see below.</para> @@ -872,6 +958,18 @@ Table=1234</programlisting></para> </varlistentry> <varlistentry> + <term><varname>IPv6RetransmissionTimeSec=</varname></term> + <listitem> + <para>Configures IPv6 Retransmission Time. The time between retransmitted Neighbor + Solicitation messages. Used by address resolution and the Neighbor Unreachability + Detection algorithm. A value of zero is ignored and the kernel's current value + will be used. Defaults to unset, and the kernel's current value will be used.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>IPv4ReversePathFilter=</varname></term> <listitem> <para>Configure IPv4 Reverse Path Filtering. If enabled, when an IPv4 packet is received, the machine will first check @@ -925,6 +1023,21 @@ Table=1234</programlisting></para> </varlistentry> <varlistentry> + <term><varname>IPv4ProxyARPPrivateVLAN=</varname></term> + <listitem> + <para>Takes a boolean. Configures proxy ARP private VLAN for IPv4, also known as VLAN aggregation, + private VLAN, source-port filtering, port-isolation, or MAC-forced forwarding.</para> + + <para>This variant of the ARP proxy technique will allow the ARP proxy to reply back to the same + interface.</para> + + <para>See <ulink url="https://tools.ietf.org/html/rfc3069">RFC 3069</ulink>. When unset, + the kernel's default will be used.</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>IPv6ProxyNDP=</varname></term> <listitem> <para>Takes a boolean. Configures proxy NDP for IPv6. Proxy NDP (Neighbor Discovery Protocol) @@ -965,6 +1078,9 @@ Table=1234</programlisting></para> distributed. See <varname>DHCPPrefixDelegation=</varname> setting and the [IPv6SendRA], [IPv6Prefix], [IPv6RoutePrefix], and [DHCPPrefixDelegation] sections for more configuration options.</para> + <para>If enabled, <varname>IPv6Forwarding=</varname> on this interface is also enabled, unless + the setting is explicitly specified. See <varname>IPv6Forwarding=</varname> in the above for more + details.</para> <xi:include href="version-info.xml" xpointer="v247"/> </listitem> @@ -1323,13 +1439,15 @@ Table=1234</programlisting></para> Fallback Peer Labeling</ulink> rules. They will be removed when the interface is deconfigured. Failures to manage the labels will be ignored.</para> - <para>Warning: Once labeling is enabled for network traffic, a lot of LSM access control points in - Linux networking stack go from dormant to active. Care should be taken to avoid getting into a - situation where for example remote connectivity is broken, when the security policy hasn't been - updated to consider LSM per-packet access controls and no rules would allow any network - traffic. Also note that additional configuration with <citerefentry - project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> - is needed.</para> + <warning> + <para>Once labeling is enabled for network traffic, a lot of LSM access control points in + Linux networking stack go from dormant to active. Care should be taken to avoid getting into a + situation where for example remote connectivity is broken, when the security policy hasn't been + updated to consider LSM per-packet access controls and no rules would allow any network + traffic. Also note that additional configuration with <citerefentry + project='man-pages'><refentrytitle>netlabelctl</refentrytitle><manvolnum>8</manvolnum></citerefentry> + is needed.</para> + </warning> <para>Example: <programlisting>[Address] @@ -1602,6 +1720,18 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> </varlistentry> <varlistentry> + <term><varname>L3MasterDevice=</varname></term> + <listitem> + <para>A boolean. Specifies whether the rule is to direct lookups to the tables associated with + level 3 master devices (also known as Virtual Routing and Forwarding or VRF devices). + For further details see <ulink url="https://docs.kernel.org/networking/vrf.html"> + Virtual Routing and Forwarding (VRF)</ulink>. Defaults to false.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>SourcePort=</varname></term> <listitem> <para>Specifies the source IP port or IP port range match in forwarding information base @@ -1714,8 +1844,10 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> <varlistentry> <term><varname>Id=</varname></term> <listitem> - <para>The id of the next hop. Takes an integer in the range 1…4294967295. If unspecified, - then automatically chosen by kernel.</para> + <para>The id of the next hop. Takes an integer in the range 1…4294967295. + This is mandatory if <varname>ManageForeignNextHops=no</varname> is specified in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + Otherwise, if unspecified, an unused ID will be automatically picked.</para> <xi:include href="version-info.xml" xpointer="v244"/> </listitem> @@ -1921,7 +2053,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> <command>ip route show table <replaceable>num</replaceable></command>. If unset and <varname>Type=</varname> is <literal>local</literal>, <literal>broadcast</literal>, <literal>anycast</literal>, or <literal>nat</literal>, then <literal>local</literal> is used. - In other cases, defaults to <literal>main</literal>.</para> + In other cases, defaults to <literal>main</literal>. Ignored if <varname>L3MasterDevice=</varname> is true.</para> <xi:include href="version-info.xml" xpointer="v230"/> </listitem> @@ -2018,16 +2150,6 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> </varlistentry> <varlistentry> - <term><varname>TTLPropagate=</varname></term> - <listitem> - <para>Takes a boolean. When true enables TTL propagation at Label Switched Path (LSP) egress. - When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - - <varlistentry> <term><varname>MTUBytes=</varname></term> <listitem> <para>The maximum transmission unit in bytes to set for the route. The usual suffixes K, M, @@ -2267,7 +2389,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> are implied and these settings in the .network file are silently ignored. Also, <varname>Hostname=</varname>, <varname>MUDURL=</varname>, - <varname>RequestAddress</varname>, + <varname>RequestAddress=</varname>, <varname>RequestOptions=</varname>, <varname>SendOption=</varname>, <varname>SendVendorOption=</varname>, @@ -2472,7 +2594,15 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> effect of the <option>Domains=</option> setting. If set to <option>route</option>, the domain name received from the DHCP server will be used for routing DNS queries only, but not for searching, similarly to the effect of the <option>Domains=</option> setting when the argument is prefixed with - <literal>~</literal>. Defaults to false.</para> + <literal>~</literal>.</para> + + <para>When unspecified, the value specified in the same setting in the [Network] section will be + used. When it is unspecified, the value specified in the same setting in the [DHCPv4] section in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + will be used. When it is unspecified, the value specified in the same setting in the [Network] + section in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + will be used. When none of them are specified, defaults to <literal>no</literal>.</para> <para>It is recommended to enable this option only on trusted networks, as setting this affects resolution of all hostnames, in particular of single-label names. It is generally @@ -2663,13 +2793,22 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> </varlistentry> <varlistentry> + <term><varname>ServerPort=</varname></term> + <listitem> + <para>Set the port on which the DHCP server is listening.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>DenyList=</varname></term> <listitem> <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a prefix length after <literal>/</literal>. DHCP offers from servers in the list are rejected. Note that if <varname>AllowList=</varname> is configured then <varname>DenyList=</varname> is ignored.</para> - <para>Note that this filters only DHCP offers, so the filtering may not work when + <para>Note that this filters only DHCP offers, so the filtering might not work when <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above. </para> @@ -2683,7 +2822,7 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> <para>A whitespace-separated list of IPv4 addresses. Each address can optionally take a prefix length after <literal>/</literal>. DHCP offers from servers in the list are accepted. </para> - <para>Note that this filters only DHCP offers, so the filtering may not work when + <para>Note that this filters only DHCP offers, so the filtering might not work when <varname>RapidCommit=</varname> is enabled. See also <varname>RapidCommit=</varname> in the above. </para> @@ -3085,6 +3224,16 @@ NFTSet=prefix:netdev:filter:eth_ipv4_prefix</programlisting> <variablelist class='network-directives'> <varlistentry> + <term><varname>UseRedirect=</varname></term> + <listitem> + <para>When true (the default), Redirect message sent by the current first-hop router will be + accepted, and configures routes to redirected nodes will be configured.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>Token=</varname></term> <listitem> <para>Specifies an optional address generation mode for the Stateless Address @@ -3274,12 +3423,25 @@ Token=prefixstable:2002:da8:1::</programlisting></para> </varlistentry> <varlistentry> - <term><varname>UseICMP6RateLimit=</varname></term> + <term><varname>UseReachableTime=</varname></term> <listitem> - <para>Takes a boolean. When true, the ICMP6 rate limit received in the Router Advertisement will be set to ICMP6 - rate limit based on the advertisement. Defaults to true.</para> + <para>Takes a boolean. When true, the reachable time received in the Router Advertisement will be + set on the interface receiving the advertisement. It is used as the base timespan of the validity + of a neighbor entry. Defaults to true.</para> - <xi:include href="version-info.xml" xpointer="v255"/> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>UseRetransmissionTime=</varname></term> + <listitem> + <para>Takes a boolean. When true, the retransmission time received in the Router Advertisement will be set + on the interface receiving the advertisement. It is used as the time between retransmissions of Neighbor + Solicitation messages to a neighbor when resolving the address or when probing the reachability of a neighbor. + Defaults to true.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> </listitem> </varlistentry> @@ -3786,6 +3948,22 @@ ServerAddress=192.168.0.1/24</programlisting> </listitem> </varlistentry> + <varlistentry> + <term><varname>PersistLeases=</varname></term> + <listitem> + <para>Takes a boolean. When true, the DHCP server will load and save leases in the persistent + storage. When false, the DHCP server will neither load nor save leases in the persistent storage. + Hence, bound leases will be lost when the interface is reconfigured e.g. by + <command>networkctl reconfigure</command>, or <filename>systemd-networkd.service</filename> + is restarted. That may cause address conflict on the network. So, please take an extra care when + disable this setting. When unspecified, the value specified in the same setting in + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + which defaults to <literal>yes</literal>, will be used.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> </refsect1> @@ -3852,13 +4030,28 @@ ServerAddress=192.168.0.1/24</programlisting> </varlistentry> <varlistentry> + <term><varname>ReachableTimeSec=</varname></term> + + <listitem> + <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which + clients can assume a neighbor is reachable after having received a reachability confirmation. Takes + a time span in the range 0…4294967295 ms. When 0, clients will handle it as if the value wasn't + specified. Defaults to 0.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>RetransmitSec=</varname></term> - <listitem><para>Takes a timespan. Configures the retransmit time, used by clients to retransmit Neighbor - Solicitation messages on address resolution and the Neighbor Unreachability Detection algorithm. - An integer, the default unit is seconds, in the range 0…4294967295 msec. Defaults to 0.</para> + <listitem> + <para>Configures the time, used in the Neighbor Unreachability Detection algorithm, for which + clients can use as retransmit time on address resolution and the Neighbor Unreachability Detection + algorithm. Takes a time span in the range 0…4294967295 ms. When 0, clients will handle it as if + the value wasn't specified. Defaults to 0.</para> - <xi:include href="version-info.xml" xpointer="v255"/> + <xi:include href="version-info.xml" xpointer="v255"/> </listitem> </varlistentry> @@ -3974,9 +4167,9 @@ ServerAddress=192.168.0.1/24</programlisting> </varlistentry> </variablelist> - </refsect1> + </refsect1> - <refsect1> + <refsect1> <title>[IPv6Prefix] Section Options</title> <para>One or more [IPv6Prefix] sections contain the IPv6 prefixes that are announced via Router Advertisements. See <ulink url="https://tools.ietf.org/html/rfc4861">RFC 4861</ulink> for further @@ -4051,9 +4244,9 @@ ServerAddress=192.168.0.1/24</programlisting> </listitem> </varlistentry> </variablelist> - </refsect1> + </refsect1> - <refsect1> + <refsect1> <title>[IPv6RoutePrefix] Section Options</title> <para>One or more [IPv6RoutePrefix] sections contain the IPv6 prefix routes that are announced via Router Advertisements. See @@ -4083,9 +4276,9 @@ ServerAddress=192.168.0.1/24</programlisting> </varlistentry> </variablelist> - </refsect1> + </refsect1> - <refsect1> + <refsect1> <title>[IPv6PREF64Prefix] Section Options</title> <para>One or more [IPv6PREF64Prefix] sections contain the IPv6 PREF64 (or NAT64) prefixes that are announced via Router Advertisements. See <ulink url="https://tools.ietf.org/html/rfc8781">RFC 8781</ulink> for further @@ -4112,480 +4305,486 @@ ServerAddress=192.168.0.1/24</programlisting> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> </variablelist> - </refsect1> + </refsect1> - <refsect1> + <refsect1> <title>[Bridge] Section Options</title> - <para>The [Bridge] section accepts the following keys:</para> - <variablelist class='network-directives'> - <varlistentry> - <term><varname>UnicastFlood=</varname></term> - <listitem> - <para>Takes a boolean. Controls whether the bridge should flood - traffic for which an FDB entry is missing and the destination - is unknown through this port. When unset, the kernel's default will be used. - </para> - - <xi:include href="version-info.xml" xpointer="v223"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>MulticastFlood=</varname></term> - <listitem> - <para>Takes a boolean. Controls whether the bridge should flood - traffic for which an MDB entry is missing and the destination - is unknown through this port. When unset, the kernel's default will be used. - </para> - - <xi:include href="version-info.xml" xpointer="v242"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>MulticastToUnicast=</varname></term> - <listitem> - <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of - the bridge. Which means unicast copies are only delivered to hosts which are interested in it. - When unset, the kernel's default will be used. - </para> - - <xi:include href="version-info.xml" xpointer="v240"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>NeighborSuppression=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for - this port. When unset, the kernel's default will be used. - </para> - - <xi:include href="version-info.xml" xpointer="v242"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Learning=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether MAC address learning is enabled for - this port. When unset, the kernel's default will be used. - </para> - - <xi:include href="version-info.xml" xpointer="v242"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>HairPin=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it - was received. When this flag is false, then the bridge will not forward traffic back out of the - receiving port. When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v223"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Isolated=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge, - isolated ports can only communicate with non-isolated ports. When set to true, this port can only - communicate with other ports whose Isolated setting is false. When set to false, this port - can communicate with any other ports. When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v251"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>UseBPDU=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be - processed by the bridge port. When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v223"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>FastLeave=</varname></term> - <listitem> - <para>Takes a boolean. This flag allows the bridge to immediately stop multicast - traffic on a port that receives an IGMP Leave message. It is only used with - IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v223"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>AllowPortToBeRoot=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether a given port is allowed to - become a root port. Only used when STP is enabled on the bridge. - When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v223"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>ProxyARP=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port. - When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>ProxyARPWiFi=</varname></term> - <listitem> - <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port - which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications. - When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>MulticastRouter=</varname></term> - <listitem> - <para>Configures this port for having multicast routers attached. A port with a multicast - router will receive all multicast traffic. Takes one of <literal>no</literal> - to disable multicast routers on this port, <literal>query</literal> to let the system detect - the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic - forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily - on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Cost=</varname></term> - <listitem> - <para>Sets the "cost" of sending packets of this interface. - Each port in a bridge may have a different speed and the cost - is used to decide which link to use. Faster interfaces - should have lower costs. It is an integer value between 1 and - 65535.</para> - - <xi:include href="version-info.xml" xpointer="v218"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Priority=</varname></term> - <listitem> - <para>Sets the "priority" of sending packets on this interface. - Each port in a bridge may have a different priority which is used - to decide which link to use. Lower value means higher priority. - It is an integer value between 0 to 63. Networkd does not set any - default, meaning the kernel default value of 32 is used.</para> - - <xi:include href="version-info.xml" xpointer="v234"/> - </listitem> - </varlistentry> - </variablelist> + <para>The [Bridge] section accepts the following keys:</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>UnicastFlood=</varname></term> + <listitem> + <para>Takes a boolean. Controls whether the bridge should flood + traffic for which an FDB entry is missing and the destination + is unknown through this port. When unset, the kernel's default will be used. + </para> + + <xi:include href="version-info.xml" xpointer="v223"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>MulticastFlood=</varname></term> + <listitem> + <para>Takes a boolean. Controls whether the bridge should flood + traffic for which an MDB entry is missing and the destination + is unknown through this port. When unset, the kernel's default will be used. + </para> + + <xi:include href="version-info.xml" xpointer="v242"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>MulticastToUnicast=</varname></term> + <listitem> + <para>Takes a boolean. Multicast to unicast works on top of the multicast snooping feature of + the bridge. Which means unicast copies are only delivered to hosts which are interested in it. + When unset, the kernel's default will be used. + </para> + + <xi:include href="version-info.xml" xpointer="v240"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>NeighborSuppression=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether ARP and ND neighbor suppression is enabled for + this port. When unset, the kernel's default will be used. + </para> + + <xi:include href="version-info.xml" xpointer="v242"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Learning=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether MAC address learning is enabled for + this port. When unset, the kernel's default will be used. + </para> + + <xi:include href="version-info.xml" xpointer="v242"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>HairPin=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether traffic may be sent back out of the port on which it + was received. When this flag is false, then the bridge will not forward traffic back out of the + receiving port. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v223"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Isolated=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether this port is isolated or not. Within a bridge, + isolated ports can only communicate with non-isolated ports. When set to true, this port can only + communicate with other ports whose Isolated setting is false. When set to false, this port + can communicate with any other ports. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v251"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>UseBPDU=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether STP Bridge Protocol Data Units will be + processed by the bridge port. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v223"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>FastLeave=</varname></term> + <listitem> + <para>Takes a boolean. This flag allows the bridge to immediately stop multicast + traffic on a port that receives an IGMP Leave message. It is only used with + IGMP snooping if enabled on the bridge. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v223"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>AllowPortToBeRoot=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether a given port is allowed to + become a root port. Only used when STP is enabled on the bridge. + When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v223"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ProxyARP=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port. + When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v243"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ProxyARPWiFi=</varname></term> + <listitem> + <para>Takes a boolean. Configures whether proxy ARP to be enabled on this port + which meets extended requirements by IEEE 802.11 and Hotspot 2.0 specifications. + When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v243"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>MulticastRouter=</varname></term> + <listitem> + <para>Configures this port for having multicast routers attached. A port with a multicast + router will receive all multicast traffic. Takes one of <literal>no</literal> + to disable multicast routers on this port, <literal>query</literal> to let the system detect + the presence of routers, <literal>permanent</literal> to permanently enable multicast traffic + forwarding on this port, or <literal>temporary</literal> to enable multicast routers temporarily + on this port, not depending on incoming queries. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v243"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Cost=</varname></term> + <listitem> + <para>Sets the "cost" of sending packets of this interface. + Each port in a bridge may have a different speed and the cost + is used to decide which link to use. Faster interfaces + should have lower costs. It is an integer value between 1 and + 65535.</para> + + <xi:include href="version-info.xml" xpointer="v218"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Priority=</varname></term> + <listitem> + <para>Sets the "priority" of sending packets on this interface. + Each port in a bridge may have a different priority which is used + to decide which link to use. Lower value means higher priority. + It is an integer value between 0 to 63. Networkd does not set any + default, meaning the kernel default value of 32 is used.</para> + + <xi:include href="version-info.xml" xpointer="v234"/> + </listitem> + </varlistentry> + </variablelist> </refsect1> + <refsect1> <title>[BridgeFDB] Section Options</title> - <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following - keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para> - <variablelist class='network-directives'> - <varlistentry> - <term><varname>MACAddress=</varname></term> - <listitem> - <para>As in the [Network] section. This key is mandatory.</para> + <para>The [BridgeFDB] section manages the forwarding database table of a port and accepts the following + keys. Specify several [BridgeFDB] sections to configure several static MAC table entries.</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>MACAddress=</varname></term> + <listitem> + <para>As in the [Network] section. This key is mandatory.</para> <xi:include href="version-info.xml" xpointer="v219"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Destination=</varname></term> - <listitem> - <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Destination=</varname></term> + <listitem> + <para>Takes an IP address of the destination VXLAN tunnel endpoint.</para> <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>VLANId=</varname></term> - <listitem> - <para>The VLAN ID for the new static MAC table entry. If - omitted, no VLAN ID information is appended to the new static MAC - table entry.</para> - - <xi:include href="version-info.xml" xpointer="v219"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>VNI=</varname></term> - <listitem> - <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to - the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215. - Defaults to unset.</para> - - <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>AssociatedWith=</varname></term> - <listitem> - <para>Specifies where the address is associated with. Takes one of <literal>use</literal>, - <literal>self</literal>, <literal>master</literal> or <literal>router</literal>. - <literal>use</literal> means the address is in use. User space can use this option to - indicate to the kernel that the fdb entry is in use. <literal>self</literal> means - the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal> - means the address is associated with master devices fdb. <literal>router</literal> means - the destination address is associated with a router. Note that it's valid if the referenced - device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>VLANId=</varname></term> + <listitem> + <para>The VLAN ID for the new static MAC table entry. If + omitted, no VLAN ID information is appended to the new static MAC + table entry.</para> + + <xi:include href="version-info.xml" xpointer="v219"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>VNI=</varname></term> + <listitem> + <para>The VXLAN Network Identifier (or VXLAN Segment ID) to use to connect to + the remote VXLAN tunnel endpoint. Takes a number in the range 1…16777215. + Defaults to unset.</para> <xi:include href="version-info.xml" xpointer="v243"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>OutgoingInterface=</varname></term> - <listitem> - <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to - reach the remote VXLAN tunnel endpoint. Defaults to unset.</para> - - <xi:include href="version-info.xml" xpointer="v249"/> - </listitem> - </varlistentry> - </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>AssociatedWith=</varname></term> + <listitem> + <para>Specifies where the address is associated with. Takes one of <literal>use</literal>, + <literal>self</literal>, <literal>master</literal> or <literal>router</literal>. + <literal>use</literal> means the address is in use. User space can use this option to + indicate to the kernel that the fdb entry is in use. <literal>self</literal> means + the address is associated with the port drivers fdb. Usually hardware. <literal>master</literal> + means the address is associated with master devices fdb. <literal>router</literal> means + the destination address is associated with a router. Note that it's valid if the referenced + device is a VXLAN type device and has route shortcircuit enabled. Defaults to <literal>self</literal>.</para> + + <xi:include href="version-info.xml" xpointer="v243"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>OutgoingInterface=</varname></term> + <listitem> + <para>Specifies the name or index of the outgoing interface for the VXLAN device driver to + reach the remote VXLAN tunnel endpoint. Defaults to unset.</para> + + <xi:include href="version-info.xml" xpointer="v249"/> + </listitem> + </varlistentry> + </variablelist> </refsect1> + <refsect1> <title>[BridgeMDB] Section Options</title> - <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following - keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para> + <para>The [BridgeMDB] section manages the multicast membership entries forwarding database table of a port and accepts the following + keys. Specify several [BridgeMDB] sections to configure several permanent multicast membership entries.</para> - <variablelist class='network-directives'> - <varlistentry> - <term><varname>MulticastGroupAddress=</varname></term> - <listitem> - <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para> + <variablelist class='network-directives'> + <varlistentry> + <term><varname>MulticastGroupAddress=</varname></term> + <listitem> + <para>Specifies the IPv4 or IPv6 multicast group address to add. This setting is mandatory.</para> <xi:include href="version-info.xml" xpointer="v247"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>VLANId=</varname></term> - <listitem> - <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>VLANId=</varname></term> + <listitem> + <para>The VLAN ID for the new entry. Valid ranges are 0 (no VLAN) to 4094. Optional, defaults to 0.</para> <xi:include href="version-info.xml" xpointer="v247"/> - </listitem> - </varlistentry> - </variablelist> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> <title>[LLDP] Section Options</title> - <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following - keys:</para> - <variablelist class='network-directives'> - <varlistentry> - <term><varname>MUDURL=</varname></term> - <listitem> - <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in - LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the - [DHCPv4] section described above.</para> - - <para>The MUD URLs received via LLDP packets are saved and can be read using the - <function>sd_lldp_neighbor_get_mud_url()</function> function.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - </variablelist> + <para>The [LLDP] section manages the Link Layer Discovery Protocol (LLDP) and accepts the following + keys:</para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>MUDURL=</varname></term> + <listitem> + <para>When configured, the specified Manufacturer Usage Descriptions (MUD) URL will be sent in + LLDP packets. The syntax and semantics are the same as for <varname>MUDURL=</varname> in the + [DHCPv4] section described above.</para> + + <para>The MUD URLs received via LLDP packets are saved and can be read using the + <function>sd_lldp_neighbor_get_mud_url()</function> function.</para> + + <xi:include href="version-info.xml" xpointer="v246"/> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> <title>[CAN] Section Options</title> - <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the - following keys:</para> - <variablelist class='network-directives'> - <varlistentry> - <term><varname>BitRate=</varname></term> - <listitem> - <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can - be used here. Takes a number in the range 1…4294967295.</para> - - <xi:include href="version-info.xml" xpointer="v239"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>SamplePoint=</varname></term> - <listitem> - <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>, - <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when - <varname>BitRate=</varname> is unspecified.</para> + <para>The [CAN] section manages the Controller Area Network (CAN bus) and accepts the + following keys:</para> + <variablelist class='network-directives'> + <varlistentry> + <term><varname>BitRate=</varname></term> + <listitem> + <para>The bitrate of CAN device in bits per second. The usual SI prefixes (K, M) with the base of 1000 can + be used here. Takes a number in the range 1…4294967295.</para> + + <xi:include href="version-info.xml" xpointer="v239"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>SamplePoint=</varname></term> + <listitem> + <para>Optional sample point in percent with one decimal (e.g. <literal>75%</literal>, + <literal>87.5%</literal>) or permille (e.g. <literal>875‰</literal>). This will be ignored when + <varname>BitRate=</varname> is unspecified.</para> <xi:include href="version-info.xml" xpointer="v239"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>TimeQuantaNSec=</varname></term> - <term><varname>PropagationSegment=</varname></term> - <term><varname>PhaseBufferSegment1=</varname></term> - <term><varname>PhaseBufferSegment2=</varname></term> - <term><varname>SyncJumpWidth=</varname></term> - <listitem> - <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the - synchronization jump width, which allow one to define the CAN bit-timing in a hardware - independent format as proposed by the Bosch CAN 2.0 Specification. - <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds. - <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>, - <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number - of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned - integer in the range 0…4294967295. These settings except for - <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is - specified.</para> - - <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>DataBitRate=</varname></term> - <term><varname>DataSamplePoint=</varname></term> - <listitem> - <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are - analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>DataTimeQuantaNSec=</varname></term> - <term><varname>DataPropagationSegment=</varname></term> - <term><varname>DataPhaseBufferSegment1=</varname></term> - <term><varname>DataPhaseBufferSegment2=</varname></term> - <term><varname>DataSyncJumpWidth=</varname></term> - <listitem> - <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the - synchronization jump width for the data phase, if CAN-FD is used. These settings are - analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para> - - <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>FDMode=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface. - Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using - the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or - <varname>DataTimeQuanta=</varname> and related settings.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>TimeQuantaNSec=</varname></term> + <term><varname>PropagationSegment=</varname></term> + <term><varname>PhaseBufferSegment1=</varname></term> + <term><varname>PhaseBufferSegment2=</varname></term> + <term><varname>SyncJumpWidth=</varname></term> + <listitem> + <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the + synchronization jump width, which allow one to define the CAN bit-timing in a hardware + independent format as proposed by the Bosch CAN 2.0 Specification. + <varname>TimeQuantaNSec=</varname> takes a timespan in nanoseconds. + <varname>PropagationSegment=</varname>, <varname>PhaseBufferSegment1=</varname>, + <varname>PhaseBufferSegment2=</varname>, and <varname>SyncJumpWidth=</varname> take number + of time quantum specified in <varname>TimeQuantaNSec=</varname> and must be an unsigned + integer in the range 0…4294967295. These settings except for + <varname>SyncJumpWidth=</varname> will be ignored when <varname>BitRate=</varname> is + specified.</para> + + <xi:include href="version-info.xml" xpointer="v250"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>DataBitRate=</varname></term> + <term><varname>DataSamplePoint=</varname></term> + <listitem> + <para>The bitrate and sample point for the data phase, if CAN-FD is used. These settings are + analogous to the <varname>BitRate=</varname> and <varname>SamplePoint=</varname> keys.</para> <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>FDNonISO=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the - interface. When unset, the kernel's default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>DataTimeQuantaNSec=</varname></term> + <term><varname>DataPropagationSegment=</varname></term> + <term><varname>DataPhaseBufferSegment1=</varname></term> + <term><varname>DataPhaseBufferSegment2=</varname></term> + <term><varname>DataSyncJumpWidth=</varname></term> + <listitem> + <para>Specifies the time quanta, propagation segment, phase buffer segment 1 and 2, and the + synchronization jump width for the data phase, if CAN-FD is used. These settings are + analogous to the <varname>TimeQuantaNSec=</varname> or related settings.</para> + + <xi:include href="version-info.xml" xpointer="v250"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>FDMode=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, CAN-FD mode is enabled for the interface. + Note, that a bitrate and optional sample point should also be set for the CAN-FD data phase using + the <varname>DataBitRate=</varname> and <varname>DataSamplePoint=</varname> keys, or + <varname>DataTimeQuanta=</varname> and related settings.</para> + + <xi:include href="version-info.xml" xpointer="v246"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>FDNonISO=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, non-ISO CAN-FD mode is enabled for the + interface. When unset, the kernel's default will be used.</para> + + <xi:include href="version-info.xml" xpointer="v246"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>RestartSec=</varname></term> + <listitem> + <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be + triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can + be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or + <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the + automatic restart off. By default automatic restart is disabled.</para> + + <xi:include href="version-info.xml" xpointer="v239"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Termination=</varname></term> + <listitem> + <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When + <literal>yes</literal>, the termination resistor is set to 120 ohm. When + <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled. + When unset, the kernel's default will be used.</para> <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>RestartSec=</varname></term> - <listitem> - <para>Automatic restart delay time. If set to a non-zero value, a restart of the CAN controller will be - triggered automatically in case of a bus-off condition after the specified delay time. Subsecond delays can - be specified using decimals (e.g. <literal>0.1s</literal>) or a <literal>ms</literal> or - <literal>us</literal> postfix. Using <literal>infinity</literal> or <literal>0</literal> will turn the - automatic restart off. By default automatic restart is disabled.</para> - - <xi:include href="version-info.xml" xpointer="v239"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Termination=</varname></term> - <listitem> - <para>Takes a boolean or a termination resistor value in ohm in the range 0…65535. When - <literal>yes</literal>, the termination resistor is set to 120 ohm. When - <literal>no</literal> or <literal>0</literal> is set, the termination resistor is disabled. - When unset, the kernel's default will be used.</para> - - <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>TripleSampling=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine - the value of a received bit by majority rule. When unset, the kernel's default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>TripleSampling=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, three samples (instead of one) are used to determine + the value of a received bit by majority rule. When unset, the kernel's default will be used.</para> <xi:include href="version-info.xml" xpointer="v242"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>BusErrorReporting=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated - (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, - unable to send recessive bit, bus overload, active error announcement, error occurred on - transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a - single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>BusErrorReporting=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, reporting of CAN bus errors is activated + (those include single bit, frame format, and bit stuffing errors, unable to send dominant bit, + unable to send recessive bit, bus overload, active error announcement, error occurred on + transmission). When unset, the kernel's default will be used. Note: in case of a CAN bus with a + single CAN device, sending a CAN frame may result in a huge number of CAN bus errors.</para> <xi:include href="version-info.xml" xpointer="v248"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>ListenOnly=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the - interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK - bit. Listen-only mode is important to debug CAN networks without interfering with the - communication or acknowledge the CAN frame. When unset, the kernel's default will be used. - </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ListenOnly=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, listen-only mode is enabled. When the + interface is in listen-only mode, the interface neither transmit CAN frames nor send ACK + bit. Listen-only mode is important to debug CAN networks without interfering with the + communication or acknowledge the CAN frame. When unset, the kernel's default will be used. + </para> <xi:include href="version-info.xml" xpointer="v246"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>Loopback=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the - loopback mode is enabled, the interface treats messages transmitted by itself as received - messages. The loopback mode is important to debug CAN networks. When unset, the kernel's - default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>Loopback=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, loopback mode is enabled. When the + loopback mode is enabled, the interface treats messages transmitted by itself as received + messages. The loopback mode is important to debug CAN networks. When unset, the kernel's + default will be used.</para> <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>OneShot=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset, - the kernel's default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>OneShot=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, one-shot mode is enabled. When unset, + the kernel's default will be used.</para> <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>PresumeAck=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN - ACKs. When unset, the kernel's default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>PresumeAck=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, the interface will ignore missing CAN + ACKs. When unset, the kernel's default will be used.</para> <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>ClassicDataLengthCode=</varname></term> - <listitem> - <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data - length code (DLC). When unset, the kernel's default will be used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ClassicDataLengthCode=</varname></term> + <listitem> + <para>Takes a boolean. When <literal>yes</literal>, the interface will handle the 4bit data + length code (DLC). When unset, the kernel's default will be used.</para> <xi:include href="version-info.xml" xpointer="v250"/> - </listitem> - </varlistentry> - </variablelist> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> <title>[IPoIB] Section Options</title> - <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para> - <variablelist class='network-directives'> - <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" /> - <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" /> - </variablelist> + <para>The [IPoIB] section manages the IP over Infiniband and accepts the following keys:</para> + + <variablelist class='network-directives'> + <xi:include href="systemd.netdev.xml" xpointer="ipoib_mode" /> + <xi:include href="systemd.netdev.xml" xpointer="ipoib_umcast" /> + </variablelist> </refsect1> <refsect1> @@ -4599,7 +4798,7 @@ ServerAddress=192.168.0.1/24</programlisting> <para>Specifies the parent Queueing Discipline (qdisc). Takes one of <literal>clsact</literal> or <literal>ingress</literal>. This is mandatory.</para> - <xi:include href="version-info.xml" xpointer="v244"/> + <xi:include href="version-info.xml" xpointer="v244"/> </listitem> </varlistentry> @@ -5855,42 +6054,54 @@ ServerAddress=192.168.0.1/24</programlisting> <refsect1> <title>[BridgeVLAN] Section Options</title> - <para>The [BridgeVLAN] section manages the VLAN ID configuration of a bridge port and accepts the - following keys. Specify several [BridgeVLAN] sections to configure several VLAN entries. The - <varname>VLANFiltering=</varname> option has to be enabled, see the [Bridge] section in - <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> - - <variablelist class='network-directives'> - <varlistentry> - <term><varname>VLAN=</varname></term> - <listitem> - <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes - an integer in the range 1…4094.</para> - - <xi:include href="version-info.xml" xpointer="v231"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>EgressUntagged=</varname></term> - <listitem> - <para>The VLAN ID specified here will be used to untag frames on egress. Configuring - <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will enable the - VLAN ID for ingress as well. This can be either a single ID or a range M-N.</para> - - <xi:include href="version-info.xml" xpointer="v231"/> - </listitem> - </varlistentry> - <varlistentry> - <term><varname>PVID=</varname></term> - <listitem> - <para>The Port VLAN ID specified here is assigned to all untagged frames at ingress. - <varname>PVID=</varname> can be used only once. Configuring <varname>PVID=</varname> implicates the use of - <varname>VLAN=</varname> above and will enable the VLAN ID for ingress as well.</para> - - <xi:include href="version-info.xml" xpointer="v231"/> - </listitem> - </varlistentry> - </variablelist> + <para> + The [BridgeVLAN] section manages the VLAN ID configurations of a bridge master or port, and accepts the + following keys. To make the settings in this section take an effect, + <varname>VLANFiltering=</varname> option has to be enabled on the bridge master, see the [Bridge] + section in + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + If at least one valid settings specified in this section in a .network file for an interface, all + assigned VLAN IDs on the interface that are not configured in the .network file will be removed. If + VLAN IDs on an interface need to be managed by other tools, then the settings in this section cannot + be used in the matching .network file. + </para> + + <variablelist class='network-directives'> + <varlistentry> + <term><varname>VLAN=</varname></term> + <listitem> + <para>The VLAN ID allowed on the port. This can be either a single ID or a range M-N. Takes an + integer in the range 1…4094. This setting can be specified multiple times. If an empty string is + assigned, then the all previous assignments are cleared.</para> + + <xi:include href="version-info.xml" xpointer="v231"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>EgressUntagged=</varname></term> + <listitem> + <para>The VLAN ID specified here will be used to untag frames on egress. Configuring + <varname>EgressUntagged=</varname> implicates the use of <varname>VLAN=</varname> above and will + enable the VLAN ID for ingress as well. This can be either a single ID or a range M-N. This + setting can be specified multiple times. If an empty string is assigned, then the all previous + assignments are cleared.</para> + + <xi:include href="version-info.xml" xpointer="v231"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>PVID=</varname></term> + <listitem> + <para>The port VLAN ID specified here is assigned to all untagged frames at ingress. Takes an + VLAN ID or negative boolean value (e.g. <literal>no</literal>). When false, the currently + assigned port VLAN ID will be dropped. Configuring <varname>PVID=</varname> implicates the use of + <varname>VLAN=</varname> setting in the above and will enable the VLAN ID for ingress as well. + Defaults to unset, and will keep the assigned port VLAN ID if exists.</para> + + <xi:include href="version-info.xml" xpointer="v231"/> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1> @@ -6217,14 +6428,14 @@ Xfrm=xfrm0</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-resolved.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.nspawn.xml b/man/systemd.nspawn.xml index 7980619..591933a 100644 --- a/man/systemd.nspawn.xml +++ b/man/systemd.nspawn.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -24,9 +24,11 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/nspawn/<replaceable>machine</replaceable>.nspawn</filename></para> - <para><filename>/run/systemd/nspawn/<replaceable>machine</replaceable>.nspawn</filename></para> - <para><filename>/var/lib/machines/<replaceable>machine</replaceable>.nspawn</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/nspawn/<replaceable>machine</replaceable>.nspawn</filename></member> + <member><filename>/run/systemd/nspawn/<replaceable>machine</replaceable>.nspawn</filename></member> + <member><filename>/var/lib/machines/<replaceable>machine</replaceable>.nspawn</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -675,11 +677,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.offline-updates.xml b/man/systemd.offline-updates.xml index 7285f9e..0195022 100644 --- a/man/systemd.offline-updates.xml +++ b/man/systemd.offline-updates.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.offline-updates"> @@ -157,13 +157,13 @@ </refsect1> <refsect1> - <title>See also</title> - - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>dnf.plugin.system-upgrade</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <title>See Also</title> + + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system-update-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>dnf.plugin.system-upgrade</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.path.xml b/man/systemd.path.xml index 7037465..6281c3d 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.path" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -214,14 +214,14 @@ section <literal>Environment Variables Set or Propagated by the Service Manager</literal> in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more details.</para> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>inotify</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.pcrlock.xml b/man/systemd.pcrlock.xml index ec08ffd..6f07dc8 100644 --- a/man/systemd.pcrlock.xml +++ b/man/systemd.pcrlock.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <refentry id="systemd.pcrlock" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -21,17 +21,18 @@ </refnamediv> <refsynopsisdiv> - <para><literallayout> -<filename>/etc/pcrlock.d/*.pcrlock</filename> -<filename>/etc/pcrlock.d/*.pcrlock.d/*.pcrlock</filename> -<filename>/run/pcrlock.d/*.pcrlock</filename> -<filename>/run/pcrlock.d/*.pcrlock.d/*.pcrlock</filename> -<filename>/var/lib/pcrlock.d/*.pcrlock</filename> -<filename>/var/lib/pcrlock.d/*.pcrlock.d/*.pcrlock</filename> -<filename>/usr/local/pcrlock.d/*.pcrlock</filename> -<filename>/usr/local/pcrlock.d/*.pcrlock.d/*.pcrlock</filename> -<filename>/usr/lib/pcrlock.d/*.pcrlock</filename> -<filename>/usr/lib/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></literallayout></para> + <para><simplelist> + <member><filename>/etc/pcrlock.d/*.pcrlock</filename></member> + <member><filename>/etc/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></member> + <member><filename>/run/pcrlock.d/*.pcrlock</filename></member> + <member><filename>/run/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></member> + <member><filename>/var/lib/pcrlock.d/*.pcrlock</filename></member> + <member><filename>/var/lib/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></member> + <member><filename>/usr/local/pcrlock.d/*.pcrlock</filename></member> + <member><filename>/usr/local/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></member> + <member><filename>/usr/lib/pcrlock.d/*.pcrlock</filename></member> + <member><filename>/usr/lib/pcrlock.d/*.pcrlock.d/*.pcrlock</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -42,7 +43,7 @@ process. <citerefentry><refentrytitle>systemd-pcrlock</refentrytitle><manvolnum>1</manvolnum></citerefentry> uses such pcrlock files to analyze and predict TPM2 PCR measurements. The pcrlock files are JSON arrays that follow a subset of the <ulink - url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Common Event Log Format + url="https://trustedcomputinggroup.org/resource/canonical-event-log-format/">TCG Canonical Event Log Format (CEL-JSON)</ulink> specification. Specifically the <literal>recnum</literal>, <literal>content</literal>, and <literal>content_type</literal> record fields are not used and ignored if present. Each pcrlock file defines one set of expected, ordered PCR measurements of a specific component of the boot.</para> @@ -289,10 +290,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrlock</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrlock</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.preset.xml b/man/systemd.preset.xml index 5d46a88..dcc740a 100644 --- a/man/systemd.preset.xml +++ b/man/systemd.preset.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.preset"> @@ -21,12 +21,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/system-preset/*.preset</filename></para> - <para><filename>/run/systemd/system-preset/*.preset</filename></para> - <para><filename>/usr/lib/systemd/system-preset/*.preset</filename></para> - <para><filename>/etc/systemd/user-preset/*.preset</filename></para> - <para><filename>/run/systemd/user-preset/*.preset</filename></para> - <para><filename>/usr/lib/systemd/user-preset/*.preset</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/system-preset/*.preset</filename></member> + <member><filename>/run/systemd/system-preset/*.preset</filename></member> + <member><filename>/usr/local/lib/systemd/system-preset/*.preset</filename></member> + <member><filename>/usr/lib/systemd/system-preset/*.preset</filename></member> + <member><filename>/etc/systemd/user-preset/*.preset</filename></member> + <member><filename>/run/systemd/user-preset/*.preset</filename></member> + <member><filename>/usr/local/lib/systemd/user-preset/*.preset</filename></member> + <member><filename>/usr/lib/systemd/user-preset/*.preset</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -39,7 +43,7 @@ <command>systemctl preset</command> is used by the post install scriptlets of rpm packages (or other OS package formats), to enable/disable specific units by default on package installation, enforcing - distribution, spin or administrator preset policy. This allows choosing a certain set of units to be + distribution, spin, or administrator preset policy. This allows choosing a certain set of units to be enabled/disabled even before installing the actual package. For more information, see <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> @@ -54,7 +58,9 @@ <para>When the machine is booted for the first time, <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> will enable/disable all units according to preset policy, similarly to <command>systemctl - preset-all</command>. Also see "First Boot Semantics" in + preset-all</command>. Also see <varname>ConditionFirstBoot=</varname> in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> and + "First Boot Semantics" in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para> </refsect1> @@ -205,11 +211,11 @@ disable *</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> <para><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry> has a discussion of packaging scriptlets.</para> diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index 5c61b74..3773a38 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.resource-control" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -151,10 +151,13 @@ CPUWeight=20 DisableControllers=cpu / \ applies to all user slices.</para> </refsect2> - <para>See the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New - Control Group Interfaces</ulink> for an introduction on how to make - use of resource control APIs from programs.</para> + <refsect2> + <title/> + <para>See the <ulink + url="https://systemd.io/CONTROL_GROUP_INTERFACE">New + Control Group Interfaces</ulink> for an introduction on how to make + use of resource control APIs from programs.</para> + </refsect2> </refsect1> <refsect1> @@ -406,7 +409,9 @@ CPUWeight=20 DisableControllers=cpu / \ system. If assigned the special value <literal>infinity</literal>, no memory throttling is applied. This controls the <literal>memory.high</literal> control group attribute. For details about this control group attribute, see - <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para> + <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>. + The effective configuration is reported as <varname>EffectiveMemoryHigh=</varname> + (see also <varname>EffectiveMemoryMax=</varname>).</para> <para>While <varname>StartupMemoryHigh=</varname> applies to the startup and shutdown phases of the system, <varname>MemoryHigh=</varname> applies to normal runtime of the system, and if the former is not set also to @@ -434,7 +439,9 @@ CPUWeight=20 DisableControllers=cpu / \ percentage value may be specified, which is taken relative to the installed physical memory on the system. If assigned the special value <literal>infinity</literal>, no memory limit is applied. This controls the <literal>memory.max</literal> control group attribute. For details about this control group attribute, see - <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>.</para> + <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#memory-interface-files">Memory Interface Files</ulink>. + The effective configuration is reported as <varname>EffectiveMemoryMax=</varname> (the value is + the most stringent limit of the unit and parent slices and it is capped by physical memory).</para> <para>While <varname>StartupMemoryMax=</varname> applies to the startup and shutdown phases of the system, <varname>MemoryMax=</varname> applies to normal runtime of the system, and if the former is not set also to @@ -480,7 +487,7 @@ CPUWeight=20 DisableControllers=cpu / \ cache for swap pages. It takes pages that are in the process of being swapped out and attempts to compress them into a dynamically allocated RAM-based memory pool. If the limit specified is hit, no entries from this unit will be stored in the pool until existing entries are faulted back or written out to disk. See the kernel's - <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/mm/zswap.html">Zswap</ulink> documentation for more details.</para> + <ulink url="https://docs.kernel.org/admin-guide/mm/zswap.html">Zswap</ulink> documentation for more details.</para> <para>Takes a size in bytes. If the value is suffixed with K, M, G or T, the specified size is parsed as Kilobytes, Megabytes, Gigabytes, or Terabytes (with the base 1024), respectively. If assigned the @@ -498,6 +505,23 @@ CPUWeight=20 DisableControllers=cpu / \ </varlistentry> <varlistentry> + <term><varname>MemoryZSwapWriteback=</varname></term> + + <listitem> + <para>This setting controls the <option>memory</option> controller in the unified hierarchy.</para> + + <para>Takes a boolean argument. When true, pages stored in the Zswap cache are permitted to be + written to the backing storage, false otherwise. Defaults to true. This allows disabling + writeback of swap pages for IO-intensive applications, while retaining the ability to store + compressed pages in Zswap. See the kernel's + <ulink url="https://docs.kernel.org/admin-guide/mm/zswap.html">Zswap</ulink> documentation + for more details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>AllowedMemoryNodes=</varname></term> <term><varname>StartupAllowedMemoryNodes=</varname></term> @@ -559,8 +583,9 @@ CPUWeight=20 DisableControllers=cpu / \ number of tasks on the system. If assigned the special value <literal>infinity</literal>, no tasks limit is applied. This controls the <literal>pids.max</literal> control group attribute. For details about this control group attribute, the - <ulink url="https://www.kernel.org/doc/html/latest/admin-guide/cgroup-v2.html#pid">pids controller - </ulink>.</para> + <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html#pid">pids controller + </ulink>. + The effective configuration is reported as <varname>EffectiveTasksMax=</varname>.</para> <para>The system default for this setting may be controlled with <varname>DefaultTasksMax=</varname> in @@ -1100,6 +1125,7 @@ NFTSet=cgroup:inet:filter:my_service user:inet:filter:serviceuser } }</programlisting> </para> + <xi:include href="system-only.xml" xpointer="singular"/> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> @@ -1666,22 +1692,22 @@ DeviceAllow=/dev/loop-control <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - The documentation for control groups and specific controllers in the Linux kernel: - <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink>. - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-oomd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member>The documentation for control groups and specific controllers in the Linux kernel: + <ulink url="https://docs.kernel.org/admin-guide/cgroup-v2.html">Control Groups v2</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.scope.xml b/man/systemd.scope.xml index ae9bc2b..9590a19 100644 --- a/man/systemd.scope.xml +++ b/man/systemd.scope.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.scope" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -42,7 +42,7 @@ command line.</para> <para>See the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New + url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group Interfaces</ulink> for an introduction on how to make use of scope units from programs.</para> @@ -105,7 +105,13 @@ of scope units are the following:</para> <variablelist class='unit-directives'> - <xi:include href="systemd.service.xml" xpointer="oom-policy" /> + <varlistentry id='oom-policy'> + <term><varname>OOMPolicy=</varname></term> + <listitem> + <xi:include href="systemd.service.xml" xpointer="xpointer(//varlistentry[@id='oom-policy']/listitem/para[position() < last()])" /> + <xi:include href="version-info.xml" xpointer="v253"/> + </listitem> + </varlistentry> <varlistentry> <term><varname>RuntimeMaxSec=</varname></term> @@ -134,14 +140,14 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>. - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 86d7108..58439df 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.service" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -992,16 +992,22 @@ <listitem><para>Takes a list of exit status definitions that, when returned by the main service process, will prevent automatic service restarts, regardless of the restart setting configured with - <varname>Restart=</varname>. Exit status definitions can either be numeric exit codes or termination - signal names, and are separated by spaces. Defaults to the empty list, so that, by default, no exit - status is excluded from the configured restart logic. For example: + <varname>Restart=</varname>. Exit status definitions can be numeric termination statuses, termination + status names, or termination signal names, separated by spaces. Defaults to the empty list, so that, + by default, no exit status is excluded from the configured restart logic. - <programlisting>RestartPreventExitStatus=1 6 SIGABRT</programlisting> + <example> + <title>A service with the <varname>RestartPreventExitStatus=</varname> setting</title> + + <programlisting>RestartPreventExitStatus=TEMPFAIL 250 SIGKILL</programlisting> + + <para>Exit status 75 (<constant>TEMPFAIL</constant>), 250, and the termination signal + <constant>SIGKILL</constant> will not result in automatic service restarting.</para> + </example> - ensures that exit codes 1 and 6 and the termination signal <constant>SIGABRT</constant> will not - result in automatic service restarting. This option may appear more than once, in which case the list - of restart-preventing statuses is merged. If the empty string is assigned to this option, the list is - reset and all prior assignments of this option will have no effect.</para> + This option may appear more than once, in which case the list of restart-preventing statuses is merged. + If the empty string is assigned to this option, the list is reset and all prior assignments of this + option will have no effect.</para> <para>Note that this setting has no effect on processes configured via <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecStop=</varname>, @@ -1015,12 +1021,15 @@ <varlistentry> <term><varname>RestartForceExitStatus=</varname></term> - <listitem><para>Takes a list of exit status definitions that, - when returned by the main service process, will force automatic - service restarts, regardless of the restart setting configured - with <varname>Restart=</varname>. The argument format is - similar to - <varname>RestartPreventExitStatus=</varname>.</para> + + <listitem><para>Takes a list of exit status definitions that, when returned by the main service + process, will force automatic service restarts, regardless of the restart setting configured with + <varname>Restart=</varname>. The argument format is similar to <varname>RestartPreventExitStatus=</varname>. + </para> + + <para>Note that for <varname>Type=oneshot</varname> services, a success exit status will prevent + them from auto-restarting, no matter whether the corresponding exit statuses are listed in this + option or not.</para> <xi:include href="version-info.xml" xpointer="v215"/></listitem> </varlistentry> @@ -1313,8 +1322,9 @@ <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecReload=</varname>, - <varname>ExecStop=</varname>, and - <varname>ExecStopPost=</varname> options.</para> + <varname>ExecStop=</varname>, + <varname>ExecStopPost=</varname>, and + <varname>ExecCondition=</varname> options.</para> <para>Multiple command lines may be concatenated in a single directive by separating them with semicolons (these semicolons must be passed as separate words). Lone semicolons may be escaped as @@ -1752,17 +1762,17 @@ WantedBy=multi-user.target</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.slice.xml b/man/systemd.slice.xml index 5e61199..a5987a3 100644 --- a/man/systemd.slice.xml +++ b/man/systemd.slice.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.slice"> @@ -63,7 +63,7 @@ </para> <para>See the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/ControlGroupInterface">New + url="https://systemd.io/CONTROL_GROUP_INTERFACE">New Control Group Interfaces</ulink> for an introduction on how to make use of slice units from programs.</para> </refsect1> @@ -102,21 +102,24 @@ <title>Options</title> <para>Slice unit files may include [Unit] and [Install] sections, which are described in - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - No options specific to this file type are supported.</para> + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <para>Slice files may include a [Slice] section. Options that may be used in this section are shared with other unit types. + These options are documented in + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index 73c8c5b..a944efa 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.socket" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -167,9 +167,9 @@ information about the socket or FIFO it supervises. A number of options that may be used in this section are shared with other unit types. These options are documented in - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> - and - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The options specific to the [Socket] section of socket units are the following:</para> @@ -221,7 +221,9 @@ <replaceable>x</replaceable> on a port <replaceable>y</replaceable> address in the <constant>AF_VSOCK</constant> family. The CID is a unique 32-bit integer identifier in <constant>AF_VSOCK</constant> analogous to an IP address. Specifying the CID is optional, and may be - set to the empty string.</para> + set to the empty string. <literal>vsock</literal> may be replaced with + <literal>vsock-stream</literal>, <literal>vsock-dgram</literal> or <literal>vsock-seqpacket</literal> + to force usage of the corresponding socket type.</para> <para>Note that <constant>SOCK_SEQPACKET</constant> (i.e. <varname>ListenSequentialPacket=</varname>) is only available @@ -458,21 +460,18 @@ <varlistentry> <term><varname>MaxConnections=</varname></term> - <listitem><para>The maximum number of connections to - simultaneously run services instances for, when - <option>Accept=yes</option> is set. If more concurrent - connections are coming in, they will be refused until at least - one existing connection is terminated. This setting has no - effect on sockets configured with - <option>Accept=no</option> or datagram sockets. Defaults to - 64.</para></listitem> + <listitem><para>The maximum number of connections to simultaneously run services instances for, when + <option>Accept=yes</option> is set. If more concurrent connections are coming in, they will be refused + until at least one existing connection is terminated. This setting has no effect on sockets configured + with <option>Accept=no</option> or datagram sockets. Defaults to 64.</para></listitem> </varlistentry> <varlistentry> <term><varname>MaxConnectionsPerSource=</varname></term> - <listitem><para>The maximum number of connections for a service per source IP address. - This is very similar to the <varname>MaxConnections=</varname> directive - above. Disabled by default.</para> + <listitem><para>The maximum number of connections for a service per source IP address (in case of + IPv4/IPv6), per source CID (in case of <constant>AF_VSOCK</constant>), or source UID (in case of + <constant>AF_UNIX</constant>). This is very similar to the <varname>MaxConnections=</varname> + directive above. Defaults to 0, i.e. disabled.</para> <xi:include href="version-info.xml" xpointer="v232"/> </listitem> @@ -919,6 +918,20 @@ <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> + <varlistentry> + <term><varname>PassFileDescriptorsToExec=</varname></term> + + <listitem><para>Takes a boolean argument. Defaults to off. If enabled, file descriptors created by + the socket unit are passed to <varname>ExecStartPost=</varname>, <varname>ExecStopPre=</varname>, and + <varname>ExecStopPost=</varname> commands from the socket unit. The passed file descriptors can be + accessed with + <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry> as + if the commands were invoked from the associated service units. Note that + <varname>ExecStartPre=</varname> command cannot access socket file descriptors.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + </variablelist> <xi:include href="systemd.service.xml" xpointer="shared-unit-options" /> @@ -926,25 +939,27 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd_listen_fds_with_names</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> <para> For more extensive descriptions see the "systemd for Developers" series: - <ulink url="https://0pointer.de/blog/projects/socket-activation.html">Socket Activation</ulink>, - <ulink url="https://0pointer.de/blog/projects/socket-activation2.html">Socket Activation, part II</ulink>, - <ulink url="https://0pointer.de/blog/projects/inetd.html">Converting inetd Services</ulink>, - <ulink url="https://0pointer.de/blog/projects/socket-activated-containers.html">Socket Activated Internet Services and OS Containers</ulink>. + <simplelist type="inline"> + <member><ulink url="https://0pointer.de/blog/projects/socket-activation.html">Socket Activation</ulink></member> + <member><ulink url="https://0pointer.de/blog/projects/socket-activation2.html">Socket Activation, part II</ulink></member> + <member><ulink url="https://0pointer.de/blog/projects/inetd.html">Converting inetd Services</ulink></member> + <member><ulink url="https://0pointer.de/blog/projects/socket-activated-containers.html">Socket Activated Internet Services and OS Containers</ulink></member> + </simplelist>. </para> </refsect1> diff --git a/man/systemd.special.xml b/man/systemd.special.xml index 8acad5c..192d097 100644 --- a/man/systemd.special.xml +++ b/man/systemd.special.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.special" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -83,6 +83,7 @@ <filename>sockets.target</filename>, <filename>soft-reboot.target</filename>, <filename>sound.target</filename>, + <filename>ssh-access.target</filename>, <filename>storage-target-mode.target</filename>, <filename>suspend.target</filename>, <filename>swap.target</filename>, @@ -92,12 +93,14 @@ <filename>time-set.target</filename>, <filename>time-sync.target</filename>, <filename>timers.target</filename>, + <filename>tpm2.target</filename>, <filename>umount.target</filename>, <filename>usb-gadget.target</filename>, <!-- slices --><filename>-.slice</filename>, + <filename>capsule.slice</filename>, + <filename>machine.slice</filename>, <filename>system.slice</filename>, <filename>user.slice</filename>, - <filename>machine.slice</filename>, <!-- the rest --><filename>-.mount</filename>, <filename>dbus.service</filename>, <filename>dbus.socket</filename>, @@ -819,7 +822,7 @@ on. All userspace log messages will be made available on this socket. For more information about syslog integration, please consult the <ulink - url="https://www.freedesktop.org/wiki/Software/systemd/syslog">Syslog + url="https://systemd.io/SYSLOG">Syslog Interface</ulink> document.</para> </listitem> </varlistentry> @@ -948,6 +951,24 @@ <xi:include href="version-info.xml" xpointer="v242"/> </listitem> </varlistentry> + <varlistentry> + <term><filename>tpm2.target</filename></term> + <listitem> + <para>This target is started automatically if a TPM2 device is discovered, either by the OS or by + the firmware. It acts as synchronization point for services that require TPM2 device access. The + target unit is enqueued by + <citerefentry><refentrytitle>systemd-tpm2-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> + if it detects that the firmware has discovered a TPM2 device but the OS kernel has not activated + a driver for it yet. It is also pulled in whenever + <citerefentry><refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> + discovers a TPM2 device. The target unit is ordered after the <filename>/dev/tpmrm0</filename> + device node, so that it only becomes active once the TPM2 device is actually accessible. Early + boot programs that intend to access the TPM2 device should hence order themselves after this + target unit, but not pull it in.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect2> @@ -1154,6 +1175,19 @@ </listitem> </varlistentry> <varlistentry> + <term><filename>ssh-access.target</filename></term> + <listitem> + <para>Service and socket units that provide remote SSH secure shell access to the local system + should pull in this unit and order themselves before this unit. It's supposed to act as a + milestone indicating if and when SSH access into the system is available. It should only become + active when an SSH port is bound for remote clients (i.e. if SSH is used as a local privilege + escalation mechanism, it should <emphasis>not</emphasis> involve this target unit), regardless of + the protocol choices, i.e. regardless if IPv4, IPv6 or <constant>AF_VSOCK</constant> is + used.</para> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> <term><filename>time-set.target</filename></term> <listitem> <para>Services responsible for setting the system clock (<constant>CLOCK_REALTIME</constant>) @@ -1272,46 +1306,56 @@ <varlistentry> <term><filename>-.slice</filename></term> <listitem> - <para>The root slice is the root of the slice hierarchy. It usually does not contain - units directly, but may be used to set defaults for the whole tree.</para> + <para>The root slice is the root of the slice hierarchy. It usually does not contain units + directly, but may be used to set defaults for the whole tree.</para> <xi:include href="version-info.xml" xpointer="v206"/> </listitem> </varlistentry> <varlistentry> - <term><filename>system.slice</filename></term> + <term><filename>machine.slice</filename></term> <listitem> - <para>By default, all system services started by - <command>systemd</command> are found in this slice.</para> + <para>By default, all virtual machines and containers registered with + <command>systemd-machined</command> are found in this slice. This is pulled in by + <filename>systemd-machined.service</filename>.</para> <xi:include href="version-info.xml" xpointer="v206"/> </listitem> </varlistentry> <varlistentry> - <term><filename>user.slice</filename></term> + <term><filename>capsule.slice</filename></term> <listitem> - <para>By default, all user processes and services started on - behalf of the user, including the per-user systemd instance - are found in this slice. This is pulled in by - <filename>systemd-logind.service</filename>.</para> + <para>By default, all capsules encapsulated in <filename>capsule@.service</filename> are found in + this slice.</para> + + <xi:include href="version-info.xml" xpointer="v255"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><filename>system.slice</filename></term> + <listitem> + <para>By default, all system services started by <command>systemd</command> are found in this + slice.</para> <xi:include href="version-info.xml" xpointer="v206"/> </listitem> </varlistentry> <varlistentry> - <term><filename>machine.slice</filename></term> + <term><filename>user.slice</filename></term> <listitem> - <para>By default, all virtual machines and containers - registered with <command>systemd-machined</command> are - found in this slice. This is pulled in by - <filename>systemd-machined.service</filename>.</para> + <para>By default, all user processes and services started on + behalf of the user, including the per-user systemd instance + are found in this slice. This is pulled in by + <filename>systemd-logind.service</filename>.</para> <xi:include href="version-info.xml" xpointer="v206"/> </listitem> </varlistentry> + </variablelist> </refsect2> </refsect1> @@ -1329,16 +1373,31 @@ <varlistentry> <term><filename>default.target</filename></term> <listitem> - <para>This is the main target of the user session, started by default. Various services that - compose the normal user session should be pulled into this target. In this regard, - <filename>default.target</filename> is similar to <filename>multi-user.target</filename> in the - system instance, but it is a real unit, not an alias.</para> + <para>This is the main target of the user service manager, started by default when the service + manager is invoked. Various services that compose the normal user session should be pulled into + this target. In this regard, <filename>default.target</filename> is similar to + <filename>multi-user.target</filename> in the system instance, but it is a real unit, not an + alias.</para> <xi:include href="version-info.xml" xpointer="v242"/> </listitem> </varlistentry> </variablelist> + <variablelist> + <varlistentry> + <term><filename>capsule@.target</filename></term> + <listitem> + <para>This is the main target of capsule service managers, started by default, instantiated with + the capsule name. This may be used to define different sets of units that are started for + different capsules via generic unit definitions. For details about capsules see + <citerefentry><refentrytitle>capsule@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v255"/> + </listitem> + </varlistentry> + </variablelist> + <para>In addition, the following units are available which have definitions similar to their system counterparts: <filename>exit.target</filename>, @@ -1497,17 +1556,17 @@ PartOf=graphical-session.target <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>user@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>user@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 1c019b2..f5e3c07 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.swap" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -181,9 +181,9 @@ information about the swap device it supervises. A number of options that may be used in this section are shared with other unit types. These options are documented in - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> - and - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry> and + <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>. The options specific to the [Swap] section of swap units are the following:</para> @@ -191,7 +191,8 @@ <varlistentry> <term><varname>What=</varname></term> - <listitem><para>Takes an absolute path of a device node or file to use for paging. See <citerefentry + <listitem><para>Takes an absolute path or a fstab-style identifier of a device node or file to use + for paging. See <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry> for details. If this refers to a device node, a dependency on the respective device unit is automatically created. (See @@ -250,20 +251,20 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>swapon</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-fstab-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.syntax.xml b/man/systemd.syntax.xml index 2fc2288..1dc4625 100644 --- a/man/systemd.syntax.xml +++ b/man/systemd.syntax.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -89,7 +89,7 @@ file type. When a comment line or lines follow a line ending with a backslash, the comment block is ignored, so the continued line is concatenated with whatever follows the comment block.</para> - <example><programlisting>[Section A] + <informalexample><programlisting>[Section A] KeyOne=value 1 KeyTwo=value 2 @@ -105,7 +105,7 @@ KeyThree=value 3\ # this line is ignored ; this line is ignored too value 3 continued -</programlisting></example> +</programlisting></informalexample> <para>Boolean arguments used in configuration files can be written in various formats. For positive settings the strings diff --git a/man/systemd.system-credentials.xml b/man/systemd.system-credentials.xml index f7f0df1..d9fbae2 100644 --- a/man/systemd.system-credentials.xml +++ b/man/systemd.system-credentials.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.system-credentials" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -138,6 +138,45 @@ </varlistentry> <varlistentry> + <term><varname>network.conf.*</varname></term> + <term><varname>network.link.*</varname></term> + <term><varname>network.netdev.*</varname></term> + <term><varname>network.network.*</varname></term> + <listitem> + <para>Configures network devices. Read by + <citerefentry><refentrytitle>systemd-network-generator.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + These credentials should contain valid + <citerefentry><refentrytitle>networkd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration data. From each matching credential a separate file is created. Example: the contents + of a credential <filename>network.link.50-foobar</filename> will be copied into a file + <filename>50-foobar.link</filename>.</para> + + <para>Note that the resulting files are created world-readable, it's hence recommended to not include + secrets in these credentials, but supply them via separate credentials directly to + <filename>systemd-networkd.service</filename>, e.g. <varname>network.wireguard.*</varname> + as described below.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>network.wireguard.*</varname></term> + <listitem> + <para>Configures secrets for WireGuard netdevs. Read by + <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + For more information, refer to the <option>[WireGuard]</option> section of + <citerefentry><refentrytitle>systemd.netdev</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>passwd.hashed-password.root</varname></term> <term><varname>passwd.plaintext-password.root</varname></term> <listitem> @@ -180,6 +219,17 @@ </varlistentry> <varlistentry> + <term><varname>ssh.listen</varname></term> + <listitem> + <para>May be used to configure SSH sockets the system shall be reachable on. See + <citerefentry><refentrytitle>systemd-ssh-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry> + for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>sysusers.extra</varname></term> <listitem> <para>Additional @@ -248,6 +298,30 @@ </varlistentry> <varlistentry> + <term><varname>journal.forward_to_socket</varname></term> + <listitem> + <para>Used by + <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry> + to determine where to forward log messages for socket forwarding, see + <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>journal.storage</varname></term> + <listitem> + <para>Used by + <citerefentry><refentrytitle>systemd-journald</refentrytitle><manvolnum>8</manvolnum></citerefentry> + to determine where to store journal files, see + <citerefentry><refentrytitle>journald.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>vmm.notify_socket</varname></term> <listitem> <para>Configures an @@ -270,16 +344,87 @@ <xi:include href="version-info.xml" xpointer="v254"/> </listitem> </varlistentry> + + <varlistentry> + <term><varname>system.hostname</varname></term> + <listitem> + <para>Accepts a (transient) hostname to configure during early boot. The static hostname specified + in <filename>/etc/hostname</filename>, if configured, takes precedence over this setting. + Interpreted by the service manager (PID 1). For details see + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v254"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>home.create.*</varname></term> + <listitem> + <para>Creates a home area for the specified user with the user record data passed in. For details see + <citerefentry><refentrytitle>homectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>cryptsetup.passphrase</varname></term> + <term><varname>cryptsetup.tpm2-pin</varname></term> + <term><varname>cryptsetup.fido2-pin</varname></term> + <term><varname>cryptsetup.pkcs11-pin</varname></term> + <term><varname>cryptsetup.luks2-pin</varname></term> + <listitem> + <para>Specifies the passphrase/PINs to use for unlock encrypted storage volumes. For details see + <citerefentry><refentrytitle>systemd-cryptsetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>systemd.extra-unit.*</varname></term> + <term><varname>systemd.unit-dropin.*</varname></term> + + <listitem><para>These credentials specify extra units and drop-ins to add to the system. For details + see <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> + <term><varname>udev.conf.*</varname></term> + <term><varname>udev.rules.*</varname></term> + + <listitem> + <para>Configures udev configuration file and udev rules. Read by + <filename>systemd-udev-load-credentials.service</filename>, which invokes + <command>udevadm control --load-credentials</command>. These credentials directly translate to a + matching + <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> or + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> rules + file. Example: the contents of a credential + <filename>udev.conf.50-foobar</filename> will be copied into a file + <filename>/run/udev/udev.conf.d/50-foobar.conf</filename>, and + <filename>udev.rules.50-foobar</filename> will be copied into a file + <filename>/run/udev/rules.d/50-foobar.rules</filename>. See + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, and + <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> + for details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> </refsect1> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>smbios-type-11</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.target.xml b/man/systemd.target.xml index f650825..37f5857 100644 --- a/man/systemd.target.xml +++ b/man/systemd.target.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.target"> @@ -138,13 +138,13 @@ AllowIsolate=yes</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.time.xml b/man/systemd.time.xml index f6a4550..885c464 100644 --- a/man/systemd.time.xml +++ b/man/systemd.time.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.time"> @@ -317,14 +317,14 @@ Wed..Sat,Tue 12-10-15 1:2:3 → Tue..Sat 2012-10-15 01:02:03 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.timer.xml b/man/systemd.timer.xml index e5af7c0..ad79552 100644 --- a/man/systemd.timer.xml +++ b/man/systemd.timer.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd.timer" xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -401,16 +401,16 @@ <literal>Environment Variables Set or Propagated by the Service Manager</literal> section in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more details.</para> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>prctl</refentrytitle><manvolnum>2</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 301fe77..919e641 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -25,52 +25,60 @@ </refnamediv> <refsynopsisdiv> - <para><filename><replaceable>service</replaceable>.service</filename>, - <filename><replaceable>socket</replaceable>.socket</filename>, - <filename><replaceable>device</replaceable>.device</filename>, - <filename><replaceable>mount</replaceable>.mount</filename>, - <filename><replaceable>automount</replaceable>.automount</filename>, - <filename><replaceable>swap</replaceable>.swap</filename>, - <filename><replaceable>target</replaceable>.target</filename>, - <filename><replaceable>path</replaceable>.path</filename>, - <filename><replaceable>timer</replaceable>.timer</filename>, - <filename><replaceable>slice</replaceable>.slice</filename>, - <filename><replaceable>scope</replaceable>.scope</filename></para> + <para><simplelist type="inline"> + <member><filename><replaceable>service</replaceable>.service</filename></member> + <member><filename><replaceable>socket</replaceable>.socket</filename></member> + <member><filename><replaceable>device</replaceable>.device</filename></member> + <member><filename><replaceable>mount</replaceable>.mount</filename></member> + <member><filename><replaceable>automount</replaceable>.automount</filename></member> + <member><filename><replaceable>swap</replaceable>.swap</filename></member> + <member><filename><replaceable>target</replaceable>.target</filename></member> + <member><filename><replaceable>path</replaceable>.path</filename></member> + <member><filename><replaceable>timer</replaceable>.timer</filename></member> + <member><filename><replaceable>slice</replaceable>.slice</filename></member> + <member><filename><replaceable>scope</replaceable>.scope</filename></member> + </simplelist></para> <refsect2> <title>System Unit Search Path</title> - <para><literallayout><filename>/etc/systemd/system.control/*</filename> -<filename>/run/systemd/system.control/*</filename> -<filename>/run/systemd/transient/*</filename> -<filename>/run/systemd/generator.early/*</filename> -<filename>/etc/systemd/system/*</filename> -<filename>/etc/systemd/system.attached/*</filename> -<filename>/run/systemd/system/*</filename> -<filename>/run/systemd/system.attached/*</filename> -<filename>/run/systemd/generator/*</filename> -<filename index='false'>…</filename> -<filename>/usr/lib/systemd/system/*</filename> -<filename>/run/systemd/generator.late/*</filename></literallayout></para> + <para><simplelist> + <member><filename>/etc/systemd/system.control/*</filename></member> + <member><filename>/run/systemd/system.control/*</filename></member> + <member><filename>/run/systemd/transient/*</filename></member> + <member><filename>/run/systemd/generator.early/*</filename></member> + <member><filename>/etc/systemd/system/*</filename></member> + <member><filename>/etc/systemd/system.attached/*</filename></member> + <member><filename>/run/systemd/system/*</filename></member> + <member><filename>/run/systemd/system.attached/*</filename></member> + <member><filename>/run/systemd/generator/*</filename></member> + <member><filename index='false'>…</filename></member> + <member><filename>/usr/local/lib/systemd/system/*</filename></member> + <member><filename>/usr/lib/systemd/system/*</filename></member> + <member><filename>/run/systemd/generator.late/*</filename></member> + </simplelist></para> </refsect2> <refsect2> <title>User Unit Search Path</title> - <para><literallayout><filename>~/.config/systemd/user.control/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/user.control/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/transient/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/generator.early/*</filename> -<filename>~/.config/systemd/user/*</filename> -<filename>$XDG_CONFIG_DIRS/systemd/user/*</filename> -<filename>/etc/systemd/user/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/user/*</filename> -<filename>/run/systemd/user/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/generator/*</filename> -<filename>$XDG_DATA_HOME/systemd/user/*</filename> -<filename>$XDG_DATA_DIRS/systemd/user/*</filename> -<filename index='false'>…</filename> -<filename>/usr/lib/systemd/user/*</filename> -<filename>$XDG_RUNTIME_DIR/systemd/generator.late/*</filename></literallayout></para> + <para><simplelist> + <member><filename>~/.config/systemd/user.control/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/user.control/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/transient/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/generator.early/*</filename></member> + <member><filename>~/.config/systemd/user/*</filename></member> + <member><filename>$XDG_CONFIG_DIRS/systemd/user/*</filename></member> + <member><filename>/etc/systemd/user/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/user/*</filename></member> + <member><filename>/run/systemd/user/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/generator/*</filename></member> + <member><filename>$XDG_DATA_HOME/systemd/user/*</filename></member> + <member><filename>$XDG_DATA_DIRS/systemd/user/*</filename></member> + <member><filename index='false'>…</filename></member> + <member><filename>/usr/local/lib/systemd/user/*</filename></member> + <member><filename>/usr/lib/systemd/user/*</filename></member> + <member><filename>$XDG_RUNTIME_DIR/systemd/generator.late/*</filename></member> + </simplelist></para> </refsect2> </refsynopsisdiv> @@ -158,7 +166,7 @@ instance (if any) is always uniquely defined for a given unit and all its aliases. The target of alias symlink must point to a valid unit file location, i.e. the symlink target name must match the symlink source name as described, and the destination path must be in one of the unit search paths, see UNIT FILE - LOAD PATH section below for more details. Note that the target file may not exist, i.e. the symlink may + LOAD PATH section below for more details. Note that the target file might not exist, i.e. the symlink may be dangling.</para> <para>Unit files may specify aliases through the <varname>Alias=</varname> directive in the [Install] @@ -190,7 +198,7 @@ <filename>.wants/</filename> or <filename>.requires/</filename> must thus point to a valid unit file location, i.e. the symlink target name must satisfy the described requirements, and the destination path must be in one of the unit search paths, see UNIT FILE LOAD PATH section below for more details. Note - that the target file may not exist, i.e. the symlink may be dangling.</para> + that the target file might not exist, i.e. the symlink may be dangling.</para> <para>Along with a unit file <filename>foo.service</filename>, a "drop-in" directory <filename>foo.service.d/</filename> may exist. All files with the suffix @@ -345,7 +353,9 @@ <para>Unit files are loaded from a set of paths determined during compilation, described in the two tables below. Unit files found in directories listed earlier override files with the same name in - directories lower in the list.</para> + directories lower in the list + <xi:include href="standard-conf.xml" xpointer="usr-local-footnote" />. + </para> <para>When the variable <varname>$SYSTEMD_UNIT_PATH</varname> is set, the contents of this variable overrides the unit load path. If @@ -399,7 +409,7 @@ </row> <row> <entry><filename>/usr/local/lib/systemd/system</filename></entry> - <entry>System units installed by the administrator </entry> + <entry>System units installed by the administrator</entry> </row> <row> <entry><filename>/usr/lib/systemd/system</filename></entry> @@ -920,6 +930,16 @@ </varlistentry> <varlistentry> + <term><varname>WantsMountsFor=</varname></term> + + <listitem><para>Same as <varname>RequiresMountsFor=</varname>, + but adds dependencies of type <varname>Wants=</varname> instead + of <varname>Requires=</varname>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>OnSuccessJobMode=</varname></term> <term><varname>OnFailureJobMode=</varname></term> @@ -1067,9 +1087,8 @@ <option>exit-force</option>, <option>soft-reboot</option>, <option>soft-reboot-force</option>, <option>kexec</option>, <option>kexec-force</option>, <option>halt</option>, <option>halt-force</option> and <option>halt-immediate</option>. In system mode, all options are - allowed. In user mode, only <option>none</option>, <option>exit</option>, - <option>exit-force</option>, <option>soft-reboot</option> and <option>soft-reboot-force</option> are - allowed. Both options default to <option>none</option>.</para> + allowed. In user mode, only <option>none</option>, <option>exit</option>, and + <option>exit-force</option> are allowed. Both options default to <option>none</option>.</para> <para>If <option>none</option> is set, no action will be triggered. <option>reboot</option> causes a reboot following the normal shutdown procedure (i.e. equivalent to <command>systemctl @@ -1144,7 +1163,8 @@ <listitem><para><varname>JobTimeoutAction=</varname> optionally configures an additional action to take when the timeout is hit, see description of <varname>JobTimeoutSec=</varname> and <varname>JobRunningTimeoutSec=</varname> above. It takes the same values as - <varname>StartLimitAction=</varname>. Defaults to <option>none</option>.</para> + <varname>FailureAction=</varname>/<varname>SuccessAction=</varname>. Defaults to + <option>none</option>.</para> <para><varname>JobTimeoutRebootArgument=</varname> configures an optional reboot string to pass to the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system @@ -1311,6 +1331,10 @@ <literal>arc-be</literal>, or <literal>native</literal>.</para> + <para>Use + <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry> + for the complete list of known architectures.</para> + <para>The architecture is determined from the information returned by <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>2</manvolnum></citerefentry> and is thus subject to @@ -1604,7 +1628,7 @@ to make sure they run before the stamp file's modification time gets reset indicating a completed update.</para> - <para>If the <varname>systemd.condition-needs-update=</varname> option is specified on the kernel + <para>If the <varname>systemd.condition_needs_update=</varname> option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over any file modification time checks. If the kernel command line option is used, <filename>systemd-update-done.service</filename> will not have immediate effect on any following @@ -1634,18 +1658,26 @@ whether the system is booting up for the first time. This roughly means that <filename>/etc/</filename> was unpopulated when the system started booting (for details, see "First Boot Semantics" in <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>). - First boot is considered finished (this condition will evaluate as false) after the manager + First Boot is considered finished (this condition will evaluate as false) after the manager has finished the startup phase.</para> <para>This condition may be used to populate <filename>/etc/</filename> on the first boot after factory reset, or when a new system instance boots up for the first time.</para> + <para>Note that the service manager itself will perform setup steps during First Boot: it will + initialize + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> and + preset all units, enabling or disabling them according to the + <citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry> + settings. Additional setup may be performed via units with + <varname>ConditionFirstBoot=yes</varname>.</para> + <para>For robustness, units with <varname>ConditionFirstBoot=yes</varname> should order themselves before <filename>first-boot-complete.target</filename> and pull in this passive target with <varname>Wants=</varname>. This ensures that in a case of an aborted first boot, these units will be re-run during the next system startup.</para> - <para>If the <varname>systemd.condition-first-boot=</varname> option is specified on the kernel + <para>If the <varname>systemd.condition_first_boot=</varname> option is specified on the kernel command line (taking a boolean), it will override the result of this condition check, taking precedence over <filename>/etc/machine-id</filename> existence checks.</para> @@ -2283,6 +2315,11 @@ <entry>This is the value of the <literal>$CREDENTIALS_DIRECTORY</literal> environment variable if available. See section "Credentials" in <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information.</entry> </row> <row> + <entry><literal>%D</literal></entry> + <entry>Shared data directory</entry> + <entry>This is either <filename>/usr/share/</filename> (for the system manager) or the path <literal>$XDG_DATA_HOME</literal> resolves to (for user managers).</entry> + </row> + <row> <entry><literal>%E</literal></entry> <entry>Configuration directory root</entry> <entry>This is either <filename>/etc/</filename> (for the system manager) or the path <literal>$XDG_CONFIG_HOME</literal> resolves to (for user managers).</entry> @@ -2629,28 +2666,27 @@ OnFailure=failure-handler@%N.service <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.socket</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.device</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.mount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.automount</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.swap</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.target</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.path</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.timer</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.scope</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-analyze</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>uname</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> - </refentry> diff --git a/man/systemd.v.xml b/man/systemd.v.xml new file mode 100644 index 0000000..43e77bd --- /dev/null +++ b/man/systemd.v.xml @@ -0,0 +1,163 @@ +<?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="systemd.v"> + + <refentryinfo> + <title>systemd.v</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>systemd.v</refentrytitle> + <manvolnum>7</manvolnum> + </refmeta> + + <refnamediv> + <refname>systemd.v</refname> + <refpurpose>Directory with Versioned Resources</refpurpose> + </refnamediv> + + <refsect1> + <title>Description</title> + + <para>In various places systemd components accept paths whose trailing components have the + <literal>.v/</literal> suffix, pointing to a directory. These components will then automatically look for + suitable files inside the directory, do a version comparison and open the newest file found (by + version). Available since version v256. Specifically, two expressions are supported:</para> + + <itemizedlist> + + <listitem><para>When looking for files with a suffix <replaceable>.SUFFIX</replaceable>, and a path + <filename>…<replaceable>PATH</replaceable>/<replaceable>NAME</replaceable><replaceable>.SUFFIX</replaceable>.v/</filename> + is specified, then all files + <filename>…<replaceable>PATH</replaceable>/<replaceable>NAME</replaceable><replaceable>.SUFFIX</replaceable>.v/<replaceable>NAME</replaceable>_*<replaceable>.SUFFIX</replaceable></filename> + are enumerated, filtered, sorted and the newest file used. The primary sorting key is the + <emphasis>variable part</emphasis>, here indicated by the wildcard + <literal>*</literal>.</para></listitem> + + <listitem><para>When a path + <filename>…<replaceable>PATH</replaceable>.v/<replaceable>NAME</replaceable>___<replaceable>.SUFFIX</replaceable></filename> + is specified (i.e. the penultimate component of the path ends in <literal>.v</literal> and the final + component contains a triple underscore), then all files + <filename>…<replaceable>PATH</replaceable>.v/<replaceable>NAME</replaceable>_*<replaceable>.SUFFIX</replaceable></filename> + are enumerated, filtered, sorted and the newest file used (again, by the <emphasis>variable + part</emphasis>, here indicated by the wildcard <literal>*</literal>).</para></listitem> + </itemizedlist> + + <para>To illustrate this in an example, consider a directory <filename>/var/lib/machines/mymachine.raw.v/</filename>, which is populated with three files:</para> + + <itemizedlist> + <listitem><para><filename>mymachine_7.5.13.raw</filename></para></listitem> + <listitem><para><filename>mymachine_7.5.14.raw</filename></para></listitem> + <listitem><para><filename>mymachine_7.6.0.raw</filename></para></listitem> + </itemizedlist> + + <para>Invoke a tool such as <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> with a command line like the following:</para> + + <programlisting># systemd-nspawn --image=/var/lib/machines/mymachine.raw.v --boot</programlisting> + + <para>Then this would automatically be resolved to the equivalent of:</para> + + <programlisting># systemd-nspawn --image=/var/lib/machines/mymachine.raw.v/mymachine_7.6.0.raw --boot</programlisting> + + <para>Much of systemd's functionality that expects a path to a disk image or OS directory hierarchy + support the <literal>.v/</literal> versioned directory mechanism, for example + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry> or + the <varname>RootDirectory=</varname>/<varname>RootImage=</varname> settings of service files (see + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para> + + <para>Use the + <citerefentry><refentrytitle>systemd-vpick</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool to + resolve <literal>.v/</literal> paths from the command line, for example for usage in shell + scripts.</para> + </refsect1> + + <refsect1> + <title>Filtering and Sorting</title> + + <para>The variable part of the filenames in the <literal>.v/</literal> directories are filtered and + compared primarily with a version comparison, implementing <ulink + url="https://uapi-group.org/specifications/specs/version_format_specification/">Version Format + Specification</ulink>. However, additional rules apply:</para> + + <itemizedlist> + <listitem><para>If the variable part is suffixed by one or two integer values ("tries left" and "tries + done") in the formats <filename>+<replaceable>LEFT</replaceable></filename> or + <filename>+<replaceable>LEFT</replaceable>-<replaceable>DONE</replaceable></filename>, then these + indicate usage attempt counters. The idea is that each time before a file is attempted to be used, its + "tries left" counter is decreased, and the "tries done" counter increased (simply by renaming the + file). When the file is successfully used (which for example could mean for an OS image: successfully + booted) the counters are removed from the file name, indicating that the file has been validated to + work correctly. This mechanism mirrors the boot assessment counters defined by <ulink + url="https://systemd.io/AUTOMATIC_BOOT_ASSESSMENT/">Automatic Boot Assessment</ulink>. Any filenames + with no boot counters or with a non-zero "tries left" counter are sorted before filenames with a zero + "tries left" counter.</para></listitem> + + <listitem><para>Preceding the use counters (if they are specified), an optional CPU architecture + identifier may be specified in the filename (separated from the version with an underscore), as defined + in the architecture vocabulary of the <varname>ConditionArchitecture=</varname> unit file setting, as + documented in + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Files + whose name indicates an architecture not supported locally are filtered and not considered for the + version comparison.</para></listitem> + + <listitem><para>The rest of the variable part is the version string.</para></listitem> + </itemizedlist> + + <para>Or in other words, the files in the <literal>.v/</literal> directories should follow one of these + naming structures:</para> + + <itemizedlist> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable>_<replaceable>ARCHITECTURE</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable>+<replaceable>LEFT</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable>+<replaceable>LEFT</replaceable>-<replaceable>DONE</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable>_<replaceable>ARCHITECTURE</replaceable>+<replaceable>LEFT</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + <listitem><para><filename><replaceable>NAME</replaceable>_<replaceable>VERSION</replaceable>_<replaceable>ARCHITECTURE</replaceable>+<replaceable>LEFT</replaceable>-<replaceable>DONE</replaceable><replaceable>.SUFFIX</replaceable></filename></para></listitem> + </itemizedlist> + </refsect1> + + <refsect1> + <title>Example</title> + + <para>Here's a more comprehensive example, further extending the one described above. Consider a + directory <filename>/var/lib/machines/mymachine.raw.v/</filename>, which is populated with the following + files:</para> + + <itemizedlist> + <listitem><para><filename>mymachine_7.5.13.raw</filename></para></listitem> + <listitem><para><filename>mymachine_7.5.14_x86-64.raw</filename></para></listitem> + <listitem><para><filename>mymachine_7.6.0_arm64.raw</filename></para></listitem> + <listitem><para><filename>mymachine_7.7.0_x86-64+0-5.raw</filename></para></listitem> + </itemizedlist> + + <para>Now invoke the following command on an x86-64 machine:</para> + + <programlisting>$ systemd-vpick --suffix=.raw /var/lib/machines/mymachine.raw.v/</programlisting> + + <para>This would resolve the specified path to + <filename>/var/lib/machines/mymachine.raw.v/mymachine_7.5.14_x86-64.raw</filename>. Explanation: even + though <filename>mymachine_7.7.0_x86-64+0-5.raw</filename> has the newest version, it is not preferred + because its tries left counter is zero. And even though <filename>mymachine_7.6.0_arm64.raw</filename> + has the second newest version it is also not considered, in this case because we operate on an x86_64 + system and the image is intended for arm64 CPUs. Finally, the <filename>mymachine_7.5.13.raw</filename> + image is not considered because it is older than <filename>mymachine_7.5.14_x86-64.raw</filename>.</para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-vpick</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysupdate</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + +</refentry> diff --git a/man/systemd.xml b/man/systemd.xml index 42da750..66db5bb 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="systemd" @@ -372,6 +372,14 @@ <refsect1> <title>Signals</title> + <para>The service listens to various UNIX process signals that can be used to request various actions + asynchronously. The signal handling is enabled very early during boot, before any further processes are + invoked. However, a supervising container manager or similar that intends to request these operations via + this mechanism must take into consideration that this functionality is not available during the earliest + initialization phase. An <function>sd_notify()</function> notification message carrying the + <varname>X_SYSTEMD_SIGNALS_LEVEL=2</varname> field is emitted once the signal handlers are enabled, see + below. This may be used to schedule submission of these signals correctly.</para> + <variablelist> <varlistentry> <term><constant>SIGTERM</constant></term> @@ -769,10 +777,11 @@ <varlistentry> <term><varname>$NOTIFY_SOCKET</varname></term> - <listitem><para>Set by systemd for supervised processes for - status and start-up completion notification. See - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> - for more information.</para></listitem> + <listitem><para>Set by service manager for its services for status and readiness notifications. Also + consumed by service manager for notifying supervising container managers or service managers up the + stack about its own progress. See + <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> and the + relevant section below for more information.</para></listitem> </varlistentry> </variablelist> @@ -844,16 +853,18 @@ </varlistentry> <varlistentry> - <term><varname>systemd.crash_reboot</varname></term> + <term><varname>systemd.crash_action=</varname></term> - <listitem><para>Takes a boolean argument or enables the option if specified - without an argument. If enabled, the system manager (PID 1) will reboot the - machine automatically when it crashes, after a 10s delay. Otherwise, the - system will hang indefinitely. Defaults to disabled, in order to avoid a - reboot loop. If combined with <varname>systemd.crash_shell</varname>, the - system is rebooted after the shell exits.</para> + <listitem><para>Takes one of <literal>freeze</literal>, <literal>reboot</literal> or + <literal>poweroff</literal>. Defaults to <literal>freeze</literal>. If set to + <literal>freeze</literal>, the system will hang indefinitely when the system manager (PID 1) crashes. + If set to <literal>reboot</literal>, the system manager (PID 1) will reboot the machine automatically + when it crashes, after a 10s delay. If set to <literal>poweroff</literal>, the system manager (PID 1) + will power off the machine immediately when it crashes. If combined with + <varname>systemd.crash_shell</varname>, the configured crash action is executed after the shell + exits.</para> - <xi:include href="version-info.xml" xpointer="v227"/></listitem> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> <varlistentry> @@ -1109,7 +1120,7 @@ </refsect1> <refsect1> - <title>System credentials</title> + <title>System Credentials</title> <para>During initialization the service manager will import credentials from various sources into the system's set of credentials, which can then be propagated into services and consumed by @@ -1151,14 +1162,18 @@ <term><varname>vmm.notify_socket</varname></term> <listitem> <para>Contains a <constant>AF_VSOCK</constant> or <constant>AF_UNIX</constant> address where to - send a <constant>READY=1</constant> notification datagram when the system has finished booting. See - <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> for - more information. Note that in case the hypervisor does not support <constant>SOCK_DGRAM</constant> - over <constant>AF_VSOCK</constant>, <constant>SOCK_SEQPACKET</constant> will be tried instead. The - credential payload for <constant>AF_VSOCK</constant> should be in the form - <literal>vsock:CID:PORT</literal>.</para> - - <para>This feature is useful for hypervisors/VMMs or other processes on the host to receive a + send a <constant>READY=1</constant> notification message when the service manager has completed + booting. See + <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + the next section for more information. Note that in case the hypervisor does not support + <constant>SOCK_DGRAM</constant> over <constant>AF_VSOCK</constant>, + <constant>SOCK_SEQPACKET</constant> will be tried instead. The credential payload for + <constant>AF_VSOCK</constant> should be a string in the form + <literal>vsock:CID:PORT</literal>. <literal>vsock-stream</literal>, <literal>vsock-dgram</literal> + and <literal>vsock-seqpacket</literal> can be used instead of <literal>vsock</literal> to force + usage of the corresponding socket type.</para> + + <para>This feature is useful for machine managers or other processes on the host to receive a notification via VSOCK when a virtual machine has finished booting.</para> <xi:include href="version-info.xml" xpointer="v254"/> @@ -1177,6 +1192,90 @@ </listitem> </varlistentry> </variablelist> + + <para>For a list of system credentials various other components of systemd consume, see + <citerefentry><refentrytitle>systemd.system-credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para> + </refsect1> + + <refsect1> + <title>Readiness Protocol</title> + + <para>The service manager implements a readiness notification protocol both between the manager and its + services (i.e. down the stack), and between the manager and a potential supervisor further up the stack + (the latter could be a machine or container manager, or in case of a per-user service manager the system + service manager instance). The basic protocol (and the suggested API for it) is described in + <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> + + <para>The notification socket the service manager (including PID 1) uses for reporting readiness to its + own supervisor is set via the usual <varname>$NOTIFY_SOCKET</varname> environment variable (see + above). Since this is directly settable only for container managers and for the per-user instance of the + service manager, an additional mechanism to configure this is available, in particular intended for use + in VM environments: the <varname>vmm.notify_socket</varname> system credential (see above) may be set to + a suitable socket (typically an <constant>AF_VSOCK</constant> one) via SMBIOS Type 11 vendor strings. For + details see above.</para> + + <para>The notification protocol from the service manager up the stack towards a supervisor supports a + number of extension fields that allow a supervisor to learn about specific properties of the system and + track its boot progress. Specifically the following fields are sent:</para> + + <itemizedlist> + <listitem><para>An <varname>X_SYSTEMD_HOSTNAME=…</varname> message will be sent out once the initial + hostname for the system has been determined. Note that during later runtime the hostname might be + changed again programmatically, and (currently) no further notifications are sent out in that case.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + + <listitem><para>An <varname>X_SYSTEMD_MACHINE_ID=…</varname> message will be sent out once the machine + ID of the system has been determined. See + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + + <listitem><para>An <varname>X_SYSTEMD_SIGNALS_LEVEL=…</varname> message will be sent out once the + service manager installed the various UNIX process signal handlers described above. The field's value + is an unsigned integer formatted as decimal string, and indicates the supported UNIX process signal + feature level of the service manager. Currently, only a single feature level is defined:</para> + + <itemizedlist> + <listitem><para><varname>X_SYSTEMD_SIGNALS_LEVEL=2</varname> covers the various UNIX process signals + documented above – which are a superset of those supported by the historical SysV init + system.</para></listitem> + </itemizedlist> + + <para>Signals sent to PID 1 before this message is sent might not be handled correctly yet. A consumer + of these messages should parse the value as an unsigned integer indication the level of support. For + now only the mentioned level 2 is defined, but later on additional levels might be defined with higher + integers, that will implement a superset of the currently defined behaviour.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + + <listitem><para><varname>X_SYSTEMD_UNIT_ACTIVE=…</varname> and + <varname>X_SYSTEMD_UNIT_INACTIVE=…</varname> messages will be sent out for each target unit as it + becomes active or stops being active. This is useful to track boot progress and functionality. For + example, once the <filename>ssh-access.target</filename> unit is reported started SSH access is + typically available, see + <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + + <listitem><para>An <varname>X_SYSTEMD_SHUTDOWN=…</varname> message will be sent out very shortly before + the system shuts down. The value is one of the strings <literal>reboot</literal>, + <literal>halt</literal>, <literal>poweroff</literal>, <literal>kexec</literal> and indicates which kind + of shutdown is being executed.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + + <listitem><para>An <varname>X_SYSTEMD_REBOOT_PARAMETER=…</varname> message will also be sent out very + shortly before the system shuts down. Its value is the reboot argument as configured with + <command>systemctl --reboot-argument=…</command>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </itemizedlist> + + <para>Note that these extension fields are sent in addition to the regular <literal>READY=1</literal> and + <literal>RELOADING=1</literal> notifications.</para> </refsect1> <refsect1> @@ -1276,7 +1375,7 @@ </varlistentry> <varlistentry> - <term><option>--crash-vt=</option><replaceable>VT</replaceable></term> + <term><option>--crash-vt=<replaceable>VT</replaceable></option></term> <listitem><para>Switch to a specific virtual console (VT) on crash. This switch has no effect when running as user instance. Same as <varname>systemd.crash_chvt=</varname> above (but not the @@ -1293,12 +1392,13 @@ </varlistentry> <varlistentry> - <term><option>--crash-reboot</option></term> + <term><option>--crash-action=</option></term> - <listitem><para>Automatically reboot the system on crash. This switch has no effect when running as - user instance. See <varname>systemd.crash_reboot</varname> above.</para> + <listitem><para>Specify what to do when the system manager (PID 1) crashes. This switch has no + effect when systemd is running as user instance. See <varname>systemd.crash_action=</varname> + above.</para> - <xi:include href="version-info.xml" xpointer="v227"/></listitem> + <xi:include href="version-info.xml" xpointer="v256"/></listitem> </varlistentry> <varlistentry> @@ -1441,23 +1541,23 @@ <refsect1> <title>See Also</title> - <para> - The <ulink url="https://systemd.io/">systemd Homepage</ulink>, - <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member>The <ulink url="https://systemd.io/">systemd Homepage</ulink></member> + <member><citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-notify</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>daemon</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-daemon</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>kernel-command-line</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>bootup</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sysupdate.d.xml b/man/sysupdate.d.xml index 00b4ac8..125c580 100644 --- a/man/sysupdate.d.xml +++ b/man/sysupdate.d.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sysupdate.d" conditional='ENABLE_SYSUPDATE' @@ -22,10 +22,12 @@ </refnamediv> <refsynopsisdiv> - <para><literallayout><filename>/etc/sysupdate.d/*.conf</filename> -<filename>/run/sysupdate.d/*.conf</filename> -<filename>/usr/lib/sysupdate.d/*.conf</filename> - </literallayout></para> + <para><simplelist> + <member><filename>/etc/sysupdate.d/*.conf</filename></member> + <member><filename>/run/sysupdate.d/*.conf</filename></member> + <member><filename>/usr/local/lib/sysupdate.d/*.conf</filename></member> + <member><filename>/usr/lib/sysupdate.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -941,11 +943,11 @@ CurrentSymlink=myContainer</programlisting></para> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysupdate</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysupdate</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-repart</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sysusers.d.xml b/man/sysusers.d.xml index e7cd285..9d5a03e 100644 --- a/man/sysusers.d.xml +++ b/man/sysusers.d.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="sysusers.d" conditional='ENABLE_SYSUSERS' xmlns:xi="http://www.w3.org/2001/XInclude"> @@ -22,9 +22,12 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/sysusers.d/*.conf</filename></para> - <para><filename>/run/sysusers.d/*.conf</filename></para> - <para><filename>/usr/lib/sysusers.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/sysusers.d/*.conf</filename></member> + <member><filename>/run/sysusers.d/*.conf</filename></member> + <member><filename>/usr/local/lib/sysusers.d/*.conf</filename></member> + <member><filename>/usr/lib/sysusers.d/*.conf</filename></member> + </simplelist></para> <programlisting> #Type Name ID GECOS Home directory Shell @@ -298,10 +301,10 @@ r - 500-900 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-sysusers</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysusers</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> @@ -1,11 +1,13 @@ <?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> + <variablelist class='network-directives'> <varlistentry id='qdisc-parent'> <term><varname>Parent=</varname></term> diff --git a/man/telinit.xml b/man/telinit.xml index 294b359..7ffd8cd 100644 --- a/man/telinit.xml +++ b/man/telinit.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="telinit" conditional='HAVE_SYSV_COMPAT' @@ -23,7 +23,7 @@ <refsynopsisdiv> <cmdsynopsis> - <command>telinit <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg></command> + <command>telinit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg choice="req">COMMAND</arg> </cmdsynopsis> </refsynopsisdiv> @@ -142,10 +142,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/threads-aware.xml b/man/threads-aware.xml index 442e45b..bb39266 100644 --- a/man/threads-aware.xml +++ b/man/threads-aware.xml @@ -1,23 +1,24 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> -<para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a -given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a -specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it -from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para> + <para id="strict">All functions listed here are thread-agnostic and only a single specific thread may operate on a + given object during its entire lifetime. It's safe to allocate multiple independent objects and use each from a + specific thread in parallel. However, it's not safe to allocate such an object in one thread, and operate or free it + from any other, even if locking is used to ensure these threads don't operate on it at the very same time.</para> -<para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para> + <para id="safe">All functions listed here are thread-safe and may be called in parallel from multiple threads.</para> -<para id='getenv'>The code described here uses -<citerefentry project='man-pages'><refentrytitle>getenv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, -which is declared to be not multi-thread-safe. This means that the code calling the functions described -here must not call -<citerefentry project='man-pages'><refentrytitle>setenv</refentrytitle><manvolnum>3</manvolnum></citerefentry> -from a parallel thread. It is recommended to only do calls to <function>setenv()</function> -from an early phase of the program when no other threads have been started.</para> + <para id='getenv'>The code described here uses + <citerefentry project='man-pages'><refentrytitle>getenv</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + which is declared to be not multi-thread-safe. This means that the code calling the functions described + here must not call + <citerefentry project='man-pages'><refentrytitle>setenv</refentrytitle><manvolnum>3</manvolnum></citerefentry> + from a parallel thread. It is recommended to only do calls to <function>setenv()</function> + from an early phase of the program when no other threads have been started.</para> </refsect1> diff --git a/man/timedatectl.xml b/man/timedatectl.xml index f06441b..ece8833 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="timedatectl" conditional='ENABLE_TIMEDATECTL' @@ -273,6 +273,15 @@ <xi:include href="version-info.xml" xpointer="v239"/></listitem> </varlistentry> + <varlistentry id='option-P'> + <term><option>-P</option></term> + + <listitem> + <xi:include href="standard-options.xml" xpointer="xpointer(//varlistentry[@id='option-P']/listitem/para)" /> + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <xi:include href="user-system-options.xml" xpointer="host" /> <xi:include href="user-system-options.xml" xpointer="machine" /> @@ -345,16 +354,16 @@ Root distance: 335us (max: 5s) <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>hwclock</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>date</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localtime</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timedated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-firstboot</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/timesyncd.conf.xml b/man/timesyncd.conf.xml index e804f5f..51c867a 100644 --- a/man/timesyncd.conf.xml +++ b/man/timesyncd.conf.xml @@ -1,6 +1,6 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="timesyncd.conf" conditional='ENABLE_TIMESYNCD' @@ -22,10 +22,16 @@ </refnamediv> <refsynopsisdiv> - <para><filename>/etc/systemd/timesyncd.conf</filename></para> - <para><filename>/etc/systemd/timesyncd.conf.d/*.conf</filename></para> - <para><filename>/run/systemd/timesyncd.conf.d/*.conf</filename></para> - <para><filename>/usr/lib/systemd/timesyncd.conf.d/*.conf</filename></para> + <para><simplelist> + <member><filename>/etc/systemd/timesyncd.conf</filename></member> + <member><filename>/run/systemd/timesyncd.conf</filename></member> + <member><filename>/usr/local/lib/systemd/timesyncd.conf</filename></member> + <member><filename>/usr/lib/systemd/timesyncd.conf</filename></member> + <member><filename>/etc/systemd/timesyncd.conf.d/*.conf</filename></member> + <member><filename>/run/systemd/timesyncd.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/systemd/timesyncd.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/systemd/timesyncd.conf.d/*.conf</filename></member> + </simplelist></para> </refsynopsisdiv> <refsect1> @@ -132,11 +138,11 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-networkd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 971b7e6..c897068 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -21,22 +21,25 @@ <refnamediv> <refname>tmpfiles.d</refname> - <refpurpose>Configuration for creation, deletion and cleaning of - volatile and temporary files</refpurpose> + <refpurpose>Configuration for creation, deletion, and cleaning of files and directories</refpurpose> </refnamediv> <refsynopsisdiv> - <para><literallayout><filename>/etc/tmpfiles.d/*.conf</filename> -<filename>/run/tmpfiles.d/*.conf</filename> -<filename>/usr/lib/tmpfiles.d/*.conf</filename> - </literallayout></para> - - <para><literallayout><filename>~/.config/user-tmpfiles.d/*.conf</filename> -<filename>$XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf</filename> -<filename>~/.local/share/user-tmpfiles.d/*.conf</filename> -<filename index='false'>…</filename> -<filename>/usr/share/user-tmpfiles.d/*.conf</filename> - </literallayout></para> + <para><simplelist> + <member><filename>/etc/tmpfiles.d/*.conf</filename></member> + <member><filename>/run/tmpfiles.d/*.conf</filename></member> + <member><filename>/usr/local/lib/tmpfiles.d/*.conf</filename></member> + <member><filename>/usr/lib/tmpfiles.d/*.conf</filename></member> + </simplelist></para> + + <para><simplelist> + <member><filename>~/.config/user-tmpfiles.d/*.conf</filename></member> + <member><filename>$XDG_RUNTIME_DIR/user-tmpfiles.d/*.conf</filename></member> + <member><filename>~/.local/share/user-tmpfiles.d/*.conf</filename></member> + <member><filename index='false'>…</filename></member> + <member><filename>/usr/local/share/user-tmpfiles.d/*.conf</filename></member> + <member><filename>/usr/share/user-tmpfiles.d/*.conf</filename></member> + </simplelist></para> <programlisting>#Type Path Mode User Group Age Argument f /file/to/create mode user group - content @@ -352,9 +355,7 @@ L /tmp/foobar - - - - /dev/null</programlisting> <term><varname>x</varname></term> <listitem><para>Ignore a path during cleaning. Use this type to exclude paths from clean-up as controlled with the Age - parameter. Note that lines of this type do not influence the - effect of <varname>r</varname> or <varname>R</varname> - lines. Lines of this type accept shell-style globs in place + parameter. Lines of this type accept shell-style globs in place of normal path names. </para></listitem> </varlistentry> @@ -364,9 +365,7 @@ L /tmp/foobar - - - - /dev/null</programlisting> to exclude paths from clean-up as controlled with the Age parameter. Unlike <varname>x</varname>, this parameter will not exclude the content if path is a directory, but only - directory itself. Note that lines of this type do not - influence the effect of <varname>r</varname> or - <varname>R</varname> lines. Lines of this type accept + directory itself. Lines of this type accept shell-style globs in place of normal path names. </para> @@ -541,7 +540,7 @@ w- /proc/sys/vm/swappiness - - - - 10</programlisting></para> Base64 decoding is applied to the credential contents.</para> <para>Note that for all line types that result in creation of any kind of file node - (i.e. <varname>f</varname>/<varname>F</varname>, + (i.e. <varname>f</varname>, <varname>d</varname>/<varname>D</varname>/<varname>v</varname>/<varname>q</varname>/<varname>Q</varname>, <varname>p</varname>, <varname>L</varname>, <varname>c</varname>/<varname>b</varname> and <varname>C</varname>) leading directories are implicitly created if needed, owned by root with an access mode of 0755. In order to @@ -700,7 +699,7 @@ d /tmp/foo/bar - - - bmA:1h -</programlisting></para> <para>For <varname>L</varname> lines determines the destination path of the symlink. For <varname>c</varname> and <varname>b</varname>, determines the major/minor of the device node, with major and minor formatted as integers, - separated by <literal>:</literal>, e.g. <literal>1:3</literal>. For <varname>f</varname>, <varname>F</varname>, + separated by <literal>:</literal>, e.g. <literal>1:3</literal>. For <varname>f</varname> and <varname>w</varname>, the argument may be used to specify a short string that is written to the file, suffixed by a newline. For <varname>C</varname>, specifies the source file or directory. For <varname>t</varname> and <varname>T</varname>, determines extended attributes to be set. For <varname>a</varname> and @@ -871,7 +870,7 @@ e! /var/cache/krb5rcache - - - 0 <example> <title>Provision SSH public key access for root user via Credentials in QEMU</title> - <programlisting>-smbios type=11,value=io.systemd.credential.binary:tmpfiles.extra=$(echo "f~ /root/.ssh/authorized_keys 700 root root - $(ssh-add -L | base64 -w 0)" | base64 -w 0) + <programlisting>-smbios type=11,value=io.systemd.credential.binary:tmpfiles.extra=$(echo -e "d /root/.ssh 0750 root root -\nf~ /root/.ssh/authorized_keys 0600 root root - $(ssh-add -L | base64 -w 0)" | base64 -w 0) </programlisting> <para>By passing this line to QEMU, the public key of the current user will be encoded in base64, added @@ -891,20 +890,20 @@ e! /var/cache/krb5rcache - - - 0 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>attr</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>setfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs-subvolume.html'>btrfs-subvolume</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs-qgroup.html'>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-tmpfiles</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-delta</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>attr</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>setfattr</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>setfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getfacl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>chattr</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs-subvolume.html'>btrfs-subvolume</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='url'><refentrytitle url='https://btrfs.readthedocs.io/en/latest/btrfs-qgroup.html'>btrfs-qgroup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev.conf.xml b/man/udev.conf.xml index bfdba7b..5e42bf3 100644 --- a/man/udev.conf.xml +++ b/man/udev.conf.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="udev.conf" @@ -18,23 +18,37 @@ <refnamediv> <refname>udev.conf</refname> + <refname>udev.conf.d</refname> <refpurpose>Configuration for device event managing daemon</refpurpose> </refnamediv> <refsynopsisdiv> - <para><filename>/etc/udev/udev.conf</filename></para> + <para> + <simplelist> + <member><filename>/etc/udev/udev.conf</filename></member> + <member><filename>/run/udev/udev.conf</filename></member> + <member><filename>/usr/local/lib/udev/udev.conf</filename></member> + <member><filename>/usr/lib/udev/udev.conf</filename></member> + <member><filename>/etc/udev/udev.conf.d/*.conf</filename></member> + <member><filename>/run/udev/udev.conf.d/*.conf</filename></member> + <member><filename>/usr/local/lib/udev/udev.conf.d/*.conf</filename></member> + <member><filename>/usr/lib/udev/udev.conf.d/*.conf</filename></member> + </simplelist> + </para> </refsynopsisdiv> <refsect1> <title>Description</title> + <para>These files contain configuration options for + <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + The syntax of these files is very simple: a list + of assignments, one per line. + All empty lines or lines beginning with <literal>#</literal> are + ignored. + </para> <para> - <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry> - expects its main configuration file at - <filename>/etc/udev/udev.conf</filename>. It consists of a set - of variables allowing the user to override default udev - values. All empty lines or lines beginning with '#' are - ignored. The following variables can be set: + The following options can be set: </para> <variablelist class='config-directives'> @@ -47,6 +61,12 @@ <option>err</option>, <option>info</option> and <option>debug</option>.</para> + <note> + <para>This option is also honored by + <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry>. + </para> + </note> + <xi:include href="version-info.xml" xpointer="v216"/> </listitem> </varlistentry> @@ -131,10 +151,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-udevd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev.xml b/man/udev.xml index 15cac8d..6719c1b 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -885,16 +885,16 @@ SUBSYSTEM=="net", OPTIONS="log_level=debug"</programlisting></para> <refsect1> <title>See Also</title> - <para> - <citerefentry> + <para><simplelist type="inline"> + <member><citerefentry> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd.link</refentrytitle><manvolnum>5</manvolnum> - </citerefentry> - </para> + </citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_device_get_syspath.xml b/man/udev_device_get_syspath.xml index f6d89c3..43269f9 100644 --- a/man/udev_device_get_syspath.xml +++ b/man/udev_device_get_syspath.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -184,15 +184,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_has_tag</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_has_tag</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_device_has_tag.xml b/man/udev_device_has_tag.xml index f66c3ed..722fafe 100644 --- a/man/udev_device_has_tag.xml +++ b/man/udev_device_has_tag.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -169,16 +169,16 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_device_new_from_syspath.xml b/man/udev_device_new_from_syspath.xml index a9bd51c..461ffb8 100644 --- a/man/udev_device_new_from_syspath.xml +++ b/man/udev_device_new_from_syspath.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -184,15 +184,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_has_tag</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_get_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_has_tag</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_enumerate_add_match_subsystem.xml b/man/udev_enumerate_add_match_subsystem.xml index 079138b..24dbb35 100644 --- a/man/udev_enumerate_add_match_subsystem.xml +++ b/man/udev_enumerate_add_match_subsystem.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -135,15 +135,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_enumerate_new.xml b/man/udev_enumerate_new.xml index 0429cd0..ba5fec9 100644 --- a/man/udev_enumerate_new.xml +++ b/man/udev_enumerate_new.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -77,15 +77,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_scan_devices</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_enumerate_scan_devices.xml b/man/udev_enumerate_scan_devices.xml index 8b1b40b..47912a2 100644 --- a/man/udev_enumerate_scan_devices.xml +++ b/man/udev_enumerate_scan_devices.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -101,15 +101,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_add_match_subsystem</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_list_entry.xml b/man/udev_list_entry.xml index de09498..46fcde8 100644 --- a/man/udev_list_entry.xml +++ b/man/udev_list_entry.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -92,13 +92,13 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_monitor_filter_update.xml b/man/udev_monitor_filter_update.xml index 8f01670..210b664 100644 --- a/man/udev_monitor_filter_update.xml +++ b/man/udev_monitor_filter_update.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -89,15 +89,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_monitor_new_from_netlink.xml b/man/udev_monitor_new_from_netlink.xml index 8084f2c..9f12d74 100644 --- a/man/udev_monitor_new_from_netlink.xml +++ b/man/udev_monitor_new_from_netlink.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -79,15 +79,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_receive_device</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_monitor_receive_device.xml b/man/udev_monitor_receive_device.xml index f2a8dc3..94d2027 100644 --- a/man/udev_monitor_receive_device.xml +++ b/man/udev_monitor_receive_device.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -105,15 +105,15 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>udev_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_device_new_from_syspath</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_enumerate_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_new_from_netlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_monitor_filter_update</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>udev_list_entry</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/udev_new.xml b/man/udev_new.xml index cf360f6..7b13081 100644 --- a/man/udev_new.xml +++ b/man/udev_new.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> diff --git a/man/udevadm.xml b/man/udevadm.xml index 76c54c3..b515f3c 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="udevadm" @@ -83,8 +83,8 @@ </variablelist> <refsect2><title>udevadm info - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional> </title> <para>Query the udev database for device information.</para> @@ -382,8 +382,8 @@ </refsect2> <refsect2><title>udevadm trigger - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional> </title> <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para> @@ -550,14 +550,16 @@ <para>Typically, it is essential that applications which intend to use such a match, make sure a suitable udev rule is installed that sets at least one property on devices that shall be matched. See also Initialized Devices section below for more details.</para> - <para>WARNING: <option>--initialized-nomatch</option> can potentially save a significant - amount of time compared to re-triggering all devices in the system and e.g. can be used to - optimize boot time. However, this is not safe to be used in a boot sequence in general. - Especially, when udev rules for a device depend on its parent devices (e.g. - <literal>ATTRS</literal> or <literal>IMPORT{parent}</literal> keys, see - <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> - for more details), the final state of the device becomes easily unstable with this option. - </para> + <warning> + <para><option>--initialized-nomatch</option> can potentially save a significant + amount of time compared to re-triggering all devices in the system and e.g. can be used to + optimize boot time. However, this is not safe to be used in a boot sequence in general. + Especially, when udev rules for a device depend on its parent devices (e.g. + <literal>ATTRS</literal> or <literal>IMPORT{parent}</literal> keys, see + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for more details), the final state of the device becomes easily unstable with this option. + </para> + </warning> <xi:include href="version-info.xml" xpointer="v251"/> </listitem> @@ -607,7 +609,7 @@ </refsect2> <refsect2><title>udevadm settle - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> </title> <para>Watches the udev event queue, and exits if all current events are handled.</para> <variablelist> @@ -702,7 +704,7 @@ </varlistentry> <varlistentry> <term><option>-m</option></term> - <term><option>--children-max=</option><replaceable>value</replaceable></term> + <term><option>--children-max=<replaceable>value</replaceable></option></term> <listitem> <para>Set the maximum number of events, systemd-udevd will handle at the same time. When 0 is specified, then the maximum is determined based on the system resources.</para> @@ -719,18 +721,59 @@ </varlistentry> <varlistentry> <term><option>-t</option></term> - <term><option>--timeout=</option><replaceable>seconds</replaceable></term> + <term><option>--timeout=<replaceable>seconds</replaceable></option></term> <listitem> <para>The maximum number of seconds to wait for a reply from systemd-udevd.</para> </listitem> </varlistentry> + <varlistentry> + <term><option>--load-credentials</option></term> + <listitem> + <para>When specified, the following credentials are used when passed in:</para> + + <variablelist> + <varlistentry> + <term><varname>udev.conf.*</varname></term> + <listitem> + <para>These credentials should contain valid + <citerefentry><refentrytitle>udev.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + configuration data. From each matching credential a separate file is created. Example: a + passed credential <filename>udev.conf.50-foobar</filename> will be copied into a + configuration file <filename>/run/udev/udev.conf.d/50-foobar.conf</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>udev.rules.*</varname></term> + <listitem> + <para>These credentials should contain valid + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> + rules. From each matching credential a separate file is created. Example: a passed credential + <filename>udev.rules.50-foobar</filename> will be copied into a configuration file + <filename>/run/udev/rules.d/50-foobar.rules</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + </variablelist> + + <para>Note, this <emphasis>does not</emphasis> imply <option>--reload</option> option. So, if + <command>systemd-udevd</command> is already running, please consider to also specify + <option>-reload</option> to make the copied udev rules files used by + <command>systemd-udevd</command>.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> + <xi:include href="standard-options.xml" xpointer="help" /> </variablelist> </refsect2> <refsect2><title>udevadm monitor - <arg choice="opt"><replaceable>options</replaceable></arg> + <optional><replaceable>options</replaceable></optional> </title> <para>Listens to the kernel uevents and events sent out by a udev rule and prints the devpath of the event to the console. It can be used to analyze the @@ -782,8 +825,8 @@ </refsect2> <refsect2><title>udevadm test - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional> </title> <para>Simulate a udev event run for the given device, and print debug output.</para> <variablelist> @@ -819,9 +862,9 @@ </refsect2> <refsect2><title>udevadm test-builtin - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg><replaceable>command</replaceable></arg> - <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <replaceable>command</replaceable> + <optional><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></optional> </title> <para>Run a built-in command <replaceable>COMMAND</replaceable> for device <replaceable>DEVPATH</replaceable>, and print debug @@ -848,8 +891,8 @@ <refsect2> <title>udevadm verify - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt" rep="repeat"><replaceable>file</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>file</replaceable></optional> … </title> @@ -913,8 +956,8 @@ <refsect2> <title>udevadm wait - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt"><replaceable>device|syspath</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>device|syspath</replaceable></optional> … </title> @@ -977,8 +1020,8 @@ <refsect2> <title>udevadm lock - <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt"><replaceable>command</replaceable></arg> + <optional><replaceable>options</replaceable></optional> + <optional><replaceable>command</replaceable></optional> … </title> @@ -1111,11 +1154,13 @@ <refsect1> <title>See Also</title> - <para><citerefentry> + <para><simplelist type="inline"> + <member><citerefentry> <refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum> - </citerefentry>, - <citerefentry> + </citerefentry></member> + <member><citerefentry> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> - </citerefentry></para> + </citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/ukify.xml b/man/ukify.xml index b882de8..bf6f328 100644 --- a/man/ukify.xml +++ b/man/ukify.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="ukify" xmlns:xi="http://www.w3.org/2001/XInclude" conditional='ENABLE_UKIFY'> @@ -67,6 +67,7 @@ <para>Additional sections will be inserted into the UKI, either automatically or only if a specific option is provided. See the discussions of + <varname>Microcode=</varname>/<option>--microcode=</option>, <varname>Cmdline=</varname>/<option>--cmdline=</option>, <varname>OSRelease=</varname>/<option>--os-release=</option>, <varname>DeviceTree=</varname>/<option>--devicetree=</option>, @@ -99,7 +100,10 @@ the n-th boot phase path set will be signed by the n-th key. This can be used to build different trust policies for different phases of the boot. In the config file, <varname>PCRPrivateKey=</varname>, <varname>PCRPublicKey=</varname>, and <varname>Phases=</varname> are grouped into separate sections, - describing separate boot phases.</para> + describing separate boot phases. If <varname>SigningEngine=</varname>/<option>--signing-engine=</option> + is specified, then the private keys arguments will be passed verbatim to OpenSSL as URIs, and the public + key arguments will be loaded as X.509 certificates, so that signing can be performed with an OpenSSL + engine.</para> <para>If a SecureBoot signing key is provided via the <varname>SecureBootPrivateKey=</varname>/<option>--secureboot-private-key=</option> option, the resulting @@ -140,6 +144,12 @@ <para>Also see the description of <option>-j</option>/<option>--json=</option> and <option>--section=</option>.</para> + + <para>Other tools that may be useful for inspect UKIs: + <citerefentry project='man-pages'><refentrytitle>llvm-objdump</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <option>-p</option> and <command>pe-inspect</command>. + <!-- TODO: add link to pe-inspect man page when it gets one --> + </para> </refsect2> </refsect1> @@ -157,7 +167,7 @@ <para>If no config file is provided via the option <option>--config=<replaceable>PATH</replaceable></option>, <command>ukify</command> will try to look for a default configuration file in the following paths in this - order: <filename>/run/systemd/ukify.conf</filename>, <filename>/etc/systemd/ukify.conf</filename>, + order: <filename>/etc/systemd/ukify.conf</filename>, <filename>/run/systemd/ukify.conf</filename>, <filename>/usr/local/lib/systemd/ukify.conf</filename>, and <filename>/usr/lib/systemd/ukify.conf</filename>, and then load the first one found. <command>ukify</command> will proceed normally if no configuration file is specified and no default one is found.</para> @@ -197,7 +207,7 @@ <varlistentry> <term><option>--section=<replaceable>NAME</replaceable>:<replaceable>TEXT</replaceable>|<replaceable>@PATH</replaceable></option></term> - <term><option>--section=<replaceable>NAME</replaceable>:<arg choice="plain">text|binary</arg><optional>@<replaceable>PATH</replaceable></optional></option></term> + <term><option>--section=<replaceable>NAME</replaceable>:text|binary<optional>@<replaceable>PATH</replaceable></optional></option></term> <listitem><para>For all verbs except <command>inspect</command>, the first syntax is used. Specify an arbitrary additional section <literal><replaceable>NAME</replaceable></literal>. @@ -294,6 +304,16 @@ </varlistentry> <varlistentry> + <term><varname>Microcode=<replaceable>UCODE</replaceable></varname></term> + <term><option>--microcode=<replaceable>UCODE</replaceable></option></term> + + <listitem><para>Path to initrd containing microcode updates. If not specified, the section + will not be present.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>Cmdline=<replaceable>TEXT</replaceable>|<replaceable>@PATH</replaceable></varname></term> <term><option>--cmdline=<replaceable>TEXT</replaceable>|<replaceable>@PATH</replaceable></option></term> @@ -676,13 +696,13 @@ Writing public key for PCR signing to /etc/kernel/pcr-system.pub.pem <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-pcrphase.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-stub</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-boot</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-measure</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-pcrphase.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/user-system-options.xml b/man/user-system-options.xml index f3bafae..ba43c89 100644 --- a/man/user-system-options.xml +++ b/man/user-system-options.xml @@ -1,9 +1,9 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE variablelist 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 --> -<variablelist> +<variablelist xmlns:xi="http://www.w3.org/2001/XInclude"> <varlistentry id='user'> <term><option>--user</option></term> @@ -55,4 +55,17 @@ implied.</para> </listitem> </varlistentry> + + <varlistentry id='capsule'> + <term><option>-C</option></term> + <term><option>--capsule=</option></term> + + <listitem id='capsule-text'> + <para>Execute operation on a capsule. Specify a capsule name to connect to. See + <citerefentry><refentrytitle>capsule@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> for + details about capsules.</para> + + <xi:include href="version-info.xml" xpointer="v256"/> + </listitem> + </varlistentry> </variablelist> diff --git a/man/user@.service.xml b/man/user@.service.xml index 0cf7f02..ba57f1b 100644 --- a/man/user@.service.xml +++ b/man/user@.service.xml @@ -1,9 +1,9 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> -<refentry id="user@.service"> +<refentry id="user_.service"> <refentryinfo> <title>user@.service</title> <productname>systemd</productname> @@ -181,14 +181,15 @@ TasksMax=33%</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>capsule@.service</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/userdbctl.xml b/man/userdbctl.xml index c3b1a10..a7b438a 100644 --- a/man/userdbctl.xml +++ b/man/userdbctl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="userdbctl" conditional='ENABLE_USERDB' @@ -53,7 +53,7 @@ <variablelist> <varlistentry> - <term><option>--output=</option><replaceable>MODE</replaceable></term> + <term><option>--output=<replaceable>MODE</replaceable></option></term> <listitem><para>Choose the output mode, takes one of <literal>classic</literal>, <literal>friendly</literal>, <literal>table</literal>, <literal>json</literal>. If @@ -74,7 +74,7 @@ </varlistentry> <varlistentry> - <term><option>--json=</option><replaceable>FORMAT</replaceable></term> + <term><option>--json=<replaceable>FORMAT</replaceable></option></term> <listitem><para>Selects JSON output mode (like <option>--output=json</option>) and selects the precise display mode. Takes one of <literal>pretty</literal> or <literal>short</literal>. If @@ -86,7 +86,7 @@ </varlistentry> <varlistentry> - <term><option>--service=</option><replaceable>SERVICE</replaceable><optional>:<replaceable>SERVICE…</replaceable></optional></term> + <term><option>--service=<replaceable>SERVICE</replaceable><optional>:<replaceable>SERVICE…</replaceable></optional></option></term> <term><option>-s</option> <replaceable>SERVICE</replaceable>:<replaceable>SERVICE…</replaceable></term> <listitem><para>Controls which services to query for users/groups. Takes a list of one or more @@ -97,7 +97,7 @@ </varlistentry> <varlistentry> - <term><option>--with-nss=</option><replaceable>BOOL</replaceable></term> + <term><option>--with-nss=<replaceable>BOOL</replaceable></option></term> <listitem><para>Controls whether to include classic glibc/NSS user/group lookups in the output. If <option>--with-nss=no</option> is used any attempts to resolve or enumerate users/groups provided @@ -108,7 +108,7 @@ </varlistentry> <varlistentry> - <term><option>--with-varlink=</option><replaceable>BOOL</replaceable></term> + <term><option>--with-varlink=<replaceable>BOOL</replaceable></option></term> <listitem><para>Controls whether to include Varlink user/group lookups in the output, i.e. those done via the <ulink url="https://systemd.io/USER_GROUP_API">User/Group Record Lookup API via @@ -120,7 +120,7 @@ </varlistentry> <varlistentry> - <term><option>--with-dropin=</option><replaceable>BOOL</replaceable></term> + <term><option>--with-dropin=<replaceable>BOOL</replaceable></option></term> <listitem><para>Controls whether to include user/group lookups in the output that are defined using drop-in files in <filename>/etc/userdb/</filename>, <filename>/run/userdb/</filename>, @@ -133,7 +133,7 @@ </varlistentry> <varlistentry> - <term><option>--synthesize=</option><replaceable>BOOL</replaceable></term> + <term><option>--synthesize=<replaceable>BOOL</replaceable></option></term> <listitem><para>Controls whether to synthesize records for the root and nobody users/groups if they aren't defined otherwise. By default (or <literal>yes</literal>) such records are implicitly @@ -155,7 +155,7 @@ </varlistentry> <varlistentry> - <term><option>--multiplexer=</option><replaceable>BOOL</replaceable></term> + <term><option>--multiplexer=<replaceable>BOOL</replaceable></option></term> <listitem><para>Controls whether to do lookups via the multiplexer service (if specified as true, the default) or do lookups in the client (if specified as false). Using the multiplexer service is @@ -378,13 +378,13 @@ AuthorizedKeysCommandUser root <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-userdbd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-userdbd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-homed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>nss-systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>getent</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/varlinkctl.xml b/man/varlinkctl.xml index 08d2312..eefc3d1 100644 --- a/man/varlinkctl.xml +++ b/man/varlinkctl.xml @@ -1,6 +1,6 @@ <?xml version='1.0'?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> <refentry id="varlinkctl" @@ -71,11 +71,16 @@ <itemizedlist> <listitem><para>A Varlink service reference starting with the <literal>unix:</literal> string, followed - by an absolute <constant>AF_UNIX</constant> path, or by <literal>@</literal> and an arbitrary string + by an absolute <constant>AF_UNIX</constant> socket path, or by <literal>@</literal> and an arbitrary string (the latter for referencing sockets in the abstract namespace).</para></listitem> <listitem><para>A Varlink service reference starting with the <literal>exec:</literal> string, followed by an absolute path of a binary to execute.</para></listitem> + + <listitem><para>A Varlink service reference starting with the <literal>ssh:</literal> string, followed + by an SSH host specification, followed by <literal>:</literal>, followed by an absolute + <constant>AF_UNIX</constant> socket path. (This requires OpenSSH 9.4 or newer on the server side, + abstract namespace sockets are not supported.)</para></listitem> </itemizedlist> <para>For convenience these two simpler (redundant) service address syntaxes are also supported:</para> @@ -180,6 +185,15 @@ </varlistentry> <varlistentry> + <term><option>--collect</option></term> + + <listitem><para>This is similar to <option>--more</option> but collects all responses in a JSON + array, and prints it, rather than in JSON_SEQ mode.</para> + + <xi:include href="version-info.xml" xpointer="v256"/></listitem> + </varlistentry> + + <varlistentry> <term><option>--oneway</option></term> <listitem><para>When used with <command>call</command>: do not expect a method reply. If this flag @@ -190,7 +204,7 @@ </varlistentry> <varlistentry> - <term><option>--json=</option><replaceable>MODE</replaceable></term> + <term><option>--json=<replaceable>MODE</replaceable></option></term> <listitem> <para>Selects the JSON output formatting, one of <literal>pretty</literal> (for nicely indented, @@ -307,9 +321,9 @@ method Extend( <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <ulink url="https://varlink.org/">Varlink</ulink> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://varlink.org/">Varlink</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml index 48001d3..5b3524d 100644 --- a/man/vconsole.conf.xml +++ b/man/vconsole.conf.xml @@ -1,6 +1,6 @@ <?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" [ + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ <!ENTITY % entities SYSTEM "custom-entities.ent" > %entities; ]> @@ -140,14 +140,14 @@ FONT=eurlatgr</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-vconsole-setup.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='mankier'><refentrytitle>loadkeys</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>setfont</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>locale.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/veritytab.xml b/man/veritytab.xml index bc9aa58..6bd0960 100644 --- a/man/veritytab.xml +++ b/man/veritytab.xml @@ -1,7 +1,7 @@ <?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"> + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> <!-- SPDX-License-Identifier: LGPL-2.1-or-later @@ -41,19 +41,19 @@ This is based on crypttab(5). verity protected block device. Fields are delimited by white space.</para> - <para>Each line is in the form<programlisting><replaceable>volume-name</replaceable> <replaceable>data-device</replaceable> <replaceable>hash-device</replaceable> <replaceable>roothash</replaceable> <replaceable>options</replaceable></programlisting> + <para>Each line is in the form<programlisting><replaceable>volume-name</replaceable> <replaceable>data-device</replaceable> <replaceable>hash-device</replaceable> <replaceable>roothash</replaceable> <optional><replaceable>options</replaceable></optional></programlisting> The first four fields are mandatory, the remaining one is optional.</para> <para>The first field contains the name of the resulting verity volume; its block device is set up below <filename>/dev/mapper/</filename>.</para> <para>The second field contains a path to the underlying block data device, or a specification of a block device via - <literal>UUID=</literal> followed by the UUID.</para> + <varname>UUID=</varname> followed by the <replaceable>UUID</replaceable>.</para> <para>The third field contains a path to the underlying block hash device, or a specification of a block device via - <literal>UUID=</literal> followed by the UUID.</para> + <varname>UUID=</varname> followed by the <replaceable>UUID</replaceable>.</para> - <para>The fourth field is the <literal>roothash</literal> in hexadecimal.</para> + <para>The fourth field is the <replaceable>roothash</replaceable> in hexadecimal.</para> <para>The fifth field, if present, is a comma-delimited list of options. The following options are recognized:</para> @@ -71,7 +71,7 @@ This is based on crypttab(5). <varlistentry> <term><option>format=<replaceable>NUMBER</replaceable></option></term> - <listitem><para>Specifies the hash version type. Format type 0 is original Chrome OS version. Format type 1 is + <listitem><para>Specifies the hash version type. Format type <literal>0</literal> is original Chrome OS version. Format type <literal>1</literal> is modern version.</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> @@ -117,7 +117,7 @@ This is based on crypttab(5). <term><option>salt=<replaceable>HEX</replaceable></option></term> <listitem><para>Salt used for format or verification. Format is a hexadecimal string; 256 bytes long maximum; - <literal>-</literal>is the special value for empty.</para> + <literal>-</literal> is the special value for empty.</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> </varlistentry> @@ -125,11 +125,10 @@ This is based on crypttab(5). <varlistentry> <term><option>uuid=<replaceable>UUID</replaceable></option></term> - <listitem><para>Use the provided UUID for format command instead of generating new one. The UUID must be - provided in standard UUID format, e.g. 12345678-1234-1234-1234-123456789abc.</para> + <listitem><para>Use the provided <replaceable>UUID</replaceable> instead of generating new one. The <replaceable>UUID</replaceable> must be + provided in standard <acronym>UUID</acronym> format, e.g. <literal>12345678-1234-1234-1234-123456789abc</literal>.</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> - <listitem><para></para></listitem> </varlistentry> <varlistentry> @@ -138,9 +137,9 @@ This is based on crypttab(5). <term><option>panic-on-corruption</option></term> <listitem><para>Defines what to do if a data verity problem is detected (data corruption). Without these - options kernel fails the IO operation with I/O error. With <literal>--ignore-corruption</literal> option the - corruption is only logged. With <literal>--restart-on-corruption</literal> or - <literal>--panic-on-corruption</literal> the kernel is restarted (panicked) immediately. + options kernel fails the <acronym>IO</acronym> operation with <acronym>I/O</acronym> error. With <option>--ignore-corruption</option> option the + corruption is only logged. With <option>--restart-on-corruption</option> or + <option>--panic-on-corruption</option> the kernel is restarted (panicked) immediately. (You have to provide way how to avoid restart loops.)</para> @@ -151,10 +150,11 @@ This is based on crypttab(5). <term><option>ignore-zero-blocks</option></term> <listitem><para>Instruct kernel to not verify blocks that are expected to contain zeroes and always directly - return zeroes instead. + return zeroes instead.</para> - WARNING: Use this option only in very specific cases. This option is available since Linux kernel version 4.5. - </para> + <warning> + <para>Use this option only in very specific cases. This option is available since Linux kernel version 4.5.</para> + </warning> <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> @@ -163,11 +163,12 @@ This is based on crypttab(5). <term><option>check-at-most-once</option></term> <listitem><para>Instruct kernel to verify blocks only the first time they are read from the data device, rather - than every time. + than every time.</para> - WARNING: It provides a reduced level of security because only offline tampering of the data device's content - will be detected, not online tampering. This option is available since Linux kernel version 4.17. - </para> + <warning> + <para>It provides a reduced level of security because only offline tampering of the data device's content + will be detected, not online tampering. This option is available since Linux kernel version 4.17.</para> + </warning> <xi:include href="version-info.xml" xpointer="v248"/></listitem> </varlistentry> @@ -184,9 +185,9 @@ This is based on crypttab(5). <varlistentry> <term><option>fec-device=<replaceable>PATH</replaceable></option></term> - <listitem><para>Use forward error correction (FEC) to recover from corruption if hash verification fails. Use - encoding data from the specified device. The fec device argument can be block device or file image. For format, - if fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must + <listitem><para>Use forward error correction (<acronym>FEC</acronym>) to recover from corruption if hash verification fails. Use + encoding data from the specified device. The fec device argument can be block device or file image. + If fec device path doesn't exist, it will be created as file. Note: block sizes for data and hash devices must match. Also, if the verity data_device is encrypted the fec_device should be too.</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> @@ -195,7 +196,7 @@ This is based on crypttab(5). <varlistentry> <term><option>fec-offset=<replaceable>BYTES</replaceable></option></term> - <listitem><para>This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding + <listitem><para>This is the offset, in bytes, from the start of the <acronym>FEC</acronym> device to the beginning of the encoding data. (Aligned on 512 bytes.)</para> <xi:include href="version-info.xml" xpointer="v254"/></listitem> @@ -313,13 +314,13 @@ data /etc/data /etc/hash a5ee4b42f70ae1f46a08a7c92c2e0a20672ad2f514792730f5d49d7 <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - <citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-veritysetup@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-veritysetup-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>fstab</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>veritysetup</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/version-info.xml b/man/version-info.xml index 5dabf9d..bd210b2 100644 --- a/man/version-info.xml +++ b/man/version-info.xml @@ -1,9 +1,11 @@ <?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" +<!DOCTYPE refsect1 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 --> <refsect1> + <title/> + <para id="v183">Added in version 183.</para> <para id="v184">Added in version 184.</para> <para id="v185">Added in version 185.</para> @@ -78,4 +80,5 @@ <para id="v254">Added in version 254.</para> <para id="v255">Added in version 255.</para> <para id="v256">Added in version 256.</para> + <para id="v257">Added in version 257.</para> </refsect1> diff --git a/man/vpick.xml b/man/vpick.xml new file mode 100644 index 0000000..e212895 --- /dev/null +++ b/man/vpick.xml @@ -0,0 +1,17 @@ +<?xml version="1.0"?> +<!DOCTYPE refsect1 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 +--> + +<refsect1> + <title/> + <para id="image">In place of the image path a <literal>.v/</literal> versioned directory may be specified, see + <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details.</para> + + <para id="directory">In place of the directory path a <literal>.v/</literal> versioned directory may be specified, + see <citerefentry><refentrytitle>systemd.v</refentrytitle><manvolnum>7</manvolnum></citerefentry> for + details.</para> +</refsect1> diff --git a/man/vtable-example.c b/man/vtable-example.c index e3346a8..2e89944 100644 --- a/man/vtable-example.c +++ b/man/vtable-example.c @@ -1,5 +1,6 @@ /* SPDX-License-Identifier: MIT-0 */ +#define _GNU_SOURCE 1 #include <errno.h> #include <stdbool.h> #include <stddef.h> @@ -9,20 +10,14 @@ #define _cleanup_(f) __attribute__((cleanup(f))) -#define check(x) ({ \ - int r = (x); \ - errno = r < 0 ? -r : 0; \ - printf(#x ": %m\n"); \ - if (r < 0) \ - return EXIT_FAILURE; \ - }) - typedef struct object { char *name; uint32_t number; } object; static int method(sd_bus_message *m, void *userdata, sd_bus_error *error) { + int r; + printf("Got called with userdata=%p\n", userdata); if (sd_bus_message_is_method_call(m, @@ -31,8 +26,17 @@ static int method(sd_bus_message *m, void *userdata, sd_bus_error *error) { return 1; const char *string; - check(sd_bus_message_read(m, "s", &string)); - check(sd_bus_reply_method_return(m, "s", string)); + r = sd_bus_message_read(m, "s", &string); + if (r < 0) { + fprintf(stderr, "sd_bus_message_read() failed: %s\n", strerror(-r)); + return 0; + } + + r = sd_bus_reply_method_return(m, "s", string); + if (r < 0) { + fprintf(stderr, "sd_bus_reply_method_return() failed: %s\n", strerror(-r)); + return 0; + } return 1; } @@ -84,28 +88,55 @@ static const sd_bus_vtable vtable[] = { int main(int argc, char **argv) { _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL; + int r; sd_bus_default(&bus); object object = { .number = 666 }; - check((object.name = strdup("name")) != NULL); + object.name = strdup("name"); + if (!object.name) { + fprintf(stderr, "OOM\n"); + return EXIT_FAILURE; + } - check(sd_bus_add_object_vtable(bus, NULL, - "/org/freedesktop/systemd/VtableExample", - "org.freedesktop.systemd.VtableExample", - vtable, - &object)); + r = sd_bus_add_object_vtable(bus, NULL, + "/org/freedesktop/systemd/VtableExample", + "org.freedesktop.systemd.VtableExample", + vtable, + &object); + if (r < 0) { + fprintf(stderr, "sd_bus_add_object_vtable() failed: %s\n", strerror(-r)); + return EXIT_FAILURE; + } - check(sd_bus_request_name(bus, - "org.freedesktop.systemd.VtableExample", - 0)); + r = sd_bus_request_name(bus, + "org.freedesktop.systemd.VtableExample", + 0); + if (r < 0) { + fprintf(stderr, "sd_bus_request_name() failed: %s\n", strerror(-r)); + return EXIT_FAILURE; + } for (;;) { - check(sd_bus_wait(bus, UINT64_MAX)); - check(sd_bus_process(bus, NULL)); + r = sd_bus_wait(bus, UINT64_MAX); + if (r < 0) { + fprintf(stderr, "sd_bus_wait() failed: %s\n", strerror(-r)); + return EXIT_FAILURE; + } + + r = sd_bus_process(bus, NULL); + if (r < 0) { + fprintf(stderr, "sd_bus_process() failed: %s\n", strerror(-r)); + return EXIT_FAILURE; + } + } + + r = sd_bus_release_name(bus, "org.freedesktop.systemd.VtableExample"); + if (r < 0) { + fprintf(stderr, "sd_bus_release_name() failed: %s\n", strerror(-r)); + return EXIT_FAILURE; } - check(sd_bus_release_name(bus, "org.freedesktop.systemd.VtableExample")); free(object.name); return 0; |