diff options
Diffstat (limited to 'upstream/fedora-40/man1/pamfix.1')
-rw-r--r-- | upstream/fedora-40/man1/pamfix.1 | 180 |
1 files changed, 180 insertions, 0 deletions
diff --git a/upstream/fedora-40/man1/pamfix.1 b/upstream/fedora-40/man1/pamfix.1 new file mode 100644 index 00000000..168fc29c --- /dev/null +++ b/upstream/fedora-40/man1/pamfix.1 @@ -0,0 +1,180 @@ +\ +.\" 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 "Pamfix User Manual" 0 "06 March 2014" "netpbm documentation" + +.SH NAME + +pamfix - repair a Netpbm image with various corruptions + +.UN synopsis +.SH SYNOPSIS + +\fBpamfix\fP + +[\fB-truncate\fP] +[\fB-changemaxval\fP] +[\fB-clip\fP] +[\fB-verbose\fP] + +[\fInetpbmfile\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 +\fBpamfix\fP reads a stream that is mostly a Netpbm image but may have +certain types of corruptions and produces a valid Netpbm image that preserves +much of the information in the original. + +In particular, Netpbm salvages streams that are truncated and that contain +illegally large sample values. +.PP +\fBpamfix\fP looks at only on the first image in a multi-image stream. + + +.UN truncatedstream +.SS Truncated Stream +.PP +This is a stream that is missing the last part. Netpbm corrects this +by creating an output image that simply has fewer rows. +.PP +You select this kind of repair with a \fB-truncate\fP option. +.PP +The header of a Netpbm image implies how large the image must +be (how many bytes the file must contain). If the file is actually +smaller than that, a Netpbm program that tries to read the image +fails, with an error message telling you that it couldn't read the +whole file. The data in the file is arranged in row order, from +top to bottom, and the most common reason for the file being smaller +than its header says it should be is because the bottommost rows are +simply missing. So \fBpamfix\fP assumes that is the case +and generates a new image with just the rows that are readable. +(technically, that means the output's header indicates a smaller +number of rows and omits any partial last row). +.PP +The most common way for a Netpbm file to be small is that something +interrupted the program that generated it before it was finished writing +the file. For example, the program ran out of its own input or +encountered a bug or ran out of space in which to write the output. +.PP +Another problem \fBpamfix\fP deals with is where the file isn't +actually too small, but because of a system error, a byte in the middle of +it cannot be read (think of a disk storage failure). \fBpamfix\fP +reads the input sequentially until it can't read any further, for any +reason. So it treats such an image as a truncated one, ignoring all +data after the unreadable byte. +.PP +But be aware that an image file is sometimes too small because of a +bug in the program that generated it, and in that case it is not +simply a matter of the bottom of the image missing, so +\fBpamfix\fP simply creates a valid Netpbm image containing a +garbage picture. +.PP +If you want to test an image file to see if it is corrupted by being +too small, use \fBpamfile --allimages\fP . It fails with an error +message if the file is too small. +.PP +If you want to cut the bottom off a valid Netpbm image, use +\fBpamcut\fP. + + +.UN excessivesample +.SS Excessive Sample Value +.PP +This is a stream that contains a purported sample value that is higher than +the maxval of the image. +.PP +The header of a Netpbm image tells the maxval of the image, which is a +value that gives meaning to all the sample values in the raster. The +sample values represent a fraction of the maxval, so a sample value that is +greater than the maxval makes no sense. +.PP +A regular Netpbm program fails if you give it input that contains a value +larger than the maxval where a sample value belongs. +.PP +\fBpamfix\fP has three ways of salvaging such a stream: + + +.IP \(bu +Clip to the maxval. Request this with \fB-clip\fP. +.IP \(bu +Raise the maxval, thus lowering the fraction represented by every sample +in the image. Request this with \fB-changemaxval\fP. +.IP \(bu +Truncate the image at the first invalid sample value. Request this with +\fB-truncate\fP and neither \fB-clip\fP nor \fB-changemaxval\fP. + +.PP +You cannot specify both \fB-clip\fP and \fB-changemaxval\fP. + + +.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 +\&), \fBpamfix\fP recognizes the following +command line options: + + +.TP +\fB-truncate\fP +Create a truncated output image from all the valid input rows that +could be read. + +.TP +\fB-changemaxval\fP +Raise the maxval to cope with pixel values that exceed the maxval +stated in the header of the input file. + +.TP +\fB-clip\fP +Change all pixel values that exceed the maxval stated in the header +of the input file. + +.TP +\fB-verbose\fP +Report details of the transportation to standard error. + + + +.UN seealso +.SH SEE ALSO +.BR "pnm" (1)\c +\&, +.BR "pam" (1)\c +\&, +.BR "pamcut" (1)\c +\&, +.BR "pamfile" (1)\c +\&, +.BR "pamvalidate" (1)\c +\& + +.UN history +.SH HISTORY +.PP +\fBpamfix\fP was new in Netpbm 10.66 (March 2014). But it grew out of +\fBpamfixtrunc\fP, which was new in Netpbm 10.38 (March 2007) and did only +the truncated image repair (and for invalid sample values would simply pass +them through to its output, generating an invalid Netpbm image). +.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/pamfix.html +.PP
\ No newline at end of file |