'\" t
.\"     Title: gnome-session-inhibit
.\"    Author: gnome-session contributors
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/16/2026
.\"    Manual: User Commands
.\"    Source: gnome-session
.\"  Language: English
.\"
.TH "GNOME\-SESSION\-INHI" "1" "" "gnome-session" "User Commands"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gnome-session-inhibit \- Inhibit gnome\-session functionality
.SH "SYNOPSIS"
.HP \w'\fBgnome\-session\-inhibit\fR\ 'u
\fBgnome\-session\-inhibit\fR [OPTION...] [COMMAND]
.SH "DESCRIPTION"
.PP
\fBgnome\-session\-inhibit\fR
can inhibit certain gnome\-session functionality while executing the given COMMAND\&. To achieve this, it calls the Inhibit() method of the gnome\-session D\-Bus API and creates an inhibitor\&. The inhibitor is automatically removed when gnome\-session\-inhibit exits\&.
.PP
A typical use case is to prevent the session from going idle (and thus locking the screen) while a movie player is running\&.
.SH "OPTIONS"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Print help and exit
.RE
.PP
\fB\-\-version\fR
.RS 4
Print version information and exit
.RE
.PP
\fB\-\-app\-id\fR ID
.RS 4
The application id to use when calling the gnome\-session Inhibit() method\&. If this option is not specified, "unknown" is used\&.
.RE
.PP
\fB\-\-reason\fR REASON
.RS 4
A human\-readable reason to pass along when calling the gnome\-session Inhibit() method\&. If this option is not specified, "not specified" is used\&.
.RE
.PP
\fB\-\-inhibit\fR ACTION
.RS 4
ACTION specifies the actions to inhibit\&. This option can be repeated to inhibit multiple actions\&. The possible values for an ACTION are: logout, switch\-user, suspend, idle, automount\&. If this option is not specified, "idle" is assumed\&.
.RE
.PP
\fB\-\-inhibit\-only\fR
.RS 4
Do not launch COMMAND and wait forever instead
.RE
.PP
\fB\-l\fR, \fB\-\-list\fR
.RS 4
List the existing inhibitions and exit
.RE
.SH "SEE ALSO"
.PP
\fBsystemd-inhibit\fR(1)
