X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=man%2Fsystemd-inhibit.xml;h=555c5414b4d1fd270d992db00a2c8e90a22420ed;hb=a049d1a9723b6608e45bf8f1a64dab5761dee555;hp=bea4724787eefd400d92ea4fd89042a099e79222;hpb=a45ad38bec7edb577b1130010ebef9c750474beb;p=elogind.git
diff --git a/man/systemd-inhibit.xml b/man/systemd-inhibit.xml
index bea472478..555c5414b 100644
--- a/man/systemd-inhibit.xml
+++ b/man/systemd-inhibit.xml
@@ -21,7 +21,8 @@
along with systemd; If not, see .
-->
-
+systemd-inhibit
@@ -71,6 +72,10 @@
to avoid system suspends while an optical disc is
being recorded, or similar operations that should not
be interrupted.
+
+ For more information see the Inhibitor
+ Lock Developer Documentation.
@@ -79,42 +84,35 @@
The following options are understood:
-
-
-
-
- Prints a short help
- text and exits.
-
-
-
-
-
- Prints a short version
- string and exits.
-
-
- Takes a colon
- separated list of one or more
+ Takes a colon-separated
+ list of one or more
operations to inhibit:
shutdown,
sleep,
- idle, for
- inhibiting reboot/power-off/halt/kexec,
- suspending/hibernating, resp. the
- automatic idle
- detection.
+ idle,
+ handle-power-key,
+ handle-suspend-key,
+ handle-hibernate-key,
+ handle-lid-switch,
+ for inhibiting
+ reboot/power-off/halt/kexec,
+ suspending/hibernating, the automatic
+ idle detection, or the low-level
+ handling of the power/sleep key and
+ the lid switch, respectively. If omitted,
+ defaults to
+ idle:sleep:shutdown.
- Takes a short human
- readable descriptive string for the
- program taking the lock. If not passed
+ Takes a short,
+ human-readable descriptive string for the
+ program taking the lock. If not passed,
defaults to the command line
string.
@@ -122,8 +120,8 @@
- Takes a short human
- readable descriptive string for the
+ Takes a short,
+ human-readable descriptive string for the
reason for taking the lock. Defaults
to "Unknown reason".
@@ -143,10 +141,14 @@
delay 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
- systemd-logind.conf5.
+ logind.conf5. Note
+ that delay is only
+ available for sleep
+ and
+ shutdown.
@@ -157,7 +159,8 @@
one.
-
+
+
@@ -168,11 +171,23 @@
Returns the exit status of the executed program.
+
+ Example
+
+ # systemd-inhibit wodim foobar.iso
+
+ This burns the ISO image
+ foobar.iso on a CD using
+ wodim1,
+ and inhibits system sleeping, shutdown and idle while
+ doing so.
+
+
See Alsosystemd1,
- systemd-logind.conf5
+ logind.conf5