Tizen 2.0 Release
[framework/uifw/xorg/util/x11-xserver-utils.git] / xkill / xkill.man
1 .\" Copyright 1988, 1998  The Open Group
2 .\" 
3 .\" Permission to use, copy, modify, distribute, and sell this software and its
4 .\" documentation for any purpose is hereby granted without fee, provided that
5 .\" the above copyright notice appear in all copies and that both that
6 .\" copyright notice and this permission notice appear in supporting
7 .\" documentation.
8 .\" 
9 .\" The above copyright notice and this permission notice shall be included
10 .\" in all copies or substantial portions of the Software.
11 .\" 
12 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
13 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
14 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
15 .\" IN NO EVENT SHALL THE OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR
16 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
17 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
18 .\" OTHER DEALINGS IN THE SOFTWARE.
19 .\" 
20 .\" Except as contained in this notice, the name of The Open Group shall
21 .\" not be used in advertising or otherwise to promote the sale, use or
22 .\" other dealings in this Software without prior written authorization
23 .\" from The Open Group.
24 .\"
25 .TH XKILL 1 __xorgversion__
26 .SH NAME
27 xkill - kill a client by its X resource
28 .SH SYNOPSIS
29 .B "xkill"
30 [\-display \fIdisplayname\fP] [\-id \fIresource\fP] [\-button number] [\-frame] [\-all] 
31 .SH DESCRIPTION
32 .PP
33 .I Xkill
34 is a utility for forcing the X server to close connections to clients.  This
35 program is very dangerous, but is useful for aborting programs that have 
36 displayed undesired windows on a user's screen.  If no resource identifier
37 is given with \fI-id\fP, \fIxkill\fP will display a special cursor
38 as a prompt for the user to select a window to be killed.  If a pointer button
39 is pressed over a non-root window, the server will close its connection to
40 the client that created the window.
41 .SH OPTIONS
42 .TP 8
43 .B \-display \fIdisplayname\fP
44 This option specifies the name of the X server to contact.
45 .TP 8
46 .B \-id \fIresource\fP
47 This option specifies the X identifier for the resource whose creator is
48 to be aborted.  If no resource is specified, \fIxkill\fP will display a 
49 special cursor with which you should select a window to be kill.
50 .TP 8
51 .B \-button \fInumber\fP
52 This option specifies the number of pointer button
53 that should be used in selecting a window to kill.  
54 If the word "any" is specified, any button on the pointer may be used.  By
55 default, the first button in the pointer map (which is usually the leftmost
56 button) is used.
57 .TP 8
58 .B \-all
59 This option indicates that all clients with top-level windows on the screen
60 should be killed.  \fIXkill\fP will ask you to select the root window with 
61 each of the currently defined buttons to give you several chances to abort.
62 Use of this option is highly discouraged.
63 .TP 8
64 .B \-frame
65 This option indicates that xkill should ignore the standard conventions for
66 finding top-level client windows (which are typically nested inside a window
67 manager window), and simply believe that you want to kill direct children of
68 the root.
69 .SH CAVEATS
70 This command does not provide any warranty that the application whose
71 connection to the X server is closed will abort nicely, or even abort
72 at all. All this command does is to close the connection to the X
73 server. Many existing applications do indeed abort when their
74 connection to the X server is closed, but some can choose to
75 continue.
76 .SH XDEFAULTS
77 .TP 8
78 .B Button
79 Specifies a specific pointer button number or the word "any" to use when 
80 selecting windows.
81 .SH "SEE ALSO"
82 X(__miscmansuffix__), xwininfo(1), XKillClient and XGetPointerMapping in the Xlib Programmers 
83 Manual, KillClient in the X Protocol Specification
84 .SH AUTHOR
85 Jim Fulton, MIT X Consortium
86 .br
87 Dana Chee, Bellcore