summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBenno Schulenberg <bensberg@telfort.nl>2023-04-04 11:35:44 +0200
committerBenno Schulenberg <bensberg@telfort.nl>2023-04-04 14:15:05 +0200
commita6528d92b3865adb4f9951df91a714f55f56d59e (patch)
tree01c0c95a19b26ae6857de87834445ac7dc9d9b24
parenteb166af8f9f4184108fe8e0611a09af03d12059e (diff)
downloadxorg-lib-libX11-a6528d92b3865adb4f9951df91a714f55f56d59e.tar.gz
XSetScreenSaver.man: restore the part that was accidentally snipped
Four years ago, while removing private macros, commit fe46eb2871 unintentionally truncated the XSetScreenSaver manpage. Restore the snipped part (minus trailing spaces and a mistaken singular). This fixes issue #187. Reported-by: Sergio Gelato Signed-off-by: Benno Schulenberg <bensberg@telfort.nl>
-rw-r--r--man/XSetScreenSaver.man78
1 files changed, 78 insertions, 0 deletions
diff --git a/man/XSetScreenSaver.man b/man/XSetScreenSaver.man
index 46626a46..4b88fb75 100644
--- a/man/XSetScreenSaver.man
+++ b/man/XSetScreenSaver.man
@@ -116,3 +116,81 @@ Other negative values generate a
error.
If the timeout value is nonzero,
.B XSetScreenSaver
+enables the screen saver.
+An interval of 0 disables the random-pattern motion.
+Both values are limited to a 16-bit signed integer range by the wire protocol,
+despite the C prototype.
+If no input from devices (keyboard, mouse, and so on) is generated
+for the specified number of timeout seconds once the screen saver is enabled,
+the screen saver is activated.
+.LP
+For each screen,
+if blanking is preferred and the hardware supports video blanking,
+the screen simply goes blank.
+Otherwise, if either exposures are allowed or the screen can be regenerated
+without sending
+.B Expose
+events to clients,
+the screen is tiled with the root window background tile randomly
+re-origined each interval seconds.
+Otherwise, the screens' states do not change,
+and the screen saver is not activated.
+The screen saver is deactivated,
+and all screen states are restored at the next
+keyboard or pointer input or at the next call to
+.B XForceScreenSaver
+with mode
+.BR ScreenSaverReset .
+.LP
+If the server-dependent screen saver method supports periodic change,
+the interval argument serves as a hint about how long the change period
+should be, and zero hints that no periodic change should be made.
+Examples of ways to change the screen include scrambling the colormap
+periodically, moving an icon image around the screen periodically, or tiling
+the screen with the root window background tile, randomly re-origined
+periodically.
+.LP
+.B XSetScreenSaver
+can generate a
+.B BadValue
+error.
+.LP
+If the specified mode is
+.B ScreenSaverActive
+and the screen saver currently is deactivated,
+.B XForceScreenSaver
+activates the screen saver even if the screen saver had been disabled
+with a timeout of zero.
+If the specified mode is
+.B ScreenSaverReset
+and the screen saver currently is enabled,
+.B XForceScreenSaver
+deactivates the screen saver if it was activated,
+and the activation timer is reset to its initial state
+(as if device input had been received).
+.LP
+.B XForceScreenSaver
+can generate a
+.B BadValue
+error.
+.LP
+The
+.B XActivateScreenSaver
+function activates the screen saver.
+.LP
+The
+.B XResetScreenSaver
+function resets the screen saver.
+.LP
+The
+.B XGetScreenSaver
+function gets the current screen saver values.
+.SH DIAGNOSTICS
+.TP 1i
+.B BadValue
+Some numeric value falls outside the range of values accepted by the request.
+Unless a specific range is specified for an argument, the full range defined
+by the argument's type is accepted. Any argument defined as a set of
+alternatives can generate this error.
+.SH "SEE ALSO"
+\fI\*(xL\fP