systemd-inhibit — Execute a program with an inhibition lock taken
systemd-inhibit [OPTIONS...] [COMMAND] [ARGUMENTS...]
systemd-inhibit [OPTIONS...] --list
systemd-inhibit may be used 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 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.
The following options are understood:
Takes a colon-separated list of one or more
operations to inhibit:
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
Takes a short, human-readable descriptive string for the program taking the lock. If not passed, defaults to the command line string.
Takes a short, human-readable descriptive string for the reason for taking the lock. Defaults to "Unknown reason".
Takes either "
delay" and describes how the lock is
applied. If "
block" is used (the default),
the lock prohibits any of the requested operations without
time limit, and only privileged users may override it. If
delay" is used, the lock can only delay the
requested operations for a limited time. If the time elapses,
the lock is ignored and the operation executed. The time limit
may be specified in
Note that "
delay" is only available for
Lists all active inhibition locks instead of acquiring one.
Do not pipe output into a pager.
Do not print the legend, i.e. column headers and the footer with hints.
Returns the exit status of the executed program.
# systemd-inhibit wodim foobar.iso
This burns the ISO image
foobar.iso on a CD using
and inhibits system sleeping, shutdown and idle while
Pager to use when
--no-pager is not given; overrides
$PAGER. If neither
$PAGER are set, a
set of well-known pager implementations are tried in turn, including
more(1), until one is found. If
no pager implementation is discovered no pager is invoked. Setting this environment variable to an empty string
or the value "
cat" is equivalent to passing
Override the options passed to less (by default
Users might want to change two options in particular:
See less(1) for more discussion.
Override the charset passed to less (by default "
the invoking terminal is determined to be UTF-8 compatible).
The value must be a boolean. Controls whether colorized output should be
generated. This can be specified to override the decision that systemd makes based
$TERM and what the console is connected to.
The value must be a boolean. Controls whether clickable links should be generated in
the output for terminal emulators supporting this. This can be specified to override the decision that
systemd makes based on
$TERM and other conditions.