| 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 XWUD 1 "xwud 1.0.6" "X Version 11" |
| 26 |
.SH NAME |
| 27 |
xwud - image displayer for X |
| 28 |
.SH SYNOPSIS |
| 29 |
.B "xwud" |
| 30 |
[\-in \fIfile\fP] [\-noclick] [\-geometry \fIgeom\fP] [\-display \fIdisplay\fP] |
| 31 |
[\-new] [\-std <maptype>] [\-raw] [\-vis <vis-type-or-id>] [\-scale] |
| 32 |
[\-help] [\-rv] [\-plane \fInumber\fP] [\-fg \fIcolor\fP] [\-bg \fIcolor\fP] |
| 33 |
[\-dumpheader] [\-version] |
| 34 |
.SH DESCRIPTION |
| 35 |
.PP |
| 36 |
.I Xwud |
| 37 |
is an X Window System image undumping utility. |
| 38 |
.I Xwud |
| 39 |
allows X users to display in a window an image saved |
| 40 |
in a specially formatted dump file, such as produced by \fIxwd(1)\fP. |
| 41 |
.SH OPTIONS |
| 42 |
.PP |
| 43 |
.TP 8 |
| 44 |
.B "\-bg \fIcolor\fP" |
| 45 |
If a bitmap image (or a single plane of an image) is displayed, this option |
| 46 |
can be used to specify the color to display for the "0" bits in the image. |
| 47 |
.PP |
| 48 |
.TP 8 |
| 49 |
.B "\-display \fIdisplay\fP" |
| 50 |
This option allows you to specify the server to connect to; see \fIX(7)\fP. |
| 51 |
.PP |
| 52 |
.TP 8 |
| 53 |
.B \-dumpheader |
| 54 |
This option prints out the XWD header information only. Nothing is displayed. |
| 55 |
.PP |
| 56 |
.TP 8 |
| 57 |
.B "\-fg \fIcolor\fP" |
| 58 |
If a bitmap image (or a single plane of an image) is displayed, this option |
| 59 |
can be used to specify the color to display for the "1" bits in the image. |
| 60 |
.PP |
| 61 |
.TP 8 |
| 62 |
.B "\-geometry \fIgeom\fP" |
| 63 |
This option allows you to specify the size and position of the window. |
| 64 |
Typically you will only want to specify the position, and let the size |
| 65 |
default to the actual size of the image. |
| 66 |
.PP |
| 67 |
.TP 8 |
| 68 |
.B "\-help" |
| 69 |
Print out a short description of the allowable options. |
| 70 |
.PP |
| 71 |
.TP 8 |
| 72 |
.B "\-in \fIfile\fP" |
| 73 |
This option allows the user to explicitly specify the input |
| 74 |
file on the command line. If no input file is given, the standard input |
| 75 |
is assumed. |
| 76 |
.PP |
| 77 |
.TP 8 |
| 78 |
.B \-new |
| 79 |
This option forces creation of a new colormap for displaying the image. |
| 80 |
If the image characteristics happen to match those of the display, this |
| 81 |
can get the image on the screen faster, but at the cost of using a new |
| 82 |
colormap (which on most displays will cause other windows to go |
| 83 |
technicolor). |
| 84 |
.PP |
| 85 |
.TP 8 |
| 86 |
.B "\-noclick" |
| 87 |
Clicking any button in the window will terminate the application, |
| 88 |
unless this option is specified. Termination can always be achieved |
| 89 |
by typing 'q', 'Q', or ctrl-c. |
| 90 |
.PP |
| 91 |
.TP 8 |
| 92 |
.B "\-plane \fInumber\fP" |
| 93 |
You can select a single bit plane of the image to display |
| 94 |
with this option. Planes are numbered with zero being the least |
| 95 |
significant bit. |
| 96 |
.PP |
| 97 |
.TP 8 |
| 98 |
.B \-raw |
| 99 |
This option forces the image to be displayed with whatever color values |
| 100 |
happen to currently exist on the screen. This option is mostly useful when |
| 101 |
undumping an image back onto the same screen that the image originally |
| 102 |
came from, while the original windows are still on the screen, and results |
| 103 |
in getting the image on the screen faster. |
| 104 |
.PP |
| 105 |
.TP 8 |
| 106 |
.B \-rv |
| 107 |
If a bitmap image (or a single plane of an image) is displayed, this option |
| 108 |
forces the foreground and background colors to be swapped. This may be |
| 109 |
needed when displaying a bitmap image which has the color sense of pixel |
| 110 |
values "0" and "1" reversed from what they are on your display. |
| 111 |
.PP |
| 112 |
.TP 8 |
| 113 |
.B \-scale |
| 114 |
Allow the window to be resized, and scale the image to the size of the window. |
| 115 |
.PP |
| 116 |
.TP 8 |
| 117 |
.B "\-std \fImaptype\fP" |
| 118 |
This option causes the image to be displayed using the specified |
| 119 |
Standard Colormap. The property name is obtained by converting the |
| 120 |
type to upper case, prepending "RGB_", and appending "_MAP". |
| 121 |
Typical types are "best", "default", and "gray". See \fIxstdcmap(1)\fP |
| 122 |
for one way of creating Standard Colormaps. |
| 123 |
.PP |
| 124 |
.TP 8 |
| 125 |
.B "\-version" |
| 126 |
This option causes |
| 127 |
.I xwd |
| 128 |
to print its version information and exit. |
| 129 |
.PP |
| 130 |
.TP 8 |
| 131 |
.B "\-vis \fIvis-type-or-id\fP" |
| 132 |
This option allows you to specify a particular visual or visual class. |
| 133 |
The default is to pick the "best" one. A particular class can be |
| 134 |
specified: "StaticGray", "GrayScale", "StaticColor", "PseudoColor", |
| 135 |
"DirectColor", or "TrueColor". Or "Match" can be specified, meaning |
| 136 |
use the same class as the source image. Alternatively, an exact |
| 137 |
visual id (specific to the server) can be specified, either as a |
| 138 |
hexadecimal number (prefixed with "0x") or as a decimal number. |
| 139 |
Finally, "default" can be specified, meaning to use the same class |
| 140 |
as the colormap of the root window. Case is not significant in |
| 141 |
any of these strings. |
| 142 |
.SH ENVIRONMENT |
| 143 |
.PP |
| 144 |
.TP 8 |
| 145 |
.B DISPLAY |
| 146 |
To get default display. |
| 147 |
.SH FILES |
| 148 |
.PP |
| 149 |
.TP 8 |
| 150 |
.B XWDFile.h |
| 151 |
X Window Dump File format definition file. |
| 152 |
.SH BUGS |
| 153 |
xwud doesn't handle big/deep images very well on servers that don't |
| 154 |
have the BIG-REQUESTS extension. |
| 155 |
.SH SEE ALSO |
| 156 |
xwd(1), xstdcmap(1), X(7) |
| 157 |
.SH AUTHOR |
| 158 |
Bob Scheifler, MIT X Consortium |
| 159 |
|
| 160 |
|