summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man1/pamvalidate.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/mageia-cauldron/man1/pamvalidate.1')
-rw-r--r--upstream/mageia-cauldron/man1/pamvalidate.185
1 files changed, 85 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man1/pamvalidate.1 b/upstream/mageia-cauldron/man1/pamvalidate.1
new file mode 100644
index 00000000..3ac976a8
--- /dev/null
+++ b/upstream/mageia-cauldron/man1/pamvalidate.1
@@ -0,0 +1,85 @@
+\
+.\" 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 "Pamvalidate User Manual" 0 "22 March 2014" "netpbm documentation"
+
+.SH NAME
+
+pamvalidate - validate Netpbm image format
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBpamvalidate\fP
+
+
+.UN description
+.SH DESCRIPTION
+.PP
+This program is part of
+.BR "Netpbm" (1)\c
+\&.
+.PP
+\fBpamvalidate\fP copies a Netpbm image from Standard Input to Standard
+Output, except that if there are certain violations of the image format in the
+input, \fBpamvalidate\fP fails \fIwithout producing any output\fP.
+.PP
+This is most useful in a pipeline, before a stage you don't want to start
+working on Netpbm input until it knows it can get all the way through it. For
+example, assume you are converting PPM images to PNG and you don't want to
+produce a partial PNG file under any circumstance. If you just
+use \fBpnmtopng\fP, and the PPM input is truncated halfway through the
+raster, \fBpnmtopng\fP fails, but also produces about half of a PNG file.
+To prevent that, pass your PPM input through \fBpamvalidate\fP on its way
+to \fBpnmtopng\fP. Then, \fBpamvalidate\fP will fail, and consequently
+the pipeline will fail, before \fBpnmtopng\fP has seen any input and
+therefore before \fBpnmtopng\fP has produced any output.
+.PP
+These are the kinds of format violations \fBpamvalidate\fP detects:
+
+
+.IP \(bu
+A purported sample value exceeds the declared maxval.
+.IP \(bu
+The stream ends prematurely.
+
+.PP
+This program works on multi-image streams, producing a corresponding output
+stream.
+.PP
+See \fBpamfix\fP for a way to salvage an invalid Netpbm image stream.
+
+
+.UN options
+.SH OPTIONS
+.PP
+There are no command line options defined specifically
+for \fBpamvalidate\fP, but it recognizes the options common to all
+programs based on libnetpbm (See
+.UR index.html#commonoptions
+ Common Options
+.UE
+\&.)
+
+.UN seealso
+.SH SEE ALSO
+.BR "pam" (1)\c
+\&
+.BR "pnm" (1)\c
+\&
+.BR "pamfix" (1)\c
+\&
+
+
+.UN history
+.SH HISTORY
+.PP
+\fBpamvalidate\fP was new in Netpbm 10.66 (March 2014).
+.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/pamvalidate.html
+.PP \ No newline at end of file