XSetScreenSaver(3X11)						     MIT X11R4						     XSetScreenSaver(3X11)

Name
       XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreenSaver, XGetScreenSaver - manipulate the screen saver

Syntax
       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;

       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
       allow_exposures
		 Specifies the screen save control values.  You can pass or

       allow_exposures_return
		 Returns the current screen save control value or

       display	 Specifies the connection to the X server.

       interval  Specifies the interval, in seconds, between screen saver alterations.

       interval_return
		 Returns the interval between screen saver invocations.

       mode	 Specifies the mode that is to be applied.  You can pass or

       prefer_blanking
		 Specifies how to enable screen blanking.  You can pass or

       prefer_blanking_return
		 Returns the current screen blanking preference or

       timeout	 Specifies the timeout, in seconds, until the screen saver turns on.

       timeout_return
		 Returns the timeout, in seconds, until the screen saver turns on.

Description
       Timeout and interval are specified in seconds.  A timeout of 0 disables the screen saver (but an activated screen saver is not deacti-
       vated), and a timeout of -1 restores the default.  Other negative values generate a error.  If the timeout value is nonzero, 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 events to clients, the screen is tiled with the root window back-
       ground tile randomly re-origined each interval minutes.	Otherwise, the screens' state do not change, and the screen saver is not acti-
       vated.  The screen saver is deactivated, and all screen states are restored at the next keyboard or pointer input or at the next call to
       with mode

       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 col-
       ormap periodically, moving an icon image around the screen periodically, or tiling the screen with the root window background tile, ran-
       domly re-origined periodically.

       can generate a error.

       If the specified mode is and the screen saver currently is deactivated, activates the screen saver even if the screen saver had been dis-
       abled with a timeout of zero.  If the specified mode is and the screen saver currently is enabled, 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).

       can generate a error.

       The function activates the screen saver.

       The function resets the screen saver.

       The function gets the current screen saver values.

Diagnostics
       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
       X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys

															     XSetScreenSaver(3X11)