Debian Codegraph @

upstream/debian-unstable/man1/pamfile.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 "Pamfile User Manual" 1 "04 July 2020" "netpbm documentation"
7
8 .SH NAME
9 pamfile - describe a Netpbm (PAM or PNM) file
10
11 .UN synopsis
12 .SH SYNOPSIS
13
14 \fBpamfile\fP
15
16 [\fB-allimages\fP]
17 [\fB-comments\fP]
18 [\fB-count\fP]
19 [\fB-machine\fP]
20 [\fB-size\fP]
21
22 [\fIfile\fP ...]
23 .PP
24 Minimum unique abbreviations of options are acceptable. You may use
25 double hyphens instead of single hyphen to denote options. You may use
26 white space in place of the equals sign to separate an option name
27 from its value.
28
29 .UN description
30 .SH DESCRIPTION
31 .PP
32 This program is part of
33 .BR "Netpbm" (1)\c
34 \&.
35 .PP
36 \fBpamfile\fP reads one or more Netpbm files as input and writes
37 out short descriptions of the image type, size, etc. This is partly
38 for use in shell scripts, so the format is not particularly pretty.
39 .PP
40 By default, \fBpamfile\fP reads only the header of the input file.
41 If that file is a pipe, that might cause problems for the process that is
42 feeding the pipe. In that case, see the \fB-allimages\fP option.
43
44 .UN options
45 .SH OPTIONS
46 .PP
47 In addition to the options common to all programs based on libnetpbm
48 (most notably \fB-quiet\fP, see
49 .UR index.html#commonoptions
50 Common Options
51 .UE
52 \&), \fBpamfile\fP recognizes the following
53 command line options:
54
55
56 .TP
57 \fB-allimages\fP
58 This option causes \fBpamfile\fP to describe every image in each
59 input file. Without this option, \fBpamfile\fP describes only the
60 first image in each input file.
61 .sp
62 This option also causes \fBpamfile\fP to read all the images from
63 the input stream, whereas without it, \fBpamfile\fP reads only the header
64 of the first one. If the input stream is from a pipe, the process that is
65 feeding the pipe might require the entire stream to be consumed. In
66 that case, use this option even if the stream contains only one image.
67 .sp
68 This option has no effect if you also specify \fB-count\fP.
69 .sp
70 Note that before July 2000, a file could not contain more than one
71 image and many programs ignore all but the first.
72 .sp
73 This option was new in Netpbm 9.5 (July 2000).
74
75 .TP
76 \fB-comments\fP
77 This option causes \fBpamfile\fP to include for each PAM image
78 a report of the comments from the header of the image.
79 .sp
80 For a PBM, PGM, or PPM image, \fBpamfile\fP reports there are no
81 comments, even if there are.
82 .sp
83 This option was new in Netpbm 10.35 (August 2006).
84
85 .TP
86 \fB-count\fP
87 This option causes \fBpamfile\fP to display only a count of how many
88 images are in each input file.
89 .sp
90 As with \fB-allimages\fP, this causes \fBpamfile\fP to read all the
91 images.
92 .sp
93 You may specify at most one of \fB-count\fP, \fB-machine\fP,
94 and \fB-size\fP.
95 .sp
96 This option was new with Netpbm 10.31 (December 2005).
97
98 .TP
99 \fB-machine\fP
100 This makes the output more convenient for a machine to use, while
101 less convenient for a human. \fBpamfile\fP reports the same information
102 as with no options.
103 .sp
104 The output is one line of ASCII text per image. Each line consists of
105 the file name, followed by a colon, followed by a space, then the
106 following tokens with a space in between:
107
108
109 .IP \(bu
110 Format: 'PAM', 'PBM', 'PGM', or
111 'PPM',
112 .IP \(bu
113 Subformat: 'PLAIN' or 'RAW'
114 .IP \(bu
115 Width: in pixels, in decimal
116 .IP \(bu
117 Height: in pixels, in decimal
118 .IP \(bu
119 Depth: in decimal
120 .IP \(bu
121 Maxval: in decimal (1 if image is PBM)
122 .IP \(bu
123 Tuple type (emulated if the image is not PAM)
124
125 .sp
126 You may specify at most one of \fB-count\fP, \fB-machine\fP,
127 and \fB-size\fP.
128 .sp
129 This option was new in Netpbm 10.86 (March 2019).
130
131 .TP
132 \fB-size\fP
133 This makes the output contain only the height and width of the image,
134 in a form convenient for machine processing.
135 .sp
136 There is one line of output per image, consisting of two blank-delimited
137 tokens:
138
139
140 .IP \(bu
141 Width: in pixels, in decimal
142 .IP \(bu
143 Height: in pixels, in decimal
144
145 .sp
146 Note that there is no way to tell which image is in which file, if you have
147 multiple input files with multiple images. If that is your case,
148 use \fB-machine\fP instead.
149 .sp
150 You may specify at most one of \fB-count\fP, \fB-machine\fP, and
151 \fB-size\fP.
152 .sp
153 This option was new in Netpbm 10.86 (March 2019).
154
155
156
157 .UN seealso
158 .SH SEE ALSO
159 .BR "pam" (1)\c
160 \&,
161 .BR "ppmhist" (1)\c
162 \&,
163 \fBfile\fP
164
165 .UN author
166 .SH AUTHOR
167
168 Copyright (C) 1991 by Jef Poskanzer.
169 .SH DOCUMENT SOURCE
170 This manual page was generated by the Netpbm tool 'makeman' from HTML
171 source. The master documentation is at
172 .IP
173 .B http://netpbm.sourceforge.net/doc/pamfile.html
174 .PP