| 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 "Ppmtoilbm User Manual" 1 "15 January 2022" "netpbm documentation" |
| 7 |
|
| 8 |
.SH NAME |
| 9 |
|
| 10 |
ppmtoilbm - convert a PPM image into an ILBM file |
| 11 |
|
| 12 |
.UN synopsis |
| 13 |
.SH SYNOPSIS |
| 14 |
|
| 15 |
\fBppmtoilbm\fP |
| 16 |
|
| 17 |
[\fB-maxplanes\fP|\fB-mp\fP \fIN\fP] |
| 18 |
|
| 19 |
[\fB-fixplanes\fP|\fB-fp\fP \fIN\fP] |
| 20 |
|
| 21 |
[\fB-ham6\fP|\fB-ham8\fP] |
| 22 |
|
| 23 |
[{\fB-dcbits\fP|\fB-dcplanes\fP} \fIr\fP \fIg\fP \fIb\fP] |
| 24 |
|
| 25 |
[ |
| 26 |
\fB-normal\fP|\fB-hamif\fP|\fB-hamforce\fP|\fB-24if\fP|\fB-24force\fP| |
| 27 |
\fB-dcif\fP|\fB-dcforce\fP|\fB-cmaponly\fP |
| 28 |
] |
| 29 |
|
| 30 |
[\fB-ecs\fP|\fB-aga\fP] |
| 31 |
|
| 32 |
[\fB-compress\fP|\fB-nocompress\fP] |
| 33 |
|
| 34 |
[\fB-cmethod\fP \fItype\fP] |
| 35 |
|
| 36 |
[\fB-map\fP \fIppmfile\fP] |
| 37 |
|
| 38 |
[\fBppmfile\fP] |
| 39 |
|
| 40 |
|
| 41 |
.UN description |
| 42 |
.SH DESCRIPTION |
| 43 |
.PP |
| 44 |
This program is part of |
| 45 |
.BR "Netpbm" (1)\c |
| 46 |
\&. |
| 47 |
.PP |
| 48 |
\fBppmtoilbm\fP reads a PPM image as input. Produces an ILBM file |
| 49 |
as output. \fBppmtoilbm\fP understands the following ILBM types: |
| 50 |
|
| 51 |
|
| 52 |
|
| 53 |
.IP \(bu |
| 54 |
Normal ILBMs with 1-16 planes |
| 55 |
|
| 56 |
.IP \(bu |
| 57 |
Amiga HAM with 3-16 planes |
| 58 |
|
| 59 |
.IP \(bu |
| 60 |
24 bit |
| 61 |
|
| 62 |
.IP \(bu |
| 63 |
Color map (BMHD + CMAP chunk only, nPlanes = 0) |
| 64 |
|
| 65 |
.IP \(bu |
| 66 |
Unofficial direct color. 1-16 planes for each color component. |
| 67 |
|
| 68 |
|
| 69 |
.PP |
| 70 |
Chunks written: BMHD, CMAP, CAMG (only for HAM), BODY (not for |
| 71 |
colormap files) unofficial DCOL chunk for direct color ILBM. |
| 72 |
|
| 73 |
|
| 74 |
.UN options |
| 75 |
.SH OPTIONS |
| 76 |
.PP |
| 77 |
In addition to the options common to all programs based on libnetpbm |
| 78 |
(most notably \fB-quiet\fP, see |
| 79 |
.UR index.html#commonoptions |
| 80 |
Common Options |
| 81 |
.UE |
| 82 |
\&), \fBppmtoilbm\fP recognizes the following |
| 83 |
command line options: |
| 84 |
.PP |
| 85 |
Options marked with (*) can be prefixed with a "no", |
| 86 |
e.g. "-nohamif". All options can be abbreviated to their |
| 87 |
shortest unique prefix. |
| 88 |
|
| 89 |
|
| 90 |
.TP |
| 91 |
\fB-maxplanes\fP | \fB-mp\fP \fIn\fP |
| 92 |
(default 5, minimum 1, maximum 16) Maximum planes to write in a |
| 93 |
normal ILBM. If the image does not fit into <n> planes, |
| 94 |
ppmtoilbm writes a HAM file (if -hamif is used), a 24bit file (if |
| 95 |
-24if is used) or a direct color file (if -dcif is used) or aborts |
| 96 |
with an error. |
| 97 |
|
| 98 |
.TP |
| 99 |
\fB-fixplanes\fP | \fB-fp\fP \fIb\fP |
| 100 |
(min 1, max 16) If a normal ILBM is written, it will have exactly |
| 101 |
<n> planes. |
| 102 |
|
| 103 |
.TP |
| 104 |
\fB-hambits\fP | \fB-hamplanes\fP \fIn\fP |
| 105 |
(default 6, min 3, max 16) Select number of planes for HAM |
| 106 |
picture. The current Amiga hardware understands 6 and 8 planes, so for |
| 107 |
now you should only use this values. |
| 108 |
|
| 109 |
.TP |
| 110 |
\fB-normal\fP |
| 111 |
Turns off -hamif/-24if/-dcif, -hamforce/-24force/-dcforce and |
| 112 |
-cmaponly. Also sets compression type to byterun1. |
| 113 |
.sp |
| 114 |
This is the default. |
| 115 |
|
| 116 |
.TP |
| 117 |
\fB-hamif\fP (*) |
| 118 |
.TP |
| 119 |
\fB-24if\fP (*) |
| 120 |
.TP |
| 121 |
\fB-dcif\fP (*) |
| 122 |
Write a HAM/24bit/direct color file if the image does not fit into |
| 123 |
<maxplanes> planes. |
| 124 |
|
| 125 |
.TP |
| 126 |
\fB-hamforce\fP (*) |
| 127 |
.TP |
| 128 |
\fB-24force\fP (*) |
| 129 |
.TP |
| 130 |
\fB-dcforce\fP (*) |
| 131 |
Write a HAM/24bit/direct color file. |
| 132 |
|
| 133 |
.TP |
| 134 |
\fB-dcbits\fP \fIr\fP \fIg\fP \fIb\fP |
| 135 |
.TP |
| 136 |
\fB-dcplanes\fP \fIr\fP \fIg\fP \fIb\fP |
| 137 |
(default 5, min 1, max 16). Select number of bits for red, green |
| 138 |
and blue in a direct color ILBM. |
| 139 |
|
| 140 |
.TP |
| 141 |
\fB-ecs\fP |
| 142 |
Shortcut for: -hamplanes 6 -maxplanes 5 |
| 143 |
.sp |
| 144 |
This is the default. |
| 145 |
|
| 146 |
.TP |
| 147 |
\fB-aga\fP |
| 148 |
Shortcut for: \fB-hamplanes 8 -maxplanes 8\fP |
| 149 |
|
| 150 |
.TP |
| 151 |
\fB-ham6\fP |
| 152 |
Shortcut for: \fB-hamplanes 6 -hamforce\fP |
| 153 |
|
| 154 |
.TP |
| 155 |
\fB-ham8\fP |
| 156 |
Shortcut for: \fB-hamplanes 8 -hamforce\fP |
| 157 |
|
| 158 |
.TP |
| 159 |
\fB-compress\fP (*) |
| 160 |
This is the default. |
| 161 |
Compress the BODY chunk. The default compression method is |
| 162 |
byterun1. Compression requires building the ILBM image in memory; |
| 163 |
turning compression off allows stream-writing of the image, but the |
| 164 |
resulting file will usually be 30% to 50% larger. Another alternative |
| 165 |
is the -savemem option, this will keep memory requirements for |
| 166 |
compression at a minimum, but is very slow. |
| 167 |
|
| 168 |
.TP |
| 169 |
\fB-cmethod\fP \fBnone\fP|\fBbyterun1\fP |
| 170 |
This option does the same thing as \fB-compress\fP. |
| 171 |
|
| 172 |
.TP |
| 173 |
\fB-map\fP \fIppmfile\fP |
| 174 |
Write a normal ILBM using the colors in <ppmfile> as the |
| 175 |
colormap. The colormap file also determines the number of planes; |
| 176 |
\fB-maxplanes\fP and \fB-fixplanes\fP are ignored. |
| 177 |
|
| 178 |
.TP |
| 179 |
\fB-cmaponly\fP |
| 180 |
Write a colormap file: only BMHD and CMAP chunks, no BODY chunk, |
| 181 |
nPlanes = 0. |
| 182 |
|
| 183 |
.TP |
| 184 |
\fB-savemem\fP |
| 185 |
See the \fB-compress\fP option. |
| 186 |
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
.UN limitations |
| 191 |
.SH LIMITATIONS |
| 192 |
.PP |
| 193 |
HAM pictures will always get a grayscale colormap; a real color |
| 194 |
selection algorithm might give better results. On the other hand, |
| 195 |
this allows row-by-row operation on HAM images, and all HAM images of |
| 196 |
the same depth (no. of planes) share a common colormap, which is |
| 197 |
useful for building HAM animations. |
| 198 |
|
| 199 |
.UN references |
| 200 |
.SH REFERENCES |
| 201 |
|
| 202 |
Amiga ROM Kernel Reference Manual - Devices (3rd Ed.) |
| 203 |
Addison Wesley, ISBN 0-201-56775-X |
| 204 |
|
| 205 |
|
| 206 |
.UN seealso |
| 207 |
.SH SEE ALSO |
| 208 |
.BR "ppm" (1)\c |
| 209 |
\&, |
| 210 |
.BR "ilbmtoppm" (1)\c |
| 211 |
\& |
| 212 |
|
| 213 |
|
| 214 |
.UN history |
| 215 |
.SH HISTORY |
| 216 |
.PP |
| 217 |
For about a year in 1993-1994, there was a \fB-savemem\fP option. |
| 218 |
.PP |
| 219 |
There used to be a \fB-floyd\fP (aka \fB-fs\fP) option that was supposed |
| 220 |
to cause images to be dithered so that a larger number of colors in the PPM |
| 221 |
input could be represented in a smaller number of colors in the ILBM output. |
| 222 |
But it was never documented. Furthermore, developers discovered in January |
| 223 |
2022 that the code for this was nonfunctional because of defects, and had |
| 224 |
been for a very long time and maybe always. Finally,, this functions is not |
| 225 |
appropriate in the Netpbm philosophy, because dithering should be done by a |
| 226 |
separate dithering program, not a format conversion program. Indeed, |
| 227 |
the programs \fBppmdither\fP, \fBpnmquant\fP, and \fBpnmremap\fP can do |
| 228 |
this. |
| 229 |
.PP |
| 230 |
Therefore, since Netpbm 10.98 (March 2022), the dithering code has not been |
| 231 |
in the program and any attempt to use the options fails with a simple |
| 232 |
invalid option message. But the \fB-nofloyd\fP and \fB-nofs\fP options |
| 233 |
remain, doing nothing as they were designed to do, and still not documented. |
| 234 |
This is just in case something uses those options, since the cost of |
| 235 |
maintaining them is so small. |
| 236 |
|
| 237 |
|
| 238 |
.UN authors |
| 239 |
.SH AUTHORS |
| 240 |
.PP |
| 241 |
Copyright (C) 1989 by Jef Poskanzer. |
| 242 |
.PP |
| 243 |
Modified October 1993 by Ingo Wilken (\[email protected]\fP) |
| 244 |
.SH DOCUMENT SOURCE |
| 245 |
This manual page was generated by the Netpbm tool 'makeman' from HTML |
| 246 |
source. The master documentation is at |
| 247 |
.IP |
| 248 |
.B http://netpbm.sourceforge.net/doc/ppmtoilbm.html |
| 249 |
.PP |