man/DPMSCapable.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 (c) 1999, 2005, Oracle and/or its affiliates. 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 DPMSCapable __libmansuffix__ __xorgversion__ "X FUNCTIONS"
  33 .SH NAME
  34 DPMSCapable \- returns the DPMS capability of the X server
  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 "Bool DPMSCapable" " ( Display *\fIdisplay\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 DPMSCapable
  52 function returns the Display Power Management Signaling (DPMS) capability of
  53 the X server, either TRUE \^(capable of DPMS\^) or FALSE \^(incapable of
  54 DPMS\^).
  55 .SH "RETURN VALUES"
  56 .TP 15
  57 True
  58 The
  59 .I DPMSCapable
  60 function returns True if the X server is capable of DPMS.
  61 .TP 15
  62 False
  63 The
  64 .I DPMSCapable
  65 function returns True if the X server is incapable of DPMS.