summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/infotopam.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/mageia-cauldron/man1/infotopam.1
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/mageia-cauldron/man1/infotopam.1')
-rw-r--r--upstream/mageia-cauldron/man1/infotopam.1247
1 files changed, 247 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man1/infotopam.1 b/upstream/mageia-cauldron/man1/infotopam.1
new file mode 100644
index 00000000..00a6bc46
--- /dev/null
+++ b/upstream/mageia-cauldron/man1/infotopam.1
@@ -0,0 +1,247 @@
+\
+.\" 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 "Infotopam User Manual" 0 "07 April 2004" "netpbm documentation"
+
+.SH NAME
+infotopam - convert Amiga .info icons to PAM
+
+.UN synopsis
+.SH SYNOPSIS
+.PP
+\fBinfotopam\fP
+[\fB-forcecolor\fP]
+[\fB-numcolors\fP \fInumcolors\fP]
+[\fB-selected\fP]
+[\fIindex color\fP ...]
+[\fIfilename\fP]
+.PP
+Minimum unique abbreviation of option is acceptable. You may use double
+hyphens instead of single hyphen to denote options. You may use white space in
+place of the equals sign to separate an option name from its value.
+
+.UN examples
+.SH EXAMPLES
+.PP
+By default, \fBinfotopam\fP converts the first icon in a .info file:
+
+.nf
+ infotopam amiga.info > amiga.first.pam
+
+.fi
+.PP
+Use the \fI-selected\fP option to convert the second icon in a .info
+file. Here \fBinfotopam\fP reads from Standard Input:
+
+.nf
+ infotopam -selected < amiga.info > amiga.second.pam
+
+.fi
+.PP
+Use the \fI-forcecolor\fP option to force color conversion for a 1
+bit-plane .info file:
+
+.nf
+ infotopam -forcecolor bw.info > bw.pam
+
+.fi
+.PP
+Use \fI-numcolors\fP to override colors for indexes 0 and 3. Notice the
+two ways to specify the color:
+
+.nf
+ infotopam -numcolors 2 0 green 3 #FF0000 icon.info > icon.pam
+
+.fi
+.PP
+Since Amiga monitors do not use square pixels, some icons may appear
+squished. Filtering the output through \fBpamscale\fP can fix this:
+
+.nf
+ infotopam squish.info | pamtopnm | pamscale -yscale 1.7 > normal.pnm
+
+.fi
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBinfotopam\fP converts an Amiga .info (icon) file to a PAM image.
+\fBinfotopam\fP reads a .info file from \fIfilename\fP, or from Standard
+Input if you do not specify a file name, and writes the converted PAM image to
+Standard Output.
+.PP
+\fBinfotopam\fP currently handles 1 and 2 bit-plane icons. If the .info
+icon only has 1 bit-plane, \fBinfotopam\fP generates a bitmap
+(black&white) PAM image; otherwise it generates a color PAM image. You
+can force \fBinfotopam\fP to convert 1 bit-plane images to color PAM images by
+using the \fI-forcecolor\fP option.
+
+.UN options
+.SH OPTIONS
+.PP
+In addition to the options common to all programs based on libnetpbm
+(most notably \fB-quiet\fP, see
+.UR index.html#commonoptions
+ Common Options
+.UE
+\&), \fBinfotopam\fP recognizes the following
+command line options:
+
+
+.TP
+\fB-forcecolor\fP
+
+
+.sp
+Forces \fBinfotopam\fP to convert 1 bit-plane icons to color PAM
+ images instead of bitmap PAM images. \fBinfotopam\fP uses the index 2
+ color for black and the index 1 color for white (more on this
+ below).
+
+.TP
+\fB-numcolors\fP \fInumcolors\fP
+
+
+.sp
+Tells \fBinfotopam\fP how many colors to override. Pixels in the
+ Amiga .info files are assigned an index value rather than a specific color.
+ The standard colors for a 2 bit-plane icon are:
+
+.nf
+ Index 0: Blue (00, 55, AA)
+ Index 1: White (FF, FF, FF)
+ Index 2: Black (00, 00, 20)
+ Index 3: Orange (FF, 8A, 00)
+
+.fi
+.sp
+To override the colors, first specify how many colors to override using
+ \fI-numcolors\fP, then specify an (\fIindex color\fP) pair for each color
+ you want to override, where \fIindex\fP is a value from 0 to 3 and
+ \fIcolor\fP the new color for that index. Specify \fIcolor\fP as
+ described for the
+.UR libnetpbm_image.html#colorname
+\fBpnm_parsecolor()\fP argument
+.UE
+\&.
+
+.TP
+\fB-selected\fP
+
+
+Tells \fBinfotopam\fP to convert the selected (second) icon instead of
+ the normal (first) icon. Each Amiga .info icon file contains two icon
+ images. The first image is the normal, unselected icon, and the second
+ image is the selected icon. By default \fBinfotopam\fP converts the first
+ icon. You can tell \fBinfotopam\fP to convert the second icon by using the
+ \fI-selected\fP option.
+
+
+.PP
+All options can be abbreviated to their shortest unique prefix.
+
+.UN seealso
+.SH SEE ALSO
+.PP
+.BR "pam" (1)\c
+\&
+.BR "pamtopnm" (1)\c
+\&
+.BR "pamscale" (1)\c
+\&
+
+
+.UN notes
+.SH NOTES
+.PP
+Thanks to the following people on comp.sys.amiga.programmer for tips
+and pointers on decoding the info file format:
+
+
+.IP \(bu
+Ben Hutchings
+.IP \(bu
+Thomas Richter
+.IP \(bu
+Kjetil Svalastog Matheussen
+.IP \(bu
+Anders Melchiorsen
+.IP \(bu
+Dirk Stoecker
+.IP \(bu
+Ronald V.D.
+
+.PP
+The format of the Amiga .info file is as follows:
+
+.nf
+ DiskObject header 78 bytes
+ Optional DrawerData header 56 bytes
+ First icon header 20 bytes
+ First icon data Varies
+ Second icon header 20 bytes
+ Second icon data Varies
+
+.fi
+.PP
+The DiskObject header contains, among other things, the magic number
+(0xE310), the object width and height (inside the embedded Gadget header),
+and the version.
+.PP
+Each icon header contains the icon width and height, which can be smaller
+than the object width and height, and the number of bit-planes.
+.PP
+The icon data has the following format:
+
+.RS
+
+.PP
+\fIBIT-PLANE\fP planes, each with \fIHEIGHT\fP rows of (\fIWIDTH\fP
+ +15) / 16 * 2 bytes length.
+.RE
+.PP
+So if you have a 9x3x2 icon, the icon data will look like this:
+
+.nf
+ aaaa aaaa a000 0000
+ aaaa aaaa a000 0000
+ aaaa aaaa a000 0000
+ bbbb bbbb b000 0000
+ bbbb bbbb b000 0000
+ bbbb bbbb b000 0000
+
+.fi
+.PP
+where \fIa\fP is a bit for the first bit-plane, \fIb\fP is a bit for the
+second bit-plane, and \fI0\fP is padding. Thanks again to Ben Hutchings for
+his very helpful post!
+
+.UN history
+.SH HISTORY
+.PP
+\fBinfotopam\fP was new in Netpbm 10.22 (April 2004).
+
+.UN limitations
+.SH LIMITATIONS
+.PP
+\fBinfotopam\fP currently only handles 1 and 2 bit-plane icons.
+.PP
+There is no \fBpamtoinfo\fP command, since the .info files contain a lot
+more than just icon data, and mapping the colors would be difficult.
+
+.UN author
+.SH AUTHOR
+.PP
+Copyright (C) 2000, 2004 by Richard Griswold.
+.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/infotopam.html
+.PP \ No newline at end of file