


XSetScreenSaver(3X11)					XSetScreenSaver(3X11)
X11R5									X11R5



NAME
  XSetScreenSaver, XForceScreenSaver, XActivateScreenSaver, XResetScreen-
  Saver, XGetScreenSaver - manipulate the screen saver

SYNTAX
  XSetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l, _p_r_e_f_e_r__b_l_a_n_k_i_n_g,
  _a_l_l_o_w__e_x_p_o_s_u_r_e_s)
	Display	*_d_i_s_p_l_a_y;
	int _t_i_m_e_o_u_t, _i_n_t_e_r_v_a_l;
	int _p_r_e_f_e_r__b_l_a_n_k_i_n_g;
	int _a_l_l_o_w__e_x_p_o_s_u_r_e_s;

  XForceScreenSaver(_d_i_s_p_l_a_y, _m_o_d_e)
	Display	*_d_i_s_p_l_a_y;
	int _m_o_d_e;

  XActivateScreenSaver(_d_i_s_p_l_a_y)
	Display	*_d_i_s_p_l_a_y;

  XResetScreenSaver(_d_i_s_p_l_a_y)
	Display	*_d_i_s_p_l_a_y;

  XGetScreenSaver(_d_i_s_p_l_a_y, _t_i_m_e_o_u_t__r_e_t_u_r_n, _i_n_t_e_r_v_a_l__r_e_t_u_r_n,
  _p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n,
		    _a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n)
	Display	*_d_i_s_p_l_a_y;
	int *_t_i_m_e_o_u_t__r_e_t_u_r_n, *_i_n_t_e_r_v_a_l__r_e_t_u_r_n;
	int *_p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n;
	int *_a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n;

ARGUMENTS

  _a_l_l_o_w__e_x_p_o_s_u_r_e_s
	    Specifies the screen save control values.  You can pass _D_o_n_t_A_l_-
	    _l_o_w_E_x_p_o_s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s.

  _a_l_l_o_w__e_x_p_o_s_u_r_e_s__r_e_t_u_r_n
	    Returns the	current	screen save control value (_D_o_n_t_A_l_l_o_w_E_x_p_o_-
	    _s_u_r_e_s, _A_l_l_o_w_E_x_p_o_s_u_r_e_s, or _D_e_f_a_u_l_t_E_x_p_o_s_u_r_e_s).

  _d_i_s_p_l_a_y   Specifies the connection to	the X server.

  _i_n_t_e_r_v_a_l  Specifies the interval, in seconds,	between	screen saver altera-
	    tions.

  _i_n_t_e_r_v_a_l__r_e_t_u_r_n
	    Returns the	interval between screen	saver invocations.

  _m_o_d_e	    Specifies the mode that is to be applied.  You can pass _S_c_r_e_e_n_-
	    _S_a_v_e_r_A_c_t_i_v_e	or _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.

  _p_r_e_f_e_r__b_l_a_n_k_i_n_g
	    Specifies how to enable screen blanking.  You can pass _D_o_n_t_P_r_e_-
	    _f_e_r_B_l_a_n_k_i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g.

  _p_r_e_f_e_r__b_l_a_n_k_i_n_g__r_e_t_u_r_n
	    Returns the	current	screen blanking	preference (_D_o_n_t_P_r_e_f_e_r_B_l_a_n_k_-
	    _i_n_g, _P_r_e_f_e_r_B_l_a_n_k_i_n_g, or _D_e_f_a_u_l_t_B_l_a_n_k_i_n_g).

  _t_i_m_e_o_u_t   Specifies the timeout, in seconds, until the screen	saver turns
	    on.

  _t_i_m_e_o_u_t__r_e_t_u_r_n
	    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	_B_a_d_-
  _V_a_l_u_e	error.	If the timeout value is	nonzero, _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r 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 speci-
  fied 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 _E_x_p_o_s_e 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 deac-
  tivated, and all screen states are restored at the next keyboard or pointer
  input	or at the next call to _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r with mode _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t.

  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.

  _X_S_e_t_S_c_r_e_e_n_S_a_v_e_r can generate a _B_a_d_V_a_l_u_e error.

  If the specified mode	is _S_c_r_e_e_n_S_a_v_e_r_A_c_t_i_v_e and the screen saver currently
  is deactivated, _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r activates the screen saver even if the
  screen saver had been	disabled with a	timeout	of zero.  If the specified
  mode is _S_c_r_e_e_n_S_a_v_e_r_R_e_s_e_t and the screen saver	currently is enabled, _X_F_o_r_-
  _c_e_S_c_r_e_e_n_S_a_v_e_r	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).

  _X_F_o_r_c_e_S_c_r_e_e_n_S_a_v_e_r can	generate a _B_a_d_V_a_l_u_e error.

  The _X_A_c_t_i_v_a_t_e_S_c_r_e_e_n_S_a_v_e_r function activates the screen saver.

  The _X_R_e_s_e_t_S_c_r_e_e_n_S_a_v_e_r	function resets	the screen saver.

  The _X_G_e_t_S_c_r_e_e_n_S_a_v_e_r function gets the	current	screen saver values.

DIAGNOSTICS

  _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of values accepted by
	    the	request.  Unless a specific range is specified for an argu-
	    ment, 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_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e	delim off




