carta
budgie-session-inhibit(1)

budgie-session-inhibit1

Inhibit budgie-session functionality

Usage

budgie-session-inhibit [OPTION ...] [COMMAND]

Overview

budgie-session-inhibit can inhibit certain budgie-session functionality while executing the given COMMAND. To achieve this, it calls the Inhibit() method of the budgie-session D-Bus API and creates an inhibitor. The inhibitor is automatically removed when budgie-session-inhibit exits.

A typical use case is to prevent the session from going idle (and thus locking the screen) while a movie player is running.

Options

-h, --help

print help and exit

--version

print version information and exit

--app-id ID

The application id to use when calling the budgie-session Inhibit() method. If this option is not specified, "unknown" is used.

--reason REASON

A human-readable reason to pass along when calling the budgie-session Inhibit() method. If this option is not specified, "not specified" is used.

--inhibit ARG

ARG specifies the things to inhibit, as a colon-separated list. The possible values are logout, switch-user, suspend, idle, automount. If this option is used more than once, the values are combined. If this option is not specified, "idle" is assumed.

--inhibit-only

Do not launch COMMAND and wait forever instead

-l, --list

list the existing inhibitions and exit

History

  • Arch Linux 2026-11-01: the text shown here
  • Debian 13 (Trixie)

From budgie-session 1.0.1-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.