1XDG-SCREENSAVER(1) XDG-SCREENSAVER(1)
2
3
4
6 xdg-screensaver - command line tool for controlling the screensaver
7
9 xdg-screensaver suspend WindowID
10
11 xdg-screensaver resume WindowID
12
13 xdg-screensaver {activate lock reset status}
14
15 xdg-screensaver {--help --manual --version}
16
18 xdg-screensaver provides commands to control the screensaver.
19
20 xdg-screensaver is for use inside a desktop session only. It is not
21 recommended to use xdg-screensaver as root.
22
24 suspend WindowID
25 Suspends the screensaver and monitor power management. WindowID
26 must be the X Window ID of an existing window of the calling
27 application. The window must remain in existance for the
28 duration of the suspension.
29
30 WindowID can be represented as either a decimal number or as a
31 hexadecimal number consisting of the prefix 0x followed by one
32 or more hexadecimal digits.
33
34 The screensaver can be suspended in relation to multiple windows
35 at the same time. In that case screensaver operation is only
36 restored once the screensaver has been resumed in relation to
37 each of the windows
38
39 resume WindowID
40 Resume the screensaver and monitor power management after being
41 suspended. WindowID must be the same X Window ID that was
42 passed to a previous call of xdg-screensaver suspend
43
44 activate
45 Turns the screensaver on immediately. This may result in the
46 screen getting locked, depending on existing system policies.
47
48 lock Lock the screen immediately.
49
50 reset Turns the screensaver off immediately. If the screen was locked
51 the user may be asked to authenticate first.
52
53 status Prints enabled to stdout if the screensaver is enabled to turn
54 on after a period of inactivity and prints disabled if the
55 screensaver is not enabled.
56
58 --help Show command synopsis.
59
60 --manual
61 Show this manualpage.
62
63 --version
64 Show the xdg-utils version information.
65
67 An exit code of 0 indicates success while a non-zero exit code
68 indicates failure. The following failure codes can be returned:
69
70 1 Error in command line syntax.
71
72 3 A required tool could not be found.
73
74 4 The action failed.
75
77 xdg-screensaver suspend 0x1c00007
78
79 Causes the screensaver to be disabled till xdg-screensaver resume
80 0x1c00007 is called. 0x1c00007 must be the X Window ID of an existing
81 window.
82
84 Bryce Harrington.
85 <bryce@osdl.org>
86
87
88
89xdg-utils 1.0 06/24/2007 XDG-SCREENSAVER(1)