1SYSTEMD-INHIBIT(1) systemd-inhibit SYSTEMD-INHIBIT(1)
2
6 systemd-inhibit - Execute a program with an inhibition lock taken
7
9 systemd-inhibit [OPTIONS...] [COMMAND] [ARGUMENTS...]
10 systemd-inhibit [OPTIONS...] --list
12
14 systemd-inhibit may be used to execute a program with a shutdown,
15 sleep, or idle inhibitor lock taken. The lock will be acquired before
16 the specified command line is executed and released afterwards.
17 Inhibitor locks may be used to block or delay system sleep and shutdown
19 requests from the user, as well as automatic idle handling of the OS.
20 This is useful to avoid system suspends while an optical disc is being
21 recorded, or similar operations that should not be interrupted.
22 For more information see the Inhibitor Lock Developer Documentation[1].
24
26 The following options are understood:
27 --what=
29 Takes a colon-separated list of one or more operations to inhibit:
30 "shutdown", "sleep", "idle", "handle-power-key",
31 "handle-suspend-key", "handle-hibernate-key", "handle-lid-switch",
32 for inhibiting reboot/power-off/halt/kexec, suspending/hibernating,
33 the automatic idle detection, or the low-level handling of the
34 power/sleep key and the lid switch, respectively. If omitted,
35 defaults to "idle:sleep:shutdown".
36 --who=
38 Takes a short, human-readable descriptive string for the program
39 taking the lock. If not passed, defaults to the command line
40 string.
41 --why=
43 Takes a short, human-readable descriptive string for the reason for
44 taking the lock. Defaults to "Unknown reason".
45 --mode=
47 Takes either "block" or "delay" and describes how the lock is
48 applied. If "block" is used (the default), the lock prohibits any
49 of the requested operations without time limit, and only privileged
50 users may override it. If "delay" is used, the lock can only delay
51 the requested operations for a limited time. If the time elapses,
52 the lock is ignored and the operation executed. The time limit may
53 be specified in logind.conf(5). Note that "delay" is only available
54 for "sleep" and "shutdown".
55 --list
57 Lists all active inhibition locks instead of acquiring one.
58 --no-pager
60 Do not pipe output into a pager.
61 --no-legend
63 Do not print the legend, i.e. column headers and the footer with
64 hints.
65 -h, --help
67 Print a short help text and exit.
68 --version
70 Print a short version string and exit.
71
73 Returns the exit status of the executed program.
74
76 # systemd-inhibit wodim foobar.iso
77 This burns the ISO image foobar.iso on a CD using wodim(1), and
79 inhibits system sleeping, shutdown and idle while doing so.
80
82 $SYSTEMD_PAGER
83 Pager to use when --no-pager is not given; overrides $PAGER. If
84 neither $SYSTEMD_PAGER nor $PAGER are set, a set of well-known
85 pager implementations are tried in turn, including less(1) and
86 more(1), until one is found. If no pager implementation is
87 discovered no pager is invoked. Setting this environment variable
88 to an empty string or the value "cat" is equivalent to passing
89 --no-pager.
90 $SYSTEMD_LESS
92 Override the options passed to less (by default "FRSXMK").
93 If the value of $SYSTEMD_LESS does not include "K", and the pager
95 that is invoked is less, Ctrl+C will be ignored by the executable.
96 This allows less to handle Ctrl+C itself.
97 $SYSTEMD_LESSCHARSET
99 Override the charset passed to less (by default "utf-8", if the
100 invoking terminal is determined to be UTF-8 compatible).
101
103 systemd(1), logind.conf(5)
104
106 1. Inhibitor Lock Developer Documentation
107 https://www.freedesktop.org/wiki/Software/systemd/inhibit
108systemd 241 SYSTEMD-INHIBIT(1)