diff options
Diffstat (limited to 'man')
41 files changed, 383 insertions, 270 deletions
diff --git a/man/coredump.conf.xml b/man/coredump.conf.xml index ee3c1b6919..4ccc174bbc 100644 --- a/man/coredump.conf.xml +++ b/man/coredump.conf.xml @@ -54,7 +54,7 @@ <para>All options are configured in the <literal>[Coredump]</literal> section:</para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>Storage=</varname></term> diff --git a/man/journal-remote.conf.xml b/man/journal-remote.conf.xml index acc1817cd8..8fa557c0ba 100644 --- a/man/journal-remote.conf.xml +++ b/man/journal-remote.conf.xml @@ -51,7 +51,7 @@ <para>All options are configured in the <literal>[Remote]</literal> section:</para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>Seal=</varname></term> diff --git a/man/journal-upload.conf.xml b/man/journal-upload.conf.xml index c3bfa47950..3dda3019b5 100644 --- a/man/journal-upload.conf.xml +++ b/man/journal-upload.conf.xml @@ -48,7 +48,7 @@ <para>All options are configured in the <literal>[Upload]</literal> section:</para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>URL=</varname></term> diff --git a/man/journalctl.xml b/man/journalctl.xml index 58f3aa205a..7ff0a479e0 100644 --- a/man/journalctl.xml +++ b/man/journalctl.xml @@ -118,8 +118,8 @@ <para>When outputting to a tty, lines are colored according to priority: lines of level ERROR and higher are colored red; lines - of level NOTICE and higher are highlighted; other lines are - displayed normally.</para> + of level NOTICE and higher are highlighted; lines of level DEBUG + are colored lighter grey; other lines are displayed normally.</para> </refsect1> <refsect1> diff --git a/man/journald.conf.xml b/man/journald.conf.xml index ed874aace9..2791678a4f 100644 --- a/man/journald.conf.xml +++ b/man/journald.conf.xml @@ -50,7 +50,7 @@ <para>All options are configured in the <literal>[Journal]</literal> section:</para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>Storage=</varname></term> @@ -258,7 +258,7 @@ <listitem><para>The maximum time to store journal entries. This controls whether journal files containing entries older - then the specified time span are deleted. Normally, time-based + than the specified time span are deleted. Normally, time-based deletion of old journal files should not be required as size-based deletion with options such as <varname>SystemMaxUse=</varname> should be sufficient to diff --git a/man/kernel-command-line.xml b/man/kernel-command-line.xml index 9d86bdf203..43dfc1073b 100644 --- a/man/kernel-command-line.xml +++ b/man/kernel-command-line.xml @@ -428,6 +428,7 @@ <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 project='man-pages'><refentrytitle>dracut.cmdline</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemd-debug-generator</refentrytitle><manvolnum>8</manvolnum></citerefentry>, diff --git a/man/kernel-install.xml b/man/kernel-install.xml index 83e50c8d70..50e1320105 100644 --- a/man/kernel-install.xml +++ b/man/kernel-install.xml @@ -28,7 +28,8 @@ <command>kernel-install</command> <arg choice="plain">COMMAND</arg> <arg choice="plain"><replaceable>KERNEL-VERSION</replaceable></arg> - <arg choice="opt"><replaceable>KERNEL-IMAGE</replaceable></arg> + <arg choice="plain"><replaceable>KERNEL-IMAGE</replaceable></arg> + <arg choice="opt" rep="repeat"><replaceable>INITRD-FILE</replaceable></arg> </cmdsynopsis> </refsynopsisdiv> @@ -61,7 +62,7 @@ <para>The following commands are understood:</para> <variablelist> <varlistentry> - <term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable></command></term> + <term><command>add <replaceable>KERNEL-VERSION</replaceable> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</command></term> <listitem> <para>This command expects a kernel version string and a path to a kernel image file as arguments. <command>kernel-install</command> creates the directory @@ -69,7 +70,7 @@ and calls the executables from <filename>/usr/lib/kernel/install.d/*.install</filename> and <filename>/etc/kernel/install.d/*.install</filename> with the following arguments: - <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable></programlisting> + <programlisting>add <replaceable>KERNEL-VERSION</replaceable> <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/</filename> <replaceable>KERNEL-IMAGE</replaceable> [<replaceable>INITRD-FILE</replaceable> ...]</programlisting> </para> <para>Two default plugins execute the following operations in this case:</para> @@ -83,14 +84,15 @@ <listitem><para><filename>90-loaderentry.install</filename> copies <replaceable>KERNEL-IMAGE</replaceable> to <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL-VERSION</replaceable>/linux</filename>. + If an <replaceable>INITRD-FILE</replaceable> is provided, it also copies <replaceable>INITRD-FILE</replaceable> + to + <filename>/boot/<replaceable>MACHINE-ID</replaceable>/<replaceable>KERNEL_VERSION</replaceable>/<replaceable>INITRD-FILE</replaceable></filename>. It also creates a boot loader entry according to the <ulink url="https://systemd.io/BOOT_LOADER_SPECIFICATION">Boot Loader Specification</ulink> in <filename>/boot/loader/entries/<replaceable>MACHINE-ID</replaceable>-<replaceable>KERNEL-VERSION</replaceable>.conf</filename>. The title of the entry is the <replaceable>PRETTY_NAME</replaceable> parameter specified in <filename>/etc/os-release</filename> or <filename>/usr/lib/os-release</filename> (if the former is - missing), or "Linux <replaceable>KERNEL-VERSION</replaceable>", if unset. If the file - <filename>initrd</filename> is found next to the kernel image file, the initrd will be added to the - configuration.</para></listitem> + missing), or "Linux <replaceable>KERNEL-VERSION</replaceable>", if unset.</para></listitem> </itemizedlist> </listitem> </varlistentry> diff --git a/man/logind.conf.xml b/man/logind.conf.xml index a407858957..ac8032ab4d 100644 --- a/man/logind.conf.xml +++ b/man/logind.conf.xml @@ -51,7 +51,7 @@ <para>All options are configured in the <literal>[Login]</literal> section:</para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>NAutoVTs=</varname></term> diff --git a/man/machine-info.xml b/man/machine-info.xml index 476996ce5f..5a268c9f36 100644 --- a/man/machine-info.xml +++ b/man/machine-info.xml @@ -58,7 +58,7 @@ <para>The following machine metadata parameters may be set using <filename>/etc/machine-info</filename>:</para> - <variablelist> + <variablelist class='environment-variables'> <varlistentry> <term><varname>PRETTY_HOSTNAME=</varname></term> diff --git a/man/os-release.xml b/man/os-release.xml index ea71b36c1e..6de0cd7148 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -90,7 +90,7 @@ <para>The following OS identifications parameters may be set using <filename>os-release</filename>:</para> - <variablelist> + <variablelist class='environment-variables'> <varlistentry> <term><varname>NAME=</varname></term> diff --git a/man/pam_systemd.xml b/man/pam_systemd.xml index 3ce3b282bd..e5e14c12d7 100644 --- a/man/pam_systemd.xml +++ b/man/pam_systemd.xml @@ -82,7 +82,7 @@ <variablelist class='pam-directives'> <varlistentry> - <term><option>class=</option></term> + <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>, @@ -92,7 +92,7 @@ </varlistentry> <varlistentry> - <term><option>type=</option></term> + <term><varname>type=</varname></term> <listitem><para>Takes a string argument which sets the session type. The <varname>XDG_SESSION_TYPE</varname> environment variable (see below) takes precedence. One of <literal>unspecified</literal>, @@ -102,7 +102,7 @@ </varlistentry> <varlistentry> - <term><option>desktop=</option></term> + <term><varname>desktop=</varname></term> <listitem><para>Takes a single, short identifier string for the desktop environment. The <varname>XDG_SESSION_DESKTOP</varname> environment variable (see below) takes precedence. This may be used to @@ -117,7 +117,7 @@ </varlistentry> <varlistentry> - <term><option>debug<optional>=</optional></option></term> + <term><varname>debug</varname><optional>=</optional></term> <listitem><para>Takes an optional boolean argument. If yes or without the argument, the module will log debugging information as it operates.</para></listitem> @@ -186,21 +186,21 @@ <varlistentry> <term><varname>$XDG_SESSION_TYPE</varname></term> - <listitem><para>The session type. This may be used instead of <option>session=</option> on the module parameter + <listitem><para>The session type. This may be used instead of <varname>session=</varname> on the module parameter line, and is usually preferred.</para></listitem> </varlistentry> <varlistentry> <term><varname>$XDG_SESSION_CLASS</varname></term> - <listitem><para>The session class. This may be used instead of <option>class=</option> on the module parameter + <listitem><para>The session class. This may be used instead of <varname>class=</varname> on the module parameter line, and is usually preferred.</para></listitem> </varlistentry> <varlistentry> <term><varname>$XDG_SESSION_DESKTOP</varname></term> - <listitem><para>The desktop identifier. This may be used instead of <option>desktop=</option> on the module + <listitem><para>The desktop identifier. This may be used instead of <varname>desktop=</varname> on the module parameter line, and is usually preferred.</para></listitem> </varlistentry> @@ -242,7 +242,7 @@ the context objects. </para> - <variablelist> + <variablelist class='pam-directives'> <varlistentry> <term><varname>systemd.memory_max</varname></term> diff --git a/man/sd-bus-errors.xml b/man/sd-bus-errors.xml index c896511541..a94022c025 100644 --- a/man/sd-bus-errors.xml +++ b/man/sd-bus-errors.xml @@ -112,7 +112,7 @@ <variablelist> <varlistentry> - <term><varname>SD_BUS_ERROR_FAILED</varname></term> + <term><constant>SD_BUS_ERROR_FAILED</constant></term> <listitem><para>A generic error indication. See the error message for further details. This error name should be avoided, in favor of a more expressive error @@ -120,134 +120,134 @@ </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NO_MEMORY</varname></term> + <term><constant>SD_BUS_ERROR_NO_MEMORY</constant></term> <listitem><para>A memory allocation failed, and the requested operation could not be completed.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_SERVICE_UNKNOWN</varname></term> + <term><constant>SD_BUS_ERROR_SERVICE_UNKNOWN</constant></term> <listitem><para>The contacted bus service is unknown and cannot be activated.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NAME_HAS_NO_OWNER</varname></term> + <term><constant>SD_BUS_ERROR_NAME_HAS_NO_OWNER</constant></term> <listitem><para>The specified bus service name currently has no owner.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NO_REPLY</varname></term> + <term><constant>SD_BUS_ERROR_NO_REPLY</constant></term> <listitem><para>A message did not receive a reply. This error is usually generated after a timeout.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_IO_ERROR</varname></term> + <term><constant>SD_BUS_ERROR_IO_ERROR</constant></term> <listitem><para>Generic input/output error, for example when accessing a socket or other I/O context.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_BAD_ADDRESS</varname></term> + <term><constant>SD_BUS_ERROR_BAD_ADDRESS</constant></term> <listitem><para>The specified D-Bus bus address string is malformed.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NOT_SUPPORTED</varname></term> + <term><constant>SD_BUS_ERROR_NOT_SUPPORTED</constant></term> <listitem><para>The requested operation is not supported on the local system.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_LIMITS_EXCEEDED</varname></term> + <term><constant>SD_BUS_ERROR_LIMITS_EXCEEDED</constant></term> <listitem><para>Some limited resource has been exhausted.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_ACCESS_DENIED</varname></term> + <term><constant>SD_BUS_ERROR_ACCESS_DENIED</constant></term> <listitem><para>Access to a resource has been denied due to security restrictions.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_AUTH_FAILED</varname></term> + <term><constant>SD_BUS_ERROR_AUTH_FAILED</constant></term> <listitem><para>Authentication did not complete successfully.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NO_SERVER</varname></term> + <term><constant>SD_BUS_ERROR_NO_SERVER</constant></term> <listitem><para>Unable to connect to the specified server.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_TIMEOUT</varname></term> + <term><constant>SD_BUS_ERROR_TIMEOUT</constant></term> <listitem><para>An operation timed out. Note that method calls which timeout generate a - <varname>SD_BUS_ERROR_NO_REPLY</varname>.</para></listitem> + <constant>SD_BUS_ERROR_NO_REPLY</constant>.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_NO_NETWORK</varname></term> + <term><constant>SD_BUS_ERROR_NO_NETWORK</constant></term> <listitem><para>No network available to execute requested network operation on.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_ADDRESS_IN_USE</varname></term> + <term><constant>SD_BUS_ERROR_ADDRESS_IN_USE</constant></term> <listitem><para>The specified network address is already being listened on.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_DISCONNECTED</varname></term> + <term><constant>SD_BUS_ERROR_DISCONNECTED</constant></term> <listitem><para>The connection has been terminated.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_INVALID_ARGS</varname></term> + <term><constant>SD_BUS_ERROR_INVALID_ARGS</constant></term> <listitem><para>One or more invalid arguments have been passed.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_FILE_NOT_FOUND</varname></term> + <term><constant>SD_BUS_ERROR_FILE_NOT_FOUND</constant></term> <listitem><para>The requested file could not be found.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_FILE_EXISTS</varname></term> + <term><constant>SD_BUS_ERROR_FILE_EXISTS</constant></term> <listitem><para>The requested file already exists.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_METHOD</varname></term> + <term><constant>SD_BUS_ERROR_UNKNOWN_METHOD</constant></term> <listitem><para>The requested method does not exist in the selected interface.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_OBJECT</varname></term> + <term><constant>SD_BUS_ERROR_UNKNOWN_OBJECT</constant></term> <listitem><para>The requested object does not exist in the selected service.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_INTERFACE</varname></term> + <term><constant>SD_BUS_ERROR_UNKNOWN_INTERFACE</constant></term> <listitem><para>The requested interface does not exist on the selected object.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_UNKNOWN_PROPERTY</varname></term> + <term><constant>SD_BUS_ERROR_UNKNOWN_PROPERTY</constant></term> <listitem><para>The requested property does not exist in the selected interface.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_PROPERTY_READ_ONLY</varname></term> + <term><constant>SD_BUS_ERROR_PROPERTY_READ_ONLY</constant></term> <listitem><para>A write operation was requested on a read-only property.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</varname></term> + <term><constant>SD_BUS_ERROR_UNIX_PROCESS_ID_UNKNOWN</constant></term> <listitem><para>The requested PID is not known.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_INVALID_SIGNATURE</varname></term> + <term><constant>SD_BUS_ERROR_INVALID_SIGNATURE</constant></term> <listitem><para>The specified message signature is not valid.</para> </listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_INCONSISTENT_MESSAGE</varname></term> + <term><constant>SD_BUS_ERROR_INCONSISTENT_MESSAGE</constant></term> <listitem><para>The passed message does not validate correctly.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</varname></term> + <term><constant>SD_BUS_ERROR_MATCH_RULE_NOT_FOUND</constant></term> <listitem><para>The specified match rule does not exist.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_MATCH_RULE_INVALID</varname></term> + <term><constant>SD_BUS_ERROR_MATCH_RULE_INVALID</constant></term> <listitem><para>The specified match rule is invalid.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</varname></term> + <term><constant>SD_BUS_ERROR_INTERACTIVE_AUTHORIZATION_REQUIRED</constant></term> <listitem><para>Access to the requested operation is not permitted. However, it might be available after interactive authentication. This is usually returned by method calls diff --git a/man/sd-login.xml b/man/sd-login.xml index 83ef0b7307..374395726f 100644 --- a/man/sd-login.xml +++ b/man/sd-login.xml @@ -148,7 +148,7 @@ <para>Assignment of hardware devices to seats is managed inside the udev database, via settings on the devices:</para> - <variablelist> + <variablelist class='udev-directives'> <varlistentry> <term>Tag <literal>seat</literal></term> diff --git a/man/sd_bus_new.xml b/man/sd_bus_new.xml index 1bc011d70a..cc08e6be17 100644 --- a/man/sd_bus_new.xml +++ b/man/sd_bus_new.xml @@ -23,6 +23,8 @@ <refname>sd_bus_ref</refname> <refname>sd_bus_unref</refname> <refname>sd_bus_unrefp</refname> + <refname>sd_bus_close_unref</refname> + <refname>sd_bus_close_unrefp</refname> <refname>sd_bus_flush_close_unref</refname> <refname>sd_bus_flush_close_unrefp</refname> @@ -49,8 +51,8 @@ </funcprototype> <funcprototype> - <funcdef>void <function>sd_bus_unrefp</function></funcdef> - <paramdef>sd_bus **<parameter>busp</parameter></paramdef> + <funcdef>sd_bus *<function>sd_bus_close_unref</function></funcdef> + <paramdef>sd_bus *<parameter>bus</parameter></paramdef> </funcprototype> <funcprototype> @@ -59,6 +61,16 @@ </funcprototype> <funcprototype> + <funcdef>void <function>sd_bus_unrefp</function></funcdef> + <paramdef>sd_bus **<parameter>busp</parameter></paramdef> + </funcprototype> + + <funcprototype> + <funcdef>void <function>sd_bus_close_unrefp</function></funcdef> + <paramdef>sd_bus **<parameter>busp</parameter></paramdef> + </funcprototype> + + <funcprototype> <funcdef>void <function>sd_bus_flush_close_unrefp</function></funcdef> <paramdef>sd_bus **<parameter>busp</parameter></paramdef> </funcprototype> @@ -124,17 +136,25 @@ execute no operation if <emphasis>that</emphasis> is <constant>NULL</constant>. </para> - <para><function>sd_bus_flush_close_unref()</function> is similar to <function>sd_bus_unref()</function>, but first - executes <citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry> as well - as <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, ensuring that - any pending messages are properly flushed out before the reference to the connection is dropped and possibly the - object freed. This call is particularly useful immediately before exiting from a program as it ensures that any - pending outgoing messages are written out, and unprocessed but queued incoming messages released before the - connection is terminated and released.</para> - - <para><function>sd_bus_flush_close_unrefp()</function> is similar to - <function>sd_bus_flush_close_unref()</function>, but may be used in GCC's and LLVM's Clean-up Variable Attribute, - see above.</para> + <para><function>sd_bus_close_unref()</function> is similar to <function>sd_bus_unref()</function>, but + first executes + <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + ensuring that the connection is terminated before the reference to the connection is dropped and possibly + the object freed.</para> + + <para><function>sd_bus_flush_close_unref()</function> is similar to <function>sd_bus_unref()</function>, + but first executes + <citerefentry><refentrytitle>sd_bus_flush</refentrytitle><manvolnum>3</manvolnum></citerefentry> as well + as <citerefentry><refentrytitle>sd_bus_close</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + ensuring that any pending messages are synchronously flushed out before the reference to the connection + is dropped and possibly the object freed. This call is particularly useful immediately before exiting + from a program as it ensures that any pending outgoing messages are written out, and unprocessed but + queued incoming messages released before the connection is terminated and released.</para> + + <para><function>sd_bus_close_unrefp()</function> is similar to + <function>sd_bus_close_unref()</function>, but may be used in GCC's and LLVM's Clean-up Variable + Attribute, see above. Similarly, <function>sd_bus_flush_close_unrefp()</function> is similar to + <function>sd_bus_flush_close_unref()</function>.</para> </refsect1> <refsect1> diff --git a/man/sd_bus_request_name.xml b/man/sd_bus_request_name.xml index 3c98b60c6a..cf0b552116 100644 --- a/man/sd_bus_request_name.xml +++ b/man/sd_bus_request_name.xml @@ -74,23 +74,23 @@ <variablelist> <varlistentry> - <term><varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname></term> + <term><constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant></term> <listitem><para>After acquiring the name successfully, permit other peers to take over the name when they try - to acquire it with the <varname>SD_BUS_NAME_REPLACE_EXISTING</varname> flag set. If - <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> is not set on the original request, such a request by other + to acquire it with the <constant>SD_BUS_NAME_REPLACE_EXISTING</constant> flag set. If + <constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> is not set on the original request, such a request by other peers will be denied.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_NAME_REPLACE_EXISTING</varname></term> + <term><constant>SD_BUS_NAME_REPLACE_EXISTING</constant></term> <listitem><para>Take over the name if it is already acquired by another peer, and that other peer has permitted - takeover by setting <varname>SD_BUS_NAME_ALLOW_REPLACEMENT</varname> while acquiring it.</para></listitem> + takeover by setting <constant>SD_BUS_NAME_ALLOW_REPLACEMENT</constant> while acquiring it.</para></listitem> </varlistentry> <varlistentry> - <term><varname>SD_BUS_NAME_QUEUE</varname></term> + <term><constant>SD_BUS_NAME_QUEUE</constant></term> <listitem><para>Queue the acquisition of the name when the name is already taken.</para></listitem> </varlistentry> @@ -130,7 +130,7 @@ <para>On success, these calls return 0 or a positive integer. On failure, these calls return a negative errno-style error code.</para> - <para>If <varname>SD_BUS_NAME_QUEUE</varname> is specified, <function>sd_bus_request_name()</function> will return + <para>If <constant>SD_BUS_NAME_QUEUE</constant> is specified, <function>sd_bus_request_name()</function> will return 0 when the name is already taken by another peer and the client has been added to the queue for the name. In that case, the caller can subscribe to <literal>NameOwnerChanged</literal> signals to be notified when the name is successfully acquired. <function>sd_bus_request_name()</function> returns > 0 when the name has immediately diff --git a/man/sd_event_wait.xml b/man/sd_event_wait.xml index 884996291c..f01d18e94e 100644 --- a/man/sd_event_wait.xml +++ b/man/sd_event_wait.xml @@ -157,7 +157,7 @@ <listitem><para>An event source is currently being prepared, i.e. the preparation handler is currently being executed, as set with - <citerefentry><refentrytitle>sd_event_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This + <citerefentry><refentrytitle>sd_event_source_set_prepare</refentrytitle><manvolnum>3</manvolnum></citerefentry>. This state is only seen in the event source preparation handler that is invoked from the <function>sd_event_prepare()</function> call and is diff --git a/man/sd_id128_get_machine.xml b/man/sd_id128_get_machine.xml index 0884838324..0bfe1b5002 100644 --- a/man/sd_id128_get_machine.xml +++ b/man/sd_id128_get_machine.xml @@ -122,8 +122,8 @@ <function>sd_id128_get_machine()</function>, <function>sd_id128_get_machine_app_specific()</function>, and <function>sd_id128_get_boot_app_specific()</function> return <constant>-ENOENT</constant> if - <filename>/etc/machine-id</filename> is missing, and <constant>-ENOMEDIUM</constant> if is empty - or all zeros.</para> + <filename>/etc/machine-id</filename> is missing, and <constant>-ENOMEDIUM</constant> if + <filename>/etc/machine-id</filename> is empty or all zeros.</para> </refsect1> <xi:include href="libsystemd-pkgconfig.xml" /> diff --git a/man/systemctl.xml b/man/systemctl.xml index b9077c55a1..08aacd8f41 100644 --- a/man/systemctl.xml +++ b/man/systemctl.xml @@ -136,6 +136,10 @@ <para>When listing units with <command>list-dependencies</command>, recursively show dependencies of all dependent units (by default only dependencies of target units are shown).</para> + + <para>When used with <command>status</command>, show journal messages in full, even if they include + unprintable characters or are very long. By default, fields with unprintable characters are + abbreviated as "blob data". (Note that the pager may escape unprintable characters again.)</para> </listitem> </varlistentry> diff --git a/man/systemd-boot.xml b/man/systemd-boot.xml index 44b0f61f22..4c914e6156 100644 --- a/man/systemd-boot.xml +++ b/man/systemd-boot.xml @@ -243,7 +243,7 @@ UUID <literal>4a67b082-0a4c-41cf-b6c7-440b29bb8c4</literal>, for communication between the OS and the boot loader:</para> - <variablelist> + <variablelist class='efi-variables'> <varlistentry> <term><varname>LoaderBootCountPath</varname></term> <listitem><para>If boot counting is enabled, contains the path to the file in whose name the boot counters are diff --git a/man/systemd-cat.xml b/man/systemd-cat.xml index 72cd196c4e..446fa4ba31 100644 --- a/man/systemd-cat.xml +++ b/man/systemd-cat.xml @@ -93,6 +93,29 @@ </varlistentry> <varlistentry> + <term><option>--stderr-priority=</option></term> + + <listitem><para>Specifies the default priority level for + messages from the process's standard error output (stderr). + Usage of this option is the same as the + <option>--priority=</option> option, above, and both can be + used at once. When both are used, <option>--priority=</option> + will specify the default priority for standard output (stdout). + </para> + + <para>If <option>--stderr-priority=</option> is not specified, + messages from stderr will still be logged, with the same + default priority level as stdout.</para> + + <para>Also, note that when stdout and stderr use the same + default priority, the messages will be strictly ordered, + because one channel is used for both. When the default priority + differs, two channels are used, and so stdout messages will not + be strictly ordered with respect to stderr messages - though + they will tend to be approximately ordered.</para></listitem> + </varlistentry> + + <varlistentry> <term><option>--level-prefix=</option></term> <listitem><para>Controls whether lines read are parsed for diff --git a/man/systemd-sleep.conf.xml b/man/systemd-sleep.conf.xml index 96e6d5e452..af61947c5c 100644 --- a/man/systemd-sleep.conf.xml +++ b/man/systemd-sleep.conf.xml @@ -112,7 +112,7 @@ <filename>/etc/systemd/sleep.conf</filename> or a <filename>sleep.conf.d</filename> file:</para> - <variablelist class='systemd-directives'> + <variablelist class='config-directives'> <varlistentry> <term><varname>AllowSuspend=</varname></term> <term><varname>AllowHibernation=</varname></term> diff --git a/man/systemd-system.conf.xml b/man/systemd-system.conf.xml index 35da82ab1a..27242b3a56 100644 --- a/man/systemd-system.conf.xml +++ b/man/systemd-system.conf.xml @@ -63,7 +63,7 @@ <para>All options are configured in the <literal>[Manager]</literal> section:</para> - <variablelist class='systemd-directives'> + <variablelist class='config-directives'> <varlistentry> <term><varname>LogLevel=</varname></term> @@ -251,7 +251,9 @@ <varname>TimeoutStopSec=</varname> and <varname>RestartSec=</varname> (for services, see <citerefentry><refentrytitle>systemd.service</refentrytitle><manvolnum>5</manvolnum></citerefentry> - for details on the per-unit settings). For non-service units, + for details on the per-unit settings). Disabled by default, when + service with <varname>Type=oneshot</varname> is used. + For non-service units, <varname>DefaultTimeoutStartSec=</varname> sets the default <varname>TimeoutSec=</varname> value. <varname>DefaultTimeoutStartSec=</varname> and diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 6419bee499..0248c3a8e0 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -393,7 +393,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> <refsect1> <title>Mandatory Access Control</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>SELinuxContext=</varname></term> @@ -436,7 +436,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> <refsect1> <title>Process Properties</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>LimitCPU=</varname></term> @@ -671,7 +671,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> <refsect1> <title>Scheduling</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>Nice=</varname></term> @@ -764,7 +764,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> (such as <varname>ProtectSystem=</varname>) are not available, as the underlying kernel functionality is only accessible to privileged processes.</para> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>ProtectSystem=</varname></term> @@ -820,7 +820,7 @@ CapabilityBoundingSet=~CAP_B CAP_C</programlisting> names must be relative, and may not include <literal>..</literal>. If set, one or more directories by the specified names will be created (including their parents) below the locations defined in the following table, when the unit is started. Also, the corresponding environment variable - is defined with the full path of directories. If multiple directories are set, then int the environment variable + is defined with the full path of directories. If multiple directories are set, then in the environment variable the paths are concatenated with colon (<literal>:</literal>).</para> <table> <title>Automatic directory creation and environment variables</title> @@ -1279,13 +1279,19 @@ RestrictNamespaces=~cgroup net</programlisting> <constant>SHM_EXEC</constant> set. Note that this option is incompatible with programs and libraries that generate program code dynamically at runtime, including JIT execution engines, executable stacks, and code "trampoline" feature of various C compilers. This option improves service security, as it makes harder for - software exploits to change running code dynamically. Note that this feature is fully available on x86-64, and - partially on x86. Specifically, the <function>shmat()</function> protection is not available on x86. Note that - on systems supporting multiple ABIs (such as x86/x86-64) it is recommended to turn off alternative ABIs for - services, so that they cannot be used to circumvent the restrictions of this option. Specifically, it is - recommended to combine this option with <varname>SystemCallArchitectures=native</varname> or similar. If - running in user mode, or in system mode, but without the <constant>CAP_SYS_ADMIN</constant> capability - (e.g. setting <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem> + software exploits to change running code dynamically. However, the protection can be circumvented, if + the service can write to a filesystem, which is not mounted with <constant>noexec</constant> (such as + <filename>/dev/shm</filename>), or it can use <function>memfd_create()</function>. This can be + prevented by making such file systems inaccessible to the service + (e.g. <varname>InaccessiblePaths=/dev/shm</varname>) and installing further system call filters + (<varname>SystemCallFilter=~memfd_create</varname>). Note that this feature is fully available on + x86-64, and partially on x86. Specifically, the <function>shmat()</function> protection is not + available on x86. Note that on systems supporting multiple ABIs (such as x86/x86-64) it is + recommended to turn off alternative ABIs for services, so that they cannot be used to circumvent the + restrictions of this option. Specifically, it is recommended to combine this option with + <varname>SystemCallArchitectures=native</varname> or similar. If running in user mode, or in system + mode, but without the <constant>CAP_SYS_ADMIN</constant> capability (e.g. setting + <varname>User=</varname>), <varname>NoNewPrivileges=yes</varname> is implied.</para></listitem> </varlistentry> <varlistentry> @@ -1382,7 +1388,7 @@ RestrictNamespaces=~cgroup net</programlisting> <refsect1> <title>System Call Filtering</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>SystemCallFilter=</varname></term> @@ -1621,7 +1627,7 @@ SystemCallErrorNumber=EPERM</programlisting> <refsect1> <title>Environment</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>Environment=</varname></term> @@ -1736,7 +1742,7 @@ SystemCallErrorNumber=EPERM</programlisting> <refsect1> <title>Logging and Standard Input/Output</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>StandardInput=</varname></term> @@ -1810,7 +1816,7 @@ SystemCallErrorNumber=EPERM</programlisting> <option>syslog</option>, <option>kmsg</option>, <option>journal+console</option>, <option>syslog+console</option>, <option>kmsg+console</option>, <option>file:<replaceable>path</replaceable></option>, <option>append:<replaceable>path</replaceable></option>, - <option>socket</option> or<option>fd:<replaceable>name</replaceable></option>.</para> + <option>socket</option> or <option>fd:<replaceable>name</replaceable></option>.</para> <para><option>inherit</option> duplicates the file descriptor of standard input for standard output.</para> @@ -2078,7 +2084,7 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy <refsect1> <title>System V Compatibility</title> - <variablelist> + <variablelist class='unit-directives'> <varlistentry> <term><varname>UtmpIdentifier=</varname></term> @@ -2878,7 +2884,8 @@ StandardInputData=SWNrIHNpdHplIGRhIHVuJyBlc3NlIEtsb3BzLAp1ZmYgZWVtYWwga2xvcHAncy <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>8</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>, diff --git a/man/systemd.kill.xml b/man/systemd.kill.xml index 9b264ecbf5..1b4a4a84a0 100644 --- a/man/systemd.kill.xml +++ b/man/systemd.kill.xml @@ -176,7 +176,7 @@ <para> <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>8</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>, diff --git a/man/systemd.link.xml b/man/systemd.link.xml index f74edd0186..178f9b81af 100644 --- a/man/systemd.link.xml +++ b/man/systemd.link.xml @@ -50,27 +50,21 @@ same name pointing to <filename>/dev/null</filename> disables the configuration file entirely (it is "masked").</para> - <para>The link file contains a <literal>[Match]</literal> section, - which determines if a given link file may be applied to a given - device, as well as a <literal>[Link]</literal> section specifying - how the device should be configured. The first (in lexical order) - of the link files that matches a given device is applied. Note - that a default file <filename>99-default.link</filename> is - shipped by the system. Any user-supplied - <filename>.link</filename> should hence have a lexically earlier - name to be considered at all.</para> - - <para>See - <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> - for diagnosing problems with <filename>.link</filename> files.</para> + <para>The link file contains a [Match] section, which determines if a given link file may be applied to a + given device, as well as a [Link] section specifying how the device should be configured. The first (in + lexical order) of the link files that matches a given device is applied. Note that a default file + <filename>99-default.link</filename> is shipped by the system. Any user-supplied + <filename>.link</filename> should hence have a lexically earlier name to be considered at all.</para> + + <para>See <citerefentry><refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum></citerefentry> for + diagnosing problems with <filename>.link</filename> files.</para> </refsect1> <refsect1> <title>[Match] Section Options</title> - <para>A link file is said to match a device if each of the entries - in the <literal>[Match]</literal> section matches, or if the - section is empty. The following keys are accepted:</para> + <para>A link file is said to match a device if each of the entries in the [Match] section matches, or if + the section is empty. The following keys are accepted:</para> <variablelist class='network-directives'> <varlistentry> @@ -100,18 +94,15 @@ <listitem> <para>A whitespace-separated list of shell-style globs matching the persistent path, as exposed by the udev property - <literal>ID_PATH</literal>.</para> + <varname>ID_PATH</varname>.</para> </listitem> </varlistentry> <varlistentry> <term><varname>Driver=</varname></term> <listitem> - <para>A whitespace-separated list of shell-style globs matching - the driver currently bound to the device, - as exposed by the udev property <literal>DRIVER</literal> - of its parent device, or if that is not set, the - driver as exposed by <literal>ethtool -i</literal> - of the device itself.</para> + <para>A whitespace-separated list of shell-style globs matching the driver currently bound to the + device, as exposed by the udev property <varname>DRIVER</varname> of its parent device, or if that + is not set, the driver as exposed by <command>ethtool -i</command> of the device itself.</para> </listitem> </varlistentry> <varlistentry> @@ -119,14 +110,14 @@ <listitem> <para>A whitespace-separated list of shell-style globs matching the device type, as exposed by the udev - property <literal>DEVTYPE</literal>.</para> + property <varname>DEVTYPE</varname>.</para> </listitem> </varlistentry> <varlistentry> <term><varname>Host=</varname></term> <listitem> <para>Matches against the hostname or machine - ID of the host. See <literal>ConditionHost=</literal> in + ID of the host. See <varname>ConditionHost=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> </listitem> @@ -137,7 +128,7 @@ <para>Checks whether the system is executed in a virtualized environment and optionally test whether it is a specific implementation. See - <literal>ConditionVirtualization=</literal> in + <varname>ConditionVirtualization=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> </listitem> @@ -147,7 +138,7 @@ <listitem> <para>Checks whether a specific kernel command line option is set (or if prefixed with the exclamation mark unset). See - <literal>ConditionKernelCommandLine=</literal> in + <varname>ConditionKernelCommandLine=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> </listitem> @@ -157,7 +148,7 @@ <listitem> <para>Checks whether the kernel version (as reported by <command>uname -r</command>) matches a certain expression (or if prefixed with the exclamation mark does not match it). See - <literal>ConditionKernelVersion=</literal> in + <varname>ConditionKernelVersion=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details. </para> @@ -167,7 +158,7 @@ <term><varname>Architecture=</varname></term> <listitem> <para>Checks whether the system is running on a specific - architecture. See <literal>ConditionArchitecture=</literal> + architecture. See <varname>ConditionArchitecture=</varname> in <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details.</para> @@ -180,7 +171,7 @@ <refsect1> <title>[Link] Section Options</title> - <para>The <literal>[Link]</literal> section accepts the following + <para>The [Link] section accepts the following keys:</para> <variablelist class='network-directives'> @@ -193,8 +184,7 @@ <varlistentry> <term><varname>Alias=</varname></term> <listitem> - <para>The <literal>ifalias</literal> is set to this - value.</para> + <para>The <varname>ifalias</varname> interface property is set to this value.</para> </listitem> </varlistentry> <varlistentry> @@ -206,7 +196,7 @@ <variablelist> <varlistentry> - <term><literal>persistent</literal></term> + <term><option>persistent</option></term> <listitem> <para>If the hardware has a persistent MAC address, as most hardware should, and if it is used by the kernel, @@ -220,7 +210,7 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>random</literal></term> + <term><option>random</option></term> <listitem> <para>If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is randomly @@ -231,7 +221,7 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>none</literal></term> + <term><option>none</option></term> <listitem> <para>Keeps the MAC address assigned by the kernel.</para> </listitem> @@ -243,28 +233,23 @@ <term><varname>MACAddress=</varname></term> <listitem> <para>The MAC address to use, if no - <literal>MACAddressPolicy=</literal> + <varname>MACAddressPolicy=</varname> is specified.</para> </listitem> </varlistentry> <varlistentry> <term><varname>NamePolicy=</varname></term> <listitem> - <para>An ordered, space-separated list of policies by which - the interface name should be set. - <literal>NamePolicy</literal> may be disabled by specifying - <literal>net.ifnames=0</literal> on the kernel command line. - Each of the policies may fail, and the first successful one - is used. The name is not set directly, but is exported to - udev as the property <literal>ID_NET_NAME</literal>, which - is, by default, used by a udev rule to set - <literal>NAME</literal>. If the name has already been set by - userspace, no renaming is performed. The available policies - are:</para> + <para>An ordered, space-separated list of policies by which the interface name should be set. + <varname>NamePolicy=</varname> may be disabled by specifying <option>net.ifnames=0</option> on the + kernel command line. Each of the policies may fail, and the first successful one is used. The name + is not set directly, but is exported to udev as the property <option>ID_NET_NAME</option>, which + is, by default, used by a udev rule to set <varname>NAME</varname>. The available policies are: + </para> <variablelist> <varlistentry> - <term><literal>kernel</literal></term> + <term><option>kernel</option></term> <listitem> <para>If the kernel claims that the name it has set for a device is predictable, then no renaming is @@ -272,46 +257,53 @@ </listitem> </varlistentry> <varlistentry> - <term><literal>database</literal></term> + <term><option>database</option></term> <listitem> <para>The name is set based on entries in the udev's Hardware Database with the key - <literal>ID_NET_NAME_FROM_DATABASE</literal>. + <varname>ID_NET_NAME_FROM_DATABASE</varname>. </para> </listitem> </varlistentry> <varlistentry> - <term><literal>onboard</literal></term> + <term><option>onboard</option></term> <listitem> <para>The name is set based on information given by the firmware for on-board devices, as exported by the - udev property <literal>ID_NET_NAME_ONBOARD</literal>. + udev property <varname>ID_NET_NAME_ONBOARD</varname>. </para> </listitem> </varlistentry> <varlistentry> - <term><literal>slot</literal></term> + <term><option>slot</option></term> <listitem> <para>The name is set based on information given by the firmware for hot-plug devices, as exported by the - udev property <literal>ID_NET_NAME_SLOT</literal>. + udev property <varname>ID_NET_NAME_SLOT</varname>. </para> </listitem> </varlistentry> <varlistentry> - <term><literal>path</literal></term> + <term><option>path</option></term> <listitem> <para>The name is set based on the device's physical location, as exported by the udev property - <literal>ID_NET_NAME_PATH</literal>.</para> + <varname>ID_NET_NAME_PATH</varname>.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>mac</literal></term> + <term><option>mac</option></term> <listitem> <para>The name is set based on the device's persistent MAC address, as exported by the udev property - <literal>ID_NET_NAME_MAC</literal>.</para> + <varname>ID_NET_NAME_MAC</varname>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>keep</option></term> + <listitem> + <para>If the device already had a name given by userspace (as part of creation of the device + or a rename), keep it.</para> </listitem> </varlistentry> </variablelist> @@ -356,9 +348,8 @@ <varlistentry> <term><varname>Duplex=</varname></term> <listitem> - <para>The duplex mode to set for the device. The accepted - values are <literal>half</literal> and - <literal>full</literal>.</para> + <para>The duplex mode to set for the device. The accepted values are <option>half</option> and + <option>full</option>.</para> </listitem> </varlistentry> <varlistentry> @@ -369,8 +360,8 @@ common transmission parameters, such as speed, duplex mode, and flow control. When unset, the kernel's default will be used.</para> - <para>Note that if autonegotiation is enabled, speed, duplex and advertise settings are - read-only. If autonegotation is disabled, speed, duplex and advertise settings are writable + <para>Note that if autonegotiation is enabled, speed and duplex settings are + read-only. If autonegotation is disabled, speed and duplex settings are writable if the driver supports multiple link modes.</para> </listitem> </varlistentry> @@ -382,58 +373,58 @@ <variablelist> <varlistentry> - <term><literal>phy</literal></term> + <term><option>phy</option></term> <listitem> <para>Wake on PHY activity.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>unicast</literal></term> + <term><option>unicast</option></term> <listitem> <para>Wake on unicast messages.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>multicast</literal></term> + <term><option>multicast</option></term> <listitem> <para>Wake on multicast messages.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>broadcast</literal></term> + <term><option>broadcast</option></term> <listitem> <para>Wake on broadcast messages.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>arp</literal></term> + <term><option>arp</option></term> <listitem> <para>Wake on ARP.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>magic</literal></term> + <term><option>magic</option></term> <listitem> <para>Wake on receipt of a magic packet. </para> </listitem> </varlistentry> <varlistentry> - <term><literal>secureon</literal></term> + <term><option>secureon</option></term> <listitem> <para>Enable secureon(tm) password for MagicPacket(tm). </para> </listitem> </varlistentry> <varlistentry> - <term><literal>off</literal></term> + <term><option>off</option></term> <listitem> <para>Never wake.</para> </listitem> </varlistentry> </variablelist> - <para>Defaults to <literal>off</literal>.</para> + <para>Defaults to <option>off</option>.</para> </listitem> </varlistentry> <varlistentry> @@ -444,32 +435,32 @@ <variablelist> <varlistentry> - <term><literal>tp</literal></term> + <term><option>tp</option></term> <listitem> <para>An Ethernet interface using Twisted-Pair cable as the medium.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>aui</literal></term> + <term><option>aui</option></term> <listitem> <para>Attachment Unit Interface (AUI). Normally used with hubs. </para> </listitem> </varlistentry> <varlistentry> - <term><literal>bnc</literal></term> + <term><option>bnc</option></term> <listitem> <para>An Ethernet interface using BNC connectors and co-axial cable.</para> </listitem> </varlistentry> <varlistentry> - <term><literal>mii</literal></term> + <term><option>mii</option></term> <listitem> <para>An Ethernet interface using a Media Independent Interface (MII).</para> </listitem> </varlistentry> <varlistentry> - <term><literal>fibre</literal></term> + <term><option>fibre</option></term> <listitem> <para>An Ethernet interface using Optical Fibre as the medium.</para> </listitem> @@ -481,7 +472,7 @@ <term><varname>Advertise=</varname></term> <listitem> <para>This sets what speeds and duplex modes of operation are advertised for auto-negotiation. - The supported values are: + This implies <literal>AutoNegotiation=yes</literal>. The supported values are: <table> <title>Supported advertise values</title> @@ -496,47 +487,46 @@ <entry>Duplex Mode</entry> </row></thead> <tbody> - - <row><entry><literal>10baset-half</literal></entry> + <row><entry><option>10baset-half</option></entry> <entry>10</entry><entry>half</entry></row> - <row><entry><literal>10baset-full</literal></entry> + <row><entry><option>10baset-full</option></entry> <entry>10</entry><entry>full</entry></row> - <row><entry><literal>100baset-half</literal></entry> + <row><entry><option>100baset-half</option></entry> <entry>100</entry><entry>half</entry></row> - <row><entry><literal>100baset-full</literal></entry> + <row><entry><option>100baset-full</option></entry> <entry>100</entry><entry>full</entry></row> - <row><entry><literal>1000baset-half</literal></entry> + <row><entry><option>1000baset-half</option></entry> <entry>1000</entry><entry>half</entry></row> - <row><entry><literal>1000baset-full</literal></entry> + <row><entry><option>1000baset-full</option></entry> <entry>1000</entry><entry>full</entry></row> - <row><entry><literal>10000baset-full</literal></entry> + <row><entry><option>10000baset-full</option></entry> <entry>10000</entry><entry>full</entry></row> - <row><entry><literal>2500basex-full</literal></entry> + <row><entry><option>2500basex-full</option></entry> <entry>2500</entry><entry>full</entry></row> - <row><entry><literal>1000basekx-full</literal></entry> + <row><entry><option>1000basekx-full</option></entry> <entry>1000</entry><entry>full</entry></row> - <row><entry><literal>10000basekx4-full</literal></entry> + <row><entry><option>10000basekx4-full</option></entry> <entry>10000</entry><entry>full</entry></row> - <row><entry><literal>10000basekr-full</literal></entry> + <row><entry><option>10000basekr-full</option></entry> <entry>10000</entry><entry>full</entry></row> - <row><entry><literal>10000baser-fec</literal></entry> + <row><entry><option>10000baser-fec</option></entry> <entry>10000</entry><entry>full</entry></row> - <row><entry><literal>20000basemld2-full</literal></entry> + <row><entry><option>20000basemld2-full</option></entry> <entry>20000</entry><entry>full</entry></row> - <row><entry><literal>20000basekr2-full</literal></entry> + <row><entry><option>20000basekr2-full</option></entry> <entry>20000</entry><entry>full</entry></row> </tbody> </tgroup> diff --git a/man/systemd.mount.xml b/man/systemd.mount.xml index 6d8c873ca5..61e97b14f2 100644 --- a/man/systemd.mount.xml +++ b/man/systemd.mount.xml @@ -131,11 +131,15 @@ <filename>umount.target</filename> in order to be stopped during shutdown.</para></listitem> <listitem><para>Mount units referring to local file systems automatically gain - an <varname>After=</varname> dependency on <filename>local-fs-pre.target</filename>.</para></listitem> + 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>. Towards the latter a + <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> </itemizedlist> @@ -506,9 +510,9 @@ <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>.) Takes a unit-less value in seconds, or a time span value such as "5min 20s". Pass 0 to disable the timeout logic. The - default value is set from the manager configuration file's - <varname>DefaultTimeoutStartSec=</varname> - variable.</para></listitem> + default value is set from <varname>DefaultTimeoutStartSec=</varname> option in + <citerefentry><refentrytitle>systemd-system.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para></listitem> </varlistentry> </variablelist> @@ -524,6 +528,7 @@ <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>, diff --git a/man/systemd.netdev.xml b/man/systemd.netdev.xml index e17c1e3fbe..74281f2d0b 100644 --- a/man/systemd.netdev.xml +++ b/man/systemd.netdev.xml @@ -287,15 +287,15 @@ <varlistentry> <term><varname>MACAddress=</varname></term> <listitem> - <para>The MAC address to use for the device. If none is - given, one is generated based on the interface name and - the - <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. - For <literal>tun</literal> or <literal>tap</literal> devices, <varname>MACAddress=</varname> setting - is not currently supported in <literal>[NetDev]</literal> section. Please specify it in - <literal>[Link]</literal> section of corresponding + <para>The MAC address to use for the device. For <literal>tun</literal> or <literal>tap</literal> + devices, setting <varname>MACAddress=</varname> in the <literal>[NetDev]</literal> section is not + supported. Please specify it in <literal>[Link]</literal> section of the corresponding <citerefentry><refentrytitle>systemd.network</refentrytitle><manvolnum>5</manvolnum></citerefentry> - files.</para> + file. If this option is not set, <literal>vlan</literal> devices inherit the MAC address of the + physical interface. For other kind of netdevs, if this option is not set, then MAC address is + generated based on the interface name and the + <citerefentry><refentrytitle>machine-id</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + </para> </listitem> </varlistentry> </variablelist> @@ -899,15 +899,15 @@ <varlistentry> <term><varname>FOUDestinationPort=</varname></term> <listitem> - <para>The <varname>FOUDestinationPort=</varname> specifies the UDP destination port for encapsulation. + <para>This setting specifies the UDP destination port for encapsulation. This field is mandatory and is not set by default.</para> </listitem> </varlistentry> <varlistentry> <term><varname>FOUSourcePort=</varname></term> <listitem> - <para>The <constant>FOUSourcePort=</constant> specifies the UDP source port for encapsulation. Defaults to <varname>0</varname>, - that is, the source port for packets is left to the network stack to decide.</para> + <para>This setting specifies the UDP source port for encapsulation. Defaults to <constant>0</constant> + — that is, the source port for packets is left to the network stack to decide.</para> </listitem> </varlistentry> <varlistentry> diff --git a/man/systemd.nspawn.xml b/man/systemd.nspawn.xml index f978fef235..7924641df9 100644 --- a/man/systemd.nspawn.xml +++ b/man/systemd.nspawn.xml @@ -112,7 +112,7 @@ <para>Settings files may include an <literal>[Exec]</literal> section, which carries various execution parameters:</para> - <variablelist> + <variablelist class='nspawn-directives'> <varlistentry> <term><varname>Boot=</varname></term> @@ -374,7 +374,7 @@ section, which carries various parameters configuring the file system of the container:</para> - <variablelist> + <variablelist class='nspawn-directives'> <varlistentry> <term><varname>ReadOnly=</varname></term> @@ -458,7 +458,7 @@ section, which carries various parameters configuring the network connectivity of the container:</para> - <variablelist> + <variablelist class='nspawn-directives'> <varlistentry> <term><varname>Private=</varname></term> diff --git a/man/systemd.resource-control.xml b/man/systemd.resource-control.xml index aa7d9bcd59..a4d793c32e 100644 --- a/man/systemd.resource-control.xml +++ b/man/systemd.resource-control.xml @@ -907,6 +907,7 @@ <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>, diff --git a/man/systemd.service.xml b/man/systemd.service.xml index ad04efeb34..f0f9aee154 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -1416,6 +1416,7 @@ WantedBy=multi-user.target</programlisting> <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>, diff --git a/man/systemd.socket.xml b/man/systemd.socket.xml index fb51ef6658..7547071e9e 100644 --- a/man/systemd.socket.xml +++ b/man/systemd.socket.xml @@ -853,6 +853,7 @@ <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>, diff --git a/man/systemd.swap.xml b/man/systemd.swap.xml index 073c2b3a27..cf00451501 100644 --- a/man/systemd.swap.xml +++ b/man/systemd.swap.xml @@ -245,6 +245,7 @@ <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>, diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index 7e1b3cb7eb..f21f9eae44 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1842,6 +1842,7 @@ PrivateTmp=yes</programlisting> <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>, diff --git a/man/systemd.xml b/man/systemd.xml index 49a29f9651..5287bdaba8 100644 --- a/man/systemd.xml +++ b/man/systemd.xml @@ -396,7 +396,7 @@ loaded into memory are those for which at least one of the following conditions is true:</para> <orderedlist> - <listitem><para>It is in an active, activating, deactivating or failed state (i.e. in any unit state except for <literal>dead</literal>)</para></listitem> + <listitem><para>It is in an active, activating, deactivating or failed state (i.e. in any unit state except for <literal>inactive</literal>)</para></listitem> <listitem><para>It has a job queued for it</para></listitem> <listitem><para>It is a dependency of some sort of at least one other unit that is loaded into memory</para></listitem> <listitem><para>It has some form of resource still allocated (e.g. a service unit that is inactive but for which @@ -453,6 +453,17 @@ verify that it makes sense, fixing it if possible, and only failing if it really cannot work.</para> + <para>Note that transactions are generated independently of a unit's + state at runtime, hence, for example, if a start job is requested on an + already started unit, it will still generate a transaction and wake up any + inactive dependencies (and cause propagation of other jobs as per the + defined relationships). This is because the enqueued job is at the time of + execution compared to the target unit's state and is marked successful and + complete when both satisfy. However, this job also pulls in other + dependencies due to the defined relationships and thus leads to, in our + our example, start jobs for any of those inactive units getting queued as + well.</para> + <para>systemd contains native implementations of various tasks that need to be executed as part of the boot process. For example, it sets the hostname or configures the loopback network device. It diff --git a/man/timedatectl.xml b/man/timedatectl.xml index a62902423a..b75b4cc72a 100644 --- a/man/timedatectl.xml +++ b/man/timedatectl.xml @@ -82,7 +82,7 @@ <varlistentry> <term><option>-a</option></term> - <term><option>-all</option></term> + <term><option>--all</option></term> <listitem><para>When showing properties of <citerefentry><refentrytitle>systemd-timesyncd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>, diff --git a/man/tmpfiles.d.xml b/man/tmpfiles.d.xml index 5d393f3984..3f2ef7ee97 100644 --- a/man/tmpfiles.d.xml +++ b/man/tmpfiles.d.xml @@ -282,11 +282,11 @@ L /tmp/foobar - - - - /dev/null</programlisting> <varlistentry> <term><varname>C</varname></term> <listitem><para>Recursively copy a file or directory, if the - destination files or directories do not exist yet. Note that - this command will not descend into subdirectories if the - destination directory already exists. Instead, the entire - copy operation is skipped. If the argument is omitted, files - from the source directory + destination files or directories do not exist yet or the + destination directory is empty. Note that this command will not + descend into subdirectories if the destination directory already + exists and is not empty. Instead, the entire copy operation is + skipped. If the argument is omitted, files from the source directory <filename>/usr/share/factory/</filename> with the same name are copied. Does not follow symlinks.</para></listitem> </varlistentry> @@ -420,7 +420,7 @@ L /tmp/foobar - - - - /dev/null</programlisting> </varlistentry> </variablelist> - <para>If the exclamation mark is used, this line is only safe of + <para>If the exclamation mark is used, this line is only safe to execute during boot, and can break a running system. Lines without the exclamation mark are presumed to be safe to execute at any time, e.g. on package upgrades. diff --git a/man/udev.conf.xml b/man/udev.conf.xml index 23a4595fa9..d1878f8c6f 100644 --- a/man/udev.conf.xml +++ b/man/udev.conf.xml @@ -40,7 +40,7 @@ ignored. The following variables can be set: </para> - <variablelist> + <variablelist class='config-directives'> <varlistentry> <term><varname>udev_log=</varname></term> diff --git a/man/udev.xml b/man/udev.xml index 08fedfc86c..74aab8e024 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -566,6 +566,18 @@ <para>Disable the watching of a device node with inotify.</para> </listitem> </varlistentry> + <varlistentry> + <term><option>db_persist</option></term> + <listitem> + <para>Set the flag (sticky bit) on the udev database entry + of the event device. Device properties are then kept in the + database even when + <command>udevadm info --cleanup-db</command> is called. + This option can be useful in certain cases + (e.g. Device Mapper devices) for persisting device state + on the transition from initramfs.</para> + </listitem> + </varlistentry> </variablelist> </listitem> </varlistentry> diff --git a/man/udev_device_has_tag.xml b/man/udev_device_has_tag.xml index f34ae9ed37..e27b770215 100644 --- a/man/udev_device_has_tag.xml +++ b/man/udev_device_has_tag.xml @@ -109,12 +109,19 @@ <function>udev_device_get_property_value()</function> and <function>udev_device_get_sysattr_value()</function> return a pointer to a constant string of the requested value. On error, - <constant>NULL</constant> is returned.</para> + <constant>NULL</constant> is returned. Attributes that may + contain <constant>NUL</constant> bytes should not be retrieved + with <function>udev_device_get_sysattr_value()</function>; + instead, read them directly from the files within the device's + <property>syspath</property>.</para> <para>On success, <function>udev_device_set_sysattr_value()</function> returns an integer greater than, or equal to, <constant>0</constant>. - On failure, a negative error code is returned.</para> + On failure, a negative error code is returned. Values that + contain <constant>NUL</constant> bytes should not be set with + this function; instead, write them directly to the files within + the device's <property>syspath</property>.</para> <para>On success, <function>udev_device_has_tag()</function> returns <constant>1</constant> or <constant>0</constant>, diff --git a/man/udevadm.xml b/man/udevadm.xml index 44be7b3f89..b7a2494f83 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -143,22 +143,25 @@ <term><option>-x</option></term> <term><option>--export</option></term> <listitem> - <para>Print output as key/value pairs. Values are enclosed in single quotes.</para> + <para>Print output as key/value pairs. Values are enclosed in single quotes. + This takes effects only when <option>--query=property</option> or + <option>--device-id-of-file=<replaceable>FILE</replaceable></option> is specified.</para> </listitem> </varlistentry> <varlistentry> <term><option>-P</option></term> <term><option>--export-prefix=<replaceable>NAME</replaceable></option></term> <listitem> - <para>Add a prefix to the key name of exported values.</para> + <para>Add a prefix to the key name of exported values. + This implies <option>--export</option>.</para> </listitem> </varlistentry> <varlistentry> <term><option>-d</option></term> <term><option>--device-id-of-file=<replaceable>FILE</replaceable></option></term> <listitem> - <para>Print major/minor numbers of the underlying device, where the file - lives on.</para> + <para>Print major/minor numbers of the underlying device, where the file lives on. + If this is specified, all positional arguments are ignored.</para> </listitem> </varlistentry> <varlistentry> @@ -182,11 +185,11 @@ <refsect2><title>udevadm trigger <arg choice="opt"><replaceable>options</replaceable></arg> - <arg choice="opt" rep="repeat"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> + <arg choice="opt"><replaceable>devpath</replaceable>|<replaceable>file</replaceable>|<replaceable>unit</replaceable></arg> </title> <para>Request device events from the kernel. Primarily used to replay events at system coldplug time.</para> - <para>Takes one or more device specifications as arguments. See the description of <command>info</command> + <para>Takes a device specification as a positional argument. See the description of <command>info</command> above.</para> <variablelist> @@ -226,8 +229,9 @@ <term><option>--subsystem-match=<replaceable>SUBSYSTEM</replaceable></option></term> <listitem> <para>Trigger events for devices which belong to a - matching subsystem. This option can be specified multiple - times and supports shell style pattern matching.</para> + matching subsystem. This option supports shell style pattern matching. + When this option is specified more than once, then each matching result is ORed, that is, + all the devices in each subsystem are triggered.</para> </listitem> </varlistentry> <varlistentry> @@ -235,77 +239,74 @@ <term><option>--subsystem-nomatch=<replaceable>SUBSYSTEM</replaceable></option></term> <listitem> <para>Do not trigger events for devices which belong to a matching subsystem. This option - can be specified multiple times and supports shell style pattern matching.</para> + supports shell style pattern matching. When this option is specified more than once, + then each matching result is ANDed, that is, devices which do not match all specified + subsystems are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>-a</option></term> <term><option>--attr-match=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term> <listitem> - <para>Trigger events for devices with a matching sysfs - attribute. If a value is specified along with the - attribute name, the content of the attribute is matched - against the given value using shell style pattern - matching. If no value is specified, the existence of the - sysfs attribute is checked. This option can be specified - multiple times.</para> + <para>Trigger events for devices with a matching sysfs attribute. If a value is specified along + with the attribute name, the content of the attribute is matched against the given value using + shell style pattern matching. If no value is specified, the existence of the sysfs attribute is + checked. When this option is specified multiple times, then each matching result is ANDed, + that is, only devices which have all specified attributes are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>-A</option></term> <term><option>--attr-nomatch=<replaceable>ATTRIBUTE</replaceable>=<replaceable>VALUE</replaceable></option></term> <listitem> - <para>Do not trigger events for devices with a matching - sysfs attribute. If a value is specified along with the - attribute name, the content of the attribute is matched - against the given value using shell style pattern - matching. If no value is specified, the existence of the - sysfs attribute is checked. This option can be specified - multiple times.</para> + <para>Do not trigger events for devices with a matching sysfs attribute. If a value is specified + along with the attribute name, the content of the attribute is matched against the given value + using shell style pattern matching. If no value is specified, the existence of the sysfs attribute + is checked. When this option is specified multiple times, then each matching result is ANDed, + that is, only devices which have none of the specified attributes are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>-p</option></term> <term><option>--property-match=<replaceable>PROPERTY</replaceable>=<replaceable>VALUE</replaceable></option></term> <listitem> - <para>Trigger events for devices with a matching property - value. This option can be specified multiple times and - supports shell style pattern matching.</para> + <para>Trigger events for devices with a matching property value. This option supports shell style + pattern matching. When this option is specified more than once, then each matching result is ORed, + that is, devices which have one of the specified properties are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>-g</option></term> <term><option>--tag-match=<replaceable>PROPERTY</replaceable></option></term> <listitem> - <para>Trigger events for devices with a matching tag. This - option can be specified multiple times.</para> + <para>Trigger events for devices with a matching tag. When this option is specified multiple times, + then each matching result is ANDed, that is, devices which have all specified tags are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>-y</option></term> - <term><option>--sysname-match=<replaceable>PATH</replaceable></option></term> + <term><option>--sysname-match=<replaceable>NAME</replaceable></option></term> <listitem> - <para>Trigger events for devices for which the last component - (i.e. the filename) of the <filename>/sys</filename> path matches - the specified <replaceable>PATH</replaceable>. This option can be - specified multiple times and also supports shell style pattern - matching.</para> + <para>Trigger events for devices for which the last component (i.e. the filename) of the + <filename>/sys</filename> path matches the specified <replaceable>PATH</replaceable>. This option + supports shell style pattern matching. When this option is specified more than once, then each + matching result is ORed, that is, all devices which have any of the specified + <replaceable>NAME</replaceable> are triggered.</para> </listitem> </varlistentry> <varlistentry> <term><option>--name-match=<replaceable>NAME</replaceable></option></term> <listitem> - <para>Trigger events for devices with a matching - device path. This option can be specified multiple - times.</para> + <para>Trigger events for devices with a matching device path. When this option is specified more than once, + the last <replaceable>NAME</replaceable> is used.</para> </listitem> </varlistentry> <varlistentry> <term><option>-b</option></term> <term><option>--parent-match=<replaceable>SYSPATH</replaceable></option></term> <listitem> - <para>Trigger events for all children of a given - device.</para> + <para>Trigger events for all children of a given device. When this option is specified more than once, + the last <replaceable>NAME</replaceable> is used.</para> </listitem> </varlistentry> <varlistentry> @@ -319,12 +320,20 @@ the same command to finish.</para> </listitem> </varlistentry> + <varlistentry> + <term><option>--wait-daemon[=<replaceable>SECONDS</replaceable>]</option></term> + <listitem> + <para>Before triggering uevents, wait for systemd-udevd daemon to be initialized. + Optionally takes timeout value. Default timeout is 5 seconds. This is equivalent to invoke + invoking <command>udevadm control --ping</command> before <command>udevadm trigger</command>.</para> + </listitem> + </varlistentry> <xi:include href="standard-options.xml" xpointer="help" /> </variablelist> - <para>In addition, optional positional arguments can be used - to specify device names or sys paths. They must start with + <para>In addition, an optional positional argument can be used + to specify device name or sys path. It must start with <filename>/dev</filename> or <filename>/sys</filename> respectively.</para> </refsect2> @@ -363,7 +372,11 @@ <term><option>-e</option></term> <term><option>--exit</option></term> <listitem> - <para>Signal and wait for systemd-udevd to exit.</para> + <para>Signal and wait for systemd-udevd to exit. Note that <filename>systemd-udevd.service</filename> + contains <option>Restart=always</option> and so as a result, this option restarts systemd-udevd. + If you want to stop <filename>systemd-udevd.service</filename>, please use the following: + <programlisting>systemctl stop systemd-udevd-control.socket systemd-udevd-kernel.socket systemd-udevd.service</programlisting> + </para> </listitem> </varlistentry> <varlistentry> @@ -420,6 +433,13 @@ </listitem> </varlistentry> <varlistentry> + <term><option>--ping</option></term> + <listitem> + <para>Send a ping message to systemd-udevd and wait for the reply. This may be useful to check that + systemd-udevd daemon is running.</para> + </listitem> + </varlistentry> + <varlistentry> <term><option>-t</option></term> <term><option>--timeout=</option><replaceable>seconds</replaceable></term> <listitem> @@ -464,14 +484,18 @@ <term><option>-s</option></term> <term><option>--subsystem-match=<replaceable>string[/string]</replaceable></option></term> <listitem> - <para>Filter kernel uevents and udev events by subsystem[/devtype]. Only events with a matching subsystem value will pass.</para> + <para>Filter kernel uevents and udev events by subsystem[/devtype]. Only events with a matching subsystem value will pass. + When this option is specified more than once, then each matching result is ORed, that is, all devices in the specified + subsystems are monitored.</para> </listitem> </varlistentry> <varlistentry> <term><option>-t</option></term> <term><option>--tag-match=<replaceable>string</replaceable></option></term> <listitem> - <para>Filter udev events by tag. Only udev events with a given tag attached will pass.</para> + <para>Filter udev events by tag. Only udev events with a given tag attached will pass. + When this option is specified more than once, then each matching result is ORed, that is, devices which have one of the + specified tags are monitored.</para> </listitem> </varlistentry> diff --git a/man/vconsole.conf.xml b/man/vconsole.conf.xml index fc8b2cb3ef..a0ca83507d 100644 --- a/man/vconsole.conf.xml +++ b/man/vconsole.conf.xml @@ -68,7 +68,7 @@ <para>The following options are understood:</para> - <variablelist> + <variablelist class='environment-variables'> <varlistentry> <term><varname>KEYMAP=</varname></term> |