Debian Codegraph @

upstream/opensuse-tumbleweed/man1/ppmsvgalib.1

raw
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 "Ppmsvgalib User Manual" 0 "11 May 2005" "netpbm documentation"
7
8 .SH NAME
9
10 ppmsvgalib - display PPM image on Linux console using Svgalib
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBppmsvgalib\fP
16
17 [\fB-mode=\fP\fImode\fP]
18 [\fB-verbose\fP]
19 .PP
20 All options can be abbreviated to their shortest unique prefix. You
21 may use two hyphens instead of one to designate an option. You may
22 use either white space or an equals sign between an option name and its
23 value.
24
25
26 .UN description
27 .SH DESCRIPTION
28 .PP
29 This program is part of
30 .BR "Netpbm" (1)\c
31 \&.
32 .PP
33 \fBppmsvgalib\fP displays a PPM image on a Linux virtual console
34 using the Svgalib facility. Svgalib is a popular means of displaying
35 Graphics in Linux without the use of the X Window System. (To display
36 a Netpbm image in an X window, see \fBpamx\fP).
37 .PP
38 If you run \fBppmsvgalib\fP with a version of Svgalib earlier than
39 1.9, you must run it with CAP_SYS_RAWIO capability (on most Linux
40 systems, that means you run it as superuser), because Svgalib uses the
41 \fBioperm()\fP system call to access the console hardware. Newer
42 Svgalib has its own device driver, so you need only proper
43 permissions on a device special file to access the console.
44 .PP
45 \fBppmsvgalib\fP is not capable of using color mapped video modes.
46 These are the old video modes that are usually called "8
47 bit" color modes.
48 .PP
49 \fBppmsvgalib\fP is a bare displayer. It won't do any
50 manipulation of the image and is not interactive in any way. If you
51 want a regular interactive graphics viewer that uses Svgalib, try
52 \fBzgv\fP (not part of Netpbm).
53 .PP
54 To exit \fBppmsvgalib\fP while it is displaying your image, send
55 it a SIGINTR signal (normally, this means "hit control C").
56 .PP
57 \fBppmsvgalib\fP draws a white border around the edges of the
58 screen. It does this to help you isolate problems between the image
59 you're displaying and the facilities you're using to display it.
60 .PP
61 (Note: if the image you're displaying reaches the edges of the
62 screen, it will replace the white border).
63 .PP
64 \fBppmsvgalib\fP places the image in the center of the screen.
65 .PP
66 If your image is too big to display in the video mode you selected,
67 \fBppmsvgalib\fP fails. You can use \fBpamcut\fP to cut out a part
68 of the image to display or use \fBpamscale\fP to shrink the image to
69 fit.
70 .PP
71 If you want to play with \fBppmsvgalib\fP, \fBppmcie\fP is a good
72 way to generate a test image.
73 .PP
74 To be totally precise, we must observe that \fBppmsvgalib\fP displays a
75 PPM image in the correct colors only if the display has a transfer function
76 which is the exact inverse of the gamma function that is specified in the PPM
77 specification. Happily, most CRT displays and the modern displays that
78 emulate them, are pretty close.
79 .PP
80 Running the PPM image through \fBpnmgamma\fP can help cause
81 \fBppmsvgalib\fP to display the correct colors.
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 \&), \fBppmsvgalib\fP recognizes the following
92 command line options:
93
94
95 .TP
96 \fB-mode=\fP\fImode\fP
97 This tells \fBppmsvgalib\fP what video mode to use. \fImode\fP
98 is the Svgalib video mode number. You can get a list of all the video
99 modes and their Svgalib video mode numbers with the program
100 \fBvgatest\fP that is packaged with Svgalib. (Unfortunately, the
101 various interesting programs that are packaged with Svgalib are
102 typically not installed on systems that have the Svgalib library
103 installed).
104 .sp
105 In practice, there are probably only two modes you'll ever care
106 about: 25 is the standard SVGA direct color mode, which is 1024
107 columns by 768 rows with 8 bit red, green, and blue components for
108 each pixel and no fancy options. 28 is the same, but with the popular
109 higher resolution of 1280 x 1024.
110 .sp
111 But if you have an older video controller (with less than 4MB of memory),
112 those modes aren't available, you might like mode 19, which is 640 x 480 and
113 takes less than a megabyte of video memory. This is a standard VGA video
114 mode.
115
116 .TP
117 \fB-verbose\fP
118 Report details of the video mode to standard error output.
119
120
121
122 .UN seealso
123 .SH SEE ALSO
124 .BR "pamx" (1)\c
125 \&,
126 .BR "pamcut" (1)\c
127 \&,
128 .BR "pamscale" (1)\c
129 \&,
130 .BR "ppmcie" (1)\c
131 \&,
132 .BR "ppm" (5)\c
133 \&,
134 \fBzgv\fP,
135 \fBSvgalib\fP,
136 \fBvgatest\fP
137
138 .UN author
139 .SH AUTHOR
140 .PP
141 By Bryan Henderson, January 2002.
142 .PP
143 Contributed to the public domain.
144 .SH DOCUMENT SOURCE
145 This manual page was generated by the Netpbm tool 'makeman' from HTML
146 source. The master documentation is at
147 .IP
148 .B http://netpbm.sourceforge.net/doc/ppmsvgalib.html
149 .PP