<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xsescsavman'>
<!--  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. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XSeScSav.man,v 1.3 2003/04/28 22:17:57 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XSetScreenSaver</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XSetScreenSaver</refname>
<refname>XForceScreenSaver</refname>
<refname>XActivateScreenSaver</refname>
<refname>XResetScreenSaver</refname>
<refname>XGetScreenSaver</refname>
<refpurpose>manipulate the screen saver</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XSetScreenSaver&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int <emphasis remap='I'>timeout</emphasis>&hairsp;,
int <emphasis remap='I'>interval</emphasis>&hairsp;, int <emphasis remap='I'>prefer_blanking</emphasis>&hairsp;, int
<emphasis remap='I'>allow_exposures</emphasis>&hairsp;);</para> 

<para>int XForceScreenSaver&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int <emphasis remap='I'>mode</emphasis>&hairsp;);</para> 

<para>int XActivateScreenSaver&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para> 

<para>int XResetScreenSaver&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;);</para> 

<para>int XGetScreenSaver&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, int *<emphasis remap='I'>timeout_return</emphasis>&hairsp;,
int *<emphasis remap='I'>interval_return</emphasis>&hairsp;, int *<emphasis remap='I'>prefer_blanking_return</emphasis>&hairsp;, int
*<emphasis remap='I'>allow_exposures_return</emphasis>&hairsp;);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>allow_exposures</emphasis></term>
  <listitem>
<para>Specifies the screen save control values.
You can pass
<emphasis remap='I'>&hairsp;DontAllowExposures&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;AllowExposures&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;DefaultExposures&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>allow_exposures_return</emphasis></term>
  <listitem>
<para>Returns the current screen save control value
(<emphasis remap='I'>&hairsp;DontAllowExposures&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;AllowExposures&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;DefaultExposures&hairsp;</emphasis>).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>interval</emphasis></term>
  <listitem>
<para>Specifies the interval, in seconds, between screen saver alterations.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>interval_return</emphasis></term>
  <listitem>
<para>Returns the interval between screen saver invocations.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>mode</emphasis></term>
  <listitem>
<para>Specifies the mode that is to be applied.
You can pass
<emphasis remap='I'>&hairsp;ScreenSaverActive&hairsp;</emphasis>
or
<emphasis remap='I'>&hairsp;ScreenSaverReset&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>prefer_blanking</emphasis></term>
  <listitem>
<para>Specifies how to enable screen blanking.
You can pass
<emphasis remap='I'>&hairsp;DontPreferBlanking&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;PreferBlanking&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;DefaultBlanking&hairsp;</emphasis>.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>prefer_blanking_return</emphasis></term>
  <listitem>
<para>Returns the current screen blanking preference
(<emphasis remap='I'>&hairsp;DontPreferBlanking&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;PreferBlanking&hairsp;</emphasis>,
or
<emphasis remap='I'>&hairsp;DefaultBlanking&hairsp;</emphasis>).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>timeout</emphasis></term>
  <listitem>
<para>Specifies the timeout, in seconds, until the screen saver turns on.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>timeout_return</emphasis></term>
  <listitem>
<para>Returns the timeout, in seconds, until the screen saver turns on.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>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
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error.
If the timeout value is nonzero, 
<emphasis remap='I'>&hairsp;XSetScreenSaver&hairsp;</emphasis>
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.</para>

<para>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 
<emphasis remap='I'>&hairsp;Expose&hairsp;</emphasis>
events to clients, 
the screen is tiled with the root window background tile randomly 
re-origined each interval seconds.
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
<emphasis remap='I'>&hairsp;XForceScreenSaver&hairsp;</emphasis>
with mode
<emphasis remap='I'>&hairsp;ScreenSaverReset&hairsp;</emphasis>.</para>

<para>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.</para>

<para><emphasis remap='I'>&hairsp;XSetScreenSaver&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error.</para>

<para>If the specified mode is 
<emphasis remap='I'>&hairsp;ScreenSaverActive&hairsp;</emphasis>
and the screen saver currently is deactivated,
<emphasis remap='I'>&hairsp;XForceScreenSaver&hairsp;</emphasis>
activates the screen saver even if the screen saver had been disabled
with a timeout of zero.
If the specified mode is 
<emphasis remap='I'>&hairsp;ScreenSaverReset&hairsp;</emphasis>
and the screen saver currently is enabled,
<emphasis remap='I'>&hairsp;XForceScreenSaver&hairsp;</emphasis>
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).</para>

<para><emphasis remap='I'>&hairsp;XForceScreenSaver&hairsp;</emphasis>
can generate a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error.</para>

<para>The
<emphasis remap='I'>&hairsp;XActivateScreenSaver&hairsp;</emphasis>
function activates the screen saver.</para>

<para>The
<emphasis remap='I'>&hairsp;XResetScreenSaver&hairsp;</emphasis>
function resets the screen saver.</para>

<para>The
<emphasis remap='I'>&hairsp;XGetScreenSaver&hairsp;</emphasis>
function gets the current screen saver values.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>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.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

