1XDG-SCREENSAVER(1)          xdg-screensaver Manual          XDG-SCREENSAVER(1)
2
3
4

NAME

6       xdg-screensaver - command line tool for controlling the screensaver
7

SYNOPSIS

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

DESCRIPTION

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

COMMANDS

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 existence for the duration
28           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 or
32           more hexadecimal digits.
33
34           The screensaver can be suspended in relation to multiple windows at
35           the same time. In that case screensaver operation is only restored
36           once the screensaver has been resumed in relation to each of the
37           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 passed
42           to a previous call of xdg-screensaver suspend
43
44       activate
45           Turns the screensaver on immediately. This may result in the screen
46           getting locked, depending on existing system policies.
47
48       lock
49           Lock the screen immediately.
50
51       reset
52           Turns the screensaver off immediately. If the screen was locked the
53           user may be asked to authenticate first.
54
55       status
56           Prints enabled to stdout if the screensaver is enabled to turn on
57           after a period of inactivity and prints disabled if the screensaver
58           is not enabled.
59

OPTIONS

61       --help
62           Show command synopsis.
63
64       --manual
65           Show this manual page.
66
67       --version
68           Show the xdg-utils version information.
69

EXIT CODES

71       An exit code of 0 indicates success while a non-zero exit code
72       indicates failure. The following failure codes can be returned:
73
74       1
75           Error in command line syntax.
76
77       3
78           A required tool could not be found.
79
80       4
81           The action failed.
82

EXAMPLES

84           xdg-screensaver suspend 0x1c00007
85
86       Causes the screensaver to be disabled till xdg-screensaver resume
87       0x1c00007 is called.  0x1c00007 must be the X Window ID of an existing
88       window.
89

AUTHOR

91       Bryce Harrington
92           Author.
93

95       Copyright © 2006
96
97
98
99xdg-utils 1.0                     01/22/2022                XDG-SCREENSAVER(1)
Impressum