.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..
 0
.nr BD 0

.KS .TA .5i 3i

..

.. .. .KS

.D

 choose appropriate monospace font
 the imagen conditional, 480,
 may be changed to L if LB is too
 heavy for your eyes...

..

.R
..
..
..
.TB

\\*(NO
.R
..
. \" Note End -- doug kraft 3/85
 0
..
.ny0
 XSetScreenSaver 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
 NAME
XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreenSaver, XGetScreenSaver - manipulate the screen saver
 SYNTAX
 $Header: XSetScrnSvr.f,v 1.1 88/02/26 10:03:37 mento Exp $
XSetScreenSaver\^(\^display, timeout\^, interval\^, prefer_blanking\^, allow_exposures\^)

 Display *display\^;

 int timeout\^, interval\^;

 int prefer_blanking\^; 

 int allow_exposures\^;

XForceScreenSaver\^(\^display\^, mode\^)

 Display *display\^;

 int mode\^;

XActivateScreenSaver\^(\^display\^)

 Display *display\^;

XResetScreenSaver\^(\^display\^)

 Display *display\^;

 $Header: XGetScrnSvr.f,v 1.1 88/02/26 10:00:59 mento Exp $
XGetScreenSaver\^(\^display, timeout_return\^, interval_return\^, prefer_blanking_return\^, 

 allow_exposures_return\^)

 Display *display\^;

 int *timeout_return\^, *interval_return\^;

 int *prefer_blanking_return\^;

 int *allow_exposures_return\^;
 ARGUMENTS
 $Header: allowexp.a,v 1.3 88/05/14 09:43:06 mento Exp $
 allow_exposures 1i
Specifies the screen save control values.
You can pass
.ZN DontAllowExposures ,
.ZN AllowExposures ,
or
.ZN DefaultExposures .
 $Header: allowexpret.a,v 1.2 88/05/14 09:50:38 mento Exp $
 allow_exposures_return 1i
Returns the current screen save control value
n ( DontAllowExposures ,
.ZN AllowExposures ,
or
.ZN DefaultExposures ).
 $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
 display 1i
Specifies the connection to the X server.
 $Header: interval.a,v 1.2 88/04/06 18:31:20 mento Exp $
 interval 1i
Specifies the interval, in seconds, between screen saver alterations.
 $Header: intervalret.a,v 1.1 88/02/26 10:28:20 mento Exp $
 interval_return 1i
Returns the interval between screen saver invocations.
 mode 1i
Specifies the mode that is to be applied.
You can pass
.ZN ScreenSaverActive
or
.ZN ScreenSaverReset .
 $Header: preferblank.a,v 1.3 88/05/14 09:42:26 mento Exp $
 prefer_blanking 1i
Specifies how to enable screen blanking.
You can pass
.ZN DontPreferBlanking ,
.ZN PreferBlanking ,
or
.ZN DefaultBlanking .
 $Header: prefrblnkret.a,v 1.2 88/05/14 09:49:37 mento Exp $
 prefer_blanking_return 1i
Returns the current screen blanking preference
n ( DontPreferBlanking ,
.ZN PreferBlanking ,
or
.ZN DefaultBlanking ).
 $Header: timeout.a,v 1.1 88/02/26 10:31:42 mento Exp $
 timeout 1i
Specifies the timeout, in seconds, until the screen saver turns on.
 $Header: timeoutret.a,v 1.1 88/02/26 10:31:43 mento Exp $
 timeout_return 1i
Returns the timeout, in seconds, until the screen saver turns on.
 DESCRIPTION
 $Header: XSetScrnSvr.d,v 1.3 88/08/19 21:02:13 mento Exp $
Timeout and interval are specified in seconds. 
A timeout of 0 disables the screen saver 
(but an activated screen saver is not deactivated),
and a timeout of -1 restores the default.
Other negative values generate a
.ZN BadValue
error.
If the timeout value is nonzero, 
.ZN XSetScreenSaver
enables the screen saver.
An interval of 0 disables the random-pattern motion.
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.

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 
.ZN Expose 
events to clients, 
the screen is tiled with the root window background tile randomly 
re-origined each interval minutes.
Otherwise, the screens' state 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
.ZN XForceScreenSaver
with mode
.ZN ScreenSaverReset . 

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.

.ZN XSetScreenSaver
can generate a
.ZN BadValue 
error.

 $Header: XForScrnSvr.d,v 1.2 88/06/11 07:50:37 mento Exp $
If the specified mode is 
.ZN ScreenSaverActive 
and the screen saver currently is deactivated,
.ZN XForceScreenSaver
activates the screen saver even if the screen saver had been disabled
with a timeout of zero.
If the specified mode is 
.ZN ScreenSaverReset 
and the screen saver currently is enabled,
.ZN 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).

.ZN XForceScreenSaver
can generate a
.ZN BadValue 
error.

 $Header: XActScrnSvr.d,v 1.2 88/06/11 07:48:32 mento Exp $
The
.ZN XActivateScreenSaver
function activates the screen saver.

 $Header: XRstScrnSvr.d,v 1.1 88/02/26 10:50:12 mento Exp $
The
.ZN XResetScreenSaver
function resets the screen saver.

 $Header: XGetScrnSvr.d,v 1.1 88/02/26 10:48:38 mento Exp $
The
.ZN XGetScreenSaver
function gets the current screen saver values.
 DIAGNOSTICS
 $Header: badvalue.e,v 1.1 87/09/04 08:23:19 mento Exp $
 1i
.ZN 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.
 "SEE ALSO"
\*(xL