.\" ** You probably do not want to edit this file directly **
.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
.\" Instead of manually editing it, you probably should edit the DocBook XML
.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
.TH "XDG\-SCREENSAVER" "1" "07/24/2006" "This is release 0.1 of the xdg\-screensav" ""
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
xdg\-screensaver \- command line tool for controlling the screensaver
.SH "SYNOPSIS"
.HP 16
\fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR
.HP 16
\fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR
.HP 16
\fBxdg\-screensaver\fR {\fBactivate\fR \fBreset\fR \fBstatus\fR}
.HP 16
\fBxdg\-screensaver\fR {\fB\-\-help\fR \fB\-\-manual\fR \fB\-\-version\fR}
.SH "DESCRIPTION"
.PP
xdg\-screensaver provides commands to control the screensaver.
.PP
xdg\-screensaver is for use inside a desktop session only. It is not recommended to use xdg\-screensaver as root.
.SH "COMMANDS"
.TP
\fBsuspend \fR\fB\fIWindowID\fR\fR
Suspends the screensaver and monitor power management.
\fIWindowID\fR
must be the X Window ID of an existing window of the calling application. The window must remain in existance for the duration of the suspension.
.sp
WindowID can be represented as either a decimal number or as a hexadecimal number consisting of the prefix
\fI0x\fR
followed by one or more hexadecimal digits.
.sp
The screensaver can be suspended in relation to multiple windows at the same time. In that case screensaver operation is only restored once the screensaver has been resumed in relation to each of the windows
.TP
\fBresume \fR\fB\fIWindowID\fR\fR
Resume the screensaver and monitor power management after being suspended.
\fIWindowID\fR
must be the same X Window ID that was passed to a previous call of
\fBxdg\-screensaver suspend\fR
.TP
\fBactivate\fR
Turns the screensaver on immediately. This may result in the screen getting locked, depending on existing system policies.
.TP
\fBreset\fR
Turns the screensaver off immediately. This my result in a password prompt to unlock the screen, depending on existing system policies.
.TP
\fBstatus\fR
Prints
\fIenabled\fR
to stdout if the screensaver is enabled to turn on after a period of inactivity and prints
\fIdisabled\fR
if the screensaver is not enabled.
.SH "OPTIONS"
.TP
\fB\-\-help\fR
Show command synopsis.
.TP
\fB\-\-manual\fR
Show this manualpage.
.TP
\fB\-\-version\fR
Show the xdg\-utils version information.
.SH "EXIT CODES"
.PP
An exit code of 0 indicates success while a non\-zero exit code indicates failure. The following failure codes can be returned:
.TP
\fB1\fR
Error in command line syntax.
.TP
\fB2\fR
One of the files passed on the command line did not exist.
.TP
\fB3\fR
A required tool could not be found.
.TP
\fB4\fR
The action failed.
.SH "EXAMPLES"
.PP
.nf
xdg\-screensaver suspend 0x1c00007
.fi
.sp
Causes the screensaver to be disabled till
\fBxdg\-screensaver resume 0x1c00007\fR
is called.
\fI0x1c00007\fR
must be the X Window ID of an existing window.
.SH "AUTHOR"
Bryce Harrington. 
.br
<bryce@osdl.org>