diff options
author | Jason St. John <jstjohn@purdue.edu> | 2014-02-13 20:25:23 -0500 |
---|---|---|
committer | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2014-02-14 22:03:40 -0500 |
commit | bcddd5bf8033b0c9cb15a9d017b7714ebe21473a (patch) | |
tree | 73a9a6dc34e5e060f05267723633c095de0e2d0e | |
parent | e10c9985bbc3cf79f12f9ec7317adfe697fa8214 (diff) |
man: fix grammatical errors and other formatting issues
* 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
-rw-r--r-- | man/systemd-bus-proxyd.xml | 4 | ||||
-rw-r--r-- | man/systemd-coredumpctl.xml | 6 | ||||
-rw-r--r-- | man/systemd-udevd.service.xml | 5 | ||||
-rw-r--r-- | man/systemd.exec.xml | 4 | ||||
-rw-r--r-- | man/systemd.service.xml | 201 | ||||
-rw-r--r-- | man/udev.xml | 195 | ||||
-rw-r--r-- | man/udevadm.xml | 2 |
7 files changed, 233 insertions, 184 deletions
diff --git a/man/systemd-bus-proxyd.xml b/man/systemd-bus-proxyd.xml index d53f966ab3..e75815fb4a 100644 --- a/man/systemd-bus-proxyd.xml +++ b/man/systemd-bus-proxyd.xml @@ -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 messages to and from a bus. The will be either the system bus or 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> <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> </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 the process that <command>systemd-bus-proxyd</command> is forwarding messages for.</para> diff --git a/man/systemd-coredumpctl.xml b/man/systemd-coredumpctl.xml index 67f75d1c53..c096f6d7b1 100644 --- a/man/systemd-coredumpctl.xml +++ b/man/systemd-coredumpctl.xml @@ -135,7 +135,7 @@ <listitem><para>Extract the last coredump matching specified characteristics. - Coredump will be written on stdout, unless + Coredump will be written on STDOUT, unless an output file is specified with <option>-o/--output</option>. </para></listitem> @@ -200,8 +200,8 @@ <refsect1> <title>Exit status</title> - <para>On success, 0 is returned, a non-zero failure - code otherwise. Not finding any matching coredumps is treated + <para>On success, 0 is returned; otherwise, a non-zero failure + code is returned. Not finding any matching coredumps is treated as failure. </para> </refsect1> diff --git a/man/systemd-udevd.service.xml b/man/systemd-udevd.service.xml index 7fce3000f5..50a10764bf 100644 --- a/man/systemd-udevd.service.xml +++ b/man/systemd-udevd.service.xml @@ -70,7 +70,7 @@ <varlistentry> <term><option>--debug</option></term> <listitem> - <para>Print debug messages to stderr.</para> + <para>Print debug messages to STDERR.</para> </listitem> </varlistentry> <varlistentry> @@ -82,7 +82,6 @@ <varlistentry> <term><option>--exec-delay=</option></term> <listitem> - <para>Delay the execution of RUN instruction by the given number of seconds. This option might be useful when debugging system crashes during coldplug caused by loading @@ -158,7 +157,7 @@ <term><varname>net.ifnames=</varname></term> <listitem> <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> </varlistentry> </variablelist> diff --git a/man/systemd.exec.xml b/man/systemd.exec.xml index 01356e4c45..8b7645c4d6 100644 --- a/man/systemd.exec.xml +++ b/man/systemd.exec.xml @@ -491,8 +491,8 @@ <varlistentry> <term><varname>TTYPath=</varname></term> <listitem><para>Sets the terminal - device node to use if standard input, - output or stderr are connected to a + device node to use if STDIN, STDOUT, + or STDERR are connected to a TTY (see above). Defaults to <filename>/dev/console</filename>.</para></listitem> </varlistentry> diff --git a/man/systemd.service.xml b/man/systemd.service.xml index 6e9b6696fc..be9bdcaf99 100644 --- a/man/systemd.service.xml +++ b/man/systemd.service.xml @@ -103,7 +103,7 @@ script. This is useful for compatibility with SysV. Note that this compatibility is quite 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 with SysV</ulink> document. </para> @@ -172,13 +172,13 @@ <varname>PIDFile=</varname> option, so that systemd can identify the main process of the daemon. systemd will - proceed starting follow-up units as - soon as the parent process + proceed with starting follow-up units + as soon as the parent process exits.</para> <para>Behavior of <option>oneshot</option> is similar - to <option>simple</option>, however + to <option>simple</option>; however, it is expected that the process has to exit before systemd starts follow-up units. <varname>RemainAfterExit=</varname> @@ -187,13 +187,13 @@ <para>Behavior of <option>dbus</option> is similar to - <option>simple</option>, however it is + <option>simple</option>; however, it is expected that the daemon acquires a name on the D-Bus bus, as configured by <varname>BusName=</varname>. systemd - will proceed starting follow-up units - after the D-Bus bus name has been + will proceed with starting follow-up + units after the D-Bus bus name has been acquired. Service units with this option configured implicitly gain dependencies on the @@ -204,12 +204,12 @@ <para>Behavior of <option>notify</option> is similar to - <option>simple</option>, however it is + <option>simple</option>; however, it is expected that the daemon sends a notification message via <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> - or an equivalent call when it finished - starting up. systemd will proceed + or an equivalent call when it has finished + starting up. systemd will proceed with starting follow-up units after this notification message has been sent. If this option is used, @@ -227,7 +227,7 @@ <para>Behavior of <option>idle</option> is very similar - to <option>simple</option>, however + to <option>simple</option>; however, actual execution of the service binary is delayed until all jobs are dispatched. This may be used to avoid @@ -260,7 +260,7 @@ is set and <option>PIDFile=</option> is unset because for the other types 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 incorrect conclusions if a daemon consists of more than one process. If @@ -292,14 +292,13 @@ <term><varname>BusName=</varname></term> <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 services where <varname>Type=</varname> is set to <option>dbus</option>, but its use - is otherwise recommended as well if - the process takes a name on the D-Bus - bus.</para> + is otherwise recommended if the process + takes a name on the D-Bus bus.</para> </listitem> </varlistentry> @@ -318,7 +317,7 @@ <varname>Type=oneshot</varname> is used, more than one command may be specified. Multiple command lines may - be concatenated in a single directive, + be concatenated in a single directive by separating them with semicolons (these semicolons must be passed as separate words). Alternatively, this @@ -362,12 +361,12 @@ <para>If more than one command is specified, the commands are invoked - one by one sequentially in the order - they appear in the unit file. If one - of the commands fails (and is not - prefixed with <literal>-</literal>), - other lines are not executed and the - unit is considered failed.</para> + sequentially in the order they appear + in the unit file. If one of the + commands fails (and is not prefixed + with <literal>-</literal>), other lines + are not executed, and the unit is + considered failed.</para> <para>Unless <varname>Type=forking</varname> is @@ -387,7 +386,7 @@ <para>Basic environment variable substitution is supported. Use <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 replaced by the value of the environment variable including all @@ -410,12 +409,12 @@ fashion may be defined through <varname>Environment=</varname> and <varname>EnvironmentFile=</varname>. - In addition, variables listed in + In addition, variables listed in the section "Environment variables 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 - configuration" may used (this includes + configuration", may be used (this includes e.g. <varname>$USER</varname>, but not <varname>$TERM</varname>).</para> @@ -447,10 +446,10 @@ <programlisting>ExecStart=/bin/echo one ; /bin/echo "two two"</programlisting> <para>This will execute <command>/bin/echo</command> two - times, each time with one argument, + times, each time with one argument: <literal>one</literal> and <literal>two two</literal>, - respectively. Since two commands are + respectively. Because two commands are specified, <varname>Type=oneshot</varname> must be used.</para> @@ -512,8 +511,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> here following the same scheme as for <varname>ExecStart=</varname>.</para> - <para>One additional special - environment variables is set: if known + <para>One additional, special + environment variable is set: if known, <varname>$MAINPID</varname> is set to the main process of the daemon, and 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 for <varname>ExecStart=</varname> above. Use of this setting is - optional. All processes remaining for - a service after the commands - configured in this option are run are + optional. After the commands configured + in this option are run, all processes + remaining for a service are terminated according to the <varname>KillMode=</varname> setting (see <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). If this option is not specified, the - process is terminated right-away when + process is terminated immediately when service stop is requested. Specifier and environment variable substitution is supported (including @@ -586,14 +585,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> daemon service does not signal start-up completion within the configured time, the service will be - considered failed and be shut down - again. + considered failed and will be shut + down again. Takes a unit-less value in seconds, or a time span value such as "5min - 20s". Pass 0 to disable the timeout - logic. Defaults to <varname>TimeoutStartSec=</varname> from the - manager configuration file, except when - <varname>Type=oneshot</varname> is + 20s". Pass <literal>0</literal> to + disable the timeout logic. Defaults to + <varname>TimeoutStartSec=</varname> from + the manager configuration file, except + when <varname>Type=oneshot</varname> is used, in which case the timeout is disabled by default. </para></listitem> @@ -603,17 +603,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <term><varname>TimeoutStopSec=</varname></term> <listitem><para>Configures the time to 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 - forcibly via <constant>SIGTERM</constant>, and after - another delay of this time with - <constant>SIGKILL</constant> (See + forcibly via <constant>SIGTERM</constant>, + and after another timeout of equal duration + with <constant>SIGKILL</constant> (see <varname>KillMode=</varname> in <citerefentry><refentrytitle>systemd.kill</refentrytitle><manvolnum>5</manvolnum></citerefentry>). Takes a unit-less value in seconds, or a time span value such as "5min - 20s". Pass 0 to disable the timeout - logic. Defaults to <varname>TimeoutStartSec=</varname> from the + 20s". Pass <literal>0</literal> to disable + the timeout logic. Defaults to + <varname>TimeoutStartSec=</varname> from the manager configuration file. </para></listitem> </varlistentry> @@ -634,11 +635,11 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> watchdog is activated when the start-up is completed. The service must call <citerefentry><refentrytitle>sd_notify</refentrytitle><manvolnum>3</manvolnum></citerefentry> - regularly with "WATCHDOG=1" (i.e. the - "keep-alive ping"). If the time + regularly with <literal>WATCHDOG=1</literal> + (i.e. the "keep-alive ping"). If the time between two such calls is larger than 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 <option>on-failure</option> or <option>always</option>, the service @@ -669,8 +670,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> service process exits, is killed, or a timeout is reached. The service process may be the main service - process, but also one of the processes - specified with + process, but it may also be one of the + processes specified with <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecStopPre=</varname>, @@ -698,12 +699,15 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> exits cleanly. In this context, a clean exit means 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 specified in <varname>SuccessExitStatus=</varname>. If set to <option>on-failure</option>, 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 core dump), when an operation (such as service reload) times out, and when the @@ -722,7 +726,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <option>always</option>, the service will be restarted regardless of whether it exited cleanly or not, got - terminated abnormally by a signal or + terminated abnormally by a signal, or hit a timeout.</para> <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 status definitions that when returned by the main service process will - prevent automatic service restarts + prevent automatic service restarts, regardless of the restart setting configured with <varname>Restart=</varname>. Exit @@ -785,19 +789,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> numeric exit codes or termination signal names, and are separated by spaces. Defaults to the empty list, so - that by default no exit status is + that, by default, no exit status is excluded from the configured restart logic. Example: <literal>RestartPreventExitStatus=1 6 SIGABRT</literal>, ensures that exit codes 1 and 6 and the termination - signal SIGABRT will not result in - automatic service restarting. This - option may appear more than once in - which case the list of restart preventing + signal <constant>SIGABRT</constant> will + not result in automatic service + restarting. This + option may appear more than once, in + which case the list of restart-preventing statuses is merged. If the empty string is assigned to this option, the - list is reset, all prior assignments + list is reset and all prior assignments of this option will have no effect.</para></listitem> </varlistentry> @@ -805,20 +810,20 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <varlistentry> <term><varname>PermissionsStartOnly=</varname></term> <listitem><para>Takes a boolean - argument. If true, the permission - related execution options as + argument. If true, the permission-related + execution options, as configured with <varname>User=</varname> and similar options (see <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 <varname>ExecStart=</varname>, and not to the various other <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecReload=</varname>, - <varname>ExecStop=</varname>, + <varname>ExecStop=</varname>, and <varname>ExecStopPost=</varname> commands. If false, the setting is applied to all configured commands the @@ -829,19 +834,19 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <varlistentry> <term><varname>RootDirectoryStartOnly=</varname></term> <listitem><para>Takes a boolean - argument. If true, the root directory + argument. If true, the root directory, as configured with the <varname>RootDirectory=</varname> option (see <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 <varname>ExecStart=</varname>, and not to the various other <varname>ExecStartPre=</varname>, <varname>ExecStartPost=</varname>, <varname>ExecReload=</varname>, - <varname>ExecStop=</varname>, + <varname>ExecStop=</varname>, and <varname>ExecStopPost=</varname> commands. If false, the setting is applied to all configured commands the @@ -851,12 +856,14 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <varlistentry> <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 socket-based activation. If true, all file descriptors >= 3 (i.e. all except 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 useful in conjunction with a socket unit, as described in @@ -912,8 +919,8 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> passed to multiple processes at the same time. Also note that a different service may be activated on incoming - traffic than inherits the sockets. Or - in other words: the + traffic than that which inherits the + sockets. Or in other words: the <varname>Service=</varname> setting of <filename>.socket</filename> units 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 units is merged. If the empty string 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 effect.</para></listitem> </varlistentry> @@ -937,10 +944,10 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> <listitem><para>Configure service start rate limiting. By default, - services which are started more often - than 5 times within 10s are not + services which are started more + than 5 times within 10 seconds are not 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 may be modified. Use <varname>StartLimitInterval=</varname> @@ -955,18 +962,18 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> manager configuration file). These configuration options are particularly useful in conjunction with - <varname>Restart=</varname>, however - apply to all kinds of starts + <varname>Restart=</varname>; however, + they apply to all kinds of starts (including manual), not just those triggered by the <varname>Restart=</varname> logic. Note that units which are configured for <varname>Restart=</varname> and which reach the start limit are not - attempted to be restarted anymore, - however they may still be restarted - manually at a later point from which - point on the restart logic is again + attempted to be restarted anymore; + however, they may still be restarted + manually at a later point, from which + point on, the restart logic is again activated. Note that <command>systemctl reset-failed</command> will cause the @@ -990,18 +997,17 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> hit. Takes one of <option>none</option>, <option>reboot</option>, - <option>reboot-force</option> or + <option>reboot-force</option>, or <option>reboot-immediate</option>. If <option>none</option> is set, hitting the rate limit will trigger no action besides that the start will not - be - permitted. <option>reboot</option> + be permitted. <option>reboot</option> causes a reboot following the normal shutdown procedure (i.e. equivalent to - <command>systemctl reboot</command>), + <command>systemctl reboot</command>). <option>reboot-force</option> causes - an forced reboot which will terminate + a forced reboot which will terminate all processes forcibly but should cause no dirty file systems on reboot (i.e. equivalent to <command>systemctl @@ -1010,7 +1016,7 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> causes immediate execution of the <citerefentry><refentrytitle>reboot</refentrytitle><manvolnum>2</manvolnum></citerefentry> system call, which might result in - data loss. Defaults to + data loss. Defaults to <option>none</option>.</para></listitem> </varlistentry> @@ -1040,22 +1046,21 @@ ExecStart=/bin/echo $ONE $TWO ${TWO}</programlisting> in relation to SysV services lacking LSB headers. This option is only 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 - script headers. As such it should only - be used as temporary compatibility - option, and not be used in new unit - files. Almost always it is a better + script headers. As such, it should only + be used as a temporary compatibility + option and should not be used in new unit + files. Almost always, it is a better choice to add explicit ordering directives via <varname>After=</varname> or <varname>Before=</varname>, - instead. For more details see - <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. If - used, pass an integer value in the + instead. For more details, see + <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + If used, pass an integer value in the range 0-99.</para></listitem> </varlistentry> - </variablelist> </refsect1> diff --git a/man/udev.xml b/man/udev.xml index 32a520e7b8..9ea1cae4a3 100644 --- a/man/udev.xml +++ b/man/udev.xml @@ -255,9 +255,9 @@ <para>Execute a program to determine whether there is a match; the key is true if the program returns successfully. The device properties are made available to the - executed program in the environment. The program's stdout - is available in the RESULT key.</para> - <para>This can only be used for very short-running foreground tasks. For details + executed program in the environment. The program's STDOUT + is available in the <varname>RESULT</varname> key.</para> + <para>This can only be used for very short-running foreground tasks. For details, see <varname>RUN</varname>.</para> </listitem> </varlistentry> @@ -265,8 +265,9 @@ <varlistentry> <term><varname>RESULT</varname></term> <listitem> - <para>Match the returned string of the last PROGRAM call. This key can - be used in the same or in any later rule after a PROGRAM call.</para> + <para>Match the returned string of the last <varname>PROGRAM</varname> call. + This key can be used in the same or in any later rule after a + <varname>PROGRAM</varname> call.</para> </listitem> </varlistentry> </variablelist> @@ -293,9 +294,10 @@ example, the pattern string <literal>tty[SR]</literal> would match either <literal>ttyS</literal> or <literal>ttyR</literal>. Ranges are also supported via the <literal>-</literal> character. - For example, to match on the range of all digits, the pattern [0-9] could - be used. If the first character following the <literal>[</literal> is a - <literal>!</literal>, any characters not enclosed are matched.</para> + For example, to match on the range of all digits, the pattern + <literal>[0-9]</literal> could be used. If the first character + following the <literal>[</literal> is a <literal>!</literal>, + any characters not enclosed are matched.</para> </listitem> </varlistentry> </variablelist> @@ -360,7 +362,8 @@ <listitem> <para>Set a device property value. Property names with a leading <literal>.</literal> 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> </varlistentry> @@ -380,24 +383,26 @@ <varlistentry> <term><varname>RUN{<replaceable>type</replaceable>}</varname></term> <listitem> - <para>Add a program to the list of programs to be executed after processing all the - rules for a specific event, depending on <literal>type</literal>:</para> + <para>Add a program to the list of programs to be executed after + processing all the rules for a specific event, depending on + <literal>type</literal>:</para> <variablelist> <varlistentry> <term><literal>program</literal></term> <listitem> <para>Execute an external program specified as the assigned - value. If no absolute path is given, the program is expected to live in - /usr/lib/udev, otherwise the absolute path must be specified.</para> - <para>This is the default if no <replaceable>type</replaceable> is - specified.</para> + value. If no absolute path is given, the program is expected + to live in <filename>/usr/lib/udev</filename>; otherwise, the + absolute path must be specified.</para> + <para>This is the default if no <replaceable>type</replaceable> + is specified.</para> </listitem> </varlistentry> <varlistentry> <term><literal>builtin</literal></term> <listitem> - <para>As <varname>program</varname>, but use one of the built-in programs rather - than an external one.</para> + <para>As <varname>program</varname>, but use one of the + built-in programs rather than an external one.</para> </listitem> </varlistentry> </variablelist> @@ -406,7 +411,7 @@ <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 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 killed after the event handling has finished.</para> </listitem> @@ -415,14 +420,14 @@ <varlistentry> <term><varname>LABEL</varname></term> <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> </varlistentry> <varlistentry> <term><varname>GOTO</varname></term> <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> </varlistentry> @@ -525,21 +530,24 @@ <varlistentry> <term><option>static_node=</option></term> <listitem> - <para>Apply the permissions specified in this rule to the static device node with - the specified name. Also, for every tag specified in this rule, create a symlink + <para>Apply the permissions specified in this rule to the + static device node with the specified name. Also, for every + tag specified in this rule, create a symlink in the directory <filename>/run/udev/static_node-tags/<replaceable>tag</replaceable></filename> - pointing at the static device node with the specified name. Static device node - creation is performed by systemd-tmpfiles before systemd-udevd is started. The - static nodes might not have a corresponding kernel device; they are used to - trigger automatic kernel module loading when they are accessed.</para> + pointing at the static device node with the specified name. + Static device node creation is performed by systemd-tmpfiles + before systemd-udevd is started. The static nodes might not + have a corresponding kernel device; they are used to trigger + automatic kernel module loading when they are accessed.</para> </listitem> </varlistentry> <varlistentry> <term><option>watch</option></term> <listitem> - <para>Watch the device node with inotify; when the node is closed after being opened for - writing, a change uevent is synthesized.</para> + <para>Watch the device node with inotify; when the node is + closed after being opened for writing, a change uevent is + synthesized.</para> </listitem> </varlistentry> <varlistentry> @@ -553,13 +561,15 @@ </varlistentry> </variablelist> - <para>The <varname>NAME</varname>, <varname>SYMLINK</varname>, <varname>PROGRAM</varname>, - <varname>OWNER</varname>, <varname>GROUP</varname>, <varname>MODE</varname> and <varname>RUN</varname> - fields support simple string substitutions. The <varname>RUN</varname> - substitutions are performed after all rules have been processed, right before the program - is executed, allowing for 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> + <para>The <varname>NAME</varname>, <varname>SYMLINK</varname>, + <varname>PROGRAM</varname>, <varname>OWNER</varname>, + <varname>GROUP</varname>, <varname>MODE</varname>, and + <varname>RUN</varname> fields support simple string substitutions. + The <varname>RUN</varname> substitutions are performed after all rules + have been processed, right before the program is executed, allowing for + 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'> <varlistentry> <term><option>$kernel</option>, <option>%k</option></term> @@ -572,7 +582,8 @@ <term><option>$number</option>, <option>%n</option></term> <listitem> <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> </varlistentry> @@ -586,8 +597,9 @@ <varlistentry> <term><option>$id</option>, <option>%b</option></term> <listitem> - <para>The name of the device matched while searching the devpath upwards for - <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>. + <para>The name of the device matched while searching the devpath + upwards for <option>SUBSYSTEMS</option>, <option>KERNELS</option>, + <option>DRIVERS</option>, and <option>ATTRS</option>. </para> </listitem> </varlistentry> @@ -595,8 +607,10 @@ <varlistentry> <term><option>$driver</option></term> <listitem> - <para>The driver name of the device matched while searching the devpath upwards for - <option>SUBSYSTEMS</option>, <option>KERNELS</option>, <option>DRIVERS</option> and <option>ATTRS</option>. + <para>The driver name of the device matched while searching the + devpath upwards for <option>SUBSYSTEMS</option>, + <option>KERNELS</option>, <option>DRIVERS</option>, and + <option>ATTRS</option>. </para> </listitem> </varlistentry> @@ -605,12 +619,15 @@ <term><option>$attr{<replaceable>file</replaceable>}</option>, <option>%s{<replaceable>file</replaceable>}</option></term> <listitem> <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 - such an attribute, and a previous KERNELS, SUBSYSTEMS, DRIVERS, or - ATTRS test selected a parent device, then the attribute from that - parent device is used.</para> - <para>If the attribute is a symlink, the last element of the symlink target is - returned as the value.</para> + all keys of the rule have matched. If the matching device does not + have such an attribute, and a previous <option>KERNELS</option>, + <option>SUBSYSTEMS</option>, <option>DRIVERS</option>, or + <option>ATTRS</option> test selected a parent device, then the + attribute from that parent device is used. + </para> + <para>If the attribute is a symlink, the last element of the + symlink target is returned as the value. + </para> </listitem> </varlistentry> @@ -638,7 +655,8 @@ <varlistentry> <term><option>$result</option>, <option>%c</option></term> <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 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 @@ -816,22 +834,28 @@ <varlistentry> <term><varname>MACAddressPolicy</varname></term> <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> <varlistentry> <term><literal>persistent</literal></term> <listitem> - <para>If the hardware has a persistent MAC address, as most hardware should, and this is used by - the kernel, nothing is 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>If the hardware has a persistent MAC address, as most + hardware should, and this is used by the kernel, nothing is + 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> </listitem> </varlistentry> <varlistentry> <term><literal>random</literal></term> <listitem> - <para>If the kernel is using a random MAC address, nothing is done. Otherwise, a new address is - randomly generated each time the device appears, typically at boot.</para> + <para>If the kernel is using a random MAC address, nothing is + done. Otherwise, a new address is randomly generated each + time the device appears, typically at boot. + </para> </listitem> </varlistentry> </variablelist> @@ -840,44 +864,58 @@ <varlistentry> <term><varname>MACAddress</varname></term> <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> </varlistentry> <varlistentry> <term><varname>NamePolicy</varname></term> <listitem> - <para>An ordered, space-separated list of policies by which the interface name should be set. - <literal>NamePolicy</literal> may be disabeld by specifying <literal>net.ifnames=0</literal> on the - kernel commandline. Each of the policies may fail, and the first successfull one is used. The name - is not set directly, but exported to udev as the property <literal>ID_NET_NAME</literal>, which is - by default used by an udev rule to set <literal>NAME</literal>. The available policies are:</para> + <para>An ordered, space-separated list of policies by which the + interface name should be set. <literal>NamePolicy</literal> may + be disabeld by specifying <literal>net.ifnames=0</literal> on the + kernel commandline. Each of the policies may fail, and the first + 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> <varlistentry> <term><literal>onboard</literal></term> <listitem> - <para>The name is set based on information given by the firmware for on-board devices, as - exported by the udev property <literal>ID_NET_NAME_ONBOARD</literal>.</para> + <para>The name is set based on information given by the + firmware for on-board devices, as exported by the udev + property <literal>ID_NET_NAME_ONBOARD</literal>. + </para> </listitem> </varlistentry> <varlistentry> <term><literal>slot</literal></term> <listitem> - <para>The name is set based on information given by the firmware for hot-plug devices, as - exported by the udev property <literal>ID_NET_NAME_SLOT</literal>.</para> + <para>The name is set based on information given by the + firmware for hot-plug devices, as exported by the udev + property <literal>ID_NET_NAME_SLOT</literal>. + </para> </listitem> </varlistentry> <varlistentry> <term><literal>path</literal></term> <listitem> - <para>The name is set based on the device's physical location, as exported by the udev - property <literal>ID_NET_NAME_PATH</literal>.</para> + <para>The name is set based on the device's physical location, + as exported by the udev property + <literal>ID_NET_NAME_PATH</literal>. + </para> </listitem> </varlistentry> <varlistentry> <term><literal>mac</literal></term> <listitem> - <para>The name is set based on the device's persistent MAC address, as exported by the udev - property <literal>ID_NET_NAME_MAC</literal>.</para> + <para>The name is set based on the device's persistent MAC + address, as exported by the udev property + <literal>ID_NET_NAME_MAC</literal>. + </para> </listitem> </varlistentry> </variablelist> @@ -886,8 +924,10 @@ <varlistentry> <term><varname>Name</varname></term> <listitem> - <para>The interface name to use in case all the policies specified in <literal>NamePolicy</literal> - fail, or in case <literal>NamePolicy</literal> is missing or disabled.</para> + <para>The interface name to use in case all the policies specified + in <literal>NamePolicy</literal> fail, or in case + <literal>NamePolicy</literal> is missing or disabled. + </para> </listitem> </varlistentry> <varlistentry> @@ -905,14 +945,17 @@ <varlistentry> <term><varname>Duplex</varname></term> <listitem> - <para>The duplex mode to set for the device. The accepted values are <literal>half</literal> and - <literal>full</literal>.</para> + <para>The duplex mode to set for the device. The accepted values + are <literal>half</literal> and <literal>full</literal>. + </para> </listitem> </varlistentry> <varlistentry> <term><varname>WakeOnLan</varname></term> <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> <varlistentry> <term><literal>phy</literal></term> @@ -923,7 +966,7 @@ <varlistentry> <term><literal>magic</literal></term> <listitem> - <para>Wake on receipt of magic packet.</para> + <para>Wake on receipt of a magic packet.</para> </listitem> </varlistentry> <varlistentry> @@ -940,11 +983,13 @@ <refsect1> <title>See Also</title> - <para><citerefentry> + <para> + <citerefentry> <refentrytitle>systemd-udevd.service</refentrytitle><manvolnum>8</manvolnum> </citerefentry>, <citerefentry> <refentrytitle>udevadm</refentrytitle><manvolnum>8</manvolnum> - </citerefentry></para> + </citerefentry> + </para> </refsect1> </refentry> diff --git a/man/udevadm.xml b/man/udevadm.xml index f5aafe50ba..e437c243c5 100644 --- a/man/udevadm.xml +++ b/man/udevadm.xml @@ -72,7 +72,7 @@ <varlistentry> <term><option>--debug</option></term> <listitem> - <para>Print debug messages to stderr.</para> + <para>Print debug messages to STDERR.</para> </listitem> </varlistentry> <varlistentry> |