XSetScreenSaver.man revision 9c927599
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation
Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.
Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Except as contained in this notice, the name of the X Consortium shall
not be used in advertising or otherwise to promote the sale, use or
other dealings in this Software without prior written authorization
from the X Consortium.
Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Digital Equipment Corporation
Portions Copyright \(co 1990, 1991 by
Tektronix, Inc.
Permission to use, copy, modify and distribute this documentation for
any purpose and without fee is hereby granted, provided that the above
copyright notice appears in all copies and that both that copyright notice
and this permission notice appear in all copies, and that the names of
Digital and Tektronix not be used in in advertising or publicity pertaining
to this documentation without specific, written prior permission.
Digital and Tektronix makes no representations about the suitability
of this documentation for any purpose.
It is provided "as is" without express or implied warranty.
XSetScreenSaver __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
NAME
XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreenSaver, XGetScreenSaver - manipulate the screen saver
SYNTAX
int XSetScreenSaver\^(\^Display *display\^, int timeout\^, int interval\^, int prefer_blanking\^, int allow_exposures\^);
int XForceScreenSaver\^(\^Display *display\^, int mode\^);
int XActivateScreenSaver\^(\^Display *display\^);
int XResetScreenSaver\^(\^Display *display\^);
int XGetScreenSaver\^(\^Display *display\^, int *timeout_return\^, int *interval_return\^, int *prefer_blanking_return\^, int *allow_exposures_return\^);
ARGUMENTS
allow_exposures 1i
Specifies the screen save control values.
You can pass
DontAllowExposures , AllowExposures , or
DefaultExposures . allow_exposures_return 1i
Returns the current screen save control value
( DontAllowExposures , AllowExposures , or
DefaultExposures ). display 1i
Specifies the connection to the X server.
interval 1i
Specifies the interval, in seconds, between screen saver alterations.
interval_return 1i
Returns the interval between screen saver invocations.
mode 1i
Specifies the mode that is to be applied.
You can pass
ScreenSaverActive or
ScreenSaverReset . prefer_blanking 1i
Specifies how to enable screen blanking.
You can pass
DontPreferBlanking , PreferBlanking , or
DefaultBlanking . prefer_blanking_return 1i
Returns the current screen blanking preference
( DontPreferBlanking , PreferBlanking , or
DefaultBlanking ). timeout 1i
Specifies the timeout, in seconds, until the screen saver turns on.
timeout_return 1i
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 deactivated),
and a timeout of -1 restores the default.
Other negative values generate a
BadValue error.
If the timeout value is nonzero,
XSetScreenSaver