|
 |
a52f674 |
From 4f6569d919c82aff74e4cfe40f988585f7d3d133 Mon Sep 17 00:00:00 2001
|
|
|
a52f674 |
From: "Jason St. John" <jstjohn@purdue.edu>
|
|
|
a52f674 |
Date: Thu, 13 Feb 2014 20:25:23 -0500
|
|
|
a52f674 |
Subject: [PATCH] man: fix grammatical errors and other formatting issues
|
|
|
a52f674 |
|
|
|
a52f674 |
* standardize capitalization of STDIN, STDOUT, and STDERR
|
|
|
a52f674 |
* reword some sentences for clarity
|
|
|
a52f674 |
* reflow some very long lines to be shorter than ~80 characters
|
|
|
a52f674 |
* add some missing <literal>, <constant>, <varname>, <option>, and <filename> tags
|
|
|
a52f674 |
|
|
|
a52f674 |
(cherry picked from commit bcddd5bf8033b0c9cb15a9d017b7714ebe21473a)
|
|
|
a52f674 |
|
|
|
a52f674 |
Conflicts:
|
|
|
a52f674 |
man/systemd-bus-proxyd.xml
|
|
|
a52f674 |
man/systemd.service.xml
|
|
|
a52f674 |
man/udev.xml
|
|
|
a52f674 |
---
|
|
|
a52f674 |
man/systemd-coredumpctl.xml | 6 +-
|
|
|
a52f674 |
man/systemd-udevd.service.xml | 5 +-
|
|
|
a52f674 |
man/systemd.exec.xml | 4 +-
|
|
|
a52f674 |
man/systemd.service.xml | 202 ++++++++++++++++++++++--------------------
|
|
|
a52f674 |
man/udev.xml | 118 ++++++++++++++----------
|
|
|
a52f674 |
man/udevadm.xml | 2 +-
|
|
|
a52f674 |
6 files changed, 181 insertions(+), 156 deletions(-)
|
|
|
a52f674 |
|
|
|
a52f674 |
diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml
|
|
|
a52f674 |
index 67f75d1..c096f6d 100644
|
|
|
a52f674 |
--- a/man/systemd-coredumpctl.xml
|
|
|
a52f674 |
+++ b/man/systemd-coredumpctl.xml
|
|
|
a52f674 |
@@ -135,7 +135,7 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<listitem><para>Extract the last coredump
|
|
|
a52f674 |
matching specified characteristics.
|
|
|
a52f674 |
- Coredump will be written on stdout, unless
|
|
|
a52f674 |
+ Coredump will be written on STDOUT, unless
|
|
|
a52f674 |
an output file is specified with
|
|
|
a52f674 |
<option>-o/--output</option>.
|
|
|
a52f674 |
</para></listitem>
|
|
|
a52f674 |
@@ -200,8 +200,8 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<refsect1>
|
|
|
a52f674 |
<title>Exit status</title>
|
|
|
a52f674 |
- <para>On success, 0 is returned, a non-zero failure
|
|
|
a52f674 |
- code otherwise. Not finding any matching coredumps is treated
|
|
|
a52f674 |
+ <para>On success, 0 is returned; otherwise, a non-zero failure
|
|
|
a52f674 |
+ code is returned. Not finding any matching coredumps is treated
|
|
|
a52f674 |
as failure.
|
|
|
a52f674 |
</para>
|
|
|
a52f674 |
</refsect1>
|
|
|
a52f674 |
diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml
|
|
|
a52f674 |
index 7fce300..50a1076 100644
|
|
|
a52f674 |
--- a/man/systemd-udevd.service.xml
|
|
|
a52f674 |
+++ b/man/systemd-udevd.service.xml
|
|
|
a52f674 |
@@ -70,7 +70,7 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>--debug</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Print debug messages to stderr.</para>
|
|
|
a52f674 |
+ <para>Print debug messages to STDERR.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
@@ -82,7 +82,6 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>--exec-delay=</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
-
|
|
|
a52f674 |
<para>Delay the execution of RUN instruction by the given
|
|
|
a52f674 |
number of seconds. This option might be useful when
|
|
|
a52f674 |
debugging system crashes during coldplug caused by loading
|
|
|
a52f674 |
@@ -158,7 +157,7 @@
|
|
|
a52f674 |
<term><varname>net.ifnames=</varname></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
<para>Network interfaces are renamed to give them predictable names
|
|
|
a52f674 |
- when possible. It is enabled by default, specifying 0 disables it.</para>
|
|
|
a52f674 |
+ when possible. It is enabled by default; specifying 0 disables it.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
</variablelist>
|
|
|
a52f674 |
diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml
|
|
|
a52f674 |
index c8414d4..5ba1aac 100644
|
|
|
a52f674 |
--- a/man/systemd.exec.xml
|
|
|
a52f674 |
+++ b/man/systemd.exec.xml
|
|
|
a52f674 |
@@ -491,8 +491,8 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>TTYPath=</varname></term>
|
|
|
a52f674 |
<listitem><para>Sets the terminal
|
|
|
a52f674 |
- device node to use if standard input,
|
|
|
a52f674 |
- output or stderr are connected to a
|
|
|
a52f674 |
+ device node to use if STDIN, STDOUT,
|
|
|
a52f674 |
+ or STDERR are connected to a
|
|
|
a52f674 |
TTY (see above). Defaults to
|
|
|
a52f674 |
<filename>/dev/console</filename>.</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
diff --git a/man/systemd.service.xml b/man/systemd.service.xml
|
|
|
a52f674 |
index e8bb02c..d23904e 100644
|
|
|
a52f674 |
--- a/man/systemd.service.xml
|
|
|
a52f674 |
+++ b/man/systemd.service.xml
|
|
|
a52f674 |
@@ -103,7 +103,7 @@
|
|
|
a52f674 |
script. This is useful for compatibility with
|
|
|
a52f674 |
SysV. Note that this compatibility is quite
|
|
|
a52f674 |
comprehensive but not 100%. For details about the
|
|
|
a52f674 |
- incompatibilities see the
|
|
|
a52f674 |
+ incompatibilities, see the
|
|
|
a52f674 |
url="http://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities
|
|
|
a52f674 |
with SysV</ulink> document.
|
|
|
a52f674 |
</para>
|
|
|
a52f674 |
@@ -172,13 +172,13 @@
|
|
|
a52f674 |
<varname>PIDFile=</varname> option, so
|
|
|
a52f674 |
that systemd can identify the main
|
|
|
a52f674 |
process of the daemon. systemd will
|
|
|
a52f674 |
- proceed starting follow-up units as
|
|
|
a52f674 |
- soon as the parent process
|
|
|
a52f674 |
+ proceed with starting follow-up units
|
|
|
a52f674 |
+ as soon as the parent process
|
|
|
a52f674 |
exits.</para>
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>Behavior of
|
|
|
a52f674 |
<option>oneshot</option> is similar
|
|
|
a52f674 |
- to <option>simple</option>, however
|
|
|
a52f674 |
+ to <option>simple</option>; however,
|
|
|
a52f674 |
it is expected that the process has to
|
|
|
a52f674 |
exit before systemd starts follow-up
|
|
|
a52f674 |
units. <varname>RemainAfterExit=</varname>
|
|
|
a52f674 |
@@ -187,13 +187,13 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>Behavior of
|
|
|
a52f674 |
<option>dbus</option> is similar to
|
|
|
a52f674 |
- <option>simple</option>, however it is
|
|
|
a52f674 |
+ <option>simple</option>; however, it is
|
|
|
a52f674 |
expected that the daemon acquires a
|
|
|
a52f674 |
name on the D-Bus bus, as configured
|
|
|
a52f674 |
by
|
|
|
a52f674 |
<varname>BusName=</varname>. systemd
|
|
|
a52f674 |
- will proceed starting follow-up units
|
|
|
a52f674 |
- after the D-Bus bus name has been
|
|
|
a52f674 |
+ will proceed with starting follow-up
|
|
|
a52f674 |
+ units after the D-Bus bus name has been
|
|
|
a52f674 |
acquired. Service units with this
|
|
|
a52f674 |
option configured implicitly gain
|
|
|
a52f674 |
dependencies on the
|
|
|
a52f674 |
@@ -204,12 +204,12 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>Behavior of
|
|
|
a52f674 |
<option>notify</option> is similar to
|
|
|
a52f674 |
- <option>simple</option>, however it is
|
|
|
a52f674 |
+ <option>simple</option>; however, it is
|
|
|
a52f674 |
expected that the daemon sends a
|
|
|
a52f674 |
notification message via
|
|
|
a52f674 |
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
a52f674 |
- or an equivalent call when it finished
|
|
|
a52f674 |
- starting up. systemd will proceed
|
|
|
a52f674 |
+ or an equivalent call when it has finished
|
|
|
a52f674 |
+ starting up. systemd will proceed with
|
|
|
a52f674 |
starting follow-up units after this
|
|
|
a52f674 |
notification message has been sent. If
|
|
|
a52f674 |
this option is used,
|
|
|
a52f674 |
@@ -227,7 +227,7 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>Behavior of
|
|
|
a52f674 |
<option>idle</option> is very similar
|
|
|
a52f674 |
- to <option>simple</option>, however
|
|
|
a52f674 |
+ to <option>simple</option>; however,
|
|
|
a52f674 |
actual execution of the service
|
|
|
a52f674 |
binary is delayed until all jobs are
|
|
|
a52f674 |
dispatched. This may be used to avoid
|
|
|
a52f674 |
@@ -260,7 +260,7 @@
|
|
|
a52f674 |
is set and <option>PIDFile=</option>
|
|
|
a52f674 |
is unset because for the other types
|
|
|
a52f674 |
or with an explicitly configured PID
|
|
|
a52f674 |
- file the main PID is always known. The
|
|
|
a52f674 |
+ file, the main PID is always known. The
|
|
|
a52f674 |
guessing algorithm might come to
|
|
|
a52f674 |
incorrect conclusions if a daemon
|
|
|
a52f674 |
consists of more than one process. If
|
|
|
a52f674 |
@@ -292,14 +292,13 @@
|
|
|
a52f674 |
<term><varname>BusName=</varname></term>
|
|
|
a52f674 |
|
|
|
a52f674 |
<listitem><para>Takes a D-Bus bus
|
|
|
a52f674 |
- name, that this service is reachable
|
|
|
a52f674 |
+ name that this service is reachable
|
|
|
a52f674 |
as. This option is mandatory for
|
|
|
a52f674 |
services where
|
|
|
a52f674 |
<varname>Type=</varname> is set to
|
|
|
a52f674 |
<option>dbus</option>, but its use
|
|
|
a52f674 |
- is otherwise recommended as well if
|
|
|
a52f674 |
- the process takes a name on the D-Bus
|
|
|
a52f674 |
- bus.</para>
|
|
|
a52f674 |
+ is otherwise recommended if the process
|
|
|
a52f674 |
+ takes a name on the D-Bus bus.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -318,7 +317,7 @@
|
|
|
a52f674 |
<varname>Type=oneshot</varname> is
|
|
|
a52f674 |
used, more than one command may be
|
|
|
a52f674 |
specified. Multiple command lines may
|
|
|
a52f674 |
- be concatenated in a single directive,
|
|
|
a52f674 |
+ be concatenated in a single directive
|
|
|
a52f674 |
by separating them with semicolons
|
|
|
a52f674 |
(these semicolons must be passed as
|
|
|
a52f674 |
separate words). Alternatively, this
|
|
|
a52f674 |
@@ -362,12 +361,12 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>If more than one command is
|
|
|
a52f674 |
specified, the commands are invoked
|
|
|
a52f674 |
- one by one sequentially in the order
|
|
|
a52f674 |
- they appear in the unit file. If one
|
|
|
a52f674 |
- of the commands fails (and is not
|
|
|
a52f674 |
- prefixed with <literal>-</literal>),
|
|
|
a52f674 |
- other lines are not executed and the
|
|
|
a52f674 |
- unit is considered failed.</para>
|
|
|
a52f674 |
+ sequentially in the order they appear
|
|
|
a52f674 |
+ in the unit file. If one of the
|
|
|
a52f674 |
+ commands fails (and is not prefixed
|
|
|
a52f674 |
+ with <literal>-</literal>), other lines
|
|
|
a52f674 |
+ are not executed, and the unit is
|
|
|
a52f674 |
+ considered failed.</para>
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>Unless
|
|
|
a52f674 |
<varname>Type=forking</varname> is
|
|
|
a52f674 |
@@ -387,7 +386,7 @@
|
|
|
a52f674 |
<para>Basic environment variable
|
|
|
a52f674 |
substitution is supported. Use
|
|
|
a52f674 |
<literal>${FOO}</literal> as part of a
|
|
|
a52f674 |
- word, or as a word of its own on the
|
|
|
a52f674 |
+ word, or as a word of its own, on the
|
|
|
a52f674 |
command line, in which case it will be
|
|
|
a52f674 |
replaced by the value of the
|
|
|
a52f674 |
environment variable including all
|
|
|
a52f674 |
@@ -410,12 +409,12 @@
|
|
|
a52f674 |
fashion may be defined through
|
|
|
a52f674 |
<varname>Environment=</varname> and
|
|
|
a52f674 |
<varname>EnvironmentFile=</varname>.
|
|
|
a52f674 |
- In addition, variables listed in
|
|
|
a52f674 |
+ In addition, variables listed in the
|
|
|
a52f674 |
section "Environment variables in
|
|
|
a52f674 |
spawned processes" in
|
|
|
a52f674 |
- <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
|
a52f674 |
+ <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
|
|
a52f674 |
which are considered "static
|
|
|
a52f674 |
- configuration" may used (this includes
|
|
|
a52f674 |
+ configuration", may be used (this includes
|
|
|
a52f674 |
e.g. <varname>$USER</varname>, but not
|
|
|
a52f674 |
<varname>$TERM</varname>).</para>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -447,10 +446,10 @@
|
|
|
a52f674 |
<programlisting>ExecStart=/bin/echo one ; /bin/echo "two two"</programlisting>
|
|
|
a52f674 |
<para>This will execute
|
|
|
a52f674 |
<command>/bin/echo</command> two
|
|
|
a52f674 |
- times, each time with one argument,
|
|
|
a52f674 |
+ times, each time with one argument:
|
|
|
a52f674 |
<literal>one</literal> and
|
|
|
a52f674 |
<literal>two two</literal>,
|
|
|
a52f674 |
- respectively. Since two commands are
|
|
|
a52f674 |
+ respectively. Because two commands are
|
|
|
a52f674 |
specified,
|
|
|
a52f674 |
<varname>Type=oneshot</varname> must
|
|
|
a52f674 |
be used.</para>
|
|
|
a52f674 |
@@ -512,8 +511,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
here following the same scheme as for
|
|
|
a52f674 |
<varname>ExecStart=</varname>.</para>
|
|
|
a52f674 |
|
|
|
a52f674 |
- <para>One additional special
|
|
|
a52f674 |
- environment variables is set: if known
|
|
|
a52f674 |
+ <para>One additional, special
|
|
|
a52f674 |
+ environment variable is set: if known,
|
|
|
a52f674 |
<varname>$MAINPID</varname> is set to
|
|
|
a52f674 |
the main process of the daemon, and
|
|
|
a52f674 |
may be used for command lines like the
|
|
|
a52f674 |
@@ -532,15 +531,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
following the same scheme as described
|
|
|
a52f674 |
for <varname>ExecStart=</varname>
|
|
|
a52f674 |
above. Use of this setting is
|
|
|
a52f674 |
- optional. All processes remaining for
|
|
|
a52f674 |
- a service after the commands
|
|
|
a52f674 |
- configured in this option are run are
|
|
|
a52f674 |
+ optional. After the commands configured
|
|
|
a52f674 |
+ in this option are run, all processes
|
|
|
a52f674 |
+ remaining for a service are
|
|
|
a52f674 |
terminated according to the
|
|
|
a52f674 |
<varname>KillMode=</varname> setting
|
|
|
a52f674 |
(see
|
|
|
a52f674 |
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If
|
|
|
a52f674 |
this option is not specified, the
|
|
|
a52f674 |
- process is terminated right-away when
|
|
|
a52f674 |
+ process is terminated immediately when
|
|
|
a52f674 |
service stop is requested. Specifier
|
|
|
a52f674 |
and environment variable substitution
|
|
|
a52f674 |
is supported (including
|
|
|
a52f674 |
@@ -586,15 +585,16 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
daemon service does not signal
|
|
|
a52f674 |
start-up completion within the
|
|
|
a52f674 |
configured time, the service will be
|
|
|
a52f674 |
- considered failed and be shut down
|
|
|
a52f674 |
- again.
|
|
|
a52f674 |
+ considered failed and will be shut
|
|
|
a52f674 |
+ down again.
|
|
|
a52f674 |
Takes a unit-less value in seconds, or a
|
|
|
a52f674 |
time span value such as "5min
|
|
|
a52f674 |
- 20s". Pass 0 to disable the timeout
|
|
|
a52f674 |
- logic. Defaults to <varname>TimeoutStartSec=</varname> in
|
|
|
a52f674 |
- manager configuration file, except when
|
|
|
a52f674 |
- <varname>Type=oneshot</varname> is
|
|
|
a52f674 |
- used in which case the timeout
|
|
|
a52f674 |
+ 20s". Pass <literal>0</literal> to
|
|
|
a52f674 |
+ disable the timeout logic. Defaults to
|
|
|
a52f674 |
+ <varname>TimeoutStartSec=</varname> from
|
|
|
a52f674 |
+ the manager configuration file, except
|
|
|
a52f674 |
+ when <varname>Type=oneshot</varname> is
|
|
|
a52f674 |
+ used, in which case the timeout
|
|
|
a52f674 |
is disabled by default.
|
|
|
a52f674 |
</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -603,17 +603,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
<term><varname>TimeoutStopSec=</varname></term>
|
|
|
a52f674 |
<listitem><para>Configures the time to
|
|
|
a52f674 |
wait for stop. If a service is asked
|
|
|
a52f674 |
- to stop but does not terminate in the
|
|
|
a52f674 |
+ to stop, but does not terminate in the
|
|
|
a52f674 |
specified time, it will be terminated
|
|
|
a52f674 |
- forcibly via <constant>SIGTERM</constant>, and after
|
|
|
a52f674 |
- another delay of this time with
|
|
|
a52f674 |
- <constant>SIGKILL</constant> (See
|
|
|
a52f674 |
+ forcibly via <constant>SIGTERM</constant>,
|
|
|
a52f674 |
+ and after another timeout of equal duration
|
|
|
a52f674 |
+ with <constant>SIGKILL</constant> (see
|
|
|
a52f674 |
<varname>KillMode=</varname>
|
|
|
a52f674 |
in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
|
|
|
a52f674 |
Takes a unit-less value in seconds, or a
|
|
|
a52f674 |
time span value such as "5min
|
|
|
a52f674 |
- 20s". Pass 0 to disable the timeout
|
|
|
a52f674 |
- logic. Defaults to <varname>TimeoutStartSec=</varname> in
|
|
|
a52f674 |
+ 20s". Pass <literal>0</literal> to disable
|
|
|
a52f674 |
+ the timeout logic. Defaults to
|
|
|
a52f674 |
+ <varname>TimeoutStartSec=</varname> from the
|
|
|
a52f674 |
manager configuration file.
|
|
|
a52f674 |
</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -634,11 +635,11 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
watchdog is activated when the start-up is
|
|
|
a52f674 |
completed. The service must call
|
|
|
a52f674 |
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
a52f674 |
- regularly with "WATCHDOG=1" (i.e. the
|
|
|
a52f674 |
- "keep-alive ping"). If the time
|
|
|
a52f674 |
+ regularly with <literal>WATCHDOG=1</literal>
|
|
|
a52f674 |
+ (i.e. the "keep-alive ping"). If the time
|
|
|
a52f674 |
between two such calls is larger than
|
|
|
a52f674 |
the configured time, then the service
|
|
|
a52f674 |
- is placed in a failure state. By
|
|
|
a52f674 |
+ is placed in a failed state. By
|
|
|
a52f674 |
setting <varname>Restart=</varname> to
|
|
|
a52f674 |
<option>on-failure</option> or
|
|
|
a52f674 |
<option>always</option>, the service
|
|
|
a52f674 |
@@ -669,8 +670,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
service process exits, is killed,
|
|
|
a52f674 |
or a timeout is reached. The service
|
|
|
a52f674 |
process may be the main service
|
|
|
a52f674 |
- process, but also one of the processes
|
|
|
a52f674 |
- specified with
|
|
|
a52f674 |
+ process, but it may also be one of the
|
|
|
a52f674 |
+ processes specified with
|
|
|
a52f674 |
<varname>ExecStartPre=</varname>,
|
|
|
a52f674 |
<varname>ExecStartPost=</varname>,
|
|
|
a52f674 |
<varname>ExecStopPre=</varname>,
|
|
|
a52f674 |
@@ -698,12 +699,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
exits cleanly.
|
|
|
a52f674 |
In this context, a clean exit means
|
|
|
a52f674 |
an exit code of 0, or one of the signals
|
|
|
a52f674 |
- <constant>SIGHUP</constant>, <constant>SIGINT</constant>, <constant>SIGTERM</constant>, or <constant>SIGPIPE</constant>, and
|
|
|
a52f674 |
+ <constant>SIGHUP</constant>,
|
|
|
a52f674 |
+ <constant>SIGINT</constant>,
|
|
|
a52f674 |
+ <constant>SIGTERM</constant>,
|
|
|
a52f674 |
+ or <constant>SIGPIPE</constant>, and
|
|
|
a52f674 |
additionally, exit statuses and signals
|
|
|
a52f674 |
specified in <varname>SuccessExitStatus=</varname>.
|
|
|
a52f674 |
If set to <option>on-failure</option>,
|
|
|
a52f674 |
the service will be restarted when the
|
|
|
a52f674 |
- process exits with an nonzero exit code,
|
|
|
a52f674 |
+ process exits with a non-zero exit code,
|
|
|
a52f674 |
is terminated by a signal (including on
|
|
|
a52f674 |
core dump), when an operation (such as
|
|
|
a52f674 |
service reload) times out, and when the
|
|
|
a52f674 |
@@ -722,7 +726,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
<option>always</option>, the service
|
|
|
a52f674 |
will be restarted regardless of whether
|
|
|
a52f674 |
it exited cleanly or not, got
|
|
|
a52f674 |
- terminated abnormally by a signal or
|
|
|
a52f674 |
+ terminated abnormally by a signal, or
|
|
|
a52f674 |
hit a timeout.</para>
|
|
|
a52f674 |
|
|
|
a52f674 |
<para>In addition to the above settings,
|
|
|
a52f674 |
@@ -774,7 +778,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
<listitem><para>Takes a list of exit
|
|
|
a52f674 |
status definitions that when returned
|
|
|
a52f674 |
by the main service process will
|
|
|
a52f674 |
- prevent automatic service restarts
|
|
|
a52f674 |
+ prevent automatic service restarts,
|
|
|
a52f674 |
regardless of the restart setting
|
|
|
a52f674 |
configured with
|
|
|
a52f674 |
<varname>Restart=</varname>. Exit
|
|
|
a52f674 |
@@ -782,19 +786,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
numeric exit codes or termination
|
|
|
a52f674 |
signal names, and are separated by
|
|
|
a52f674 |
spaces. Defaults to the empty list, so
|
|
|
a52f674 |
- that by default no exit status is
|
|
|
a52f674 |
+ that, by default, no exit status is
|
|
|
a52f674 |
excluded from the configured restart
|
|
|
a52f674 |
logic. Example:
|
|
|
a52f674 |
<literal>RestartPreventExitStatus=1 6
|
|
|
a52f674 |
SIGABRT</literal>, ensures that exit
|
|
|
a52f674 |
codes 1 and 6 and the termination
|
|
|
a52f674 |
- signal SIGABRT will not result in
|
|
|
a52f674 |
- automatic service restarting. This
|
|
|
a52f674 |
- option may appear more than once in
|
|
|
a52f674 |
- which case the list of restart preventing
|
|
|
a52f674 |
+ signal <constant>SIGABRT</constant> will
|
|
|
a52f674 |
+ not result in automatic service
|
|
|
a52f674 |
+ restarting. This
|
|
|
a52f674 |
+ option may appear more than once, in
|
|
|
a52f674 |
+ which case the list of restart-preventing
|
|
|
a52f674 |
statuses is merged. If the empty
|
|
|
a52f674 |
string is assigned to this option, the
|
|
|
a52f674 |
- list is reset, all prior assignments
|
|
|
a52f674 |
+ list is reset and all prior assignments
|
|
|
a52f674 |
of this option will have no
|
|
|
a52f674 |
effect.</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -802,20 +807,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>PermissionsStartOnly=</varname></term>
|
|
|
a52f674 |
<listitem><para>Takes a boolean
|
|
|
a52f674 |
- argument. If true, the permission
|
|
|
a52f674 |
- related execution options as
|
|
|
a52f674 |
+ argument. If true, the permission-related
|
|
|
a52f674 |
+ execution options, as
|
|
|
a52f674 |
configured with
|
|
|
a52f674 |
<varname>User=</varname> and similar
|
|
|
a52f674 |
options (see
|
|
|
a52f674 |
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
|
a52f674 |
- for more information) are only applied
|
|
|
a52f674 |
+ for more information), are only applied
|
|
|
a52f674 |
to the process started with
|
|
|
a52f674 |
<varname>ExecStart=</varname>, and not
|
|
|
a52f674 |
to the various other
|
|
|
a52f674 |
<varname>ExecStartPre=</varname>,
|
|
|
a52f674 |
<varname>ExecStartPost=</varname>,
|
|
|
a52f674 |
<varname>ExecReload=</varname>,
|
|
|
a52f674 |
- <varname>ExecStop=</varname>,
|
|
|
a52f674 |
+ <varname>ExecStop=</varname>, and
|
|
|
a52f674 |
<varname>ExecStopPost=</varname>
|
|
|
a52f674 |
commands. If false, the setting is
|
|
|
a52f674 |
applied to all configured commands the
|
|
|
a52f674 |
@@ -826,19 +831,19 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>RootDirectoryStartOnly=</varname></term>
|
|
|
a52f674 |
<listitem><para>Takes a boolean
|
|
|
a52f674 |
- argument. If true, the root directory
|
|
|
a52f674 |
+ argument. If true, the root directory,
|
|
|
a52f674 |
as configured with the
|
|
|
a52f674 |
<varname>RootDirectory=</varname>
|
|
|
a52f674 |
option (see
|
|
|
a52f674 |
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
|
a52f674 |
- for more information) is only applied
|
|
|
a52f674 |
+ for more information), is only applied
|
|
|
a52f674 |
to the process started with
|
|
|
a52f674 |
<varname>ExecStart=</varname>, and not
|
|
|
a52f674 |
to the various other
|
|
|
a52f674 |
<varname>ExecStartPre=</varname>,
|
|
|
a52f674 |
<varname>ExecStartPost=</varname>,
|
|
|
a52f674 |
<varname>ExecReload=</varname>,
|
|
|
a52f674 |
- <varname>ExecStop=</varname>,
|
|
|
a52f674 |
+ <varname>ExecStop=</varname>, and
|
|
|
a52f674 |
<varname>ExecStopPost=</varname>
|
|
|
a52f674 |
commands. If false, the setting is
|
|
|
a52f674 |
applied to all configured commands the
|
|
|
a52f674 |
@@ -848,12 +853,14 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>NonBlocking=</varname></term>
|
|
|
a52f674 |
- <listitem><para>Set O_NONBLOCK flag
|
|
|
a52f674 |
+ <listitem><para>Set the
|
|
|
a52f674 |
+ <constant>O_NONBLOCK</constant> flag
|
|
|
a52f674 |
for all file descriptors passed via
|
|
|
a52f674 |
socket-based activation. If true, all
|
|
|
a52f674 |
file descriptors >= 3 (i.e. all except
|
|
|
a52f674 |
STDIN/STDOUT/STDERR) will have
|
|
|
a52f674 |
- the O_NONBLOCK flag set and hence are in
|
|
|
a52f674 |
+ the <constant>O_NONBLOCK</constant> flag
|
|
|
a52f674 |
+ set and hence are in
|
|
|
a52f674 |
non-blocking mode. This option is only
|
|
|
a52f674 |
useful in conjunction with a socket
|
|
|
a52f674 |
unit, as described in
|
|
|
a52f674 |
@@ -909,8 +916,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
passed to multiple processes at the
|
|
|
a52f674 |
same time. Also note that a different
|
|
|
a52f674 |
service may be activated on incoming
|
|
|
a52f674 |
- traffic than inherits the sockets. Or
|
|
|
a52f674 |
- in other words: the
|
|
|
a52f674 |
+ traffic than that which inherits the
|
|
|
a52f674 |
+ sockets. Or in other words: the
|
|
|
a52f674 |
<varname>Service=</varname> setting of
|
|
|
a52f674 |
<filename>.socket</filename> units
|
|
|
a52f674 |
does not have to match the inverse of
|
|
|
a52f674 |
@@ -923,7 +930,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
once, in which case the list of socket
|
|
|
a52f674 |
units is merged. If the empty string
|
|
|
a52f674 |
is assigned to this option, the list of
|
|
|
a52f674 |
- sockets is reset, all prior uses of
|
|
|
a52f674 |
+ sockets is reset, and all prior uses of
|
|
|
a52f674 |
this setting will have no
|
|
|
a52f674 |
effect.</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -934,10 +941,10 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
|
|
|
a52f674 |
<listitem><para>Configure service
|
|
|
a52f674 |
start rate limiting. By default,
|
|
|
a52f674 |
- services which are started more often
|
|
|
a52f674 |
- than 5 times within 10s are not
|
|
|
a52f674 |
+ services which are started more
|
|
|
a52f674 |
+ than 5 times within 10 seconds are not
|
|
|
a52f674 |
permitted to start any more times
|
|
|
a52f674 |
- until the 10s interval ends. With
|
|
|
a52f674 |
+ until the 10 second interval ends. With
|
|
|
a52f674 |
these two options, this rate limiting
|
|
|
a52f674 |
may be modified. Use
|
|
|
a52f674 |
<varname>StartLimitInterval=</varname>
|
|
|
a52f674 |
@@ -952,18 +959,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
manager configuration file). These
|
|
|
a52f674 |
configuration options are particularly
|
|
|
a52f674 |
useful in conjunction with
|
|
|
a52f674 |
- <varname>Restart=</varname>, however
|
|
|
a52f674 |
- apply to all kinds of starts
|
|
|
a52f674 |
+ <varname>Restart=</varname>; however,
|
|
|
a52f674 |
+ they apply to all kinds of starts
|
|
|
a52f674 |
(including manual), not just those
|
|
|
a52f674 |
triggered by the
|
|
|
a52f674 |
<varname>Restart=</varname> logic.
|
|
|
a52f674 |
Note that units which are configured
|
|
|
a52f674 |
for <varname>Restart=</varname> and
|
|
|
a52f674 |
which reach the start limit are not
|
|
|
a52f674 |
- attempted to be restarted anymore,
|
|
|
a52f674 |
- however they may still be restarted
|
|
|
a52f674 |
- manually at a later point from which
|
|
|
a52f674 |
- point on the restart logic is again
|
|
|
a52f674 |
+ attempted to be restarted anymore;
|
|
|
a52f674 |
+ however, they may still be restarted
|
|
|
a52f674 |
+ manually at a later point, from which
|
|
|
a52f674 |
+ point on, the restart logic is again
|
|
|
a52f674 |
activated. Note that
|
|
|
a52f674 |
<command>systemctl
|
|
|
a52f674 |
reset-failed</command> will cause the
|
|
|
a52f674 |
@@ -987,18 +994,17 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
hit. Takes one of
|
|
|
a52f674 |
<option>none</option>,
|
|
|
a52f674 |
<option>reboot</option>,
|
|
|
a52f674 |
- <option>reboot-force</option> or
|
|
|
a52f674 |
+ <option>reboot-force</option>, or
|
|
|
a52f674 |
<option>reboot-immediate</option>. If
|
|
|
a52f674 |
<option>none</option> is set,
|
|
|
a52f674 |
hitting the rate limit will trigger no
|
|
|
a52f674 |
action besides that the start will not
|
|
|
a52f674 |
- be
|
|
|
a52f674 |
- permitted. <option>reboot</option>
|
|
|
a52f674 |
+ be permitted. <option>reboot</option>
|
|
|
a52f674 |
causes a reboot following the normal
|
|
|
a52f674 |
shutdown procedure (i.e. equivalent to
|
|
|
a52f674 |
- <command>systemctl reboot</command>),
|
|
|
a52f674 |
+ <command>systemctl reboot</command>).
|
|
|
a52f674 |
<option>reboot-force</option> causes
|
|
|
a52f674 |
- an forced reboot which will terminate
|
|
|
a52f674 |
+ a forced reboot which will terminate
|
|
|
a52f674 |
all processes forcibly but should
|
|
|
a52f674 |
cause no dirty file systems on reboot
|
|
|
a52f674 |
(i.e. equivalent to <command>systemctl
|
|
|
a52f674 |
@@ -1007,7 +1013,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
causes immediate execution of the
|
|
|
a52f674 |
<citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
|
|
|
a52f674 |
system call, which might result in
|
|
|
a52f674 |
- data loss. Defaults to
|
|
|
a52f674 |
+ data loss. Defaults to
|
|
|
a52f674 |
<option>none</option>.</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -1037,19 +1043,19 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
|
|
|
a52f674 |
in relation to SysV services lacking
|
|
|
a52f674 |
LSB headers. This option is only
|
|
|
a52f674 |
necessary to fix ordering in relation
|
|
|
a52f674 |
- to legacy SysV services, that have no
|
|
|
a52f674 |
+ to legacy SysV services that have no
|
|
|
a52f674 |
ordering information encoded in the
|
|
|
a52f674 |
- script headers. As such it should only
|
|
|
a52f674 |
- be used as temporary compatibility
|
|
|
a52f674 |
- option, and not be used in new unit
|
|
|
a52f674 |
- files. Almost always it is a better
|
|
|
a52f674 |
+ script headers. As such, it should only
|
|
|
a52f674 |
+ be used as a temporary compatibility
|
|
|
a52f674 |
+ option and should not be used in new unit
|
|
|
a52f674 |
+ files. Almost always, it is a better
|
|
|
a52f674 |
choice to add explicit ordering
|
|
|
a52f674 |
directives via
|
|
|
a52f674 |
<varname>After=</varname> or
|
|
|
a52f674 |
<varname>Before=</varname>,
|
|
|
a52f674 |
- instead. For more details see
|
|
|
a52f674 |
- <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If
|
|
|
a52f674 |
- used, pass an integer value in the
|
|
|
a52f674 |
+ instead. For more details, see
|
|
|
a52f674 |
+ <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
|
|
a52f674 |
+ If used, pass an integer value in the
|
|
|
a52f674 |
range 0-99.</para></listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
diff --git a/man/udev.xml b/man/udev.xml
|
|
|
a52f674 |
index f107482..82e7478 100644
|
|
|
a52f674 |
--- a/man/udev.xml
|
|
|
a52f674 |
+++ b/man/udev.xml
|
|
|
a52f674 |
@@ -255,9 +255,9 @@
|
|
|
a52f674 |
<para>Execute a program to determine whether there
|
|
|
a52f674 |
is a match; the key is true if the program returns
|
|
|
a52f674 |
successfully. The device properties are made available to the
|
|
|
a52f674 |
- executed program in the environment. The program's stdout
|
|
|
a52f674 |
- is available in the RESULT key.</para>
|
|
|
a52f674 |
- <para>This can only be used for very short-running foreground tasks. For details
|
|
|
a52f674 |
+ executed program in the environment. The program's STDOUT
|
|
|
a52f674 |
+ is available in the <varname>RESULT</varname> key.</para>
|
|
|
a52f674 |
+ <para>This can only be used for very short-running foreground tasks. For details,
|
|
|
a52f674 |
see <varname>RUN</varname>.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -265,8 +265,9 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>RESULT</varname></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Match the returned string of the last PROGRAM call. This key can
|
|
|
a52f674 |
- be used in the same or in any later rule after a PROGRAM call.</para>
|
|
|
a52f674 |
+ <para>Match the returned string of the last <varname>PROGRAM</varname> call.
|
|
|
a52f674 |
+ This key can be used in the same or in any later rule after a
|
|
|
a52f674 |
+ <varname>PROGRAM</varname> call.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
</variablelist>
|
|
|
a52f674 |
@@ -293,9 +294,10 @@
|
|
|
a52f674 |
example, the pattern string <literal>tty[SR]</literal>
|
|
|
a52f674 |
would match either <literal>ttyS</literal> or <literal>ttyR</literal>.
|
|
|
a52f674 |
Ranges are also supported via the <literal>-</literal> character.
|
|
|
a52f674 |
- For example, to match on the range of all digits, the pattern [0-9] could
|
|
|
a52f674 |
- be used. If the first character following the <literal>[</literal> is a
|
|
|
a52f674 |
- <literal>!</literal>, any characters not enclosed are matched.</para>
|
|
|
a52f674 |
+ For example, to match on the range of all digits, the pattern
|
|
|
a52f674 |
+ <literal>[0-9]</literal> could be used. If the first character
|
|
|
a52f674 |
+ following the <literal>[</literal> is a <literal>!</literal>,
|
|
|
a52f674 |
+ any characters not enclosed are matched.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
</variablelist>
|
|
|
a52f674 |
@@ -353,7 +355,8 @@
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
<para>Set a device property value. Property names with a leading <literal>.</literal>
|
|
|
a52f674 |
are neither stored in the database nor exported to events or
|
|
|
a52f674 |
- external tools (run by, say, the PROGRAM match key).</para>
|
|
|
a52f674 |
+ external tools (run by, for example, the <varname>PROGRAM</varname>
|
|
|
a52f674 |
+ match key).</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -373,24 +376,26 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>RUN{<replaceable>type</replaceable>}</varname></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Add a program to the list of programs to be executed after processing all the
|
|
|
a52f674 |
- rules for a specific event, depending on <literal>type</literal>:</para>
|
|
|
a52f674 |
+ <para>Add a program to the list of programs to be executed after
|
|
|
a52f674 |
+ processing all the rules for a specific event, depending on
|
|
|
a52f674 |
+ <literal>type</literal>:</para>
|
|
|
a52f674 |
<variablelist>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><literal>program</literal></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
<para>Execute an external program specified as the assigned
|
|
|
a52f674 |
- value. If no absolute path is given, the program is expected to live in
|
|
|
a52f674 |
- /usr/lib/udev, otherwise the absolute path must be specified.</para>
|
|
|
a52f674 |
- <para>This is the default if no <replaceable>type</replaceable> is
|
|
|
a52f674 |
- specified.</para>
|
|
|
a52f674 |
+ value. If no absolute path is given, the program is expected
|
|
|
a52f674 |
+ to live in <filename>/usr/lib/udev</filename>; otherwise, the
|
|
|
a52f674 |
+ absolute path must be specified.</para>
|
|
|
a52f674 |
+ <para>This is the default if no <replaceable>type</replaceable>
|
|
|
a52f674 |
+ is specified.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><literal>builtin</literal></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>As <varname>program</varname>, but use one of the built-in programs rather
|
|
|
a52f674 |
- than an external one.</para>
|
|
|
a52f674 |
+ <para>As <varname>program</varname>, but use one of the
|
|
|
a52f674 |
+ built-in programs rather than an external one.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
</variablelist>
|
|
|
a52f674 |
@@ -399,7 +404,7 @@
|
|
|
a52f674 |
<para>This can only be used for very short-running foreground tasks. Running an
|
|
|
a52f674 |
event process for a long period of time may block all further events for
|
|
|
a52f674 |
this or a dependent device.</para>
|
|
|
a52f674 |
- <para>Starting daemons or other long running processes is not appropriate
|
|
|
a52f674 |
+ <para>Starting daemons or other long-running processes is not appropriate
|
|
|
a52f674 |
for udev; the forked processes, detached or not, will be unconditionally
|
|
|
a52f674 |
killed after the event handling has finished.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
@@ -408,14 +413,14 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>LABEL</varname></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>A named label to which a GOTO may jump.</para>
|
|
|
a52f674 |
+ <para>A named label to which a <varname>GOTO</varname> may jump.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><varname>GOTO</varname></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Jumps to the next LABEL with a matching name.</para>
|
|
|
a52f674 |
+ <para>Jumps to the next <varname>LABEL</varname> with a matching name.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -518,21 +523,24 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>static_node=</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Apply the permissions specified in this rule to the static device node with
|
|
|
a52f674 |
- the specified name. Also, for every tag specified in this rule, create a symlink
|
|
|
a52f674 |
+ <para>Apply the permissions specified in this rule to the
|
|
|
a52f674 |
+ static device node with the specified name. Also, for every
|
|
|
a52f674 |
+ tag specified in this rule, create a symlink
|
|
|
a52f674 |
in the directory
|
|
|
a52f674 |
<filename>/run/udev/static_node-tags/<replaceable>tag</replaceable></filename>
|
|
|
a52f674 |
- pointing at the static device node with the specified name. Static device node
|
|
|
a52f674 |
- creation is performed by systemd-tmpfiles before systemd-udevd is started. The
|
|
|
a52f674 |
- static nodes might not have a corresponding kernel device; they are used to
|
|
|
a52f674 |
- trigger automatic kernel module loading when they are accessed.</para>
|
|
|
a52f674 |
+ pointing at the static device node with the specified name.
|
|
|
a52f674 |
+ Static device node creation is performed by systemd-tmpfiles
|
|
|
a52f674 |
+ before systemd-udevd is started. The static nodes might not
|
|
|
a52f674 |
+ have a corresponding kernel device; they are used to trigger
|
|
|
a52f674 |
+ automatic kernel module loading when they are accessed.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>watch</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Watch the device node with inotify; when the node is closed after being opened for
|
|
|
a52f674 |
- writing, a change uevent is synthesized.</para>
|
|
|
a52f674 |
+ <para>Watch the device node with inotify; when the node is
|
|
|
a52f674 |
+ closed after being opened for writing, a change uevent is
|
|
|
a52f674 |
+ synthesized.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
@@ -546,13 +554,15 @@
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
</variablelist>
|
|
|
a52f674 |
|
|
|
a52f674 |
- <para>The <varname>NAME</varname>, <varname>SYMLINK</varname>, <varname>PROGRAM</varname>,
|
|
|
a52f674 |
- <varname>OWNER</varname>, <varname>GROUP</varname>, <varname>MODE</varname> and <varname>RUN</varname>
|
|
|
a52f674 |
- fields support simple string substitutions. The <varname>RUN</varname>
|
|
|
a52f674 |
- substitutions are performed after all rules have been processed, right before the program
|
|
|
a52f674 |
- is executed, allowing for the use of device properties set by earlier matching
|
|
|
a52f674 |
- rules. For all other fields, substitutions are performed while the individual rule is
|
|
|
a52f674 |
- being processed. The available substitutions are:</para>
|
|
|
a52f674 |
+ <para>The <varname>NAME</varname>, <varname>SYMLINK</varname>,
|
|
|
a52f674 |
+ <varname>PROGRAM</varname>, <varname>OWNER</varname>,
|
|
|
a52f674 |
+ <varname>GROUP</varname>, <varname>MODE</varname>, and
|
|
|
a52f674 |
+ <varname>RUN</varname> fields support simple string substitutions.
|
|
|
a52f674 |
+ The <varname>RUN</varname> substitutions are performed after all rules
|
|
|
a52f674 |
+ have been processed, right before the program is executed, allowing for
|
|
|
a52f674 |
+ the use of device properties set by earlier matching rules. For all other
|
|
|
a52f674 |
+ fields, substitutions are performed while the individual rule is being
|
|
|
a52f674 |
+ processed. The available substitutions are:</para>
|
|
|
a52f674 |
<variablelist class='udev-directives'>
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>$kernel</option>, <option>%k</option></term>
|
|
|
a52f674 |
@@ -565,7 +575,8 @@
|
|
|
a52f674 |
<term><option>$number</option>, <option>%n</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
<para>The kernel number for this device. For example,
|
|
|
a52f674 |
- <literal>sda3</literal> has kernel number <literal>3</literal>.</para>
|
|
|
a52f674 |
+ <literal>sda3</literal> has kernel number <literal>3</literal>.
|
|
|
a52f674 |
+ </para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -579,8 +590,9 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>$id</option>, <option>%b</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>The name of the device matched while searching the devpath upwards for
|
|
|
a52f674 |
- <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
|
|
|
a52f674 |
+ <para>The name of the device matched while searching the devpath
|
|
|
a52f674 |
+ upwards for <option>SUBSYSTEMS</option>, <option>KERNELS</option>,
|
|
|
a52f674 |
+ <option>DRIVERS</option>, and <option>ATTRS</option>.
|
|
|
a52f674 |
</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -588,8 +600,10 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>$driver</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>The driver name of the device matched while searching the devpath upwards for
|
|
|
a52f674 |
- <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>.
|
|
|
a52f674 |
+ <para>The driver name of the device matched while searching the
|
|
|
a52f674 |
+ devpath upwards for <option>SUBSYSTEMS</option>,
|
|
|
a52f674 |
+ <option>KERNELS</option>, <option>DRIVERS</option>, and
|
|
|
a52f674 |
+ <option>ATTRS</option>.
|
|
|
a52f674 |
</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
@@ -598,12 +612,15 @@
|
|
|
a52f674 |
<term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
<para>The value of a sysfs attribute found at the device where
|
|
|
a52f674 |
- all keys of the rule have matched. If the matching device does not have
|
|
|
a52f674 |
- such an attribute, and a previous KERNELS, SUBSYSTEMS, DRIVERS, or
|
|
|
a52f674 |
- ATTRS test selected a parent device, then the attribute from that
|
|
|
a52f674 |
- parent device is used.</para>
|
|
|
a52f674 |
- <para>If the attribute is a symlink, the last element of the symlink target is
|
|
|
a52f674 |
- returned as the value.</para>
|
|
|
a52f674 |
+ all keys of the rule have matched. If the matching device does not
|
|
|
a52f674 |
+ have such an attribute, and a previous <option>KERNELS</option>,
|
|
|
a52f674 |
+ <option>SUBSYSTEMS</option>, <option>DRIVERS</option>, or
|
|
|
a52f674 |
+ <option>ATTRS</option> test selected a parent device, then the
|
|
|
a52f674 |
+ attribute from that parent device is used.
|
|
|
a52f674 |
+ </para>
|
|
|
a52f674 |
+ <para>If the attribute is a symlink, the last element of the
|
|
|
a52f674 |
+ symlink target is returned as the value.
|
|
|
a52f674 |
+ </para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
|
|
|
a52f674 |
@@ -631,7 +648,8 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>$result</option>, <option>%c</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>The string returned by the external program requested with PROGRAM.
|
|
|
a52f674 |
+ <para>The string returned by the external program requested with
|
|
|
a52f674 |
+ <varname>PROGRAM</varname>.
|
|
|
a52f674 |
A single part of the string, separated by a space character, may be selected
|
|
|
a52f674 |
by specifying the part number as an attribute: <literal>%c{N}</literal>.
|
|
|
a52f674 |
If the number is followed by the <literal>+</literal> character, this part plus all remaining parts
|
|
|
a52f674 |
@@ -736,11 +754,13 @@
|
|
|
a52f674 |
|
|
|
a52f674 |
<refsect1>
|
|
|
a52f674 |
<title>See Also</title>
|
|
|
a52f674 |
- <para><citerefentry>
|
|
|
a52f674 |
+ <para>
|
|
|
a52f674 |
+ <citerefentry>
|
|
|
a52f674 |
<refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
|
|
|
a52f674 |
</citerefentry>,
|
|
|
a52f674 |
<citerefentry>
|
|
|
a52f674 |
<refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
|
|
|
a52f674 |
- </citerefentry></para>
|
|
|
a52f674 |
+ </citerefentry>
|
|
|
a52f674 |
+ </para>
|
|
|
a52f674 |
</refsect1>
|
|
|
a52f674 |
</refentry>
|
|
|
a52f674 |
diff --git a/man/udevadm.xml b/man/udevadm.xml
|
|
|
a52f674 |
index ca3713f..32bf480 100644
|
|
|
a52f674 |
--- a/man/udevadm.xml
|
|
|
a52f674 |
+++ b/man/udevadm.xml
|
|
|
a52f674 |
@@ -72,7 +72,7 @@
|
|
|
a52f674 |
<varlistentry>
|
|
|
a52f674 |
<term><option>--debug</option></term>
|
|
|
a52f674 |
<listitem>
|
|
|
a52f674 |
- <para>Print debug messages to stderr.</para>
|
|
|
a52f674 |
+ <para>Print debug messages to STDERR.</para>
|
|
|
a52f674 |
</listitem>
|
|
|
a52f674 |
</varlistentry>
|
|
|
a52f674 |
<varlistentry>
|