Blame man/XSetCloseDownMode.man

Packit 5bd3a9
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit 5bd3a9
.\" a copy of this software and associated documentation files (the
Packit 5bd3a9
.\" "Software"), to deal in the Software without restriction, including
Packit 5bd3a9
.\" without limitation the rights to use, copy, modify, merge, publish,
Packit 5bd3a9
.\" distribute, sublicense, and/or sell copies of the Software, and to
Packit 5bd3a9
.\" permit persons to whom the Software is furnished to do so, subject to
Packit 5bd3a9
.\" the following conditions:
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" The above copyright notice and this permission notice shall be included
Packit 5bd3a9
.\" in all copies or substantial portions of the Software.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Packit 5bd3a9
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit 5bd3a9
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Packit 5bd3a9
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
Packit 5bd3a9
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Packit 5bd3a9
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Packit 5bd3a9
.\" OTHER DEALINGS IN THE SOFTWARE.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Except as contained in this notice, the name of the X Consortium shall
Packit 5bd3a9
.\" not be used in advertising or otherwise to promote the sale, use or
Packit 5bd3a9
.\" other dealings in this Software without prior written authorization
Packit 5bd3a9
.\" from the X Consortium.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Packit 5bd3a9
.\" Digital Equipment Corporation
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Portions Copyright \(co 1990, 1991 by
Packit 5bd3a9
.\" Tektronix, Inc.
Packit 5bd3a9
.\"
Packit 5bd3a9
.\" Permission to use, copy, modify and distribute this documentation for
Packit 5bd3a9
.\" any purpose and without fee is hereby granted, provided that the above
Packit 5bd3a9
.\" copyright notice appears in all copies and that both that copyright notice
Packit 5bd3a9
.\" and this permission notice appear in all copies, and that the names of
Packit 5bd3a9
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
Packit 5bd3a9
.\" to this documentation without specific, written prior permission.
Packit 5bd3a9
.\" Digital and Tektronix makes no representations about the suitability
Packit 5bd3a9
.\" of this documentation for any purpose.
Packit 5bd3a9
.\" It is provided ``as is'' without express or implied warranty.
Packit 5bd3a9
.\" 
Packit 5bd3a9
.\"
Packit 5bd3a9
.ds xT X Toolkit Intrinsics \- C Language Interface
Packit 5bd3a9
.ds xW Athena X Widgets \- C Language X Toolkit Interface
Packit 5bd3a9
.ds xL Xlib \- C Language X Interface
Packit 5bd3a9
.ds xC Inter-Client Communication Conventions Manual
Packit 5bd3a9
.na
Packit 5bd3a9
.de Ds
Packit 5bd3a9
.nf
Packit 5bd3a9
.\\$1D \\$2 \\$1
Packit 5bd3a9
.ft CW
Packit 5bd3a9
.\".ps \\n(PS
Packit 5bd3a9
.\".if \\n(VS>=40 .vs \\n(VSu
Packit 5bd3a9
.\".if \\n(VS<=39 .vs \\n(VSp
Packit 5bd3a9
..
Packit 5bd3a9
.de De
Packit 5bd3a9
.ce 0
Packit 5bd3a9
.if \\n(BD .DF
Packit 5bd3a9
.nr BD 0
Packit 5bd3a9
.in \\n(OIu
Packit 5bd3a9
.if \\n(TM .ls 2
Packit 5bd3a9
.sp \\n(DDu
Packit 5bd3a9
.fi
Packit 5bd3a9
..
Packit 5bd3a9
.de IN		\" send an index entry to the stderr
Packit 5bd3a9
..
Packit 5bd3a9
.de Pn
Packit 5bd3a9
.ie t \\$1\fB\^\\$2\^\fR\\$3
Packit 5bd3a9
.el \\$1\fI\^\\$2\^\fP\\$3
Packit 5bd3a9
..
Packit 5bd3a9
.de ZN
Packit 5bd3a9
.ie t \fB\^\\$1\^\fR\\$2
Packit 5bd3a9
.el \fI\^\\$1\^\fP\\$2
Packit 5bd3a9
..
Packit 5bd3a9
.de hN
Packit 5bd3a9
.ie t <\fB\\$1\fR>\\$2
Packit 5bd3a9
.el <\fI\\$1\fP>\\$2
Packit 5bd3a9
..
Packit 5bd3a9
.ny0
Packit 5bd3a9
.TH XSetCloseDownMode __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
Packit 5bd3a9
.SH NAME
Packit 5bd3a9
XSetCloseDownMode, XKillClient \- control clients
Packit 5bd3a9
.SH SYNTAX
Packit 5bd3a9
.HP
Packit 5bd3a9
int XSetCloseDownMode\^(\^Display *\fIdisplay\fP\^, int \fIclose_mode\fP\^); 
Packit 5bd3a9
.HP
Packit 5bd3a9
int XKillClient\^(\^Display *\fIdisplay\fP\^, XID \fIresource\fP\^); 
Packit 5bd3a9
.SH ARGUMENTS
Packit 5bd3a9
.IP \fIclose_mode\fP 1i
Packit 5bd3a9
Specifies the client close-down mode.
Packit 5bd3a9
You can pass 
Packit 5bd3a9
.ZN DestroyAll , 
Packit 5bd3a9
.ZN RetainPermanent , 
Packit 5bd3a9
or
Packit 5bd3a9
.ZN RetainTemporary . 
Packit 5bd3a9
.IP \fIdisplay\fP 1i
Packit 5bd3a9
Specifies the connection to the X server.
Packit 5bd3a9
.IP \fIresource\fP 1i
Packit 5bd3a9
Specifies any resource associated with the client that you want to destroy or
Packit 5bd3a9
.ZN AllTemporary .
Packit 5bd3a9
.SH DESCRIPTION
Packit 5bd3a9
The
Packit 5bd3a9
.ZN XSetCloseDownMode
Packit 5bd3a9
defines what will happen to the client's resources at connection close.
Packit 5bd3a9
A connection starts in
Packit 5bd3a9
.ZN DestroyAll
Packit 5bd3a9
mode.
Packit 5bd3a9
For information on what happens to the client's resources when the
Packit 5bd3a9
close_mode argument is
Packit 5bd3a9
.ZN RetainPermanent
Packit 5bd3a9
or
Packit 5bd3a9
.ZN RetainTemporary ,
Packit 5bd3a9
see section 2.6.
Packit 5bd3a9
.LP
Packit 5bd3a9
.ZN XSetCloseDownMode
Packit 5bd3a9
can generate a
Packit 5bd3a9
.ZN BadValue 
Packit 5bd3a9
error.
Packit 5bd3a9
.LP
Packit 5bd3a9
The
Packit 5bd3a9
.ZN XKillClient
Packit 5bd3a9
function
Packit 5bd3a9
forces a close down of the client
Packit 5bd3a9
that created the resource
Packit 5bd3a9
if a valid resource is specified.
Packit 5bd3a9
If the client has already terminated in
Packit 5bd3a9
either 
Packit 5bd3a9
.ZN RetainPermanent 
Packit 5bd3a9
or 
Packit 5bd3a9
.ZN RetainTemporary 
Packit 5bd3a9
mode, all of the client's
Packit 5bd3a9
resources are destroyed.
Packit 5bd3a9
If 
Packit 5bd3a9
.ZN AllTemporary 
Packit 5bd3a9
is specified, the resources of all clients that have terminated in
Packit 5bd3a9
.ZN RetainTemporary 
Packit 5bd3a9
are destroyed (see section 2.5).
Packit 5bd3a9
This permits implementation of window manager facilities that aid debugging.
Packit 5bd3a9
A client can set its close-down mode to
Packit 5bd3a9
.ZN RetainTemporary .
Packit 5bd3a9
If the client then crashes,
Packit 5bd3a9
its windows would not be destroyed. 
Packit 5bd3a9
The programmer can then inspect the application's window tree 
Packit 5bd3a9
and use the window manager to destroy the zombie windows.
Packit 5bd3a9
.LP
Packit 5bd3a9
.ZN XKillClient
Packit 5bd3a9
can generate a
Packit 5bd3a9
.ZN BadValue 
Packit 5bd3a9
error.
Packit 5bd3a9
.SH DIAGNOSTICS
Packit 5bd3a9
.TP 1i
Packit 5bd3a9
.ZN BadValue
Packit 5bd3a9
Some numeric value falls outside the range of values accepted by the request.
Packit 5bd3a9
Unless a specific range is specified for an argument, the full range defined
Packit 5bd3a9
by the argument's type is accepted.  Any argument defined as a set of
Packit 5bd3a9
alternatives can generate this error.
Packit 5bd3a9
.SH "SEE ALSO"
Packit 5bd3a9
\fI\*(xL\fP