man: wording and grammar updates

[elogind.git] / man / systemd.device.xml

diff --git a/man/systemd.device.xml b/man/systemd.device.xml
index c5306430fb6d19b2f885ec8933a6bbd128ed917b..96ebe890953fd3c499ab4b8120c2c86089de4496 100644 (file)
--- a/man/systemd.device.xml
+++ b/man/systemd.device.xml
@@ -9,16 +9,16 @@
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it
   Copyright 2010 Lennart Poettering
 
   systemd is free software; you can redistribute it and/or modify it

-  under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or

   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
   (at your option) any later version.
 
   systemd is distributed in the hope that it will be useful, but
   WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

-  General Public License for more details.
+  Lesser General Public License for more details.

 
 

-  You should have received a copy of the GNU General Public License
+  You should have received a copy of the GNU Lesser General Public License

   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 


@@ -44,18 +44,18 @@
 
         <refnamediv>
                 <refname>systemd.device</refname>
 
         <refnamediv>
                 <refname>systemd.device</refname>

-                <refpurpose>systemd device configuration files</refpurpose>
+                <refpurpose>Device unit configuration</refpurpose>

         </refnamediv>
 
         <refsynopsisdiv>
         </refnamediv>
 
         <refsynopsisdiv>

-                <para><filename>systemd.device</filename></para>
+                <para><filename><replaceable>device</replaceable>.device</filename></para>

         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>A unit configuration file whose name ends in
         </refsynopsisdiv>
 
         <refsect1>
                 <title>Description</title>
 
                 <para>A unit configuration file whose name ends in

-                <filename>.device</filename> encodes information about
+                <literal>.device</literal> encodes information about

                 a device unit as exposed in the
                 sysfs/<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 device tree.</para>
                 a device unit as exposed in the
                 sysfs/<citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
                 device tree.</para>


@@ -80,7 +80,7 @@
                 <para>Device units are named after the
                 <filename>/sys</filename> and
                 <filename>/dev</filename> paths they control. Example:
                 <para>Device units are named after the
                 <filename>/sys</filename> and
                 <filename>/dev</filename> paths they control. Example:

-                the device <filename>/dev/sda5</filename> is exposed
+                the device <filename noindex='true'>/dev/sda5</filename> is exposed

                 in systemd as <filename>dev-sda5.device</filename>. For
                 details about the escaping logic used to convert a
                 file system path to a unit name see
                 in systemd as <filename>dev-sda5.device</filename>. For
                 details about the escaping logic used to convert a
                 file system path to a unit name see


@@ -96,7 +96,7 @@
                 database (which is recommended). The following udev
                 properties are understood by systemd:</para>
 
                 database (which is recommended). The following udev
                 properties are understood by systemd:</para>
 

-                <variablelist>
+                <variablelist class='udev-directives'>

                         <varlistentry>
                                 <term><varname>SYSTEMD_WANTS=</varname></term>
                                 <listitem><para>Adds dependencies of
                         <varlistentry>
                                 <term><varname>SYSTEMD_WANTS=</varname></term>
                                 <listitem><para>Adds dependencies of


@@ -107,7 +107,7 @@
                                 available. Note that this and the
                                 other tags are not taken into account
                                 unless the device is tagged with the
                                 available. Note that this and the
                                 other tags are not taken into account
                                 unless the device is tagged with the

-                                "<literal>systemd</literal>" string in
+                                <literal>systemd</literal> string in

                                 the udev database, because otherwise
                                 the device is not exposed as systemd
                                 unit.</para></listitem>
                                 the udev database, because otherwise
                                 the device is not exposed as systemd
                                 unit.</para></listitem>


@@ -122,6 +122,25 @@
                                 name. (See above.)</para></listitem>
                         </varlistentry>
 
                                 name. (See above.)</para></listitem>
                         </varlistentry>
 

+                        <varlistentry>
+                                <term><varname>SYSTEMD_READY=</varname></term>
+                                <listitem><para>If set to 0, systemd
+                                will consider this device unplugged
+                                even if it shows up in the udev
+                                tree. If this property is unset or set
+                                to 1, the device will be considered
+                                plugged the moment it shows up in the
+                                udev tree. This property has no
+                                influence on the behavior when a
+                                device disappears from the udev
+                                tree. This option is useful to support
+                                devices that initially show up in an
+                                uninitialized state in the tree, and for
+                                which a changed event is generated the
+                                moment they are fully set
+                                up.</para></listitem>
+                        </varlistentry>
+

                         <varlistentry>
                                 <term><varname>ID_MODEL_FROM_DATABASE=</varname></term>
                                 <term><varname>ID_MODEL=</varname></term>
                         <varlistentry>
                                 <term><varname>ID_MODEL_FROM_DATABASE=</varname></term>
                                 <term><varname>ID_MODEL=</varname></term>


@@ -139,10 +158,11 @@
         <refsect1>
                   <title>See Also</title>
                   <para>
         <refsect1>
                   <title>See Also</title>
                   <para>

-                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,

                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
                           <citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>,

-                          <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>
+                          <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+                          <citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>

                   </para>
         </refsect1>
 
                   </para>
         </refsect1>