shaba/systemd-stable
1
1
Fork 0
mirror of https://github.com/systemd/systemd-stable.git synced 2025-01-11 05:17:44 +03:00
Code

man: fix grammatical errors and other formatting issues

Browse Source 
* standardize capitalization of STDIN, STDOUT, and STDERR
* reword some sentences for clarity
* reflow some very long lines to be shorter than ~80 characters
* add some missing <literal>, <constant>, <varname>, <option>, and <filename> tags
This commit is contained in:
Jason St. John 2014-02-13 20:25:23 -05:00 committed by Zbigniew Jędrzejewski-Szmek
parent e10c9985bb
commit bcddd5bf80
7 changed files with 233 additions and 184 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
man/systemd-bus-proxyd.xml
View File

@ -61,7 +61,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
<para><command>systemd-bus-proxyd</command> will proxy D-Bus <para><command>systemd-bus-proxyd</command> will proxy D-Bus
messages to and from a bus. The will be either the system bus or messages to and from a bus. The will be either the system bus or
the bus specified with <option>--address</option> when that option the bus specified with <option>--address</option> when that option
is given. Messages will be proxied to/from stdin and stdout, or is given. Messages will be proxied to/from STDIN and STDOUT, or
the socket received through socket activation.</para> the socket received through socket activation.</para>
<para>This program can be used to connect a program using classic <para>This program can be used to connect a program using classic
@ -103,7 +103,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para><replaceable>PLACEHOLDER</replaceable> if given must be a string <para><replaceable>PLACEHOLDER</replaceable>, if given, must be a string
of <literal>x</literal> and will be used to display information about of <literal>x</literal> and will be used to display information about
the process that <command>systemd-bus-proxyd</command> is forwarding the process that <command>systemd-bus-proxyd</command> is forwarding
messages for.</para> messages for.</para>

6
man/systemd-coredumpctl.xml
View File

@ -135,7 +135,7 @@
<listitem><para>Extract the last coredump <listitem><para>Extract the last coredump
matching specified characteristics. matching specified characteristics.
Coredump will be written on stdout, unless Coredump will be written on STDOUT, unless
an output file is specified with an output file is specified with
<option>-o/--output</option>. <option>-o/--output</option>.
</para></listitem> </para></listitem>
@ -200,8 +200,8 @@
<refsect1> <refsect1>
<title>Exit status</title> <title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure <para>On success, 0 is returned; otherwise, a non-zero failure
code otherwise. Not finding any matching coredumps is treated code is returned. Not finding any matching coredumps is treated
as failure. as failure.
</para> </para>
</refsect1> </refsect1>

5
man/systemd-udevd.service.xml
View File

@ -70,7 +70,7 @@
<varlistentry> <varlistentry>
<term><option>--debug</option></term> <term><option>--debug</option></term>
<listitem> <listitem>
<para>Print debug messages to stderr.</para> <para>Print debug messages to STDERR.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -82,7 +82,6 @@
<varlistentry> <varlistentry>
<term><option>--exec-delay=</option></term> <term><option>--exec-delay=</option></term>
<listitem> <listitem>
<para>Delay the execution of RUN instruction by the given <para>Delay the execution of RUN instruction by the given
number of seconds. This option might be useful when number of seconds. This option might be useful when
debugging system crashes during coldplug caused by loading debugging system crashes during coldplug caused by loading
@ -158,7 +157,7 @@
<term><varname>net.ifnames=</varname></term> <term><varname>net.ifnames=</varname></term>
<listitem> <listitem>
<para>Network interfaces are renamed to give them predictable names <para>Network interfaces are renamed to give them predictable names
when possible. It is enabled by default, specifying 0 disables it.</para> when possible. It is enabled by default; specifying 0 disables it.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>

4
man/systemd.exec.xml
View File

@ -491,8 +491,8 @@
<varlistentry> <varlistentry>
<term><varname>TTYPath=</varname></term> <term><varname>TTYPath=</varname></term>
<listitem><para>Sets the terminal <listitem><para>Sets the terminal
device node to use if standard input, device node to use if STDIN, STDOUT,
output or stderr are connected to a or STDERR are connected to a
TTY (see above). Defaults to TTY (see above). Defaults to
<filename>/dev/console</filename>.</para></listitem> <filename>/dev/console</filename>.</para></listitem>
</varlistentry> </varlistentry>

201
man/systemd.service.xml
View File

