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

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


.TL
Ppmtoilbm User Manual
.SH 1
ppmtoilbm
.LP
Updated: 31 October 1993
.br
Table Of Contents
.SH 2
NAME
.LP
ppmtoilbm - convert a PPM image into an ILBM file
.SH 2
SYNOPSIS
.LP
\fBppmtoilbm\fR
[\fB-maxplanes\fR|\fB-mp\fR \fIN\fR]
[\fB-fixplanes\fR|\fB-fp\fR \fIN\fR]
[\fB-ham6\fR|\fB-ham8\fR]
[{\fB-dcbits\fR|\fB-dcplanes\fR} \fIr\fR \fIg\fR \fIb\fR]
[
\fB-normal\fR|\fB-hamif\fR|\fB-hamforce\fR|\fB-24if\fR|\fB-24force\fR|
\fB-dcif\fR|\fB-dcforce\fR|\fB-cmaponly\fR
]
[\fB-ecs\fR|\fB-aga\fR]
[\fB-compress\fR|\fB-nocompress\fR]
[\fB-cmethod\fR \fItype\fR]
[\fB-map\fR \fIppmfile\fR]
[\fB-savemem\fR]
[\fBppmfile\fR]
.SH 2
DESCRIPTION
.LP
.LP
This program is part of Netpbm.
.LP
\fBppmtoilbm\fR reads a PPM image as input.  Produces an ILBM file
as output.  \fBppmtoilbm\fR understands the following ILBM types:
.IP \(bu
Normal ILBMs with 1-16 planes
.IP \(bu
Amiga HAM with 3-16 planes
.IP \(bu
24 bit
.IP \(bu
Color map (BMHD + CMAP chunk only, nPlanes = 0)
.IP \(bu
Unofficial direct color.  1-16 planes for each color component.
.LP
.LP
Chunks written: BMHD, CMAP, CAMG (only for HAM), BODY (not for
colormap files) unofficial DCOL chunk for direct color ILBM.
.SH 2
OPTIONS
.LP
.LP
Options marked with (*) can be prefixed with a "no",
e.g. "-nohamif".  All options can be abbreviated to their
shortest unique prefix.
.RS
.IP "\fB-maxplanes\fR | \fB-mp\fR \fIn\fR"
(default 5, minimum 1, maximum 16) Maximum planes to write in a
normal ILBM.  If the pixmap does not fit into <n> planes,
ppmtoilbm writes a HAM file (if -hamif is used), a 24bit file (if
-24if is used) or a direct color file (if -dcif is used) or aborts
with an error.
.IP "\fB-fixplanes\fR | \fB-fp\fR \fIb\fR"
(min 1, max 16) If a normal ILBM is written, it will have exactly
<n> planes.
.IP "\fB-hambits\fR | \fB-hamplanes\fR \fIn\fR"
(default 6, min 3, max 16) Select number of planes for HAM
picture.  The current Amiga hardware supports 6 and 8 planes, so for
now you should only use this values.
.IP "\fB-normal\fR"
Turns off -hamif/-24if/-dcif, -hamforce/-24force/-dcforce and
-cmaponly.  Also sets compression type to byterun1.
.LP
This is the default.
.IP "\fB-hamif\fR (*)"
.IP "\fB-24if\fR (*)"
.IP "\fB-dcif\fR (*)"
Write a HAM/24bit/direct color file if the image does not fit into
<maxplanes> planes.
.IP "\fB-hamforce\fR (*)"
.IP "\fB-24force\fR (*)"
.IP "\fB-dcforce\fR (*)"
Write a HAM/24bit/direct color file.
.IP "\fB-dcbits\fR \fIr\fR \fIg\fR \fIb\fR"
.IP "\fB-dcplanes\fR \fIr\fR \fIg\fR \fIb\fR"
(default 5, min 1, max 16).  Select number of bits for red, green
and blue in a direct color ILBM.
.IP "\fB-ecs\fR"
Shortcut for: -hamplanes 6 -maxplanes 5
.LP
This is the default.
.IP "\fB-aga\fR"
Shortcut for: \fB-hamplanes 8 -maxplanes 8\fR
.IP "\fB-ham6\fR"
Shortcut for: \fB-hamplanes 6 -hamforce\fR
.IP "\fB-ham8\fR"
Shortcut for: \fB-hamplanes 8 -hamforce\fR
.IP "\fB-compress\fR (*)"
This is the default.
Compress the BODY chunk.  The default compression method is
byterun1.  Compression requires building the ILBM image in memory;
turning compression off allows stream-writing of the image, but the
resulting file will usually be 30% to 50% larger.  Another alternative
is the -savemem option, this will keep memory requirements for
compression at a minimum, but is very slow.
.IP "\fB-cmethod\fR \fBnone\fR|\fBbyterun1\fR"
This option does the same thing as \fB-compress\fR.
.IP "\fB-map\fR \fIppmfile\fR"
Write a normal ILBM using the colors in <ppmfile> as the
colormap.  The colormap file also determines the number of planes, a
\fB-maxplanes\fR or \fB-fixplanes\fR option is ignored.
.IP "\fB-cmaponly\fR"
Write a colormap file: only BMHD and CMAP chunks, no BODY chunk,
nPlanes = 0.
.IP "\fB-savemem\fR"
See the \fB-compress\fR option.
.RE
.SH 2
LIMITATIONS
.LP
.LP
HAM pictures will always get a grayscale colormap; a real color
selection algorithm might give better results.  On the other hand,
this allows row-by-row operation on HAM images, and all HAM images of
the same depth (no. of planes) share a common colormap, which is
useful for building HAM animations.
.SH 2
REFERENCES
.LP
Amiga ROM Kernel Reference Manual - Devices (3rd Ed.)
.br
Addison Wesley, ISBN 0-201-56775-X
.SH 2
SEE ALSO
.LP
ppm, 
ilbmtoppm
.SH 2
AUTHORS
.LP
.LP
Copyright (C) 1989 by Jef Poskanzer.
.LP
Modified October 1993 by Ingo Wilken (Ingo.Wilken@informatik.uni-oldenburg.de)
.br
\l'5i'
.SH 2
Table Of Contents
.LP
.IP \(bu
NAME
.IP \(bu
SYNOPSIS
.IP \(bu
DESCRIPTION
.IP \(bu
OPTIONS
.IP \(bu
LIMITATIONS
.IP \(bu
REFERENCES
.IP \(bu
SEE ALSO
.IP \(bu
AUTHORS
.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.