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
The maximum log level of emitted messages (messages with a higher
log level, i.e. less important ones, will be suppressed). Either one of (in order of decreasing
debug, or an integer in the range 0…7. See
for more information.
A boolean. If true, messages written to the tty will be colored according to priority.
This setting is only useful when messages are written directly to the terminal, because journalctl(1) and other tools that display logs will color messages based on the log level on their own.
A boolean. If true, console log messages will be prefixed with a timestamp.
This setting is only useful when messages are written directly to the terminal or a file, because journalctl(1) and other tools that display logs will attach timestamps based on the entry metadata on their own.
A boolean. If true, messages will be prefixed with a filename and line number in the source code where the message originates.
Note that the log location is often attached as metadata to journal entries anyway. Including it directly in the message text can nevertheless be convenient when debugging programs.
A boolean. If true, messages will be prefixed with the current numerical thread ID (TID).
Note that the this information is attached as metadata to journal entries anyway. Including it directly in the message text can nevertheless be convenient when debugging programs.
The destination for log messages. One of
console (log to the attached tty),
console-prefixed (log to
the attached tty but with prefixes encoding the log level and "facility", see syslog(3),
kmsg (log to the kernel circular log buffer),
journal (log to
journal-or-kmsg (log to the journal if available, and to kmsg
auto (determine the appropriate log target automatically, the default),
null (disable log output).
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
$SYSTEMD_PAGERSECURE is not set,
(as well as
$PAGER) will be silently ignored.
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).
Takes a boolean argument. When true, the "secure" mode of the pager is enabled; if
false, disabled. If
$SYSTEMD_PAGERSECURE is not set at all, secure mode is enabled
if the effective UID is not the same as the owner of the login session, see
In secure mode,
LESSSECURE=1 will be set when invoking the pager, and the pager shall
disable commands that open or create new files or start new subprocesses. When
$SYSTEMD_PAGERSECURE is not set at all, pagers which are not known to implement
secure mode will not be used. (Currently only
implements secure mode.)
Note: when commands are invoked with elevated privileges, for example under sudo(8) or
must be taken to ensure that unintended interactive features are not enabled. "Secure" mode for the
pager may be enabled automatically as describe above. Setting
or not removing it from the inherited environment allows the user to invoke arbitrary commands. Note
that if the
$PAGER variables are to be
$SYSTEMD_PAGERSECURE must be set too. It might be reasonable to completely
disable the pager using
Takes a boolean argument. When true, systemd and related utilities
will use colors in their output, otherwise the output will be monochrome. Additionally, the variable can
take one of the following special values: "
256" to restrict the use
of colors to the base 16 or 256 ANSI colors, respectively. This can be specified to override the automatic
decision based on
$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.