diff options
Diffstat (limited to 'man/DPMSSetTimeouts.man')
| -rw-r--r-- | man/DPMSSetTimeouts.man | 94 |
1 files changed, 43 insertions, 51 deletions
diff --git a/man/DPMSSetTimeouts.man b/man/DPMSSetTimeouts.man index 77f3af6..3be4823 100644 --- a/man/DPMSSetTimeouts.man +++ b/man/DPMSSetTimeouts.man @@ -31,90 +31,82 @@ .\" .\" X Window System is a trademark of The Open Group. .\" -.TH DPMSSetTimeouts __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.TH DPMSSetTimeouts __libmansuffix__ 2005-06-28 __xorgversion__ .SH NAME DPMSSetTimeouts \- permits applications to set the timeout values used by the X server for DPMS timings .SH SYNOPSIS -.PP .nf \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] \&#include <X11/extensions/dpms.h> -.HP -.B Status DPMSSetTimeouts -( -.br +.sp +.B Status DPMSSetTimeouts ( Display *\fIdisplay\fP\^, -.br CARD16 \fIstandby\fP\^, -.br CARD16 \fIsuspend\fP\^, -.br CARD16 \fIoff\fP\^ ); .if n .ti +5n .if t .ti +.5i .SH ARGUMENTS -.TP +.TP 15 .I display Specifies the connection to the X server -.TP +.TP 15 .I standby Specifies the new standby timeout in seconds -.TP +.TP 15 .I suspend Specifies the new suspend timeout in seconds -.TP +.TP 15 .I off Specifies the new off timeout in seconds .SH DESCRIPTION -.LP -The DPMSSetTimeouts function permits applications to set the timeout values +The +.B DPMSSetTimeouts +function permits applications to set the timeout values used by the X server for Display Power Management Signaling (DPMS) timings. .LP The value \fIstandby\fP 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. +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. .LP -The value \fIsuspend\fP 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. +The value \fIsuspend\fP 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. .LP -The value \fIoff\fP 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. +The value \fIoff\fP 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. .LP -Chronologically, \fIstandby\fP mode occurs before or simultaneously with -\fIsuspend\fP mode, and +Chronologically, +\fIstandby\fP mode occurs before or simultaneously with \fIsuspend\fP mode, and \fIsuspend\fP mode must occur before or simultaneously with \fIoff\fP 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. +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 \fBBadValue\fP error will result. .SH "RETURN VALUES" .TP 15 -TRUE +.B TRUE The .I DPMSSetTimeouts function returns TRUE when the function has succeeded. |