SYSTEMD-INHIBIT(1)systemd-inhibitSYSTEMD-INHIBIT(1)NAMEsystemd-inhibit - Execute a program with an inhibition lock taken
SYNOPSISsystemd-inhibit [OPTIONS...] [COMMAND] [ARGUMENTS...]
systemd-inhibit [OPTIONS...] --list
DESCRIPTIONsystemd-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.
OPTIONS
The following options are understood:
--h, --help
Prints a short help text and exits.
--version
Prints a short version string and exits.
--what=
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.
--who=
Takes a short human readable descriptive string for the program
taking the lock. If not passed defaults to the command line string.
--why=
Takes a short human readable descriptive string for the reason for
taking the lock. Defaults to "Unknown reason".
--mode=
Takes either block or 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 systemd-logind.conf(5).
--list
Lists all active inhibition locks instead of acquiring one.
EXIT STATUS
Returns the exit status of the executed program.
SEE ALSOsystemd(1), systemd-logind.conf(5)AUTHOR
Lennart Poettering <lennart@poettering.net>
Developer
systemd 02/15/2013 SYSTEMD-INHIBIT(1)