Git init
[framework/uifw/xorg/lib/libxext.git] / man / DPMSDisable.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 .TH DPMSDisable __libmansuffix__ __xorgversion__ "X FUNCTIONS"
33 .SH NAME
34 DPMSDisable \- disables DPMS on the specified display
35 .SH SYNOPSIS
36 .PP
37 .nf
38 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
39 \&#include <X11/extensions/dpms.h>
40 .HP
41 .BR "Status DPMSDisable" " ( Display \fI*display\fP\^ );"
42 .if n .ti +5n
43 .if t .ti +.5i
44 .SH ARGUMENTS
45 .TP
46 .I display
47 Specifies the connection to the X server
48 .SH DESCRIPTION
49 .LP
50 The 
51 .I DPMSDisable 
52 function disables Display Power Management Signaling (DPMS) on the specified
53 display.  When disabled, DPMS sets the display to DPMSModeOn.  If 
54 .I DPMSDisable 
55 is invoked on a display with DPMS already disabled or on a display which does 
56 not support DPMS, no change is made and no error is returned.
57 .SH "RETURN VALUES"
58 .TP 15
59 TRUE
60 The 
61 .I DPMSDisable 
62 function always returns TRUE.
63 .SH "SEE ALSO"
64 .BR DPMSCapable (__libmansuffix__),
65 .BR DPMSEnable (__libmansuffix__)