blob: dc684097b803397e9a58ba5a840fa9ef23453603 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
'\" t
.\" Title: xdg-screensaver
.\" Author: Bryce Harrington
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\" Date: 12/31/2010
.\" Manual: xdg-screensaver Manual
.\" Source: xdg-utils 1.0
.\" Language: English
.\"
.TH "XDG\-SCREENSAVER" "1" "12/31/2010" "xdg-utils 1.0" "xdg-screensaver Manual"
.\" -----------------------------------------------------------------
.\" * 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"
xdg-screensaver \- command line tool for controlling the screensaver
.SH "SYNOPSIS"
.HP \w'\fBxdg\-screensaver\fR\ 'u
\fBxdg\-screensaver\fR \fBsuspend\ \fR\fB\fIWindowID\fR\fR
.HP \w'\fBxdg\-screensaver\fR\ 'u
\fBxdg\-screensaver\fR \fBresume\ \fR\fB\fIWindowID\fR\fR
.HP \w'\fBxdg\-screensaver\fR\ 'u
\fBxdg\-screensaver\fR {\fBactivate\fR | \fBlock\fR | \fBreset\fR | \fBstatus\fR}
.HP \w'\fBxdg\-screensaver\fR\ 'u
\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"
.PP
\fBsuspend \fR\fB\fIWindowID\fR\fR
.RS 4
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
.RE
.PP
\fBresume \fR\fB\fIWindowID\fR\fR
.RS 4
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
.RE
.PP
\fBactivate\fR
.RS 4
Turns the screensaver on immediately\&. This may result in the screen getting locked, depending on existing system policies\&.
.RE
.PP
\fBlock\fR
.RS 4
Lock the screen immediately\&.
.RE
.PP
\fBreset\fR
.RS 4
Turns the screensaver off immediately\&. If the screen was locked the user may be asked to authenticate first\&.
.RE
.PP
\fBstatus\fR
.RS 4
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\&.
.RE
.SH "OPTIONS"
.PP
\fB\-\-help\fR
.RS 4
Show command synopsis\&.
.RE
.PP
\fB\-\-manual\fR
.RS 4
Show this manualpage\&.
.RE
.PP
\fB\-\-version\fR
.RS 4
Show the xdg\-utils version information\&.
.RE
.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:
.PP
\fB1\fR
.RS 4
Error in command line syntax\&.
.RE
.PP
\fB3\fR
.RS 4
A required tool could not be found\&.
.RE
.PP
\fB4\fR
.RS 4
The action failed\&.
.RE
.SH "EXAMPLES"
.PP
.sp
.if n \{\
.RS 4
.\}
.nf
xdg\-screensaver suspend 0x1c00007
.fi
.if n \{\
.RE
.\}
.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"
.PP
\fBBryce Harrington\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2006
.br
|
