Plan 9 from Bell Labs’s /usr/web/sources/contrib/pac/sys/doc/netpbm/ms/ppmsvgalib.ms

Copyright © 2021 Plan 9 Foundation.
Distributed under the MIT License.
Download the Plan 9 distribution.


.TL
Ppmsvgalib User Manual
.SH 1
ppmsvgalib
.LP
Updated: 11 May 2005
.br
Table Of Contents
.SH 2
NAME
.LP
ppmsvgalib - display PPM image on Linux console using Svgalib
.SH 2
SYNOPSIS
.LP
\fBppmsvgalib\fR
[\fB-mode=\fR\fImode\fR]
.LP
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.
.SH 2
DESCRIPTION
.LP
.LP
This program is part of Netpbm.
\fBppmsvgalib\fR 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\fR).
.LP
If you run \fBppmsvgalib\fR 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()\fR 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.
.LP
\fBppmsvgalib\fR is not capable of using color mapped video modes.
These are the old video modes that are usually called "8
bit" color modes.
.LP
\fBppmsvgalib\fR 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\fR (not part of Netpbm).
.LP
To exit \fBppmsvgalib\fR while it is displaying your image, send
it a SIGINTR signal (normally, this means "hit control C").
.LP
\fBppmsvgalib\fR 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.
.LP
(Note: if the image you're displaying reaches the edges of the
screen, it will replace the white border).
.LP
\fBppmsvgalib\fR places the image in the center of the screen.
.LP
If your image is too big to display in the video mode you selected,
\fBppmsvgalib\fR fails.  You can use \fBpamcut\fR to cut out a part
of the image to display or use \fBpamscale\fR to shrink the image to
fit.
.LP
If you want to play with \fBppmsvgalib\fR, \fBppmcie\fR is a good
way to generate a test image.
.LP
To be pedantic, we must observe that \fBppmsvgalib\fR 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 are
pretty close.
.LP
Running the PPM image through \fBpnmgamma\fR can help cause
\fBppmsvgalib\fR to display the correct colors.
.SH 2
OPTIONS
.LP
.RS
.IP "\fB-mode=\fR\fImode\fR"
This tells \fBppmsvgalib\fR what video mode to use.  \fImode\fR
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\fR 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).
.LP
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.
.LP
But if you have an older video controller (with less than 4MB of
memory), those modes aren't available and 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.
.RE
.SH 2
SEE ALSO
.LP
\fBpamx\fR,
\fBpamcut\fR,
\fBpamscale\fR,
\fBppmcie\fR,
\fBppm\fR,
\fBzgv\fR,
\fBSvgalib\fR,
\fBvgatest\fR
.SH 2
AUTHOR
.LP
.LP
By Bryan Henderson, January 2002.
.LP
Contributed to the public domain.
.br
\l'5i'
.SH 2
Table Of Contents
.LP
.IP \(bu
SYNOPSIS
.IP \(bu
DESCRIPTION
.IP \(bu
OPTIONS
.IP \(bu
SEE ALSO
.IP \(bu
AUTHOR
.LP

Bell Labs OSI certified Powered by Plan 9

(Return to Plan 9 Home Page)

Copyright © 2021 Plan 9 Foundation. All Rights Reserved.
Comments to webmaster@9p.io.