man/DPMSEnable.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 .\" X Window System is a trademark of The Open Group.
  33 .\"
  34 .TH DPMSEnable __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSEnable \- enables DPMS on the specified display
  37 .SH SYNOPSIS
  38 .PP
  39 .nf
  40 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  41 \&#include <X11/extensions/dpms.h>
  42 .HP
  43 .BR "Status DPMSEnable" " ( Display *\fIdisplay\fP\^ );"
  44 .if n .ti +5n
  45 .if t .ti +.5i
  46 .SH ARGUMENTS
  47 .TP
  48 .I display
  49 Specifies the connection to the X server
  50 .SH DESCRIPTION
  51 .LP
  52 The
  53 .I DPMSEnable
  54 function enables Display Power Management Signaling (DPMS) on the specified
  55 .I display.
  56 When DPMS is enabled, DPMS will use the currently saved timeout values. It will
  57 trigger the appropriate DPMS power level based on the timeout values. Refer to
  58 .I DPMSSetTimeouts.
  59 All physical screens are affected by
  60 .I DPMSEnable
  61 at the same time.
  62
  63 If
  64 .I DPMSEnable
  65 is invoked on a display which has DPMS already enabled, or on a display which
  66 does not support DPMS, no change is made and no error is returned.
  67 .SH "RETURN VALUES"
  68 .TP 15
  69 TRUE
  70 The
  71 .I DPMSEnable
  72 function always returns TRUE.
  73 .SH "SEE ALSO"
  74 .BR DPMSCapable (__libmansuffix__),
  75 .BR DPMSDisable (__libmansuffix__),
  76 .BR DPMSGetTimeouts (__libmansuffix__),
  77 .BR DPMSSetTimeouts (__libmansuffix__)