| 1 |
\ |
| 2 |
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source. |
| 3 |
.\" Do not hand-hack it! If you have bug fixes or improvements, please find |
| 4 |
.\" the corresponding HTML page on the Netpbm website, generate a patch |
| 5 |
.\" against that, and send it to the Netpbm maintainer. |
| 6 |
.TH "Pamx User Manual" 1 "02 July 2011" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
pamx - display Netpbm image in X Window System window |
| 10 |
|
| 11 |
.UN synopsis |
| 12 |
.SH SYNOPSIS |
| 13 |
|
| 14 |
\fBpamx\fP |
| 15 |
|
| 16 |
[\fB-fullscreen\fP] |
| 17 |
[\fB-install\fP] |
| 18 |
[\fB-private\fP] |
| 19 |
[\fB-fit\fP] |
| 20 |
[\fB-pixmap\fP] |
| 21 |
[\fB-verbose\fP] |
| 22 |
[\fB-display=\fP\fIx-display\fP] |
| 23 |
[\fB-title=\fP\fItext\fP] |
| 24 |
[\fB-foreground=\fP\fIcolor\fP] |
| 25 |
[\fB-background=\fP\fIcolor\fP] |
| 26 |
[\fB-border=\fP\fIcolor\fP] |
| 27 |
[\fB-geometry=\fP\fIx-geometry-string\fP] |
| 28 |
[\fB-visual=\fP\fIname\fP] \fInetpbm_file\fP |
| 29 |
.PP |
| 30 |
All options can be abbreviated to their shortest unique prefix. You |
| 31 |
may use two hyphens instead of one to designate an option. You may |
| 32 |
use either white space or an equals sign between an option name and its |
| 33 |
value. |
| 34 |
|
| 35 |
.UN description |
| 36 |
.SH DESCRIPTION |
| 37 |
.PP |
| 38 |
This program is part of |
| 39 |
.BR "Netpbm" (1)\c |
| 40 |
\&. |
| 41 |
.PP |
| 42 |
\fBpamx\fP displays a Netpbm image in an X Window System window. |
| 43 |
It is like a very simple version of the classic X image viewer |
| 44 |
\fBxloadimage\fP. |
| 45 |
.PP |
| 46 |
If you don't specify the input file \fInetpbm_file\fP, the input is |
| 47 |
from Standard Input. The input image can be any Netpbm image format. |
| 48 |
If the input is a multi-image stream, \fBpamx\fP ignores all but the |
| 49 |
first image. |
| 50 |
.PP |
| 51 |
\fBpamx\fP is not the best choice for general purpose viewing of |
| 52 |
images, because it is a traditional simple Netpbm building block. It |
| 53 |
is a good thing to build into other programs and can be useful for |
| 54 |
debugging more complex systems, but you can get much more powerful |
| 55 |
viewers that can display Netpbm images. For example, \fBxloadimage\fP, |
| 56 |
\fBxli\fP, \fBxzgv\fP, and any web browser. |
| 57 |
.PP |
| 58 |
The program \fBxwud\fP (X Window Undump) is part of the X Window System |
| 59 |
and performs the same basic display function, though with input in the special |
| 60 |
X Window Dump format (for which Netpbm has converters). |
| 61 |
.PP |
| 62 |
The initial window is at most 90% of the size of the display unless |
| 63 |
the window manager does not correctly handle window size requests or |
| 64 |
if you've used the \fB-fullscreen\fP option. You may move the image |
| 65 |
around in the window by dragging with the first mouse button. The |
| 66 |
cursor will indicate which directions you may drag, if any. You may |
| 67 |
exit the window by typing 'q' or control-C when the keyboard focus is |
| 68 |
on the window. |
| 69 |
.PP |
| 70 |
\fBppmsvgalib\fP is a similar program that displays an image on a |
| 71 |
Linux system without the need for the X Window System. |
| 72 |
|
| 73 |
|
| 74 |
.UN resource |
| 75 |
.SH X RESOURCE CLASS |
| 76 |
.PP |
| 77 |
\fBpamx\fP uses the resource class name \fBXloadimage\fP for |
| 78 |
window managers which need this resource set. This is, of course, the |
| 79 |
same resource class that the conventional viewer program |
| 80 |
\fBxloadimage\fP uses. |
| 81 |
|
| 82 |
|
| 83 |
.UN options |
| 84 |
.SH OPTIONS |
| 85 |
.PP |
| 86 |
In addition to the options common to all programs based on libnetpbm |
| 87 |
(most notably \fB-quiet\fP, see |
| 88 |
.UR index.html#commonoptions |
| 89 |
Common Options |
| 90 |
.UE |
| 91 |
\&), \fBpamx\fP recognizes the following |
| 92 |
command line options: |
| 93 |
|
| 94 |
|
| 95 |
.TP |
| 96 |
\fB-border=\fP\fIcolor\fP |
| 97 |
This sets the background portion of the window which is not |
| 98 |
covered by any images to be \fIcolor\fP. |
| 99 |
|
| 100 |
.TP |
| 101 |
\fB-display=\fP\fIdisplay_name\fP |
| 102 |
This names the X display in which to put the window. E.g. \fB0:0\fP. |
| 103 |
|
| 104 |
.TP |
| 105 |
\fB-fit\fP |
| 106 |
Force image to use the default visual and colormap. This is |
| 107 |
useful if you do not want technicolor effects when the colormap focus |
| 108 |
is inside the image window, but it may reduce the quality of the |
| 109 |
displayed image. |
| 110 |
|
| 111 |
.TP |
| 112 |
\fB-fullscreen\fP |
| 113 |
Use the entire screen to display the image. |
| 114 |
|
| 115 |
.TP |
| 116 |
\fB-geometry=\fP\fIW\fP\fBx\fP\fIH\fP[{\fB+\fP,\fB-\fP}\fIX\fP{\fB+\fP,\fB-\fP}\fIY\fP |
| 117 |
This sets the size and position of the window in which \fBpamx\fP |
| 118 |
displays the image. |
| 119 |
.sp |
| 120 |
By default, the window size exactly matches the image size, except that |
| 121 |
if you don't specify \fB-fullscreen\fP, the maximum is 90% of the screen |
| 122 |
dimensions. |
| 123 |
|
| 124 |
.TP |
| 125 |
\fB-install\fP |
| 126 |
Forcibly install the image's colormap when the window is focused. |
| 127 |
This violates ICCCM standards and only exists to allow operation with |
| 128 |
naive window managers. Use this option only if your window manager |
| 129 |
does not install colormaps properly. |
| 130 |
|
| 131 |
.TP |
| 132 |
\fB-pixmap\fP |
| 133 |
Force the use of a pixmap as backing-store. This is provided for |
| 134 |
servers where backing-store is broken (such as some versions of the |
| 135 |
AIXWindows server). It may improve scrolling performance on servers |
| 136 |
which provide backing-store. |
| 137 |
|
| 138 |
.TP |
| 139 |
\fB-private\fP |
| 140 |
Force \fBpamx\fP to use of a private colormap. By default, |
| 141 |
\fBpamx\fP allocates colors shared unless there are not enough colors |
| 142 |
available. |
| 143 |
|
| 144 |
.TP |
| 145 |
\fB-verbose\fP |
| 146 |
Causes \fBpamx\fP to print various information about what it's |
| 147 |
doing to Standard Error. |
| 148 |
|
| 149 |
.TP |
| 150 |
\fB-visual=\fP\fIvisual_name\fP |
| 151 |
Force the use of a specific visual type to display an image. By |
| 152 |
default, \fBpamx\fP tries to pick the best available image for a |
| 153 |
particular image type. The available visual types are: |
| 154 |
\fBDirectColor\fP, \fBTrueColor\fP, \fBPseudoColor\fP, |
| 155 |
\fBStaticColor\fP, \fBGrayScale\fP, and \fBStaticGray\fP. |
| 156 |
You may use the shortest unique prefix of these names, and case is |
| 157 |
not significant. |
| 158 |
|
| 159 |
.TP |
| 160 |
\fB-background=\fP\fIcolor\fP |
| 161 |
Use \fIcolor\fP as the background color instead of the default |
| 162 |
(usually white but this depends on the image type) if you are |
| 163 |
transferring a monochrome image to a color display. |
| 164 |
|
| 165 |
.TP |
| 166 |
\fB-foreground=\fP\fIcolor\fP |
| 167 |
Use \fIcolor\fP as the foreground color instead of black if you are |
| 168 |
transferring a monochrome image to a color display. You can also use |
| 169 |
this to invert the foreground and background colors of a monochrome |
| 170 |
image. |
| 171 |
|
| 172 |
.TP |
| 173 |
\fB-title=\fP\fItext\fP |
| 174 |
Set the title bar title of the window. Default is the file name of |
| 175 |
the input file, or "stdin" if the image is from Standard Input. |
| 176 |
|
| 177 |
|
| 178 |
|
| 179 |
.UN seealso |
| 180 |
.SH SEE ALSO |
| 181 |
.BR "ppmsvgalib" (1)\c |
| 182 |
\&, |
| 183 |
.BR "pam" (1)\c |
| 184 |
\&, |
| 185 |
.BR "pnm" (1)\c |
| 186 |
\&, |
| 187 |
\fBxzgv\fP, |
| 188 |
\fBxwud\fP, |
| 189 |
\fBxloadimage\fP, |
| 190 |
\fBxli\fP |
| 191 |
|
| 192 |
|
| 193 |
.UN author |
| 194 |
.SH AUTHOR |
| 195 |
.PP |
| 196 |
\fBpamx\fP is by Bryan Henderson, in March 2006, based on |
| 197 |
\fBxloadimage\fP by Jim Frost, Centerline Software, |
| 198 |
[email protected], 1989-1993. |
| 199 |
.PP |
| 200 |
Jim's code contained the following copyright notice and license: |
| 201 |
|
| 202 |
.RS |
| 203 |
.PP |
| 204 |
Copyright 1989, 1993 Jim Frost |
| 205 |
|
| 206 |
.PP |
| 207 |
Permission to use, copy, modify, distribute, and sell this software |
| 208 |
and its documentation for any purpose is hereby granted without fee, |
| 209 |
provided that the above copyright notice appear in all copies and that |
| 210 |
both that copyright notice and this permission notice appear in |
| 211 |
supporting documentation. The author makes no representations about |
| 212 |
the suitability of this software for any purpose. It is provided "as |
| 213 |
is" without express or implied warranty. |
| 214 |
|
| 215 |
.PP |
| 216 |
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, |
| 217 |
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO |
| 218 |
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR |
| 219 |
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF |
| 220 |
USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR |
| 221 |
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR |
| 222 |
PERFORMANCE OF THIS SOFTWARE. |
| 223 |
|
| 224 |
.RE |
| 225 |
.PP |
| 226 |
Lots of other people contributed to Xloadimage, and they are listed |
| 227 |
in the file COPYRIGHT in the source code. |
| 228 |
|
| 229 |
|
| 230 |
.UN history |
| 231 |
.SH HISTORY |
| 232 |
.PP |
| 233 |
\fBpamx\fP was new in Netpbm 10.34 (May 2006). |
| 234 |
.PP |
| 235 |
\fBpamx\fP is essentially based on the classic X displayer program |
| 236 |
\fBxloadimage\fP by Jim Frost, 1989. Bryan Henderson stripped it |
| 237 |
down and adapted it to Netpbm in March 2006. |
| 238 |
.PP |
| 239 |
The following features of \fBxloadimage\fP are left out of \fBpamx\fP, |
| 240 |
to be more compatible with Netpbm's philosophy of simple building blocks. |
| 241 |
Note that there are other programs in Netpbm that do most of these things: |
| 242 |
|
| 243 |
.IP \(bu |
| 244 |
zoom in/out |
| 245 |
.IP \(bu |
| 246 |
ability to accept formats other than Netpbm |
| 247 |
.IP \(bu |
| 248 |
image transformations (brightening, clipping, rotating, etc) |
| 249 |
.IP \(bu |
| 250 |
decompressing and other decoding of input |
| 251 |
.IP \(bu |
| 252 |
ability to display on the root window |
| 253 |
.IP \(bu |
| 254 |
slide show |
| 255 |
|
| 256 |
|
| 257 |
\fBpamx\fP also differs from \fBxloadimage\fP in that it uses |
| 258 |
Libnetpbm. |
| 259 |
.PP |
| 260 |
There is virtually no code from \fBxloadimage\fP actually in |
| 261 |
\fBpamx\fP, because Bryan rewrote it all to make it easier to |
| 262 |
understand. |
| 263 |
.SH DOCUMENT SOURCE |
| 264 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 265 |
source. The master documentation is at |
| 266 |
.IP |
| 267 |
.B http://netpbm.sourceforge.net/doc/pamx.html |
| 268 |
.PP |