man: explain a bit more detailed what happens on suspend

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

diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml
index 55569681cf43164801073c55ed186b7cceccb3a5..c20efe5527500232c288ede37fb460ee372d48fb 100644 (file)
--- a/man/systemd.unit.xml
+++ b/man/systemd.unit.xml
@@ -75,10 +75,10 @@
                 inspired by Microsoft Windows
                 <filename>.ini</filename> files.</para>
 
                 inspired by Microsoft Windows
                 <filename>.ini</filename> files.</para>
 

-                <para>This man pages lists the common configuration
+                <para>This man page lists the common configuration

                 options of all the unit types. These options need to
                 options of all the unit types. These options need to

-                be configured in the [Unit] resp. [Install]
-                section of the unit files.</para>
+                be configured in the [Unit] or [Install]
+                sections of the unit files.</para>

 
                 <para>In addition to the generic [Unit] and [Install]
                 sections described here, each unit should have a
 
                 <para>In addition to the generic [Unit] and [Install]
                 sections described here, each unit should have a


@@ -338,7 +338,15 @@
                                 <literal>man:</literal>. For more
                                 information about the syntax of these
                                 URIs see
                                 <literal>man:</literal>. For more
                                 information about the syntax of these
                                 URIs see

-                                <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>.</para></listitem>
+                                <citerefentry><refentrytitle>uri</refentrytitle><manvolnum>7</manvolnum></citerefentry>. The
+                                URIs should be listed in order of
+                                relevance, starting with the most
+                                relevant. It is a good idea to first
+                                reference documentation that explains
+                                what the unit's purpose is, followed
+                                by how it is configured, followed by
+                                any other related
+                                documentation.</para></listitem>

                         </varlistentry>
 
                         <varlistentry>
                         </varlistentry>
 
                         <varlistentry>


@@ -418,7 +426,7 @@
 
                                 <listitem><para>Similar to
                                 <varname>Requires=</varname>
 
                                 <listitem><para>Similar to
                                 <varname>Requires=</varname>

-                                resp. <varname>RequiresOverridable=</varname>. However,
+                                and <varname>RequiresOverridable=</varname>, respectively. However,

                                 if a unit listed here is not started
                                 already it will not be started and the
                                 transaction fails
                                 if a unit listed here is not started
                                 already it will not be started and the
                                 transaction fails


@@ -566,7 +574,7 @@
                                 <varname>Before=</varname>. If two
                                 units have no ordering dependencies
                                 between them they are shut down
                                 <varname>Before=</varname>. If two
                                 units have no ordering dependencies
                                 between them they are shut down

-                                resp. started up simultaneously, and
+                                or started up simultaneously, and

                                 no ordering takes
                                 place. </para></listitem>
                         </varlistentry>
                                 no ordering takes
                                 place. </para></listitem>
                         </varlistentry>


@@ -672,13 +680,13 @@
                                 <listitem><para>Takes a boolean
                                 argument. If <option>true</option>
                                 this unit can only be activated
                                 <listitem><para>Takes a boolean
                                 argument. If <option>true</option>
                                 this unit can only be activated

-                                (resp. deactivated) indirectly. In
+                                or deactivated indirectly. In

                                 this case explicit start-up
                                 this case explicit start-up

-                                (resp. termination) requested by the
+                                or termination requested by the

                                 user is denied, however if it is
                                 user is denied, however if it is

-                                started (resp. stopped) as a
+                                started or stopped as a

                                 dependency of another unit, start-up
                                 dependency of another unit, start-up

-                                (resp. termination) will succeed. This
+                                or termination will succeed. This

                                 is mostly a safety feature to ensure
                                 that the user does not accidentally
                                 activate units that are not intended
                                 is mostly a safety feature to ensure
                                 that the user does not accidentally
                                 activate units that are not intended


@@ -1023,8 +1031,8 @@
 
                                 <listitem><para>Installs a symlink in
                                 the <filename>.wants/</filename>
 
                                 <listitem><para>Installs a symlink in
                                 the <filename>.wants/</filename>

-                                resp. <filename>.requires/</filename>
-                                subdirectory for a unit. This has the
+                                or <filename>.requires/</filename>
+                                subdirectory for a unit, respectively. This has the

                                 effect that when the listed unit name
                                 is activated the unit listing it is
                                 activated
                                 effect that when the listed unit name
                                 is activated the unit listing it is
                                 activated