Descriptionsystemd-inhibit may be used
- to execute a program with a shutdown, suspend or idle
+ to execute a program with a shutdown, sleep or idle
inhibitor lock taken. The lock will be acquired before
the specified command line is executed and released
afterwards.Inhibitor locks may be used to block or delay
- suspend and shutdown requests from the user, as well
- as automatic idle handling of the OS. This may be used
+ system sleep and shutdown requests from the user, as well
+ as automatic idle handling of the OS. This is useful
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.
@@ -80,7 +84,7 @@
-
+ Prints a short help
@@ -97,24 +101,32 @@
- Takes a colon
- separated list of one or more
+ Takes a colon-separated
+ list of one or more
operations to inhibit:
shutdown,
- suspend,
- idle, for
- inhibiting reboot/power-off/halt/kexec,
- suspending/hibernating, resp. the
- automatic idle
- detection.
+ sleep,
+ 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 +134,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 +155,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.
+ systemd-logind.conf5. Note
+ that delay is only
+ available for sleep
+ and
+ shutdown.
@@ -156,8 +172,6 @@
inhibition locks instead of acquiring
one.
-
-
@@ -168,6 +182,18 @@
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 Also