Debian Codegraph @

upstream/debian-unstable/man1/pamvalidate.1

raw
1 \
2 .\" This man page was generated by the Netpbm tool 'makeman' from HTML source.
3 .\" Do not hand-hack it! If you have bug fixes or improvements, please find
4 .\" the corresponding HTML page on the Netpbm website, generate a patch
5 .\" against that, and send it to the Netpbm maintainer.
6 .TH "Pamvalidate User Manual" 1 "22 March 2014" "netpbm documentation"
7
8 .SH NAME
9
10 pamvalidate - validate Netpbm image format
11
12 .UN synopsis
13 .SH SYNOPSIS
14
15 \fBpamvalidate\fP
16
17
18 .UN description
19 .SH DESCRIPTION
20 .PP
21 This program is part of
22 .BR "Netpbm" (1)\c
23 \&.
24 .PP
25 \fBpamvalidate\fP copies a Netpbm image from Standard Input to Standard
26 Output, except that if there are certain violations of the image format in the
27 input, \fBpamvalidate\fP fails \fIwithout producing any output\fP.
28 .PP
29 This is most useful in a pipeline, before a stage you don't want to start
30 working on Netpbm input until it knows it can get all the way through it. For
31 example, assume you are converting PPM images to PNG and you don't want to
32 produce a partial PNG file under any circumstance. If you just
33 use \fBpnmtopng\fP, and the PPM input is truncated halfway through the
34 raster, \fBpnmtopng\fP fails, but also produces about half of a PNG file.
35 To prevent that, pass your PPM input through \fBpamvalidate\fP on its way
36 to \fBpnmtopng\fP. Then, \fBpamvalidate\fP will fail, and consequently
37 the pipeline will fail, before \fBpnmtopng\fP has seen any input and
38 therefore before \fBpnmtopng\fP has produced any output.
39 .PP
40 These are the kinds of format violations \fBpamvalidate\fP detects:
41
42
43 .IP \(bu
44 A purported sample value exceeds the declared maxval.
45 .IP \(bu
46 The stream ends prematurely.
47
48 .PP
49 This program works on multi-image streams, producing a corresponding output
50 stream.
51 .PP
52 See \fBpamfix\fP for a way to salvage an invalid Netpbm image stream.
53
54
55 .UN options
56 .SH OPTIONS
57 .PP
58 There are no command line options defined specifically
59 for \fBpamvalidate\fP, but it recognizes the options common to all
60 programs based on libnetpbm (See
61 .UR index.html#commonoptions
62 Common Options
63 .UE
64 \&.)
65
66 .UN seealso
67 .SH SEE ALSO
68 .BR "pam" (1)\c
69 \&
70 .BR "pnm" (1)\c
71 \&
72 .BR "pamfix" (1)\c
73 \&
74
75
76 .UN history
77 .SH HISTORY
78 .PP
79 \fBpamvalidate\fP was new in Netpbm 10.66 (March 2014).
80 .SH DOCUMENT SOURCE
81 This manual page was generated by the Netpbm tool 'makeman' from HTML
82 source. The master documentation is at
83 .IP
84 .B http://netpbm.sourceforge.net/doc/pamvalidate.html
85 .PP