152 lines
4.5 KiB
HTML
152 lines
4.5 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of DPMSSetTimeouts</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>DPMSSetTimeouts</H1>
|
|
Section: X FUNCTIONS (3)<BR>Updated: libXext 1.3.4<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
DPMSSetTimeouts - permits applications to set the timeout values
|
|
used by the X server for DPMS timings
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
<PRE>
|
|
<B>cc</B> [ <I>flag</I> ... ] <I>file</I> ... -<B>lXext</B> [ <I>library</I> ... ]
|
|
#include <<A HREF="file:///usr/include/X11/extensions/dpms.h">X11/extensions/dpms.h</A>>
|
|
<DL COMPACT>
|
|
<DT id="1"><B>Status DPMSSetTimeouts</B>
|
|
(
|
|
<DD> Display *<I>display</I>,
|
|
<DD> CARD16 <I>standby</I>,
|
|
<DD> CARD16 <I>suspend</I>,
|
|
<DD> CARD16 <I>off</I>
|
|
);
|
|
<BR>
|
|
</DL>
|
|
</PRE><A NAME="lbAD"> </A>
|
|
<H2>ARGUMENTS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="2"><I>display</I>
|
|
|
|
<DD>
|
|
<DD>Specifies the connection to the X server
|
|
<DT id="3"><I>standby</I>
|
|
|
|
<DD>
|
|
Specifies the new standby timeout in seconds
|
|
<DT id="4"><I>suspend</I>
|
|
|
|
<DD>
|
|
Specifies the new suspend timeout in seconds
|
|
<DT id="5"><I>off</I>
|
|
|
|
<DD>
|
|
Specifies the new off timeout in seconds
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
The DPMSSetTimeouts function permits applications to set the timeout values
|
|
used by the X server for Display Power Management Signaling (DPMS) timings.
|
|
<P>
|
|
|
|
The value <I>standby</I> is the amount of inactivity time, in seconds, before
|
|
standby mode is invoked. The actual
|
|
effects of this mode are dependent on the characteristics of the monitor and
|
|
frame buffer card. Standby mode is
|
|
implemented by shutting off the horizontal sync signal, and pulsing the vertical
|
|
sync signal. Standby mode
|
|
provides the quickest monitor recovery time. Note also that many monitors
|
|
implement this mode identical to
|
|
suspend mode. A value of zero disables the standby mode.
|
|
<P>
|
|
|
|
The value <I>suspend</I> is the amount of time of inactivity, in seconds, before
|
|
the second level of power
|
|
savings is invoked. Suspend mode's physical and electrical characteristics are
|
|
implementation defined. For DPMS
|
|
compliant hardware, setting the suspend mode is implemented by pulsing the
|
|
horizontal sync signal and
|
|
shutting off the vertical sync signal. In general, suspend mode recovery is
|
|
considered to be slower than
|
|
standby mode, but faster than off mode. However it may vary from monitor to
|
|
monitor. As noted above, many
|
|
monitors implement this mode identical to the standby mode. A value of zero
|
|
disables this mode.
|
|
<P>
|
|
|
|
The value <I>off</I> is the amount of time of inactivity, in seconds, before the
|
|
third and final level of power
|
|
savings is invoked. Off mode's physical and electrical characteristics are
|
|
implementation defined. In DPMS
|
|
compliant hardware, it is implemented by shutting off both horizontal and
|
|
vertical sync signals, resulting in
|
|
powering down of the monitor. Recovery time is implementation dependent.
|
|
Usually the recovery time is very
|
|
close to the power-up time of the monitor. A value of zero disables this mode.
|
|
<P>
|
|
|
|
Chronologically, <I>standby</I> mode occurs before or simultaneously with
|
|
<I>suspend</I> mode, and
|
|
<I>suspend</I> mode must occur before or simultaneously with <I>off</I> mode.
|
|
Therefore, non-zero mode timeout
|
|
values must be greater than or equal to the timeout values of earlier modes. If
|
|
inconsistent values are
|
|
supplied, a BadValue error will result.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>RETURN VALUES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="6">TRUE<DD>
|
|
The
|
|
<I>DPMSSetTimeouts</I>
|
|
|
|
function returns TRUE when the function has succeeded.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="7"><FONT SIZE="-1">BadValue</FONT>
|
|
<DD>
|
|
An argument is out of range.
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+DPMSCapable">DPMSCapable</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+DPMSInfo">DPMSInfo</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+DPMSGetTimeouts">DPMSGetTimeouts</A></B>(3)
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="8"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="9"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="10"><A HREF="#lbAD">ARGUMENTS</A><DD>
|
|
<DT id="11"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
|
<DT id="12"><A HREF="#lbAF">RETURN VALUES</A><DD>
|
|
<DT id="13"><A HREF="#lbAG">ERRORS</A><DD>
|
|
<DT id="14"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:39 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|