1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
|
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
<refentry id="systemd-inhibit"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-inhibit</title>
<productname>systemd</productname>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-inhibit</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-inhibit</refname>
<refpurpose>Execute a program with an inhibition lock taken</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-inhibit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>systemd-inhibit</command> <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>--list</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><command>systemd-inhibit</command> 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.</para>
<para>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.</para>
<para>For more information see
<ulink url="https://systemd.io/INHIBITOR_LOCKS">Inhibitor Locks</ulink>.</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--what=</option></term>
<listitem><para>Takes a colon-separated list of one or more
operations to inhibit:
<literal>shutdown</literal>,
<literal>sleep</literal>,
<literal>idle</literal>,
<literal>handle-power-key</literal>,
<literal>handle-suspend-key</literal>,
<literal>handle-hibernate-key</literal>,
<literal>handle-lid-switch</literal>,
for inhibiting reboot/power-off/halt/kexec/soft-reboot,
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
<literal>idle:sleep:shutdown</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--who=</option></term>
<listitem><para>Takes a short, human-readable descriptive
string for the program taking the lock. If not passed,
defaults to the command line string.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--why=</option></term>
<listitem><para>Takes a short, human-readable descriptive
string for the reason for taking the lock. Defaults to
"Unknown reason".</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--mode=</option></term>
<listitem><para>Takes either <literal>block</literal> or
<literal>delay</literal> and describes how the lock is
applied. If <literal>block</literal> is used (the default),
the lock prohibits any of the requested operations without
time limit, and only privileged users may override it. If
<literal>delay</literal> 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
<citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
Note that <literal>delay</literal> is only available for
<literal>sleep</literal> and
<literal>shutdown</literal>.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--list</option></term>
<listitem><para>Lists all active inhibition locks instead of
acquiring one.</para></listitem>
</varlistentry>
<xi:include href="standard-options.xml" xpointer="no-pager" />
<xi:include href="standard-options.xml" xpointer="no-legend" />
<xi:include href="standard-options.xml" xpointer="help" />
<xi:include href="standard-options.xml" xpointer="version" />
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>Returns the exit status of the executed program.</para>
</refsect1>
<refsect1>
<title>Example</title>
<programlisting># systemd-inhibit wodim foobar.iso</programlisting>
<para>This burns the ISO image
<filename>foobar.iso</filename> on a CD using
<citerefentry project='man-pages'><refentrytitle>wodim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
and inhibits system sleeping, shutdown and idle while
doing so.</para>
</refsect1>
<xi:include href="common-variables.xml" />
<refsect1>
<title>See Also</title>
<para><simplelist type="inline">
<member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
<member><citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
</simplelist></para>
</refsect1>
</refentry>
|
