| 1 |
.\" $XConsortium: xwd.man /main/21 1996/12/09 17:11:08 kaleb $ |
| 2 |
.\" Copyright (c) 1988, 1994 X Consortium |
| 3 |
.\" |
| 4 |
.\" Permission is hereby granted, free of charge, to any person obtaining |
| 5 |
.\" a copy of this software and associated documentation files (the |
| 6 |
.\" "Software"), to deal in the Software without restriction, including |
| 7 |
.\" without limitation the rights to use, copy, modify, merge, publish, |
| 8 |
.\" distribute, sublicense, and/or sell copies of the Software, and to |
| 9 |
.\" permit persons to whom the Software is furnished to do so, subject to |
| 10 |
.\" the following conditions: |
| 11 |
.\" |
| 12 |
.\" The above copyright notice and this permission notice shall be included |
| 13 |
.\" in all copies or substantial portions of the Software. |
| 14 |
.\" |
| 15 |
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS |
| 16 |
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 17 |
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 18 |
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 19 |
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 20 |
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 21 |
.\" OTHER DEALINGS IN THE SOFTWARE. |
| 22 |
.\" |
| 23 |
.\" Except as contained in this notice, the name of the X Consortium shall |
| 24 |
.\" not be used in advertising or otherwise to promote the sale, use or |
| 25 |
.\" other dealings in this Software without prior written authorization |
| 26 |
.\" from the X Consortium. |
| 27 |
.TH XWD 1 "Release 6.3" "X Version 11" |
| 28 |
.SH NAME |
| 29 |
xwintoppm - dump an image of an X window |
| 30 |
.SH SYNOPSIS |
| 31 |
.B "xwintoppm" |
| 32 |
[-debug] [-help] [-nobdrs] [-out \fIfile\fP] [-xy] [-frame] [-add \fIvalue\fP] |
| 33 |
[-root | -id \fIid\fP | -name \fIname\fP ] [-icmap] [-screen] |
| 34 |
[-display \fIdisplay\fP] |
| 35 |
.SH DESCRIPTION |
| 36 |
.PP |
| 37 |
.I Xwintoppm |
| 38 |
is an X Window System window dumping utility. |
| 39 |
.I Xwintoppm |
| 40 |
allows X users to store window images in |
| 41 |
.I ppm(5) |
| 42 |
format. |
| 43 |
This file can then be read by various other X utilities for |
| 44 |
redisplay, printing, editing, formatting, archiving, image processing, etc. |
| 45 |
.\"The target window is selected by clicking the pointer in the desired window. |
| 46 |
.\"The keyboard bell is rung once at the beginning of the dump and twice when |
| 47 |
.\"the dump is completed. |
| 48 |
.SH OPTIONS |
| 49 |
.PP |
| 50 |
.TP 8 |
| 51 |
.B "-display \fIdisplay\fP" |
| 52 |
This argument allows you to specify the server to connect to; see \fIX(1)\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 an 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 \fIid\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 \fIname\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 |
.SH ENVIRONMENT |
| 120 |
.PP |
| 121 |
.TP 8 |
| 122 |
.B DISPLAY |
| 123 |
To get default host and display number. |
| 124 |
.\".SH FILES |
| 125 |
.\".PP |
| 126 |
.\".TP 8 |
| 127 |
.\".B XWDFile.h |
| 128 |
.\"X Window Dump File format definition file. |
| 129 |
.SH SEE ALSO |
| 130 |
xwd(1), xwud(1), xpr(1), X(1), ppm(5). |
| 131 |
.SH ORIGINAL AUTHORS |
| 132 |
Tony Della Fera, Digital Equipment Corp., MIT Project Athena |
| 133 |
.br |
| 134 |
William F. Wyatt, Smithsonian Astrophysical Observatory |
| 135 |
.PP |
| 136 |
.I Xwintoppm |
| 137 |
is an tiny modification to |
| 138 |
.I Xwd |
| 139 |
program which is distributed with X11 kit. |
| 140 |
.SH MODIFICATIONS |
| 141 |
Jun-ichiro itojun Itoh, WIDE Project |