Debian Codegraph @

upstream/debian-unstable/man1/xwd.1

raw
1 .\" Copyright 1988, 1994, 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 XWD 1 "xwd 1.0.9" "X Version 11"
26 .SH NAME
27 xwd - dump an image of an X window
28 .SH SYNOPSIS
29 .B "xwd"
30 [-debug] [-help] [-nobdrs] [-out \fIfile\fP] [-xy] [-frame] [-add \fIvalue\fP]
31 [-root | -id \fIwdid\fP | -name \fIwdname\fP ] [-icmap] [-screen] [-silent]
32 [-display \fIhost:dpy\fP] [-version]
33 .SH DESCRIPTION
34 .PP
35 .I Xwd
36 is an X Window System window dumping utility.
37 .I Xwd
38 allows X users to store window images in a specially formatted dump
39 file. This file can then be read by various other X utilities for
40 redisplay, printing, editing, formatting, archiving, image processing, etc.
41 The target window is selected by clicking the pointer in the desired window.
42 The keyboard bell is rung once at the beginning of the dump and twice when
43 the dump is completed.
44 .SH OPTIONS
45 .PP
46 .TP 8
47 .B "-debug"
48 Enable debug mode.
49 .PP
50 .TP 8
51 .B "-d, -display \fIhost:dpy\fP"
52 This argument allows you to specify the server to connect to; see \fIX(7)\fP.
53 .PP
54 .TP 8
55 .B "-help"
56 Print out the `Usage:' command syntax summary.
57 .PP
58 .TP 8
59 .B "-nobdrs"
60 This argument specifies that the window dump should not include the
61 pixels that compose the X window border. This is useful in situations
62 where you may wish to include the window contents in a document
63 as an illustration.
64 .PP
65 .TP 8
66 .B "-out \fIfile\fP"
67 This argument allows the user to explicitly specify the output
68 file on the command line. The default is to output to standard out.
69 .PP
70 .TP 8
71 .B "-xy"
72 This option applies to color displays only. It selects `XY' format dumping
73 instead of the default `Z' format.
74 .PP
75 .TP 8
76 .B "-add \fIvalue\fP"
77 This option specifies a signed value to be added to every pixel.
78 .PP
79 .TP 8
80 .B "-frame"
81 This option indicates that the window manager frame should be included when
82 manually selecting a window.
83 .PP
84 .TP 8
85 .B "-root"
86 This option indicates that the root window should be selected for the
87 window dump, without requiring the user to select a window with the pointer.
88 .PP
89 .TP 8
90 .B "-id \fIwdid\fP"
91 This option indicates that the window with the specified resource id
92 should be selected for the window dump, without requiring the user to
93 select a window with the pointer.
94 .PP
95 .TP 8
96 .B "-name \fIwdname\fP"
97 This option indicates that the window with the specified WM_NAME property
98 should be selected for the window dump, without requiring the user to
99 select a window with the pointer.
100 .PP
101 .TP 8
102 .B "-icmap"
103 Normally the colormap of the chosen window is used to obtain RGB values.
104 This option forces the first installed colormap of the screen to be used
105 instead.
106 .PP
107 .TP 8
108 .B "-screen"
109 This option indicates that the GetImage request used to obtain the image
110 should be done on the root window, rather than directly on the specified
111 window. In this way, you can obtain pieces of other windows that overlap
112 the specified window, and more importantly, you can capture menus or other
113 popups that are independent windows but appear over the specified window.
114 .PP
115 .TP 8
116 .B "-silent"
117 Operate silently, i.e. don't ring any bells before and after dumping
118 the window.
119 .PP
120 .TP 8
121 .B "-version"
122 This option indicates that
123 .I xwd
124 should print its version information and exit.
125 .SH ENVIRONMENT
126 .PP
127 .TP 8
128 .B DISPLAY
129 To get default host and display number.
130 .SH FILES
131 .PP
132 .TP 8
133 .B XWDFile.h
134 X Window Dump File format definition file.
135 .SH SEE ALSO
136 xwud(1), X(7)
137 .SH AUTHORS
138 Tony Della Fera, Digital Equipment Corp., MIT Project Athena
139 .br
140 William F. Wyatt, Smithsonian Astrophysical Observatory