blob: c0cf741d4730c6c6f30da2eaa915529518269582 (
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
|
.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "XDG-SCREENSAVER" 1 "" "" "xdg-screensaver Manual"
.SH NAME
xdg-screensaver \- command line tool for controlling the screensaver
.SH "SYNOPSIS"
.ad l
.hy 0
.HP 16
\fBxdg\-screensaver\fR \fBsuspend\ \fIWindowID\fR\fR
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-screensaver\fR \fBresume\ \fIWindowID\fR\fR
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-screensaver\fR {\fB\fBactivate\fR\fR | \fB\fBreset\fR\fR | \fB\fBstatus\fR\fR}
.ad
.hy
.ad l
.hy 0
.HP 16
\fBxdg\-screensaver\fR {\fB\fB\-\-help\fR\fR | \fB\fB\-\-manual\fR\fR | \fB\fB\-\-version\fR\fR}
.ad
.hy
.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 \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\&.
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\&.
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 \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\&. On some systems the user may be asked to authenticate first before the screen is unlocked\&.
.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
\fB3\fR
A required tool could not be found\&.
.TP
\fB4\fR
The action failed\&.
.SH "EXAMPLES"
.PP
.nf
xdg\-screensaver suspend 0x1c00007
.fi
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.
|
