libXext-1.0.2/man/DPMSInfo.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 DPMSInfo __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  42 .SH NAME
  43 DPMSInfo \- returns information about the current DPMS state
  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 .B Status DPMSInfo
  51 (
  52 .br
  53       Display \fI*display\fP\^,
  54 .br
  55       CARD16 \fI*power_level\fP\^,
  56 .br
  57       BOOL \fI*state\fP\^
  58 );
  59 .if n .ti +5n
  60 .if t .ti +.5i
  61 .SH ARGUMENTS
  62 .TP
  63 .I display
  64 Specifies the connection to the X server
  65 .TP
  66 .I power_level
  67 Specifies the current power level
  68 .TP
  69 .I state
  70 Specifies the current DPMS state
  71 .SH DESCRIPTION
  72 .LP
  73 The
  74 .I DPMSInfo
  75 function returns information about the current Display Power Management
  76 Signaling (DPMS) state. The \fIstate\fP
  77 return parameter indicates whether or not DPMS is enabled \^(TRUE\^) or
  78 disabled \^(FALSE\^). The \fIpower_level\fP return parameter indicates the
  79 current power level \^(one of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend, or
  80 DPMSModeOff.\^)
  81 .SH "RETURN VALUES"
  82 .TP 15
  83 TRUE
  84 The
  85 .I DPMSInfo
  86 function returns TRUE, if values are returned.
  87 .TP 15
  88 FALSE
  89 The
  90 .I DPMSInfo
  91 function returns FALSE, if no values are returned.
  92 .SH "SEE ALSO"
  93 .BR DPMSEnable (__libmansuffix__)