@ -103,7 +103,7 @@
script. This is useful for compatibility with script. This is useful for compatibility with
SysV. Note that this compatibility is quite SysV. Note that this compatibility is quite
comprehensive but not 100%. For details about the comprehensive but not 100%. For details about the
incompatibilities see the <ulink incompatibilities, see the <ulink
url="http://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities url="http://www.freedesktop.org/wiki/Software/systemd/Incompatibilities">Incompatibilities
with SysV</ulink> document. with SysV</ulink> document.
</para> </para>
@ -172,13 +172,13 @@
<varname>PIDFile=</varname> option, so <varname>PIDFile=</varname> option, so
that systemd can identify the main that systemd can identify the main
process of the daemon. systemd will process of the daemon. systemd will
proceed starting follow-up units as proceed with starting follow-up units
soon as the parent process as soon as the parent process
exits.</para> exits.</para>
<para>Behavior of <para>Behavior of
<option>oneshot</option> is similar <option>oneshot</option> is similar
to <option>simple</option>, however to <option>simple</option>; however,
it is expected that the process has to it is expected that the process has to
exit before systemd starts follow-up exit before systemd starts follow-up
units. <varname>RemainAfterExit=</varname> units. <varname>RemainAfterExit=</varname>
@ -187,13 +187,13 @@
<para>Behavior of <para>Behavior of
<option>dbus</option> is similar to <option>dbus</option> is similar to
<option>simple</option>, however it is <option>simple</option>; however, it is
expected that the daemon acquires a expected that the daemon acquires a
name on the D-Bus bus, as configured name on the D-Bus bus, as configured
by by
<varname>BusName=</varname>. systemd <varname>BusName=</varname>. systemd
will proceed starting follow-up units will proceed with starting follow-up
after the D-Bus bus name has been units after the D-Bus bus name has been
acquired. Service units with this acquired. Service units with this
option configured implicitly gain option configured implicitly gain
dependencies on the dependencies on the
@ -204,12 +204,12 @@
<para>Behavior of <para>Behavior of
<option>notify</option> is similar to <option>notify</option> is similar to
<option>simple</option>, however it is <option>simple</option>; however, it is
expected that the daemon sends a expected that the daemon sends a
notification message via notification message via
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
or an equivalent call when it finished or an equivalent call when it has finished
starting up. systemd will proceed starting up. systemd will proceed with
starting follow-up units after this starting follow-up units after this
notification message has been sent. If notification message has been sent. If
this option is used, this option is used,
@ -227,7 +227,7 @@
<para>Behavior of <para>Behavior of
<option>idle</option> is very similar <option>idle</option> is very similar
to <option>simple</option>, however to <option>simple</option>; however,
actual execution of the service actual execution of the service
binary is delayed until all jobs are binary is delayed until all jobs are
dispatched. This may be used to avoid dispatched. This may be used to avoid
@ -260,7 +260,7 @@
is set and <option>PIDFile=</option> is set and <option>PIDFile=</option>
is unset because for the other types is unset because for the other types
or with an explicitly configured PID or with an explicitly configured PID
file the main PID is always known. The file, the main PID is always known. The
guessing algorithm might come to guessing algorithm might come to
incorrect conclusions if a daemon incorrect conclusions if a daemon
consists of more than one process. If consists of more than one process. If
@ -292,14 +292,13 @@
<term><varname>BusName=</varname></term> <term><varname>BusName=</varname></term>
<listitem><para>Takes a D-Bus bus <listitem><para>Takes a D-Bus bus
name, that this service is reachable name that this service is reachable
as. This option is mandatory for as. This option is mandatory for
services where services where
<varname>Type=</varname> is set to <varname>Type=</varname> is set to
<option>dbus</option>, but its use <option>dbus</option>, but its use
is otherwise recommended as well if is otherwise recommended if the process
the process takes a name on the D-Bus takes a name on the D-Bus bus.</para>
bus.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -318,7 +317,7 @@
<varname>Type=oneshot</varname> is <varname>Type=oneshot</varname> is
used, more than one command may be used, more than one command may be
specified. Multiple command lines may specified. Multiple command lines may
be concatenated in a single directive, be concatenated in a single directive
by separating them with semicolons by separating them with semicolons
(these semicolons must be passed as (these semicolons must be passed as
separate words). Alternatively, this separate words). Alternatively, this
@ -362,12 +361,12 @@
<para>If more than one command is <para>If more than one command is
specified, the commands are invoked specified, the commands are invoked
one by one sequentially in the order sequentially in the order they appear
they appear in the unit file. If one in the unit file. If one of the
of the commands fails (and is not commands fails (and is not prefixed
prefixed with <literal>-</literal>), with <literal>-</literal>), other lines
other lines are not executed and the are not executed, and the unit is
unit is considered failed.</para> considered failed.</para>
<para>Unless <para>Unless
<varname>Type=forking</varname> is <varname>Type=forking</varname> is
@ -387,7 +386,7 @@
<para>Basic environment variable <para>Basic environment variable
substitution is supported. Use substitution is supported. Use
<literal>${FOO}</literal> as part of a <literal>${FOO}</literal> as part of a
word, or as a word of its own on the word, or as a word of its own, on the
command line, in which case it will be command line, in which case it will be
replaced by the value of the replaced by the value of the
environment variable including all environment variable including all
@ -410,12 +409,12 @@
fashion may be defined through fashion may be defined through
<varname>Environment=</varname> and <varname>Environment=</varname> and
<varname>EnvironmentFile=</varname>. <varname>EnvironmentFile=</varname>.
In addition, variables listed in In addition, variables listed in the
section "Environment variables in section "Environment variables in
spawned processes" in spawned processes" in
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
which are considered "static which are considered "static
configuration" may used (this includes configuration", may be used (this includes
e.g. <varname>$USER</varname>, but not e.g. <varname>$USER</varname>, but not
<varname>$TERM</varname>).</para> <varname>$TERM</varname>).</para>
@ -447,10 +446,10 @@
<programlisting>ExecStart=/bin/echo one ; /bin/echo "two two"</programlisting> <programlisting>ExecStart=/bin/echo one ; /bin/echo "two two"</programlisting>
<para>This will execute <para>This will execute
<command>/bin/echo</command> two <command>/bin/echo</command> two
times, each time with one argument, times, each time with one argument:
<literal>one</literal> and <literal>one</literal> and
<literal>two two</literal>, <literal>two two</literal>,
respectively. Since two commands are respectively. Because two commands are
specified, specified,
<varname>Type=oneshot</varname> must <varname>Type=oneshot</varname> must
be used.</para> be used.</para>
@ -512,8 +511,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
here following the same scheme as for here following the same scheme as for
<varname>ExecStart=</varname>.</para> <varname>ExecStart=</varname>.</para>
<para>One additional special <para>One additional, special
environment variables is set: if known environment variable is set: if known,
<varname>$MAINPID</varname> is set to <varname>$MAINPID</varname> is set to
the main process of the daemon, and the main process of the daemon, and
may be used for command lines like the may be used for command lines like the
@ -532,15 +531,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
following the same scheme as described following the same scheme as described
for <varname>ExecStart=</varname> for <varname>ExecStart=</varname>
above. Use of this setting is above. Use of this setting is
optional. All processes remaining for optional. After the commands configured
a service after the commands in this option are run, all processes
configured in this option are run are remaining for a service are
terminated according to the terminated according to the
<varname>KillMode=</varname> setting <varname>KillMode=</varname> setting
(see (see
<citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If
this option is not specified, the this option is not specified, the
process is terminated right-away when process is terminated immediately when
service stop is requested. Specifier service stop is requested. Specifier
and environment variable substitution and environment variable substitution
is supported (including is supported (including
@ -586,14 +585,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
daemon service does not signal daemon service does not signal
start-up completion within the start-up completion within the
configured time, the service will be configured time, the service will be
considered failed and be shut down considered failed and will be shut
again. down again.
Takes a unit-less value in seconds, or a Takes a unit-less value in seconds, or a
time span value such as "5min time span value such as "5min
20s". Pass 0 to disable the timeout 20s". Pass <literal>0</literal> to
logic. Defaults to <varname>TimeoutStartSec=</varname> from the disable the timeout logic. Defaults to
manager configuration file, except when <varname>TimeoutStartSec=</varname> from
<varname>Type=oneshot</varname> is the manager configuration file, except
when <varname>Type=oneshot</varname> is
used, in which case the timeout used, in which case the timeout
is disabled by default. is disabled by default.
</para></listitem> </para></listitem>
@ -603,17 +603,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<term><varname>TimeoutStopSec=</varname></term> <term><varname>TimeoutStopSec=</varname></term>
<listitem><para>Configures the time to <listitem><para>Configures the time to
wait for stop. If a service is asked wait for stop. If a service is asked
to stop but does not terminate in the to stop, but does not terminate in the
specified time, it will be terminated specified time, it will be terminated
forcibly via <constant>SIGTERM</constant>, and after forcibly via <constant>SIGTERM</constant>,
another delay of this time with and after another timeout of equal duration
<constant>SIGKILL</constant> (See with <constant>SIGKILL</constant> (see
<varname>KillMode=</varname> <varname>KillMode=</varname>
in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>).
Takes a unit-less value in seconds, or a Takes a unit-less value in seconds, or a
time span value such as "5min time span value such as "5min
20s". Pass 0 to disable the timeout 20s". Pass <literal>0</literal> to disable
logic. Defaults to <varname>TimeoutStartSec=</varname> from the the timeout logic. Defaults to
<varname>TimeoutStartSec=</varname> from the
manager configuration file. manager configuration file.
</para></listitem> </para></listitem>
</varlistentry> </varlistentry>
@ -634,11 +635,11 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
watchdog is activated when the start-up is watchdog is activated when the start-up is
completed. The service must call completed. The service must call
<citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry>
regularly with "WATCHDOG=1" (i.e. the regularly with <literal>WATCHDOG=1</literal>
"keep-alive ping"). If the time (i.e. the "keep-alive ping"). If the time
between two such calls is larger than between two such calls is larger than
the configured time, then the service the configured time, then the service
is placed in a failure state. By is placed in a failed state. By
setting <varname>Restart=</varname> to setting <varname>Restart=</varname> to
<option>on-failure</option> or <option>on-failure</option> or
<option>always</option>, the service <option>always</option>, the service
@ -669,8 +670,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
service process exits, is killed, service process exits, is killed,
or a timeout is reached. The service or a timeout is reached. The service
process may be the main service process may be the main service
process, but also one of the processes process, but it may also be one of the
specified with processes specified with
<varname>ExecStartPre=</varname>, <varname>ExecStartPre=</varname>,
<varname>ExecStartPost=</varname>, <varname>ExecStartPost=</varname>,
<varname>ExecStopPre=</varname>, <varname>ExecStopPre=</varname>,
@ -698,12 +699,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
exits cleanly. exits cleanly.
In this context, a clean exit means In this context, a clean exit means
an exit code of 0, or one of the signals an exit code of 0, or one of the signals
<constant>SIGHUP</constant>, <constant>SIGINT</constant>, <constant>SIGTERM</constant>, or <constant>SIGPIPE</constant>, and <constant>SIGHUP</constant>,
<constant>SIGINT</constant>,
<constant>SIGTERM</constant>,
or <constant>SIGPIPE</constant>, and
additionally, exit statuses and signals additionally, exit statuses and signals
specified in <varname>SuccessExitStatus=</varname>. specified in <varname>SuccessExitStatus=</varname>.
If set to <option>on-failure</option>, If set to <option>on-failure</option>,
the service will be restarted when the the service will be restarted when the
process exits with an nonzero exit code, process exits with a non-zero exit code,
is terminated by a signal (including on is terminated by a signal (including on
core dump), when an operation (such as core dump), when an operation (such as
service reload) times out, and when the service reload) times out, and when the
@ -722,7 +726,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<option>always</option>, the service <option>always</option>, the service
will be restarted regardless of whether will be restarted regardless of whether
it exited cleanly or not, got it exited cleanly or not, got
terminated abnormally by a signal or terminated abnormally by a signal, or
hit a timeout.</para> hit a timeout.</para>
<para>In addition to the above settings, <para>In addition to the above settings,
@ -777,7 +781,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<listitem><para>Takes a list of exit <listitem><para>Takes a list of exit
status definitions that when returned status definitions that when returned
by the main service process will by the main service process will
prevent automatic service restarts prevent automatic service restarts,
regardless of the restart setting regardless of the restart setting
configured with configured with
<varname>Restart=</varname>. Exit <varname>Restart=</varname>. Exit
@ -785,19 +789,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
numeric exit codes or termination numeric exit codes or termination
signal names, and are separated by signal names, and are separated by
spaces. Defaults to the empty list, so spaces. Defaults to the empty list, so
that by default no exit status is that, by default, no exit status is
excluded from the configured restart excluded from the configured restart
logic. Example: logic. Example:
<literal>RestartPreventExitStatus=1 6 <literal>RestartPreventExitStatus=1 6
SIGABRT</literal>, ensures that exit SIGABRT</literal>, ensures that exit
codes 1 and 6 and the termination codes 1 and 6 and the termination
signal SIGABRT will not result in signal <constant>SIGABRT</constant> will
automatic service restarting. This not result in automatic service
option may appear more than once in restarting. This
which case the list of restart preventing option may appear more than once, in
which case the list of restart-preventing
statuses is merged. If the empty statuses is merged. If the empty
string is assigned to this option, the string is assigned to this option, the
list is reset, all prior assignments list is reset and all prior assignments
of this option will have no of this option will have no
effect.</para></listitem> effect.</para></listitem>
</varlistentry> </varlistentry>
@ -805,20 +810,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<varlistentry> <varlistentry>
<term><varname>PermissionsStartOnly=</varname></term> <term><varname>PermissionsStartOnly=</varname></term>
<listitem><para>Takes a boolean <listitem><para>Takes a boolean
argument. If true, the permission argument. If true, the permission-related
related execution options as execution options, as
configured with configured with
<varname>User=</varname> and similar <varname>User=</varname> and similar
options (see options (see
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information) are only applied for more information), are only applied
to the process started with to the process started with
<varname>ExecStart=</varname>, and not <varname>ExecStart=</varname>, and not
to the various other to the various other
<varname>ExecStartPre=</varname>, <varname>ExecStartPre=</varname>,
<varname>ExecStartPost=</varname>, <varname>ExecStartPost=</varname>,
<varname>ExecReload=</varname>, <varname>ExecReload=</varname>,
<varname>ExecStop=</varname>, <varname>ExecStop=</varname>, and
<varname>ExecStopPost=</varname> <varname>ExecStopPost=</varname>
commands. If false, the setting is commands. If false, the setting is
applied to all configured commands the applied to all configured commands the
@ -829,19 +834,19 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<varlistentry> <varlistentry>
<term><varname>RootDirectoryStartOnly=</varname></term> <term><varname>RootDirectoryStartOnly=</varname></term>
<listitem><para>Takes a boolean <listitem><para>Takes a boolean
argument. If true, the root directory argument. If true, the root directory,
as configured with the as configured with the
<varname>RootDirectory=</varname> <varname>RootDirectory=</varname>
option (see option (see
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry> <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>
for more information) is only applied for more information), is only applied
to the process started with to the process started with
<varname>ExecStart=</varname>, and not <varname>ExecStart=</varname>, and not
to the various other to the various other
<varname>ExecStartPre=</varname>, <varname>ExecStartPre=</varname>,
<varname>ExecStartPost=</varname>, <varname>ExecStartPost=</varname>,
<varname>ExecReload=</varname>, <varname>ExecReload=</varname>,
<varname>ExecStop=</varname>, <varname>ExecStop=</varname>, and
<varname>ExecStopPost=</varname> <varname>ExecStopPost=</varname>
commands. If false, the setting is commands. If false, the setting is
applied to all configured commands the applied to all configured commands the
@ -851,12 +856,14 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<varlistentry> <varlistentry>
<term><varname>NonBlocking=</varname></term> <term><varname>NonBlocking=</varname></term>
<listitem><para>Set O_NONBLOCK flag <listitem><para>Set the
<constant>O_NONBLOCK</constant> flag
for all file descriptors passed via for all file descriptors passed via
socket-based activation. If true, all socket-based activation. If true, all
file descriptors >= 3 (i.e. all except file descriptors >= 3 (i.e. all except
STDIN/STDOUT/STDERR) will have STDIN/STDOUT/STDERR) will have
the O_NONBLOCK flag set and hence are in the <constant>O_NONBLOCK</constant> flag
set and hence are in
non-blocking mode. This option is only non-blocking mode. This option is only
useful in conjunction with a socket useful in conjunction with a socket
unit, as described in unit, as described in
@ -912,8 +919,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
passed to multiple processes at the passed to multiple processes at the
same time. Also note that a different same time. Also note that a different
service may be activated on incoming service may be activated on incoming
traffic than inherits the sockets. Or traffic than that which inherits the
in other words: the sockets. Or in other words: the
<varname>Service=</varname> setting of <varname>Service=</varname> setting of
<filename>.socket</filename> units <filename>.socket</filename> units
does not have to match the inverse of does not have to match the inverse of
@ -926,7 +933,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
once, in which case the list of socket once, in which case the list of socket
units is merged. If the empty string units is merged. If the empty string
is assigned to this option, the list of is assigned to this option, the list of
sockets is reset, all prior uses of sockets is reset, and all prior uses of
this setting will have no this setting will have no
effect.</para></listitem> effect.</para></listitem>
</varlistentry> </varlistentry>
@ -937,10 +944,10 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
<listitem><para>Configure service <listitem><para>Configure service
start rate limiting. By default, start rate limiting. By default,
services which are started more often services which are started more
than 5 times within 10s are not than 5 times within 10 seconds are not
permitted to start any more times permitted to start any more times
until the 10s interval ends. With until the 10 second interval ends. With
these two options, this rate limiting these two options, this rate limiting
may be modified. Use may be modified. Use
<varname>StartLimitInterval=</varname> <varname>StartLimitInterval=</varname>
@ -955,18 +962,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
manager configuration file). These manager configuration file). These
configuration options are particularly configuration options are particularly
useful in conjunction with useful in conjunction with
<varname>Restart=</varname>, however <varname>Restart=</varname>; however,
apply to all kinds of starts they apply to all kinds of starts
(including manual), not just those (including manual), not just those
triggered by the triggered by the
<varname>Restart=</varname> logic. <varname>Restart=</varname> logic.
Note that units which are configured Note that units which are configured
for <varname>Restart=</varname> and for <varname>Restart=</varname> and
which reach the start limit are not which reach the start limit are not
attempted to be restarted anymore, attempted to be restarted anymore;
however they may still be restarted however, they may still be restarted
manually at a later point from which manually at a later point, from which
point on the restart logic is again point on, the restart logic is again
activated. Note that activated. Note that
<command>systemctl <command>systemctl
reset-failed</command> will cause the reset-failed</command> will cause the
@ -990,18 +997,17 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
hit. Takes one of hit. Takes one of
<option>none</option>, <option>none</option>,
<option>reboot</option>, <option>reboot</option>,
<option>reboot-force</option> or <option>reboot-force</option>, or
<option>reboot-immediate</option>. If <option>reboot-immediate</option>. If
<option>none</option> is set, <option>none</option> is set,
hitting the rate limit will trigger no hitting the rate limit will trigger no
action besides that the start will not action besides that the start will not
be be permitted. <option>reboot</option>
permitted. <option>reboot</option>
causes a reboot following the normal causes a reboot following the normal
shutdown procedure (i.e. equivalent to shutdown procedure (i.e. equivalent to
<command>systemctl reboot</command>), <command>systemctl reboot</command>).
<option>reboot-force</option> causes <option>reboot-force</option> causes
an forced reboot which will terminate a forced reboot which will terminate
all processes forcibly but should all processes forcibly but should
cause no dirty file systems on reboot cause no dirty file systems on reboot
(i.e. equivalent to <command>systemctl (i.e. equivalent to <command>systemctl
@ -1010,7 +1016,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
causes immediate execution of the causes immediate execution of the
<citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry>
system call, which might result in system call, which might result in
data loss. Defaults to data loss. Defaults to
<option>none</option>.</para></listitem> <option>none</option>.</para></listitem>
</varlistentry> </varlistentry>
@ -1040,22 +1046,21 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting>
in relation to SysV services lacking in relation to SysV services lacking
LSB headers. This option is only LSB headers. This option is only
necessary to fix ordering in relation necessary to fix ordering in relation
to legacy SysV services, that have no to legacy SysV services that have no
ordering information encoded in the ordering information encoded in the
script headers. As such it should only script headers. As such, it should only
be used as temporary compatibility be used as a temporary compatibility
option, and not be used in new unit option and should not be used in new unit
files. Almost always it is a better files. Almost always, it is a better
choice to add explicit ordering choice to add explicit ordering
directives via directives via
<varname>After=</varname> or <varname>After=</varname> or
<varname>Before=</varname>, <varname>Before=</varname>,
instead. For more details see instead. For more details, see
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
used, pass an integer value in the If used, pass an integer value in the
range 0-99.</para></listitem> range 0-99.</para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>

195
man/udev.xml
View File

@ -255,9 +255,9 @@
<para>Execute a program to determine whether there <para>Execute a program to determine whether there
is a match; the key is true if the program returns is a match; the key is true if the program returns
successfully. The device properties are made available to the successfully. The device properties are made available to the
executed program in the environment. The program's stdout executed program in the environment. The program's STDOUT
is available in the RESULT key.</para> is available in the <varname>RESULT</varname> key.</para>
<para>This can only be used for very short-running foreground tasks. For details <para>This can only be used for very short-running foreground tasks. For details,
see <varname>RUN</varname>.</para> see <varname>RUN</varname>.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -265,8 +265,9 @@
<varlistentry> <varlistentry>
<term><varname>RESULT</varname></term> <term><varname>RESULT</varname></term>
<listitem> <listitem>
<para>Match the returned string of the last PROGRAM call. This key can <para>Match the returned string of the last <varname>PROGRAM</varname> call.
be used in the same or in any later rule after a PROGRAM call.</para> This key can be used in the same or in any later rule after a
<varname>PROGRAM</varname> call.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -293,9 +294,10 @@
example, the pattern string <literal>tty[SR]</literal> example, the pattern string <literal>tty[SR]</literal>
would match either <literal>ttyS</literal> or <literal>ttyR</literal>. would match either <literal>ttyS</literal> or <literal>ttyR</literal>.
Ranges are also supported via the <literal>-</literal> character. Ranges are also supported via the <literal>-</literal> character.
For example, to match on the range of all digits, the pattern [0-9] could For example, to match on the range of all digits, the pattern
be used. If the first character following the <literal>[</literal> is a <literal>[0-9]</literal> could be used. If the first character
<literal>!</literal>, any characters not enclosed are matched.</para> following the <literal>[</literal> is a <literal>!</literal>,
any characters not enclosed are matched.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -360,7 +362,8 @@
<listitem> <listitem>
<para>Set a device property value. Property names with a leading <literal>.</literal> <para>Set a device property value. Property names with a leading <literal>.</literal>
are neither stored in the database nor exported to events or are neither stored in the database nor exported to events or
external tools (run by, say, the PROGRAM match key).</para> external tools (run by, for example, the <varname>PROGRAM</varname>
match key).</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -380,24 +383,26 @@
<varlistentry> <varlistentry>
<term><varname>RUN{<replaceable>type</replaceable>}</varname></term> <term><varname>RUN{<replaceable>type</replaceable>}</varname></term>
<listitem> <listitem>
<para>Add a program to the list of programs to be executed after processing all the <para>Add a program to the list of programs to be executed after
rules for a specific event, depending on <literal>type</literal>:</para> processing all the rules for a specific event, depending on
<literal>type</literal>:</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>program</literal></term> <term><literal>program</literal></term>
<listitem> <listitem>
<para>Execute an external program specified as the assigned <para>Execute an external program specified as the assigned
value. If no absolute path is given, the program is expected to live in value. If no absolute path is given, the program is expected
/usr/lib/udev, otherwise the absolute path must be specified.</para> to live in <filename>/usr/lib/udev</filename>; otherwise, the
<para>This is the default if no <replaceable>type</replaceable> is absolute path must be specified.</para>
specified.</para> <para>This is the default if no <replaceable>type</replaceable>
is specified.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>builtin</literal></term> <term><literal>builtin</literal></term>
<listitem> <listitem>
<para>As <varname>program</varname>, but use one of the built-in programs rather <para>As <varname>program</varname>, but use one of the
than an external one.</para> built-in programs rather than an external one.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -406,7 +411,7 @@
<para>This can only be used for very short-running foreground tasks. Running an <para>This can only be used for very short-running foreground tasks. Running an
event process for a long period of time may block all further events for event process for a long period of time may block all further events for
this or a dependent device.</para> this or a dependent device.</para>
<para>Starting daemons or other long running processes is not appropriate <para>Starting daemons or other long-running processes is not appropriate
for udev; the forked processes, detached or not, will be unconditionally for udev; the forked processes, detached or not, will be unconditionally
killed after the event handling has finished.</para> killed after the event handling has finished.</para>
</listitem> </listitem>
@ -415,14 +420,14 @@
<varlistentry> <varlistentry>
<term><varname>LABEL</varname></term> <term><varname>LABEL</varname></term>
<listitem> <listitem>
<para>A named label to which a GOTO may jump.</para> <para>A named label to which a <varname>GOTO</varname> may jump.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>GOTO</varname></term> <term><varname>GOTO</varname></term>
<listitem> <listitem>
<para>Jumps to the next LABEL with a matching name.</para> <para>Jumps to the next <varname>LABEL</varname> with a matching name.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -525,21 +530,24 @@
<varlistentry> <varlistentry>
<term><option>static_node=</option></term> <term><option>static_node=</option></term>
<listitem> <listitem>
<para>Apply the permissions specified in this rule to the static device node with <para>Apply the permissions specified in this rule to the
the specified name. Also, for every tag specified in this rule, create a symlink static device node with the specified name. Also, for every
tag specified in this rule, create a symlink
in the directory in the directory
<filename>/run/udev/static_node-tags/<replaceable>tag</replaceable></filename> <filename>/run/udev/static_node-tags/<replaceable>tag</replaceable></filename>
pointing at the static device node with the specified name. Static device node pointing at the static device node with the specified name.
creation is performed by systemd-tmpfiles before systemd-udevd is started. The Static device node creation is performed by systemd-tmpfiles
static nodes might not have a corresponding kernel device; they are used to before systemd-udevd is started. The static nodes might not
trigger automatic kernel module loading when they are accessed.</para> have a corresponding kernel device; they are used to trigger
automatic kernel module loading when they are accessed.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>watch</option></term> <term><option>watch</option></term>
<listitem> <listitem>
<para>Watch the device node with inotify; when the node is closed after being opened for <para>Watch the device node with inotify; when the node is
writing, a change uevent is synthesized.</para> closed after being opened for writing, a change uevent is
synthesized.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -553,13 +561,15 @@
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<para>The <varname>NAME</varname>, <varname>SYMLINK</varname>, <varname>PROGRAM</varname>, <para>The <varname>NAME</varname>, <varname>SYMLINK</varname>,
<varname>OWNER</varname>, <varname>GROUP</varname>, <varname>MODE</varname> and <varname>RUN</varname> <varname>PROGRAM</varname>, <varname>OWNER</varname>,
fields support simple string substitutions. The <varname>RUN</varname> <varname>GROUP</varname>, <varname>MODE</varname>, and
substitutions are performed after all rules have been processed, right before the program <varname>RUN</varname> fields support simple string substitutions.
is executed, allowing for the use of device properties set by earlier matching The <varname>RUN</varname> substitutions are performed after all rules
rules. For all other fields, substitutions are performed while the individual rule is have been processed, right before the program is executed, allowing for
being processed. The available substitutions are:</para> the use of device properties set by earlier matching rules. For all other
fields, substitutions are performed while the individual rule is being
processed. The available substitutions are:</para>
<variablelist class='udev-directives'> <variablelist class='udev-directives'>
<varlistentry> <varlistentry>
<term><option>$kernel</option>, <option>%k</option></term> <term><option>$kernel</option>, <option>%k</option></term>
@ -572,7 +582,8 @@
<term><option>$number</option>, <option>%n</option></term> <term><option>$number</option>, <option>%n</option></term>
<listitem> <listitem>
<para>The kernel number for this device. For example, <para>The kernel number for this device. For example,
<literal>sda3</literal> has kernel number <literal>3</literal>.</para> <literal>sda3</literal> has kernel number <literal>3</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -586,8 +597,9 @@
<varlistentry> <varlistentry>
<term><option>$id</option>, <option>%b</option></term> <term><option>$id</option>, <option>%b</option></term>
<listitem> <listitem>
<para>The name of the device matched while searching the devpath upwards for <para>The name of the device matched while searching the devpath
<option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>. upwards for <option>SUBSYSTEMS</option>, <option>KERNELS</option>,
<option>DRIVERS</option>, and <option>ATTRS</option>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -595,8 +607,10 @@
<varlistentry> <varlistentry>
<term><option>$driver</option></term> <term><option>$driver</option></term>
<listitem> <listitem>
<para>The driver name of the device matched while searching the devpath upwards for <para>The driver name of the device matched while searching the
<option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>. devpath upwards for <option>SUBSYSTEMS</option>,
<option>KERNELS</option>, <option>DRIVERS</option>, and
<option>ATTRS</option>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -605,12 +619,15 @@
<term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term> <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term>
<listitem> <listitem>
<para>The value of a sysfs attribute found at the device where <para>The value of a sysfs attribute found at the device where
all keys of the rule have matched. If the matching device does not have all keys of the rule have matched. If the matching device does not
such an attribute, and a previous KERNELS, SUBSYSTEMS, DRIVERS, or have such an attribute, and a previous <option>KERNELS</option>,
ATTRS test selected a parent device, then the attribute from that <option>SUBSYSTEMS</option>, <option>DRIVERS</option>, or
parent device is used.</para> <option>ATTRS</option> test selected a parent device, then the
<para>If the attribute is a symlink, the last element of the symlink target is attribute from that parent device is used.
returned as the value.</para> </para>
<para>If the attribute is a symlink, the last element of the
symlink target is returned as the value.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -638,7 +655,8 @@
<varlistentry> <varlistentry>
<term><option>$result</option>, <option>%c</option></term> <term><option>$result</option>, <option>%c</option></term>
<listitem> <listitem>
<para>The string returned by the external program requested with PROGRAM. <para>The string returned by the external program requested with
<varname>PROGRAM</varname>.
A single part of the string, separated by a space character, may be selected A single part of the string, separated by a space character, may be selected
by specifying the part number as an attribute: <literal>%c{N}</literal>. by specifying the part number as an attribute: <literal>%c{N}</literal>.
If the number is followed by the <literal>+</literal> character, this part plus all remaining parts If the number is followed by the <literal>+</literal> character, this part plus all remaining parts
@ -816,22 +834,28 @@
<varlistentry> <varlistentry>
<term><varname>MACAddressPolicy</varname></term> <term><varname>MACAddressPolicy</varname></term>
<listitem> <listitem>
<para>The policy by which the MAC address should be set. The available policies are:</para> <para>The policy by which the MAC address should be set. The
available policies are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>persistent</literal></term> <term><literal>persistent</literal></term>
<listitem> <listitem>
<para>If the hardware has a persistent MAC address, as most hardware should, and this is used by <para>If the hardware has a persistent MAC address, as most
the kernel, nothing is done. Otherwise, a new MAC address is generated which is guaranteed to be hardware should, and this is used by the kernel, nothing is
the same on every boot for the given machine and the given device, but which is otherwise random. done. Otherwise, a new MAC address is generated which is
guaranteed to be the same on every boot for the given
machine and the given device, but which is otherwise random.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>random</literal></term> <term><literal>random</literal></term>
<listitem> <listitem>
<para>If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is <para>If the kernel is using a random MAC address, nothing is
randomly generated each time the device appears, typically at boot.</para> done. Otherwise, a new address is randomly generated each
time the device appears, typically at boot.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -840,44 +864,58 @@
<varlistentry> <varlistentry>
<term><varname>MACAddress</varname></term> <term><varname>MACAddress</varname></term>
<listitem> <listitem>
<para>The MAC address to use, if no <literal>MACAddressPolicy</literal> is specified.</para> <para>The MAC address to use, if no <literal>MACAddressPolicy</literal>
is specified.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>NamePolicy</varname></term> <term><varname>NamePolicy</varname></term>
<listitem> <listitem>
<para>An ordered, space-separated list of policies by which the interface name should be set. <para>An ordered, space-separated list of policies by which the
<literal>NamePolicy</literal> may be disabeld by specifying <literal>net.ifnames=0</literal> on the interface name should be set. <literal>NamePolicy</literal> may
kernel commandline. Each of the policies may fail, and the first successfull one is used. The name be disabeld by specifying <literal>net.ifnames=0</literal> on the
is not set directly, but exported to udev as the property <literal>ID_NET_NAME</literal>, which is kernel commandline. Each of the policies may fail, and the first
by default used by an udev rule to set <literal>NAME</literal>. The available policies are:</para> successfull 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>. The available policies are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>onboard</literal></term> <term><literal>onboard</literal></term>
<listitem> <listitem>
<para>The name is set based on information given by the firmware for on-board devices, as <para>The name is set based on information given by the
exported by the udev property <literal>ID_NET_NAME_ONBOARD</literal>.</para> firmware for on-board devices, as exported by the udev
property <literal>ID_NET_NAME_ONBOARD</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>slot</literal></term> <term><literal>slot</literal></term>
<listitem> <listitem>
<para>The name is set based on information given by the firmware for hot-plug devices, as <para>The name is set based on information given by the
exported by the udev property <literal>ID_NET_NAME_SLOT</literal>.</para> firmware for hot-plug devices, as exported by the udev
property <literal>ID_NET_NAME_SLOT</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>path</literal></term> <term><literal>path</literal></term>
<listitem> <listitem>
<para>The name is set based on the device's physical location, as exported by the udev <para>The name is set based on the device's physical location,
property <literal>ID_NET_NAME_PATH</literal>.</para> as exported by the udev property
<literal>ID_NET_NAME_PATH</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>mac</literal></term> <term><literal>mac</literal></term>
<listitem> <listitem>
<para>The name is set based on the device's persistent MAC address, as exported by the udev <para>The name is set based on the device's persistent MAC
property <literal>ID_NET_NAME_MAC</literal>.</para> address, as exported by the udev property
<literal>ID_NET_NAME_MAC</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
@ -886,8 +924,10 @@
<varlistentry> <varlistentry>
<term><varname>Name</varname></term> <term><varname>Name</varname></term>
<listitem> <listitem>
<para>The interface name to use in case all the policies specified in <literal>NamePolicy</literal> <para>The interface name to use in case all the policies specified
fail, or in case <literal>NamePolicy</literal> is missing or disabled.</para> in <literal>NamePolicy</literal> fail, or in case
<literal>NamePolicy</literal> is missing or disabled.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -905,14 +945,17 @@
<varlistentry> <varlistentry>
<term><varname>Duplex</varname></term> <term><varname>Duplex</varname></term>
<listitem> <listitem>
<para>The duplex mode to set for the device. The accepted values are <literal>half</literal> and <para>The duplex mode to set for the device. The accepted values
<literal>full</literal>.</para> are <literal>half</literal> and <literal>full</literal>.
</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>WakeOnLan</varname></term> <term><varname>WakeOnLan</varname></term>
<listitem> <listitem>
<para>The Wake-On-Lan policy to set for the device. The supported values are:</para> <para>The Wake-on-LAN policy to set for the device. The supported
values are:
</para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>phy</literal></term> <term><literal>phy</literal></term>
@ -923,7 +966,7 @@
<varlistentry> <varlistentry>
<term><literal>magic</literal></term> <term><literal>magic</literal></term>
<listitem> <listitem>
<para>Wake on receipt of magic packet.</para> <para>Wake on receipt of a magic packet.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
@ -940,11 +983,13 @@
<refsect1> <refsect1>
<title>See Also</title> <title>See Also</title>
<para><citerefentry> <para>
<citerefentry>
<refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>, </citerefentry>,
<citerefentry> <citerefentry>
<refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum>
</citerefentry></para> </citerefentry>
</para>
</refsect1> </refsect1>
</refentry> </refentry>

2
man/udevadm.xml
View File

@ -72,7 +72,7 @@
<varlistentry> <varlistentry>
<term><option>--debug</option></term> <term><option>--debug</option></term>
<listitem> <listitem>
<para>Print debug messages to stderr.</para> <para>Print debug messages to STDERR.</para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>