man/DPMSForceLevel.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 DPMSForceLevel __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  35 .SH NAME
  36 DPMSForceLevel \- forces a DPMS capable display into the
  37 specified power level
  38 .SH SYNOPSIS
  39 .PP
  40 .nf
  41 \fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
  42 \&#include <X11/extensions/dpms.h>
  43 .HP
  44 .BR "Status DPMSForceLevel" " ( Display \fI*display\fP\^, CARD16 \fIlevel\fP\^ );"
  45 .if n .ti +5n
  46 .if t .ti +.5i
  47 .SH ARGUMENTS
  48 .TP
  49 .I display
  50 Specifies the connection to the X server
  51 .TP
  52 .I level
  53 Specifies the level to force power to
  54 .SH DESCRIPTION
  55 .LP
  56 The
  57 .I DPMSForceLevel
  58 function forces a DPMS capable display into the specified power level.  The
  59 \fIlevel\fP must be one of following four states: DPMSModeOn, DPMSModeStandby,
  60 DPMSModeSuspend, or DPMSModeOff. Values other than these will result in a
  61 BadValue error.  If DPMS
  62 is disabled on the display, trying to set the power level on the display will
  63 result in a BadMatch
  64 protocol error.
  65 .SH "RETURN VALUES"
  66 .TP 15
  67 TRUE
  68 The
  69 .I DPMSForceLevel
  70 function always returns TRUE.
  71 .SH ERRORS
  72 .TP 15
  73 BadValue
  74 A level other than DPMSModeOn, DPMSModeStandby, DPMSModeSuspend, or DPMSModeOff
  75 was specified.
  76 .TP 15
  77 .SM BadMatch
  78 DPMS is disabled on the specified display.
  79 .SH "SEE ALSO"
  80 .BR DPMSCapable (__libmansuffix__),
  81 .BR DPMSInfo (__libmansuffix__),
  82 .BR DPMSGetTimeouts (__libmansuffix__),
  83 .BR DPMSSetTimeouts (__libmansuffix__)