diff options
Diffstat (limited to 'man')
59 files changed, 412 insertions, 133 deletions
diff --git a/man/capsule@.service.xml b/man/capsule@.service.xml index f9c5455f3b..ea210533d4 100644 --- a/man/capsule@.service.xml +++ b/man/capsule@.service.xml @@ -106,17 +106,17 @@ <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> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>user@.service</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.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-run</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>pam</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/crypttab.xml b/man/crypttab.xml index 8ffeaf7fcb..2ebc3bf20a 100644 --- a/man/crypttab.xml +++ b/man/crypttab.xml @@ -950,7 +950,7 @@ for supported formats). Defaults to 30s. Once the specified timeout elapsed authentication via password is attempted. Note that this timeout applies to waiting for the security device to show up — it does not apply to the PIN prompt for the device (should one be needed) or similar. Pass 0 to turn - off the time-out and wait forever.</para> + off the timeout and wait forever.</para> <xi:include href="version-info.xml" xpointer="v250"/></listitem> </varlistentry> diff --git a/man/hwdb.xml b/man/hwdb.xml index 382255267d..6dd72c67b4 100644 --- a/man/hwdb.xml +++ b/man/hwdb.xml @@ -145,10 +145,8 @@ PROPERTY_WITH_SPACES=some string</programlisting> <refsect1> <title>See Also</title> - <para> - <citerefentry> - <refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum> - </citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-hwdb</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/libsystemd.xml b/man/libsystemd.xml index d3d9798d6b..ef34571dd6 100644 --- a/man/libsystemd.xml +++ b/man/libsystemd.xml @@ -35,6 +35,7 @@ #include <systemd/sd-login.h> #include <systemd/sd-messages.h> #include <systemd/sd-path.h> +#include <systemd/sd-varlink.h> </programlisting> <cmdsynopsis> @@ -61,8 +62,9 @@ <citerefentry><refentrytitle>sd-id128</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-journal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - and <citerefentry><refentrytitle>sd-login</refentrytitle><manvolnum>3</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry> for information about different parts of the library interface.</para> </refsect1> diff --git a/man/org.freedesktop.LogControl1.xml b/man/org.freedesktop.LogControl1.xml index 5738a3dda6..135e8bc8de 100644 --- a/man/org.freedesktop.LogControl1.xml +++ b/man/org.freedesktop.LogControl1.xml @@ -89,7 +89,9 @@ node /org/freedesktop/LogControl1 { <citerefentry project="man-pages"><refentrytitle>syslog</refentrytitle><manvolnum>3</manvolnum></citerefentry> call). </para> - <para>Those two properties are writable, so they may be set by sufficiently privileged users.</para> + <caution><title>Write Access</title><para>The <varname>LogLevel</varname> and + <varname>LogTarget</varname> properties are supposed to be writable. Care should be taken to ensure + that only appropriately privileged clients can modify them.</para></caution> <para><varname>SyslogIdentifier</varname> is a read-only property that shows the "syslog identifier". It is a short string that identifies the program that is the source of log messages that is passed to @@ -127,6 +129,11 @@ node /org/freedesktop/LogControl1 { <para>This creates a simple server on the bus. It implements the LogControl1 interface by providing the required properties and allowing to set the writable ones. It logs at the configured log level using <citerefentry><refentrytitle>sd_journal_print</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> + + <para>Note that when porting this example to other D-Bus libraries it might be necessary to add manual + client privilege checks, as they typically do not default to the restrictive defaults of sd-bus, where + unprivileged access to properties is controlled via the <constant>SD_BUS_VTABLE_UNPRIVILEGED</constant> + flag that is opt-in rather than opt-out.</para> </example> </refsect1> diff --git a/man/org.freedesktop.hostname1.xml b/man/org.freedesktop.hostname1.xml index d16ae9ab1c..6c329cbd2c 100644 --- a/man/org.freedesktop.hostname1.xml +++ b/man/org.freedesktop.hostname1.xml @@ -427,8 +427,6 @@ node /org/freedesktop/hostname1 { name.</para> </refsect1> - <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> - <refsect1> <title>Examples</title> @@ -442,12 +440,7 @@ node /org/freedesktop/hostname1 { </example> </refsect1> - <refsect1> - <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> - </refsect1> + <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> <refsect1> <title>History</title> @@ -462,4 +455,16 @@ node /org/freedesktop/hostname1 { <varname>VSockCID</varname> were added in version 256.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-hostnamed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>hostnamectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member>David Zeuthen's original Fedora + <ulink url="https://fedoraproject.org/wiki/Features/BetterHostname">Feature page about xdg-hostname</ulink></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.import1.xml b/man/org.freedesktop.import1.xml index 2486eea4b3..cfcf133975 100644 --- a/man/org.freedesktop.import1.xml +++ b/man/org.freedesktop.import1.xml @@ -453,6 +453,7 @@ node /org/freedesktop/import1/transfer/_1 { </refsect1> <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> + <refsect1> <title>History</title> <refsect2> @@ -469,4 +470,13 @@ node /org/freedesktop/import1/transfer/_1 { </refsect2> </refsect1> + <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>importctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + </refentry> diff --git a/man/org.freedesktop.locale1.xml b/man/org.freedesktop.locale1.xml index 6e0d118e25..0fd8876ca8 100644 --- a/man/org.freedesktop.locale1.xml +++ b/man/org.freedesktop.locale1.xml @@ -185,4 +185,14 @@ $ gdbus introspect --system \ <para>These D-Bus interfaces follow <ulink url="https://0pointer.de/blog/projects/versioning-dbus.html"> the usual interface versioning guidelines</ulink>.</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-localed.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>localectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + </refentry> diff --git a/man/org.freedesktop.login1.xml b/man/org.freedesktop.login1.xml index 00ca82487a..750d68518e 100644 --- a/man/org.freedesktop.login1.xml +++ b/man/org.freedesktop.login1.xml @@ -1648,4 +1648,13 @@ node /org/freedesktop/login1/session/1 { <para><function>SetClass()</function> was added in version 256.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <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> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.machine1.xml b/man/org.freedesktop.machine1.xml index 602c04bf4f..50d9aa6792 100644 --- a/man/org.freedesktop.machine1.xml +++ b/man/org.freedesktop.machine1.xml @@ -719,4 +719,13 @@ $ gdbus introspect --system \ and <varname>SSHPrivateKeyPath</varname> were added in version 256.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <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> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.network1.xml b/man/org.freedesktop.network1.xml index 1d8ce0de81..c7f1a68798 100644 --- a/man/org.freedesktop.network1.xml +++ b/man/org.freedesktop.network1.xml @@ -602,4 +602,13 @@ $ gdbus introspect --system \ <para><varname>NamespaceNSID</varname> was added in version 256.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <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>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.oom1.xml b/man/org.freedesktop.oom1.xml index 1b549c347c..4b61119d6b 100644 --- a/man/org.freedesktop.oom1.xml +++ b/man/org.freedesktop.oom1.xml @@ -103,4 +103,14 @@ node /org/freedesktop/oom1 { <para><function>Killed()</function> was added in version 252.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <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>oomctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> + </refentry> diff --git a/man/org.freedesktop.portable1.xml b/man/org.freedesktop.portable1.xml index 4de3da2905..af5e303e6e 100644 --- a/man/org.freedesktop.portable1.xml +++ b/man/org.freedesktop.portable1.xml @@ -591,4 +591,13 @@ node /org/freedesktop/portable1 { <para><function>ReattachWithExtensions()</function> was added in version 254.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-portabled.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>portablectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.resolve1.xml b/man/org.freedesktop.resolve1.xml index f6b70d6e4f..07c0528b5c 100644 --- a/man/org.freedesktop.resolve1.xml +++ b/man/org.freedesktop.resolve1.xml @@ -935,4 +935,13 @@ $ gdbus introspect --system \ </refsect1> <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> + + <refsect1> + <title>See Also</title> + <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/org.freedesktop.systemd1.xml b/man/org.freedesktop.systemd1.xml index 7ade8c3e8b..e554e860ca 100644 --- a/man/org.freedesktop.systemd1.xml +++ b/man/org.freedesktop.systemd1.xml @@ -3263,6 +3263,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PrivateIPC = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s PrivatePIDs = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectHome = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectSystem = '...'; @@ -4584,6 +4586,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <variablelist class="dbus-property" generated="True" extra-ref="PrivateIPC"/> + <variablelist class="dbus-property" generated="True" extra-ref="PrivatePIDs"/> + <variablelist class="dbus-property" generated="True" extra-ref="ProtectHome"/> <variablelist class="dbus-property" generated="True" extra-ref="ProtectSystem"/> @@ -4870,6 +4874,11 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2eservice { <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Unlike boolean <varname>ProtectControlGroups</varname>, <varname>ProtectControlGroupsEx</varname> is a string type.</para> + + <para><varname>PrivatePIDs</varname> implements the destination parameter of the + unit file setting <varname>PrivatePIDs=</varname> listed in + <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + Note <varname>PrivatePIDs</varname> is a string type to allow adding more values in the future.</para> </refsect2> </refsect1> @@ -5439,6 +5448,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PrivateIPC = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s PrivatePIDs = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectHome = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectSystem = '...'; @@ -6744,6 +6755,8 @@ node /org/freedesktop/systemd1/unit/avahi_2ddaemon_2esocket { <variablelist class="dbus-property" generated="True" extra-ref="PrivateIPC"/> + <variablelist class="dbus-property" generated="True" extra-ref="PrivatePIDs"/> + <variablelist class="dbus-property" generated="True" extra-ref="ProtectHome"/> <variablelist class="dbus-property" generated="True" extra-ref="ProtectSystem"/> @@ -7442,6 +7455,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PrivateIPC = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s PrivatePIDs = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectHome = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectSystem = '...'; @@ -8585,6 +8600,8 @@ node /org/freedesktop/systemd1/unit/home_2emount { <variablelist class="dbus-property" generated="True" extra-ref="PrivateIPC"/> + <variablelist class="dbus-property" generated="True" extra-ref="PrivatePIDs"/> + <variablelist class="dbus-property" generated="True" extra-ref="ProtectHome"/> <variablelist class="dbus-property" generated="True" extra-ref="ProtectSystem"/> @@ -9412,6 +9429,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly b PrivateIPC = ...; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") + readonly s PrivatePIDs = '...'; + @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectHome = '...'; @org.freedesktop.DBus.Property.EmitsChangedSignal("const") readonly s ProtectSystem = '...'; @@ -10527,6 +10546,8 @@ node /org/freedesktop/systemd1/unit/dev_2dsda3_2eswap { <variablelist class="dbus-property" generated="True" extra-ref="PrivateIPC"/> + <variablelist class="dbus-property" generated="True" extra-ref="PrivatePIDs"/> + <variablelist class="dbus-property" generated="True" extra-ref="ProtectHome"/> <variablelist class="dbus-property" generated="True" extra-ref="ProtectSystem"/> @@ -12281,8 +12302,9 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>ExtraFileDescriptorNames</varname>, <varname>ManagedOOMMemoryPressureDurationUSec</varname>, <varname>BindLogSockets</varname>, - <varname>ProtectControlGroupsEx</varname>, and - <varname>PrivateUsersEx</varname> were added in version 257.</para> + <varname>ProtectControlGroupsEx</varname>, + <varname>PrivateUsersEx</varname>, and + <varname>PrivatePIDs</varname> were added in version 257.</para> </refsect2> <refsect2> <title>Socket Unit Objects</title> @@ -12323,8 +12345,9 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>ImportCredentialEx</varname>, <varname>BindLogSockets</varname>, <varname>PrivateUsersEx</varname>, - <varname>ManagedOOMMemoryPressureDurationUSec</varname>, and - <varname>ProtectControlGroupsEx</varname> were added in version 257.</para> + <varname>ManagedOOMMemoryPressureDurationUSec</varname>, + <varname>ProtectControlGroupsEx</varname>, and + <varname>PrivatePIDs</varname> were added in version 257.</para> </refsect2> <refsect2> <title>Mount Unit Objects</title> @@ -12362,8 +12385,9 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>ImportCredentialEx</varname>, <varname>BindLogSockets</varname>, <varname>PrivateUsersEx</varname>, - <varname>ManagedOOMMemoryPressureDurationUSec</varname>, and - <varname>ProtectControlGroupsEx</varname> were added in version 257.</para> + <varname>ManagedOOMMemoryPressureDurationUSec</varname>, + <varname>ProtectControlGroupsEx</varname>, and + <varname>PrivatePIDs</varname> were added in version 257.</para> </refsect2> <refsect2> <title>Swap Unit Objects</title> @@ -12401,8 +12425,9 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <varname>ImportCredentialEx</varname>, <varname>BindLogSockets</varname>, <varname>PrivateUsersEx</varname>, - <varname>ManagedOOMMemoryPressureDurationUSec</varname>, and - <varname>ProtectControlGroupsEx</varname> were added in version 257.</para> + <varname>ManagedOOMMemoryPressureDurationUSec</varname>, + <varname>ProtectControlGroupsEx</varname>, and + <varname>PrivatePIDs</varname> were added in version 257.</para> </refsect2> <refsect2> <title>Slice Unit Objects</title> @@ -12464,4 +12489,13 @@ $ gdbus introspect --system --dest org.freedesktop.systemd1 \ <para><varname>DeferReactivation</varname> was added in version 257.</para> </refsect2> </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/org.freedesktop.sysupdate1.xml b/man/org.freedesktop.sysupdate1.xml index 29b938f1a6..a109cef04a 100644 --- a/man/org.freedesktop.sysupdate1.xml +++ b/man/org.freedesktop.sysupdate1.xml @@ -582,4 +582,13 @@ node /org/freedesktop/sysupdate1/job/_1 { <varname>Progress</varname> were added in version 257.</para> </refsect2> </refsect1> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-sysupdated.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>updatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/org.freedesktop.timedate1.xml b/man/org.freedesktop.timedate1.xml index 1dfb630545..d0271145f9 100644 --- a/man/org.freedesktop.timedate1.xml +++ b/man/org.freedesktop.timedate1.xml @@ -194,7 +194,11 @@ $ gdbus introspect --system \ <refsect1> <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> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timedate.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>timedatectl.service</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><ulink url="https://lists.freedesktop.org/archives/systemd-devel/2011-May/002526.html">More information on how the system clock and RTC interact</ulink></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/org.freedesktop.timesync1.xml b/man/org.freedesktop.timesync1.xml index 22bf73103d..70f8b70b3a 100644 --- a/man/org.freedesktop.timesync1.xml +++ b/man/org.freedesktop.timesync1.xml @@ -153,4 +153,11 @@ $ gdbus introspect --system \ <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-timesync.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> </refentry> diff --git a/man/pstore.conf.xml b/man/pstore.conf.xml index 6173765130..ef431c8a6c 100644 --- a/man/pstore.conf.xml +++ b/man/pstore.conf.xml @@ -91,9 +91,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd-journald.service</refentrytitle><manvolnum>8</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd-pstore.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/rules/meson.build b/man/rules/meson.build index eb4300386d..ce587efb21 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -155,6 +155,7 @@ manpages = [ ['sd-journal', '3', [], ''], ['sd-json', '3', [], ''], ['sd-login', '3', [], 'HAVE_PAM'], + ['sd-varlink', '3', [], ''], ['sd_booted', '3', [], ''], ['sd_bus_add_match', '3', diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 26392d7a31..7392c2b4b0 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -179,6 +179,9 @@ <member><citerefentry><refentrytitle>sd_bus_track_new</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> </simplelist> for more information about the functions available.</para> + + <para>The <citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool + makes the functionality implemented by sd-bus available from the command line.</para> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> @@ -189,9 +192,10 @@ <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry><refentrytitle>busctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry project='man-pages'><refentrytitle>dbus-daemon</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> <member><citerefentry project='man-pages'><refentrytitle>dbus-send</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> </simplelist></para> </refsect1> - </refentry> diff --git a/man/sd-json.xml b/man/sd-json.xml index e10ef0d953..95a1985d6f 100644 --- a/man/sd-json.xml +++ b/man/sd-json.xml @@ -84,7 +84,8 @@ <refsect1> <title>See Also</title> <para><simplelist type="inline"> - <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>, + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-varlink</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/sd-varlink.xml b/man/sd-varlink.xml new file mode 100644 index 0000000000..b28d100b31 --- /dev/null +++ b/man/sd-varlink.xml @@ -0,0 +1,64 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" + "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"> +<!-- SPDX-License-Identifier: LGPL-2.1-or-later --> + +<refentry id="sd-varlink" + xmlns:xi="http://www.w3.org/2001/XInclude"> + + <refentryinfo> + <title>sd-varlink</title> + <productname>systemd</productname> + </refentryinfo> + + <refmeta> + <refentrytitle>sd-varlink</refentrytitle> + <manvolnum>3</manvolnum> + </refmeta> + + <refnamediv> + <refname>sd-varlink</refname> + <refpurpose>APIs for Varlink IPC</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <funcsynopsis> + <funcsynopsisinfo>#include <systemd/sd-varlink.h></funcsynopsisinfo> + </funcsynopsis> + + <cmdsynopsis> + <command>pkg-config --cflags --libs libsystemd</command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + + <para><filename>sd-varlink.h</filename> is part of + <citerefentry><refentrytitle>libsystemd</refentrytitle><manvolnum>3</manvolnum></citerefentry> and + provides APIs for implementing Varlink IPC clients and services. See <ulink url="https://varlink.org/"/> + for more information about Varlink IPC.</para> + + <para>Varlink IPC uses <ulink url="https://json.org/">JSON</ulink> as marshalling format. The sd-varlink + API relies on the + <citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry> API for JSON + seralization, deserialization and manipulation.</para> + + <para>The <citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry> tool + makes the functionality implemented by sd-varlink available from the command line.</para> + </refsect1> + + <xi:include href="libsystemd-pkgconfig.xml" /> + + <refsect1> + <title>See Also</title> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-event</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-json</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>varlinkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry project='die-net'><refentrytitle>pkg-config</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> + </refsect1> +</refentry> diff --git a/man/sd_bus_get_fd.xml b/man/sd_bus_get_fd.xml index 9d239f3294..c7bab0f955 100644 --- a/man/sd_bus_get_fd.xml +++ b/man/sd_bus_get_fd.xml @@ -66,8 +66,8 @@ <constant>POLLIN</constant>, <constant>POLLOUT</constant>, … events, or negative on error. </para> - <para><function>sd_bus_get_timeout()</function> returns the <emphasis>absolute</emphasis> time-out in μs, - from which the relative time-out to pass to <function>poll()</function> (or a similar call) can be + <para><function>sd_bus_get_timeout()</function> returns the <emphasis>absolute</emphasis> timeout in μs, + from which the relative timeout to pass to <function>poll()</function> (or a similar call) can be derived, when waiting for events on the specified bus connection. The returned timeout may be zero, in which case a subsequent I/O polling call should be invoked in non-blocking mode. The returned timeout may be <constant>UINT64_MAX</constant> in which case the I/O polling call may block indefinitely, without any diff --git a/man/sd_bus_pending_method_calls.xml b/man/sd_bus_pending_method_calls.xml index 063009cf94..9ed14f190f 100644 --- a/man/sd_bus_pending_method_calls.xml +++ b/man/sd_bus_pending_method_calls.xml @@ -40,7 +40,7 @@ <para><function>sd_bus_pending_method_calls()</function> returns the number of currently pending outgoing method calls, i.e. method calls enqueued with <citerefentry><refentrytitle>sd_bus_call_async</refentrytitle><manvolnum>3</manvolnum></citerefentry> for - which no reply has been received yet, and which have not reached a time-out yet.</para> + which no reply has been received yet, and which have not reached a timeout yet.</para> <para>The <parameter>bus</parameter> argument may be <constant>NULL</constant>, in which case zero is returned.</para> diff --git a/man/sd_device_get_syspath.xml b/man/sd_device_get_syspath.xml index 8856c38644..36e9194620 100644 --- a/man/sd_device_get_syspath.xml +++ b/man/sd_device_get_syspath.xml @@ -250,9 +250,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-device</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_event_exit.xml b/man/sd_event_exit.xml index faa1ea992f..b01e110ca4 100644 --- a/man/sd_event_exit.xml +++ b/man/sd_event_exit.xml @@ -83,7 +83,7 @@ <citerefentry><refentrytitle>sd_event_add_signal</refentrytitle><manvolnum>3</manvolnum></citerefentry>, …) has the effect of <function>sd_event_exit()</function> being invoked once the event source triggers, with the specified userdata pointer cast to an integer as the exit code parameter. This is useful to - automatically terminate an event loop after some condition, such as a time-out or reception of + automatically terminate an event loop after some condition, such as a timeout or reception of <constant>SIGTERM</constant> or similar. See the documentation for the respective constructor call for details.</para> </refsect1> diff --git a/man/sd_journal_has_runtime_files.xml b/man/sd_journal_has_runtime_files.xml index 12870d72cb..dd6fc02d58 100644 --- a/man/sd_journal_has_runtime_files.xml +++ b/man/sd_journal_has_runtime_files.xml @@ -77,9 +77,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>sd-journal</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> + </simplelist></para> </refsect1> </refentry> diff --git a/man/sd_path_lookup.xml b/man/sd_path_lookup.xml index f557e4f6bf..fc6bac640c 100644 --- a/man/sd_path_lookup.xml +++ b/man/sd_path_lookup.xml @@ -226,10 +226,11 @@ <refsect1> <title>See Also</title> - - <para> - <citerefentry><refentrytitle>systemd-path</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>sd-path</refentrytitle><manvolnum>3</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-path</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-ac-power.xml b/man/systemd-ac-power.xml index cbf7279f51..a693187864 100644 --- a/man/systemd-ac-power.xml +++ b/man/systemd-ac-power.xml @@ -75,9 +75,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</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 bb7f2b6b3e..0021aec971 100644 --- a/man/systemd-backlight@.service.xml +++ b/man/systemd-backlight@.service.xml @@ -71,9 +71,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-battery-check.service.xml b/man/systemd-battery-check.service.xml index a5f564b888..2824797c04 100644 --- a/man/systemd-battery-check.service.xml +++ b/man/systemd-battery-check.service.xml @@ -83,9 +83,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-bsod.service.xml b/man/systemd-bsod.service.xml index 5ef10c2c07..29a08710c2 100644 --- a/man/systemd-bsod.service.xml +++ b/man/systemd-bsod.service.xml @@ -79,9 +79,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-hostnamed.service.xml b/man/systemd-hostnamed.service.xml index c2a4015ff0..e7dc879201 100644 --- a/man/systemd-hostnamed.service.xml +++ b/man/systemd-hostnamed.service.xml @@ -76,6 +76,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.hostname1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-hwdb.xml b/man/systemd-hwdb.xml index 3c6feb2a4a..ab27643e6e 100644 --- a/man/systemd-hwdb.xml +++ b/man/systemd-hwdb.xml @@ -83,8 +83,9 @@ <refsect1> <title>See Also</title> - <para><citerefentry> - <refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum> - </citerefentry></para> + <para> + <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry><refentrytitle>hwdb</refentrytitle><manvolnum>7</manvolnum></citerefentry> + </para> </refsect1> </refentry> diff --git a/man/systemd-importd.service.xml b/man/systemd-importd.service.xml index dfeaff4fd7..cc5ac6af22 100644 --- a/man/systemd-importd.service.xml +++ b/man/systemd-importd.service.xml @@ -50,6 +50,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.import1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-initctl.service.xml b/man/systemd-initctl.service.xml index af092b88b3..ad0d49de48 100644 --- a/man/systemd-initctl.service.xml +++ b/man/systemd-initctl.service.xml @@ -41,9 +41,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-localed.service.xml b/man/systemd-localed.service.xml index ef597de278..43a4f66b5a 100644 --- a/man/systemd-localed.service.xml +++ b/man/systemd-localed.service.xml @@ -55,6 +55,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.locale1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-logind.service.xml b/man/systemd-logind.service.xml index 4ecd700f8b..93bcd6bc8f 100644 --- a/man/systemd-logind.service.xml +++ b/man/systemd-logind.service.xml @@ -104,6 +104,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.login1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-machined.service.xml b/man/systemd-machined.service.xml index bb931ac50b..7ad35c8584 100644 --- a/man/systemd-machined.service.xml +++ b/man/systemd-machined.service.xml @@ -135,6 +135,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.machine1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-mountfsd.service.xml b/man/systemd-mountfsd.service.xml index 25c1568f33..a8f48365b0 100644 --- a/man/systemd-mountfsd.service.xml +++ b/man/systemd-mountfsd.service.xml @@ -62,9 +62,9 @@ <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> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-nsresourced.service</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-networkd.service.xml b/man/systemd-networkd.service.xml index b33a7f6510..2ded90f0f3 100644 --- a/man/systemd-networkd.service.xml +++ b/man/systemd-networkd.service.xml @@ -63,6 +63,12 @@ <para><command>systemd-networkd</command> may be introspected and controlled at runtime using <citerefentry><refentrytitle>networkctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>. </para> + + <para>See + <citerefentry><refentrytitle>org.freedesktop.network1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for a description of the D-Bus API.</para> </refsect1> <refsect1><title>Configuration Files</title> @@ -91,6 +97,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.network1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-nsresourced.service.xml b/man/systemd-nsresourced.service.xml index de43eacdd5..787312d858 100644 --- a/man/systemd-nsresourced.service.xml +++ b/man/systemd-nsresourced.service.xml @@ -69,13 +69,13 @@ <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> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-mountfsd.service</refentrytitle><manvolnum>8</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-dissect</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry project='man-pages'><refentrytitle>user_namespaces</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-oomd.service.xml b/man/systemd-oomd.service.xml index 51a9377ea0..53a9250983 100644 --- a/man/systemd-oomd.service.xml +++ b/man/systemd-oomd.service.xml @@ -57,6 +57,12 @@ <para>See <citerefentry><refentrytitle>oomd.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for more information about the configuration of this service.</para> + + <para>See + <citerefentry><refentrytitle>org.freedesktop.oom1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for a description of the D-Bus API.</para> </refsect1> <refsect1> @@ -129,6 +135,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.oom1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-portabled.service.xml b/man/systemd-portabled.service.xml index abf42cff2f..894b47bf27 100644 --- a/man/systemd-portabled.service.xml +++ b/man/systemd-portabled.service.xml @@ -37,6 +37,12 @@ <para>See the <ulink url="https://systemd.io/PORTABLE_SERVICES">Portable Services</ulink> page for details about the concepts this service implements.</para> + + <para>See + <citerefentry><refentrytitle>org.freedesktop.portable1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + and + <citerefentry><refentrytitle>org.freedesktop.LogControl1</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for a description of the D-Bus API.</para> </refsect1> <refsect1> diff --git a/man/systemd-poweroff.service.xml b/man/systemd-poweroff.service.xml index ec7ffdeb0d..c55260d380 100644 --- a/man/systemd-poweroff.service.xml +++ b/man/systemd-poweroff.service.xml @@ -44,7 +44,7 @@ <filename>kexec.target</filename> to execute the respective actions.</para> <para>When these services are run, they ensure that PID 1 is replaced by the - <filename>/usr/lib/systemd/systemd-shutdown</filename> tool which is then responsible for the actual + <filename>/usr/lib/systemd/systemd-shutdown</filename> binary which is then responsible for the actual shutdown. Before shutting down, this binary will try to unmount all remaining file systems (or at least remount them read-only), disable all remaining swap devices, detach all remaining storage devices and kill all remaining processes.</para> @@ -58,12 +58,12 @@ <filename>/usr/lib/systemd/system-shutdown/</filename> and pass one arguments to them: either <literal>poweroff</literal>, <literal>halt</literal>, <literal>reboot</literal>, or <literal>kexec</literal>, depending on the chosen action. All executables in this directory are executed - in parallel, and execution of the action is not continued before all executables finished. Note that - these executables are run <emphasis>after</emphasis> all services have been shut down, and after most - mounts have been unmounted (the root file system as well as <filename>/run/</filename> and various API - file systems are still around though). This means any programs dropped into this directory must be - prepared to run in such a limited execution environment and not rely on external services or hierarchies - such as <filename>/var/</filename> to be around (or writable).</para> + in parallel, and execution of the action is not continued before all executables finished. (A safety + timeout of 90s is applied however.) Note that these executables are run <emphasis>after</emphasis> all + services have been shut down, and after most mounts have been unmounted (the root file system as well as + <filename>/run/</filename> and various API file systems are still around though). This means any programs + dropped into this directory must be prepared to run in such a limited execution environment and not rely + on external services or hierarchies such as <filename>/var/</filename> to be around (or writable).</para> <para>Note that <filename>systemd-poweroff.service</filename> (and the related units) should never be executed directly. Instead, trigger system shutdown with a command such as <literal>systemctl diff --git a/man/systemd-pstore.service.xml b/man/systemd-pstore.service.xml index 12c5459597..f3a879625f 100644 --- a/man/systemd-pstore.service.xml +++ b/man/systemd-pstore.service.xml @@ -107,8 +107,8 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>pstore.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>pstore.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-resolved.service.xml b/man/systemd-resolved.service.xml index 210a843233..b7673dc6c4 100644 --- a/man/systemd-resolved.service.xml +++ b/man/systemd-resolved.service.xml @@ -516,6 +516,7 @@ search foobar.com barbar.com <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> + <member><citerefentry><refentrytitle>org.freedesktop.resolve1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-rfkill.service.xml b/man/systemd-rfkill.service.xml index 9449a048e3..9074ddcf17 100644 --- a/man/systemd-rfkill.service.xml +++ b/man/systemd-rfkill.service.xml @@ -60,9 +60,9 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-sysupdated.service.xml b/man/systemd-sysupdated.service.xml index 30a9bd8d69..768b19ef8d 100644 --- a/man/systemd-sysupdated.service.xml +++ b/man/systemd-sysupdated.service.xml @@ -45,11 +45,12 @@ <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>updatectl</refentrytitle><manvolnum>1</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>updatectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>org.freedesktop.sysupdate1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd-timedated.service.xml b/man/systemd-timedated.service.xml index eb4fc18096..9f119189d2 100644 --- a/man/systemd-timedated.service.xml +++ b/man/systemd-timedated.service.xml @@ -99,6 +99,7 @@ systemd-timesyncd.service <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> + <member><citerefentry><refentrytitle>org.freedesktop.timedate1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> </refsect1> diff --git a/man/systemd-tpm2-setup.service.xml b/man/systemd-tpm2-setup.service.xml index 3fa3490995..71b5de387c 100644 --- a/man/systemd-tpm2-setup.service.xml +++ b/man/systemd-tpm2-setup.service.xml @@ -75,8 +75,8 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 30a926c9a0..a955f767e4 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -893,8 +893,6 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> <refsect1> <title>Mandatory Access Control</title> - <xi:include href="system-only.xml" xpointer="plural"/> - <variablelist class='unit-directives'> <varlistentry> @@ -921,6 +919,8 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> prefixed by <literal>-</literal>, all errors will be ignored. This setting has no effect if AppArmor is not enabled. This setting does not affect commands prefixed with <literal>+</literal>.</para> + <xi:include href="system-only.xml" xpointer="singular"/> + <xi:include href="version-info.xml" xpointer="v210"/> </listitem> </varlistentry> @@ -939,6 +939,8 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> value may be specified to unset previous assignments. This does not affect commands prefixed with <literal>+</literal>.</para> + <xi:include href="system-only.xml" xpointer="singular"/> + <xi:include href="version-info.xml" xpointer="v218"/></listitem> </varlistentry> @@ -1431,6 +1433,10 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> set. This setting cannot ensure protection in all cases. In general it has the same limitations as <varname>ReadOnlyPaths=</varname>, see below. Defaults to off.</para> + <para>Note that if <varname>ProtectSystem=</varname> is set to <literal>strict</literal> and + <varname>PrivateTmp=</varname> is enabled, then <filename>/tmp/</filename> and + <filename>/var/tmp/</filename> will be writable.</para> + <xi:include href="version-info.xml" xpointer="v214"/></listitem> </varlistentry> @@ -1977,6 +1983,30 @@ BindReadOnlyPaths=/var/lib/systemd</programlisting> </varlistentry> <varlistentry> + <term><varname>PrivatePIDs=</varname></term> + + <listitem><para>Takes a boolean argument. Defaults to false. If enabled, sets up a new PID namespace + for the executed processes. Each executed process is now PID 1 - the init process - in the new namespace. + <filename>/proc/</filename> is mounted such that only processes in the PID namespace are visible. + If <varname>PrivatePIDs=</varname> is set, <varname>MountAPIVFS=yes</varname> is implied.</para> + + <para><varname>PrivatePIDs=</varname> is only supported for service units. This setting is not supported + with <varname>Type=forking</varname> since the kernel will kill all processes in the PID namespace if + the init process terminates.</para> + + <para>This setting will be ignored if the kernel does not support PID namespaces.</para> + + <para>Note unprivileged user services (i.e. a service run by the per-user instance of the service manager) + will fail with <varname>PrivatePIDs=yes</varname> if <filename>/proc/</filename> is masked + (i.e. <filename>/proc/kmsg</filename> is over-mounted with <constant>tmpfs</constant> like + <citerefentry><refentrytitle>systemd-nspawn</refentrytitle><manvolnum>1</manvolnum></citerefentry> does). + This is due to a kernel restriction not allowing unprivileged user namespaces to mount a less restrictive + instance of <filename>/proc/</filename>.</para> + + <xi:include href="version-info.xml" xpointer="v257"/></listitem> + </varlistentry> + + <varlistentry> <term><varname>PrivateUsers=</varname></term> <listitem><para>Takes a boolean argument or one of <literal>self</literal> or diff --git a/man/systemd.path.xml b/man/systemd.path.xml index 6281c3d847..1ef5db0a73 100644 --- a/man/systemd.path.xml +++ b/man/systemd.path.xml @@ -153,11 +153,14 @@ not apply to <varname>PathChanged=</varname> and <varname>PathModified=</varname>.</para> - <para>If the path itself or any of the containing directories - are not accessible, <command>systemd</command> will watch for - permission changes and notice that conditions are satisfied - when permissions allow that. </para></listitem> + <para>If the path itself or any of the containing directories are not accessible, + <command>systemd</command> will watch for permission changes and notice that conditions are satisfied + when permissions allow that. </para> + + <para>Note that files whose name starts with a dot (i.e. hidden files) are generally ignored when + monitoring these paths.</para></listitem> </varlistentry> + <varlistentry> <term><varname>Unit=</varname></term> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index a5c0dc84e1..7929f86528 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -551,11 +551,11 @@ <varname>ExecStop=</varname> – commands specified with this setting are invoked when a service failed to start up correctly and is shut down again.</para> - <para>It is recommended to use this setting for clean-up operations that shall be executed even when the - service failed to start up correctly. Commands configured with this setting need to be able to operate even if - the service failed starting up half-way and left incompletely initialized data around. As the service's - processes have been terminated already when the commands specified with this setting are executed they should - not attempt to communicate with them.</para> + <para>It is recommended to use this setting for clean-up operations that shall be executed even when + the service failed to start up correctly. Commands configured with this setting need to be able to + operate even if the service failed starting up half-way and left incompletely initialized data + around. As the service's processes have likely exited already when the commands specified with this + setting are executed they should not attempt to communicate with them.</para> <para>Note that all commands that are configured with this setting are invoked with the result code of the service, as well as the main process' exit code and status, set in the <varname>$SERVICE_RESULT</varname>, diff --git a/man/systemd.syntax.xml b/man/systemd.syntax.xml index 1dc46255ef..48b0a64c5c 100644 --- a/man/systemd.syntax.xml +++ b/man/systemd.syntax.xml @@ -224,9 +224,10 @@ KeyThree=value 3\ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry> - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd.time</refentrytitle><manvolnum>7</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/systemd.xml b/man/systemd.xml index 71da1ec8f1..e4eac906b3 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -1590,6 +1590,7 @@ <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> + <member><citerefentry><refentrytitle>org.freedesktop.systemd1</refentrytitle><manvolnum>5</manvolnum></citerefentry></member> </simplelist></para> <para>For more information about the concepts and diff --git a/man/udev_new.xml b/man/udev_new.xml index 7b13081fb1..4650cbecf3 100644 --- a/man/udev_new.xml +++ b/man/udev_new.xml @@ -82,9 +82,10 @@ <refsect1> <title>See Also</title> - <para> - <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - </para> + <para><simplelist type="inline"> + <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member> + <member><citerefentry><refentrytitle>systemd-udevd.sevice</refentrytitle><manvolnum>8</manvolnum></citerefentry></member> + </simplelist></para> </refsect1> </refentry> diff --git a/man/varlinkctl.xml b/man/varlinkctl.xml index 1f9012ec62..1e0562682f 100644 --- a/man/varlinkctl.xml +++ b/man/varlinkctl.xml @@ -202,19 +202,19 @@ <listitem><para>When used with <command>call</command>: expect multiple method replies. If this flag is set the method call is sent with the <constant>more</constant> flag set, which tells the service to generate multiple replies, if needed. The command remains running until the service sends a reply - message that indicates it is the last in the series (or if the configured time-out is reached, see + message that indicates it is the last in the series (or if the configured timeout is reached, see below). This flag should be set only for method calls that support this mechanism.</para> <para>If this mode is enabled output is automatically switched to JSON-SEQ mode, so that individual reply objects can be easily discerned.</para> - <para>This switch has no effect on the method call time-out applied by default: regardless if - <option>--more</option> is specified or not, the default time-out will be 45s. Use - <option>--timeout=</option> (see below) to change or disable the time-out. When invoking a method - call that continuously returns updates it is typically desirable to disable the time-out with + <para>This switch has no effect on the method call timeout applied by default: regardless if + <option>--more</option> is specified or not, the default timeout will be 45s. Use + <option>--timeout=</option> (see below) to change or disable the timeout. When invoking a method + call that continuously returns updates it is typically desirable to disable the timeout with <option>--timeout=infinity</option>. On the other hand, when invoking a <option>--more</option> method call for the purpose of enumerating objects (which likely will complete quickly) it is - typically beneficial to leave the time-out logic enabled, for robustness reasons.</para> + typically beneficial to leave the timeout logic enabled, for robustness reasons.</para> <xi:include href="version-info.xml" xpointer="v255"/></listitem> </varlistentry> @@ -300,8 +300,8 @@ <term><option>--timeout=</option></term> <listitem> - <para>Expects a time-out in seconds as parameter. By default a time-out of 45s is enforced. To turn - off the time-out specify <literal>infinity</literal> or an empty string.</para> + <para>Expects a timeout in seconds as parameter. By default a timeout of 45s is enforced. To turn + off the timeout specify <literal>infinity</literal> or an empty string.</para> <xi:include href="version-info.xml" xpointer="v257"/> </listitem> |