man/XSetCloseDownMode.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XSetCloseDownMode __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetCloseDownMode, XKillClient \- control clients
 145 .SH SYNTAX
 146 .HP
 147 int XSetCloseDownMode\^(\^Display *\fIdisplay\fP\^, int \fIclose_mode\fP\^);
 148 .HP
 149 int XKillClient\^(\^Display *\fIdisplay\fP\^, XID \fIresource\fP\^);
 150 .SH ARGUMENTS
 151 .IP \fIclose_mode\fP 1i
 152 Specifies the client close-down mode.
 153 You can pass
 154 .ZN DestroyAll ,
 155 .ZN RetainPermanent ,
 156 or
 157 .ZN RetainTemporary .
 158 .IP \fIdisplay\fP 1i
 159 Specifies the connection to the X server.
 160 .IP \fIresource\fP 1i
 161 Specifies any resource associated with the client that you want to destroy or
 162 .ZN AllTemporary .
 163 .SH DESCRIPTION
 164 The
 165 .ZN XSetCloseDownMode
 166 defines what will happen to the client's resources at connection close.
 167 A connection starts in
 168 .ZN DestroyAll
 169 mode.
 170 For information on what happens to the client's resources when the
 171 close_mode argument is
 172 .ZN RetainPermanent
 173 or
 174 .ZN RetainTemporary ,
 175 see section 2.6.
 176 .LP
 177 .ZN XSetCloseDownMode
 178 can generate a
 179 .ZN BadValue
 180 error.
 181 .LP
 182 The
 183 .ZN XKillClient
 184 function
 185 forces a close down of the client
 186 that created the resource
 187 if a valid resource is specified.
 188 If the client has already terminated in
 189 either
 190 .ZN RetainPermanent
 191 or
 192 .ZN RetainTemporary
 193 mode, all of the client's
 194 resources are destroyed.
 195 If
 196 .ZN AllTemporary
 197 is specified, the resources of all clients that have terminated in
 198 .ZN RetainTemporary
 199 are destroyed (see section 2.5).
 200 This permits implementation of window manager facilities that aid debugging.
 201 A client can set its close-down mode to
 202 .ZN RetainTemporary .
 203 If the client then crashes,
 204 its windows would not be destroyed.
 205 The programmer can then inspect the application's window tree
 206 and use the window manager to destroy the zombie windows.
 207 .LP
 208 .ZN XKillClient
 209 can generate a
 210 .ZN BadValue
 211 error.
 212 .SH DIAGNOSTICS
 213 .TP 1i
 214 .ZN BadValue
 215 Some numeric value falls outside the range of values accepted by the request.
 216 Unless a specific range is specified for an argument, the full range defined
 217 by the argument's type is accepted.  Any argument defined as a set of
 218 alternatives can generate this error.
 219 .SH "SEE ALSO"
 220 \fI\*(xL\fP