systemd-inhibit(1) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXIT STATUS | EXAMPLE | ENVIRONMENT | SEE ALSO | NOTES | COLOPHON

SYSTEMD-INHIBIT(1)           systemd-inhibit          SYSTEMD-INHIBIT(1)

NAME         top

       systemd-inhibit - Execute a program with an inhibition lock taken

SYNOPSIS         top

       systemd-inhibit [OPTIONS...] [COMMAND] [ARGUMENTS...]

       systemd-inhibit [OPTIONS...] --list

DESCRIPTION         top

       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[1].

OPTIONS         top

       The following options are understood:

       --what=
           Takes a colon-separated list of one or more operations to
           inhibit: "shutdown", "sleep", "idle", "handle-power-key",
           "handle-suspend-key", "handle-hibernate-key",
           "handle-lid-switch", 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 "idle:sleep:shutdown".

       --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
           logind.conf(5). Note that "delay" is only available for
           "sleep" and "shutdown".

       --list
           Lists all active inhibition locks instead of acquiring one.

       --no-pager
           Do not pipe output into a pager.

       --no-legend
           Do not print the legend, i.e. column headers and the footer
           with hints.

       -h, --help
           Print a short help text and exit.

       --version
           Print a short version string and exit.

EXIT STATUS         top

       Returns the exit status of the executed program.

EXAMPLE         top

           # systemd-inhibit wodim foobar.iso

       This burns the ISO image foobar.iso on a CD using wodim(1), and
       inhibits system sleeping, shutdown and idle while doing so.

ENVIRONMENT         top

       $SYSTEMD_PAGER
           Pager to use when --no-pager is not given; overrides $PAGER.
           If neither $SYSTEMD_PAGER nor $PAGER are set, a set of
           well-known pager implementations are tried in turn, including
           less(1) and 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 --no-pager.

       $SYSTEMD_LESS
           Override the options passed to less (by default "FRSXMK").

           Users might want to change two options in particular:

           K
               This option instructs the pager to exit immediately when
               Ctrl+C is pressed. To allow less to handle Ctrl+C itself
               to switch back to the pager command prompt, unset this
               option.

               If the value of $SYSTEMD_LESS does not include "K", and
               the pager that is invoked is less, Ctrl+C will be ignored
               by the executable, and needs to be handled by the pager.

           X
               This option instructs the pager to not send termcap
               initialization and deinitialization strings to the
               terminal. It is set by default to allow command output to
               remain visible in the terminal even after the pager
               exits. Nevertheless, this prevents some pager
               functionality from working, in particular paged output
               cannot be scrolled with the mouse.

           See less(1) for more discussion.

       $SYSTEMD_LESSCHARSET
           Override the charset passed to less (by default "utf-8", if
           the invoking terminal is determined to be UTF-8 compatible).

       $SYSTEMD_PAGERSECURE
           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
           geteuid(2) and sd_pid_get_owner_uid(3). 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 less(1) implements secure
           mode.)

           Note: when commands are invoked with elevated privileges, for
           example under sudo(8) or pkexec(1), care 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 SYSTEMD_PAGERSECURE=0 or not removing
           it from the inherited environment allows the user to invoke
           arbitrary commands. Note that if the $SYSTEMD_PAGER or $PAGER
           variables are to be honoured, $SYSTEMD_PAGERSECURE must be
           set too. It might be reasonable to completely disable the
           pager using --no-pager instead.

       $SYSTEMD_COLORS
           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: "16", "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.

       $SYSTEMD_URLIFY
           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.

SEE ALSO         top

       systemd(1), logind.conf(5)

NOTES         top

        1. Inhibitor Lock Developer Documentation
           https://www.freedesktop.org/wiki/Software/systemd/inhibit

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2020-12-18.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2020-12-18.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 247                                           SYSTEMD-INHIBIT(1)

Pages that refer to this page: systemd.directives(7)systemd.index(7)rpm-plugin-systemd-inhibit(8)