man/DPMSSetTimeouts.man

   1 .\" Copyright \(co Digital Equipment Corporation, 1996
   2 .\"
   3 .\" Permission to use, copy, modify, distribute, and sell this
   4 .\" documentation for any purpose is hereby granted without fee,
   5 .\" provided that the above copyright notice and this permission
   6 .\" notice appear in all copies.  Digital Equipment Corporation
   7 .\" makes no representations about the suitability for any purpose
   8 .\" of the information in this document.  This documentation is
   9 .\" provided ``as is'' without express or implied warranty.
  10 .\"
  11 .\" Copyright 1999, 2005 Sun Microsystems, Inc.  All rights reserved.
  12 .\"
  13 .\" Permission is hereby granted, free of charge, to any person obtaining a
  14 .\" copy of this software and associated documentation files (the "Software"),
  15 .\" to deal in the Software without restriction, including without limitation
  16 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
  17 .\" and/or sell copies of the Software, and to permit persons to whom the
  18 .\" Software is furnished to do so, subject to the following conditions:
  19 .\"
  20 .\" The above copyright notice and this permission notice (including the next
  21 .\" paragraph) shall be included in all copies or substantial portions of the
  22 .\" Software.
  23 .\"
  24 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  27 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  29 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  30 .\" DEALINGS IN THE SOFTWARE.
  31 .\"
  32 .\" X Window System is a trademark of The Open Group.
  33 .\"
  34 .TH DPMSSetTimeouts __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSSetTimeouts \- permits applications to set the timeout values
  37 used by the X server for DPMS timings
  38 .SH SYNOPSIS
  39 .PP
  40 .nf
  41 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  42 \&#include <X11/extensions/dpms.h>
  43 .HP
  44 .B Status DPMSSetTimeouts
  45 (
  46 .br
  47       Display *\fIdisplay\fP\^,
  48 .br
  49       CARD16 \fIstandby\fP\^,
  50 .br
  51       CARD16 \fIsuspend\fP\^,
  52 .br
  53       CARD16 \fIoff\fP\^
  54 );
  55 .if n .ti +5n
  56 .if t .ti +.5i
  57 .SH ARGUMENTS
  58 .TP
  59 .I display
  60 Specifies the connection to the X server
  61 .TP
  62 .I standby
  63 Specifies the new standby timeout in seconds
  64 .TP
  65 .I suspend
  66 Specifies the new suspend timeout in seconds
  67 .TP
  68 .I off
  69 Specifies the new off timeout in seconds
  70 .SH DESCRIPTION
  71 .LP
  72 The DPMSSetTimeouts function permits applications to set the timeout values
  73 used by the X server for Display Power Management Signaling (DPMS) timings.
  74 .LP
  75 The value \fIstandby\fP is the amount of inactivity time, in seconds, before
  76 standby mode is invoked. The actual
  77 effects of this mode are dependent on the characteristics of the monitor and
  78 frame buffer card. Standby mode is
  79 implemented by shutting off the horizontal sync signal, and pulsing the vertical
  80 sync signal. Standby mode
  81 provides the quickest monitor recovery time.  Note also that many monitors
  82 implement this mode identical to
  83 suspend mode.  A value of zero disables the standby mode.
  84 .LP
  85 The value \fIsuspend\fP is the amount of time of inactivity, in seconds, before
  86 the second level of power
  87 savings is invoked. Suspend mode's physical and electrical characteristics are
  88 implementation defined. For DPMS
  89 compliant hardware, setting the suspend mode is implemented by pulsing the
  90 horizontal sync signal and
  91 shutting off the vertical sync signal.  In general, suspend mode recovery is
  92 considered to be slower than
  93 standby mode, but faster than off mode. However it may vary from monitor to
  94 monitor.  As noted above, many
  95 monitors implement this mode identical to the standby mode.  A value of zero
  96 disables this mode.
  97 .LP
  98 The value \fIoff\fP is the amount of time of inactivity,in seconds, before the
  99 third and final level of power
 100 savings is invoked. Off mode's physical and electrical characteristics are
 101 implementation defined. In DPMS
 102 compliant hardware, it is implemented by shutting off both horizontal and
 103 vertical sync signals, resulting in
 104 powering down of the monitor.  Recovery time is implementation dependent.
 105 Usually the recovery time is very
 106 close to the power-up time of the monitor. A value of zero disables this mode.
 107 .LP
 108 Chronologically, \fIstandby\fP mode occurs before or simultaneously with
 109 \fIsuspend\fP mode, and
 110 \fIsuspend\fP mode must occur before or simultaneously with \fIoff\fP mode.
 111 Therefore, non-zero mode timeout
 112 values must be greater than or equal to the timeout values of earlier modes.  If
 113 inconsistent values are
 114 supplied, a BadValue error will result.
 115 .SH "RETURN VALUES"
 116 .TP 15
 117 TRUE
 118 The
 119 .I DPMSSetTimeouts
 120 function returns TRUE when the function has succeeded.
 121 .SH ERRORS
 122 .TP 15
 123 .SM BadValue
 124 An argument is out of range.
 125 .SH "SEE ALSO"
 126 .BR DPMSCapable (__libmansuffix__),
 127 .BR DPMSInfo (__libmansuffix__),
 128 .BR DPMSGetTimeouts (__libmansuffix__)