\
.\" 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 "Ppmsvgalib User Manual" 0 "11 May 2005" "netpbm documentation"

.SH NAME

ppmsvgalib - display PPM image on Linux console using Svgalib

.UN synopsis
.SH SYNOPSIS

\fBppmsvgalib\fP

[\fB-mode=\fP\fImode\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
\fBppmsvgalib\fP displays a PPM image on a Linux virtual console
using the Svgalib facility.  Svgalib is a popular means of displaying
Graphics in Linux without the use of the X Window System.  (To display
a Netpbm image in an X window, see \fBpamx\fP).
.PP
If you run \fBppmsvgalib\fP with a version of Svgalib earlier than
1.9, you must run it with CAP_SYS_RAWIO capability (on most Linux
systems, that means you run it as superuser), because Svgalib uses the
\fBioperm()\fP system call to access the console hardware.  Newer
Svgalib has its own device driver, so you need only proper
permissions on a device special file to access the console.
.PP
\fBppmsvgalib\fP is not capable of using color mapped video modes.
These are the old video modes that are usually called "8
bit" color modes.
.PP
\fBppmsvgalib\fP is a bare displayer.  It won't do any
manipulation of the image and is not interactive in any way.  If you
want a regular interactive graphics viewer that uses Svgalib, try
\fBzgv\fP (not part of Netpbm).
.PP
To exit \fBppmsvgalib\fP while it is displaying your image, send
it a SIGINTR signal (normally, this means "hit control C").
.PP
\fBppmsvgalib\fP draws a white border around the edges of the
screen.  It does this to help you isolate problems between the image
you're displaying and the facilities you're using to display it.
.PP
(Note: if the image you're displaying reaches the edges of the
screen, it will replace the white border).
.PP
\fBppmsvgalib\fP places the image in the center of the screen.
.PP
If your image is too big to display in the video mode you selected,
\fBppmsvgalib\fP fails.  You can use \fBpamcut\fP to cut out a part
of the image to display or use \fBpamscale\fP to shrink the image to
fit.
.PP
If you want to play with \fBppmsvgalib\fP, \fBppmcie\fP is a good
way to generate a test image.
.PP
To be pedantic, we must observe that \fBppmsvgalib\fP displays a PPM image
in the correct colors only if the display has a transfer function which is the
exact inverse of the gamma function that is specified in the PPM
specification.  Happily, most CRT displays and the modern displays that
emulate them, are pretty close.
.PP
Running the PPM image through \fBpnmgamma\fP can help cause
\fBppmsvgalib\fP to display the correct colors.

.UN options
.SH OPTIONS


.TP
\fB-mode=\fP\fImode\fP
This tells \fBppmsvgalib\fP what video mode to use.  \fImode\fP
is the Svgalib video mode number.  You can get a list of all the video
modes and their Svgalib video mode numbers with the program
\fBvgatest\fP that is packaged with Svgalib.  (Unfortunately, the
various interesting programs that are packaged with Svgalib are
typically not installed on systems that have the Svgalib library
installed).
.sp
In practice, there are probably only two modes you'll ever care
about: 25 is the standard SVGA direct color mode, which is 1024
columns by 768 rows with 8 bit red, green, and blue components for
each pixel and no fancy options.  28 is the same, but with the popular
higher resolution of 1280 x 1024.
.sp
But if you have an older video controller (with less than 4MB of memory),
those modes aren't available, you might like mode 19, which is 640 x 480 and
takes less than a megabyte of video memory.  This is a standard VGA video
mode.



.UN seealso
.SH SEE ALSO
.BR "pamx" (1)\c
\&,
.BR "pamcut" (1)\c
\&,
.BR "pamscale" (1)\c
\&,
.BR "ppmcie" (1)\c
\&,
.BR "ppm" (5)\c
\&,
\fBzgv\fP,
\fBSvgalib\fP,
\fBvgatest\fP

.UN author
.SH AUTHOR
.PP
By Bryan Henderson, January 2002.
.PP
Contributed to the public domain.
.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/ppmsvgalib.html
.PP