path: root/upstream/fedora-40/man1/pamx.1

\
.\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
.\" Do not hand-hack it!  If you have bug fixes or improvements, please find
.\" the corresponding HTML page on the Netpbm website, generate a patch
.\" against that, and send it to the Netpbm maintainer.
.TH "Pamx User Manual" 0 "02 July 2011" "netpbm documentation"

.SH NAME
pamx - display Netpbm image in X Window System window

.UN synopsis
.SH SYNOPSIS

\fBpamx\fP

[\fB-fullscreen\fP]
[\fB-install\fP]
[\fB-private\fP]
[\fB-fit\fP]
[\fB-pixmap\fP]
[\fB-verbose\fP]
[\fB-display=\fP\fIx-display\fP]
[\fB-title=\fP\fItext\fP]
[\fB-foreground=\fP\fIcolor\fP]
[\fB-background=\fP\fIcolor\fP]
[\fB-border=\fP\fIcolor\fP]
[\fB-geometry=\fP\fIx-geometry-string\fP]
[\fB-visual=\fP\fIname\fP] \fInetpbm_file\fP
.PP
All options can be abbreviated to their shortest unique prefix.  You
may use two hyphens instead of one to designate an option.  You may
use either white space or an equals sign between an option name and its
value.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpamx\fP displays a Netpbm image in an X Window System window.
It is like a very simple version of the classic X image viewer
\fBxloadimage\fP.
.PP
If you don't specify the input file \fInetpbm_file\fP, the input is
from Standard Input.  The input image can be any Netpbm image format.
If the input is a multi-image stream, \fBpamx\fP ignores all but the
first image.
.PP
\fBpamx\fP is not the best choice for general purpose viewing of
images, because it is a traditional simple Netpbm building block.  It
is a good thing to build into other programs and can be useful for
debugging more complex systems, but you can get much more powerful
viewers that can display Netpbm images.  For example, \fBxloadimage\fP,
\fBxli\fP, \fBxzgv\fP, and any web browser.
.PP
The program \fBxwud\fP (X Window Undump) is part of the X Window System
and performs the same basic display function, though with input in the special
X Window Dump format (for which Netpbm has converters).
.PP
The initial window is at most 90% of the size of the display unless
the window manager does not correctly handle window size requests or
if you've used the \fB-fullscreen\fP option.  You may move the image
around in the window by dragging with the first mouse button.  The
cursor will indicate which directions you may drag, if any.  You may
exit the window by typing 'q' or control-C when the keyboard focus is
on the window.
.PP
\fBppmsvgalib\fP is a similar program that displays an image on a
Linux system without the need for the X Window System.


.UN resource
.SH X RESOURCE CLASS
.PP
\fBpamx\fP uses the resource class name \fBXloadimage\fP for
window managers which need this resource set.  This is, of course, the
same resource class that the conventional viewer program
\fBxloadimage\fP uses.


.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBpamx\fP recognizes the following
command line options:


.TP
\fB-border=\fP\fIcolor\fP
This sets the background portion of the window which is not
covered by any images to be \fIcolor\fP.

.TP
\fB-display=\fP\fIdisplay_name\fP
This names the X display in which to put the window.  E.g. \fB0:0\fP.

.TP
\fB-fit\fP
Force image to use the default visual and colormap.  This is
useful if you do not want technicolor effects when the colormap focus
is inside the image window, but it may reduce the quality of the
displayed image.

.TP
\fB-fullscreen\fP
Use the entire screen to display the image.

