mirror of
https://github.com/systemd/systemd.git
synced 2024-10-31 07:51:21 +03:00
5aded36978
It is annoying when we have dead links on fd.o. Add project='man-pages|die-net|archlinux' to <citerefentry>-ies. In generated html, add external links to http://man7.org/linux/man-pages/man, http://linux.die.net/man/, https://www.archlinux.org/. By default, pages in sections 2 and 4 go to man7, since Michael Kerrisk is the autorative source on kernel related stuff. The rest of links goes to linux.die.net, because they have the manpages. Except for the pacman stuff, since it seems to be only available from archlinux.org. Poor gummiboot gets no link, because gummitboot(8) ain't to be found on the net. According to common wisdom, that would mean that it does not exist. But I have seen Kay using it, so I know it does, and deserves to be found. Can somebody be nice and put it up somewhere?
195 lines
8.6 KiB
XML
195 lines
8.6 KiB
XML
<?xml version='1.0'?> <!--*-nxml-*-->
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
|
<!--
|
|
This file is part of systemd.
|
|
|
|
Copyright 2012 Lennart Poettering
|
|
|
|
systemd is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 of the License, or
|
|
(at your option) any later version.
|
|
|
|
systemd is distributed in the hope that it will be useful, but
|
|
WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License
|
|
along with systemd; If not, see <http://www.gnu.org/licenses/>.
|
|
-->
|
|
|
|
<refentry id="systemd-inhibit"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude">
|
|
|
|
<refentryinfo>
|
|
<title>systemd-inhibit</title>
|
|
<productname>systemd</productname>
|
|
|
|
<authorgroup>
|
|
<author>
|
|
<contrib>Developer</contrib>
|
|
<firstname>Lennart</firstname>
|
|
<surname>Poettering</surname>
|
|
<email>lennart@poettering.net</email>
|
|
</author>
|
|
</authorgroup>
|
|
</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 <arg choice="opt" rep="repeat">OPTIONS</arg> <arg>COMMAND</arg> <arg choice="opt" rep="repeat">ARGUMENTS</arg></command>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>systemd-inhibit <arg choice="opt" rep="repeat">OPTIONS</arg> --list</command>
|
|
</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 the <ulink
|
|
url="http://www.freedesktop.org/wiki/Software/systemd/inhibit">Inhibitor
|
|
Lock Developer Documentation</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,
|
|
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="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>
|
|
|
|
<refsect1>
|
|
<title>See Also</title>
|
|
<para>
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
<citerefentry><refentrytitle>logind.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
|
|
</para>
|
|
</refsect1>
|
|
|
|
</refentry>
|