libXext-1.0.2/man/DPMSForceLevel.man

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