diff options
Diffstat (limited to 'libXext/man/DPMSEnable.man')
-rw-r--r-- | libXext/man/DPMSEnable.man | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/libXext/man/DPMSEnable.man b/libXext/man/DPMSEnable.man new file mode 100644 index 000000000..d52902c62 --- /dev/null +++ b/libXext/man/DPMSEnable.man @@ -0,0 +1,84 @@ +.\" $XdotOrg: $ +.\" +.\" Copyright \(co Digital Equipment Corporation, 1996 +.\" +.\" Permission to use, copy, modify, distribute, and sell this +.\" documentation for any purpose is hereby granted without fee, +.\" provided that the above copyright notice and this permission +.\" notice appear in all copies. Digital Equipment Corporation +.\" makes no representations about the suitability for any purpose +.\" of the information in this document. This documentation is +.\" provided ``as is'' without express or implied warranty. +.\" +.\" Copyright 1999, 2005 Sun Microsystems, Inc. All Rights Reserved +.\" +.\" 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 COPYRIGHT HOLDERS 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 names of the copyright holders +.\" shall not be used in advertising or otherwise to promote the sale, use +.\" or other dealings in this Software without prior written authorization +.\" from said copyright holders. +.\" +.\" X Window System is a trademark of The Open Group. +.\" +.TH DPMSEnable __libmansuffix__ __xorgversion__ "X FUNCTIONS" +.SH NAME +DPMSEnable \- enables DPMS on the specified display +.SH SYNOPSIS +.PP +.nf +\fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ] +\&#include <X11/extensions/dpms.h> +.HP +.BR "Status DPMSEnable" " ( Display *\fIdisplay\fP\^ );" +.if n .ti +5n +.if t .ti +.5i +.SH ARGUMENTS +.TP +.I display +Specifies the connection to the X server +.SH DESCRIPTION +.LP +The +.I DPMSEnable +function enables Display Power Management Signaling (DPMS) on the specified +.I display. +When DPMS is enabled, DPMS will use the currently saved timeout values. It will +trigger the appropriate DPMS power level based on the timeout values. Refer to +.I DPMSSetTimeouts. +All physical screens are affected by +.I DPMSEnable +at the same time. + +If +.I DPMSEnable +is invoked on a display which has DPMS already enabled, or on a display which +does not support DPMS, no change is made and no error is returned. +.SH "RETURN VALUES" +.TP 15 +TRUE +The +.I DPMSEnable +function always returns TRUE. +.SH "SEE ALSO" +.BR DPMSCapable (__libmansuffix__), +.BR DPMSDisable (__libmansuffix__), +.BR DPMSGetTimeouts (__libmansuffix__), +.BR DPMSSetTimeouts (__libmansuffix__) |