diff options
Diffstat (limited to 'upstream/debian-bookworm/man1/rawtopgm.1')
| -rw-r--r-- | upstream/debian-bookworm/man1/rawtopgm.1 | 168 |
1 files changed, 168 insertions, 0 deletions
diff --git a/upstream/debian-bookworm/man1/rawtopgm.1 b/upstream/debian-bookworm/man1/rawtopgm.1 new file mode 100644 index 00000000..43abfb00 --- /dev/null +++ b/upstream/debian-bookworm/man1/rawtopgm.1 @@ -0,0 +1,168 @@ +\ +.\" 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 "Rawtopgm User Manual" 1 "14 September 2000" "netpbm documentation" + +.SH NAME + +rawtopgm - convert raw grayscale bytes to a PGM image + +.UN synopsis +.SH SYNOPSIS + +\fBrawtopgm\fP + +[\fB-bpp\fP [\fB1\fP|\fB2\fP]] + +[\fB-littleendian\fP] + +[\fB-maxval\fP \fIN\fP] + +[\fB-headerskip\fP \fIN\fP] + +[\fB-rowskip\fP \fIN\fP] + +[\fB-tb\fP|\fB-topbottom\fP] + +[\fIwidth\fP \fIheight\fP] + +[\fIimagefile\fP] + +.UN description +.SH DESCRIPTION +.PP +This program is part of +.BR "Netpbm" (1)\c +\&. +.PP +\fBrawtopgm\fP reads raw grayscale values as input and produces a +PGM image as output. The input file is just a sequence of pure binary +numbers, either one or two bytes each, either bigendian or +littleendian, representing gray values. They may be arranged either +top to bottom, left to right or bottom to top, left to right. There +may be arbitrary header information at the start of the file (to which +\fBrawtopgm\fP pays no attention at all other than the header's +size). +.PP +Arguments to \fBrawtopgm\fP tell how to interpret the pixels (a +function that is served by a header in a regular graphics format). +.PP +The \fIwidth\fP and \fIheight\fP parameters tell the dimensions +of the image. If you omit these parameters, \fBrawtopgm\fP assumes +it is a quadratic image and bases the dimensions on the size of the +input stream. If this size is not a perfect square, \fBrawtopgm\fP +fails. +.PP +When you don't specify \fIwidth\fP and \fIheight\fP, +\fBrawtopgm\fP reads the entire input stream into storage at once, +which may take a lot of storage. Otherwise, \fBrawtopgm\fP +ordinarily stores only one row at a time. +.PP +If you don't specify \fIimagefile\fP, or specify \fB-\fP, the +input is from Standard Input. +.PP +The PGM output is to Standard 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 +\&), \fBrawtopgm\fP recognizes the following +command line options: + + +.TP +\fB-maxval\fP \fIN\fP +\fIN\fP is the maxval for the gray values in the input, and is +also the maxval of the PGM output image. The default is the maximum +value that can be represented in the number of bytes used for each +sample (i.e. 255 or 65535). + +.TP +\fB-bpp\fP [\fB1\fP|\fB2\fP] +tells the number of bytes that represent each sample in the input. +If the value is \fB2\fP, The most significant byte is first in the +stream. +.sp +The default is 1 byte per sample. + +.TP +\fB-littleendian\fP +says that the bytes of each input sample are ordered with the +least significant byte first. Without this option, \fBrawtopgm\fP +assumes MSB first. This obviously has no effect when there is only +one byte per sample. + +.TP +\fB-headerskip\fP \fIN\fP +\fBrawtopgm\fP skips over \fIN\fP bytes at the beginning of the +stream and reads the image immediately after. The default is 0. +.sp +This is useful when the input is actually some graphics format that +has a descriptive header followed by an ordinary raster, and you don't +have a program that understands the header or you want to ignore the +header. + +.TP +\fB-rowskip\fP \fIN\fP +If there is padding at the ends of the rows, you can skip it with +this option. Note that rowskip need not be an integer. Amazingly, I +once had an image with 0.376 bytes of padding per row. This turned +out to be due to a file-transfer problem, but I was still able to read +the image. +.sp +Skipping a fractional byte per row means skipping one byte per +multiple rows. + +.TP +\fB-bt -bottomfirst\fP +By default, \fBrawtopgm\fP assumes the pixels in the input go top +to bottom, left to right. If you specify \fB-bt\fP or +\fB-bottomfirst\fP, \fBrawtopgm\fP assumes the pixels go bottom to +top, left to right. The Molecular Dynamics and Leica confocal format, +for example, use the latter arrangement. +.sp +If you don't specify \fB-bt\fP when you should or vice versa, the +resulting image is upside down, which you can correct with +\fBpamflip\fP. +.sp +This option causes \fBrawtopgm\fP to read the entire input stream +into storage at once, which may take a lot of storage. Normally, +\fBrawtopgm\fP stores only one row at a time. +.sp +For backwards compatibility, \fBrawtopgm\fP also accepts \fB-tb +\fP and \fB-topbottom\fP to mean exactly the same thing. The +reasons these are named backwards is that the original author thought +of it as specifying that the wrong results of assuming the data is top +to bottom should be corrected by flipping the result top for bottom. +Today, we think of it as simply specifying the format of the input +data so that there are no wrong results. + + + +.UN seealso +.SH SEE ALSO +.BR "pgm" (1)\c +\&, +.BR "rawtoppm" (1)\c +\&, +.BR "pamflip" (1)\c +\& + +.UN authors +.SH AUTHORS + +Copyright (C) 1989 by Jef Poskanzer. +Modified June 1993 by Oliver Trepte, \fIoliver@fysik4.kth.se\fP +.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/rawtopgm.html +.PP
\ No newline at end of file |