.TP
\fB-geometry=\fP\fIW\fP\fBx\fP\fIH\fP[{\fB+\fP,\fB-\fP}\fIX\fP{\fB+\fP,\fB-\fP}\fIY\fP
This sets the size and position of the window in which \fBpamx\fP
displays the image.
.sp
By default, the window size exactly matches the image size, except that
if you don't specify \fB-fullscreen\fP, the maximum is 90% of the screen
dimensions.

.TP
\fB-install\fP
Forcibly install the image's colormap when the window is focused.
This violates ICCCM standards and only exists to allow operation with
naive window managers.  Use this option only if your window manager
does not install colormaps properly.

.TP
\fB-pixmap\fP
Force the use of a pixmap as backing-store.  This is provided for
servers where backing-store is broken (such as some versions of the
AIXWindows server).  It may improve scrolling performance on servers
which provide backing-store.

.TP
\fB-private\fP
Force \fBpamx\fP to use of a private colormap.  By default,
\fBpamx\fP allocates colors shared unless there are not enough colors
available.

.TP
\fB-verbose\fP
Causes \fBpamx\fP to print various information about what it's
doing to Standard Error.

.TP
\fB-visual=\fP\fIvisual_name\fP
Force the use of a specific visual type to display an image.  By
default, \fBpamx\fP tries to pick the best available image for a
particular image type.  The available visual types are:
\fBDirectColor\fP, \fBTrueColor\fP, \fBPseudoColor\fP,
\fBStaticColor\fP, \fBGrayScale\fP, and \fBStaticGray\fP.
You may use the shortest unique prefix of these names, and case is
not significant.

.TP
\fB-background=\fP\fIcolor\fP
Use \fIcolor\fP as the background color instead of the default
(usually white but this depends on the image type) if you are
transferring a monochrome image to a color display.

.TP
\fB-foreground=\fP\fIcolor\fP
Use \fIcolor\fP as the foreground color instead of black if you are
transferring a monochrome image to a color display.  You can also use
this to invert the foreground and background colors of a monochrome
image.

.TP
\fB-title=\fP\fItext\fP
Set the title bar title of the window.  Default is the file name of
the input file, or "stdin" if the image is from Standard Input.



.UN seealso
.SH SEE ALSO
.BR "ppmsvgalib" (1)\c
\&,
.BR "pam" (1)\c
\&,
.BR "pnm" (1)\c
\&,
\fBxzgv\fP,
\fBxwud\fP,
\fBxloadimage\fP,
\fBxli\fP


.UN author
.SH AUTHOR
.PP
\fBpamx\fP is by Bryan Henderson, in March 2006, based on
\fBxloadimage\fP by Jim Frost, Centerline Software,
jimf@centerline.com, 1989-1993.
.PP
Jim's code contained the following copyright notice and license:

.RS
.PP
Copyright 1989, 1993 Jim Frost
   
.PP
Permission to use, copy, modify, distribute, and sell this software
and its documentation for any purpose is hereby granted without fee,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in
supporting documentation.  The author makes no representations about
the suitability of this software for any purpose.  It is provided "as
is" without express or implied warranty.
   
.PP
THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.

.RE
.PP
Lots of other people contributed to Xloadimage, and they are listed
in the file COPYRIGHT in the source code.


.UN history
.SH HISTORY
.PP
\fBpamx\fP was new in Netpbm 10.34 (May 2006).
.PP
\fBpamx\fP is essentially based on the classic X displayer program
\fBxloadimage\fP by Jim Frost, 1989.  Bryan Henderson stripped it
down and adapted it to Netpbm in March 2006.
.PP
The following features of \fBxloadimage\fP are left out of \fBpamx\fP,
to be more compatible with Netpbm's philosophy of simple building blocks.
Note that there are other programs in Netpbm that do most of these things:

.IP \(bu
zoom in/out
.IP \(bu
ability to accept formats other than Netpbm
.IP \(bu
image transformations (brightening, clipping, rotating, etc)
.IP \(bu
decompressing and other decoding of input
.IP \(bu
ability to display on the root window
.IP \(bu
slide show


\fBpamx\fP also differs from \fBxloadimage\fP in that it uses
Libnetpbm.
.PP
There is virtually no code from \fBxloadimage\fP actually in
\fBpamx\fP, because Bryan rewrote it all to make it easier to
understand.
.SH DOCUMENT SOURCE
This manual page was generated by the Netpbm tool 'makeman' from HTML
source.  The master documentation is at
.IP
.B http://netpbm.sourceforge.net/doc/pamx.html
.PP