summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/ppmtobmp.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/ppmtobmp.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/ppmtobmp.1')
-rw-r--r--upstream/mageia-cauldron/man1/ppmtobmp.1167
1 files changed, 167 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man1/ppmtobmp.1 b/upstream/mageia-cauldron/man1/ppmtobmp.1
new file mode 100644
index 00000000..ecd5c9aa
--- /dev/null
+++ b/upstream/mageia-cauldron/man1/ppmtobmp.1
@@ -0,0 +1,167 @@
+\
+.\" 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 "Ppmtobmp User Manual" 0 "20 December 2018" "netpbm documentation"
+
+.SH NAME
+ppmtobmp - convert a PPM image into a BMP file
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBppmtobmp\fP
+
+[\fB-windows\fP]
+
+[\fB-os2\fP]
+
+[\fB-bpp=\fP\fIbits_per_pixel\fP]
+
+[\fB-mapfile=\fP\fIfilename\fP]
+
+[\fIppmfile\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 description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBppmtobmp\fP reads a PPM image as input and produces a Microsoft
+Windows or OS/2 BMP file as output.
+
+.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
+\&), \fBppmtobmp\fP recognizes the following
+command line options:
+
+
+.TP
+\fB-windows\fP
+Tells the program to produce a Microsoft Windows BMP file. (This
+is the default.)
+
+.TP
+\fB-os2\fP
+Tells the program to produce an OS/2 BMP file. (Before August
+2000, this was the default).
+
+.TP
+\fB-bpp\fP
+This tells how many bits per pixel you want the BMP file to
+contain. Only 1, 4, 8, and 24 are possible. By default,
+\fBppmtobmp\fP chooses the smallest number with which it can
+represent all the colors in the input image. If you specify a number
+too small to represent all the colors in the input image,
+\fBppmtobmp\fP tells you and terminates. You can use \fBpnmquant\fP
+or \fBppmdither\fP to reduce the number of colors in the image.
+.sp
+Before Netpbm 10.85 (December 2018), \fBppmtobmp\fP ignores this option if
+the input is PBM and produces a BMP with 1 bit per pixel. With these
+versions, if you want more than that, use \fBpbmtopgm\fP to convert the PBM
+to PGM first.
+
+.TP
+\fB-mapfile=\fP\fIfilename\fP
+This identifies a file to use as the BMP palette (aka
+"colormap"). In one BMP subformat, the BMP stream contains
+a palette of up to 256 colors, and represents the image raster as
+indices into that palette. Normally, \fBppmtobmp\fP takes care of
+computing a suitable palette, but if you are going to dissect the BMP
+output in some way, you may want certain values for the palette
+indices. E.g. you might want red to be 13, where \fBppmtobmp\fP
+would (arbitrarily) choose 39. In that case, you can construct the
+palette yourself and use this option to tell \fBppmtobmp\fP to use
+your palette.
+.sp
+This option does \fInot\fP control what colors are in the
+output. The colors in the output are exactly those in the input, and
+the palette you supply must contain at least all the colors that are
+in the input. You can use \fBpnmremap\fP to adjust your input image
+so that it contains only colors from your palette.
+.sp
+The palette file is a Netpbm format file with one pixel per
+palette entry. Each pixel must have a distinct color (no repeats).
+The order of the BMP palette \fBppmtobmp\fP generates is the order
+of the pixels in the palette file, going from top to bottom, left
+to right.
+.sp
+A BMP palette may have at most 256 colors, so the palette file
+must have at most 256 pixels.
+.sp
+You may find \fBpnmcolormap\fP useful in generating the palette
+file. \fBpamseq\fP too.
+.sp
+In the case of grayscale image, if you are processing the BMP image, it
+ may be convenient for you to have the actual gray values in the raster
+ part of the image rather than arbitrary indices into a palette. There is
+ no BMP format specifically for that, but you can achieve it by using a
+ palette in which each index is equal to the indexed gray value, and then
+ ignoring the palette when you process the BMP image.
+.sp
+Here is an example of doing that:
+
+.nf
+ \f(CW
+ $ pamseq 1 255 > mapfile.pgm
+
+ $ ppmtobmp -mapfile=mapfile.pgm input.pgm > output.bmp
+ \fP
+
+.fi
+.sp
+This option was new in Netpbm 10.45 (December 2008).
+
+
+
+
+.UN notes
+.SH NOTES
+.PP
+To get a faithful reproduction of the input image, the maxval of the
+input image must be 255. If it is something else,
+the colors in the BMP file may be slightly different from the colors
+in the input.
+.PP
+Windows icons are not BMP files. Use \fBppmtowinicon\fP to
+create those.
+
+.UN seealso
+.SH SEE ALSO
+.BR "bmptoppm" (1)\c
+\&,
+.BR "ppmtowinicon" (1)\c
+\&,
+.BR "pnmquant" (1)\c
+\&,
+.BR "ppmdither" (1)\c
+\&,
+.BR "pnmremap" (1)\c
+\&,
+.BR "ppm" (1)\c
+\&
+
+.UN author
+.SH AUTHOR
+
+Copyright (C) 1992 by David W. Sanderson.
+.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/ppmtobmp.html
+.PP \ No newline at end of file