Initial commit
[xorg_rtime.git] / libXext-1.0.2 / man / DPMSDisable.man
blobf68177d2e22f197862122ab5dab3261bba87e1f5
1 .\" $XdotOrg: $
2 .\" 
3 .\" Copyright \(co Digital Equipment Corporation, 1996
4 .\" 
5 .\" Permission to use, copy, modify, distribute, and sell this
6 .\" documentation for any purpose is hereby granted without fee,
7 .\" provided that the above copyright notice and this permission
8 .\" notice appear in all copies.  Digital Equipment Corporation
9 .\" makes no representations about the suitability for any purpose
10 .\" of the information in this document.  This documentation is
11 .\" provided ``as is'' without express or implied warranty.
12 .\"
13 .\" Copyright 1999, 2005 Sun Microsystems, Inc.  All Rights Reserved
14 .\" 
15 .\" Permission is hereby granted, free of charge, to any person obtaining a
16 .\" copy of this software and associated documentation files (the "Software"),
17 .\" to deal in the Software without restriction, including without limitation
18 .\" the rights to use, copy, modify, merge, publish, distribute,
19 .\" sublicense, and/or sell copies of the Software, and to permit persons
20 .\" to whom the Software is furnished to do so, subject to the following
21 .\" conditions:
22 .\"
23 .\" The above copyright notice and this permission notice shall be
24 .\" included in all copies or substantial portions of the Software.
25 .\"
26 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
27 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
28 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
29 .\" IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
30 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
31 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
32 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 .\"
34 .\" Except as contained in this notice, the names of the copyright holders
35 .\" shall not be used in advertising or otherwise to promote the sale, use
36 .\" or other dealings in this Software without prior written authorization
37 .\" from said copyright holders.
38 .\"
39 .\" X Window System is a trademark of The Open Group.
40 .\" 
41 .TH DPMSDisable __libmansuffix__ __xorgversion__ "X FUNCTIONS"
42 .SH NAME
43 DPMSDisable \- disables DPMS on the specified display
44 .SH SYNOPSIS
45 .PP
46 .nf
47 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
48 \&#include <X11/extensions/dpms.h>
49 .HP
50 .BR "Status DPMSDisable" " ( Display \fI*display\fP\^ );"
51 .if n .ti +5n
52 .if t .ti +.5i
53 .SH ARGUMENTS
54 .TP
55 .I display
56 Specifies the connection to the X server
57 .SH DESCRIPTION
58 .LP
59 The 
60 .I DPMSDisable 
61 function disables Display Power Management Signaling (DPMS) on the specified
62 display.  When disabled, DPMS sets the display to DPMSModeOn.  If 
63 .I DPMSDisable 
64 is invoked on a display with DPMS already disabled or on a display which does 
65 not support DPMS, no change is made and no error is returned.
66 .SH "RETURN VALUES"
67 .TP 15
68 TRUE
69 The 
70 .I DPMSDisable 
71 function always returns TRUE.
72 .SH "SEE ALSO"
73 .BR DPMSCapable (__libmansuffix__),
74 .BR DPMSEnable (__libmansuffix__)