chiark / gitweb /
service: add FailureAction= option
[elogind.git] / man / systemd-inhibit.xml
index 1218836..555c541 100644 (file)
@@ -21,7 +21,8 @@
   along with systemd; If not, see <http://www.gnu.org/licenses/>.
 -->
 
-<refentry id="systemd-inhibit">
+<refentry id="systemd-inhibit"
+          xmlns:xi="http://www.w3.org/2001/XInclude">
 
         <refentryinfo>
                 <title>systemd-inhibit</title>
 
                 <variablelist>
                         <varlistentry>
-                                <term><option>-h</option></term>
-                                <term><option>--help</option></term>
-
-                                <listitem><para>Prints a short help
-                                text and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
-                                <term><option>--version</option></term>
-
-                                <listitem><para>Prints a short version
-                                string and exits.</para></listitem>
-                        </varlistentry>
-
-                        <varlistentry>
                                 <term><option>--what=</option></term>
 
-                                <listitem><para>Takes a colon
-                                separated list of one or more
+                                <listitem><para>Takes a colon-separated
+                                list of one or more
                                 operations to inhibit:
                                 <literal>shutdown</literal>,
                                 <literal>sleep</literal>,
                                 for inhibiting
                                 reboot/power-off/halt/kexec,
                                 suspending/hibernating, the automatic
-                                idle detection, resp. the low-level
+                                idle detection, or the low-level
                                 handling of the power/sleep key and
-                                the lid switch. If omitted defaults to
+                                the lid switch, respectively. If omitted,
+                                defaults to
                                 <literal>idle:sleep:shutdown</literal>.</para></listitem>
                         </varlistentry>
 
                         <varlistentry>
                                 <term><option>--who=</option></term>
 
-                                <listitem><para>Takes a short human
-                                readable descriptive string for the
-                                program taking the lock. If not passed
+                                <listitem><para>Takes a short,
+                                human-readable descriptive string for the
+                                program taking the lock. If not passed,
                                 defaults to the command line
                                 string.</para></listitem>
                         </varlistentry>
                         <varlistentry>
                                 <term><option>--why=</option></term>
 
-                                <listitem><para>Takes a short human
-                                readable descriptive string for the
+                                <listitem><para>Takes a short,
+                                human-readable descriptive string for the
                                 reason for taking the lock. Defaults
                                 to "Unknown reason".</para></listitem>
                         </varlistentry>
                                 <literal>delay</literal> is used, the
                                 lock can only delay the requested
                                 operations for a limited time. If the
-                                time elapses the lock is ignored and
+                                time elapses, the lock is ignored and
                                 the operation executed. The time limit
                                 may be specified in
-                                <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
+                                <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Note
                                 that <literal>delay</literal> is only
-                                available or <literal>sleep</literal>
+                                available for <literal>sleep</literal>
                                 and
                                 <literal>shutdown</literal>.</para></listitem>
                         </varlistentry>
                                 inhibition locks instead of acquiring
                                 one.</para></listitem>
                         </varlistentry>
+
+                        <xi:include href="standard-options.xml" xpointer="help" />
+                        <xi:include href="standard-options.xml" xpointer="version" />
                 </variablelist>
 
         </refsect1>
                 <title>See Also</title>
                 <para>
                         <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
-                        <citerefentry><refentrytitle>systemd-logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+                        <citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
                 </para>
         </refsect1>