Debian Codegraph @

userguide/pnmindex.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.3//EN">
2 <html><head><title>Pnmindex User Manual</title></head>
3 <body>
4 <h1>pnmindex</h1>
5 Updated: 23 November 2023
6 <br>
7 <a href="#index">Table Of Contents</a>
8
9 <h2>NAME</h2>
10 pnmindex - build a visual index of a bunch of PNM images
11
12 <h2 id="synopsis">SYNOPSIS</h2>
13
14 <b>pnmindex</b>
15
16 [<b>-size=</b><i>N</i>]
17
18 [<b>-across=</b><i>N</i>]
19
20 [<b>-black</b>]
21
22 [<b>-title=</b><i>title</i>]
23
24 [<b>-quant</b>|<b>-noquant</b>]
25
26 [<b>-colors=</b><i>N</i>]
27
28 <i>pnmfile</i> ...
29
30 <p>You can use the minimum unique abbreviation of the options. You can use
31 two hyphens instead of one. You can separate an option name from its value
32 with white space instead of an equals sign.
33
34
35 <h2 id="description">DESCRIPTION</h2>
36
37 <p>This program is part of <a href="index.html">Netpbm</a>.
38
39 <p><b>pnmindex</b> creates an index image containing thumbnail (small)
40 versions of a bunch of PNM files you supply (akin to a photographic
41 "contact sheet").
42
43 <p><b>pnmindex</b> labels each thumbnail and, optionally, contains a
44 title.
45
46 <p>If you just want to concatenate some images together in a grid, use
47 <b>pamundice</b> for that.
48
49 <p>If you want to take apart the image you generated with <b>pnmindex</b>,
50 use <b>pamdice</b> or <b>pamcut</b>.
51
52 <p>The program can generate large temporary files. By default, these go in
53 directory <b>/tmp</b>, but you can usse the <b>TMPDIR</b> environment variable
54 to have them somewhere else.
55
56
57 <h2 id="options">OPTIONS</h2>
58
59 <p>In addition to the options common to all programs based on libnetpbm
60 (most notably <b>-quiet</b>, see <a href="index.html#commonoptions">
61 Common Options</a>), <b>pnmindex</b> recognizes the following
62 command line options:
63
64 <dl compact>
65 <dt><b>-size=</b><i>N</i>
66
67 <dd>The size of each thumbnail. The image is scaled down to fit maximally
68 inside a <i>N</i> x <i>N</i> pixel box without changing its aspect ratio.
69
70 <p>If the input image is already smaller than this, its size remains the same
71 in the output.
72
73 <p>The value must be at least 1.
74
75 <p>The default is 100.
76
77 <dt><b>-across=</b><i>N</i>
78
79 <dd>This is the number of thumbnails in each row.
80
81 <p>The value must be at least 1.
82
83 <p>The default is 6.
84
85 <dt><b>-black</b>
86
87 <dd>This controls the color of the padding between the images; by default it
88 is white and the labels are black lettering on white background, but the
89 <b>-black</b> option reverses this.
90
91 <dt><b>-title=</b><i>title</i>
92
93 <dd>
94 This specifies a title to be placed at the top of the image.
95 <p>The <i>title</i> value must be in ASCII. Characters that are not valid
96 ASCII are not rendered.
97
98 <p>Default is no title.
99
100 <dt><b>-noquant</b>
101
102 <dd>Disables color quantization. By default, if any input image is PPM, the
103 program reduces the number of colors to the number of colors specified
104 by <b>-colors</b>).
105
106 <dt><b>-quant</b>
107
108 <dd>This option has no effect; it explicitly selects the default behavior of
109 quantizing colors. See <b>-noquant</b>.
110
111 <dt><b>-colors=</b><i>N</i>
112
113 <dd>The maximum number of colors allowed in the overall image. If it would
114 otherwise have more colors than these, <b>pnmindex</b> quantizes the result.
115 To reduce the effect of the colors in one thumbnail on the colors used for
116 another, the program quantizes colors to this number in each thumbnail
117 independently, then quantizes the colors in each row of thumbnails to this
118 number, then quantizes the colors in the entire output image to this number.
119
120 <p>This value is meaningless if you specify the <b>-noquant</b> option or if
121 no input image is PPM.
122
123 <p>The default is 256.
124
125 </dl>
126
127
128 <h2 id="history">HISTORY</h2>
129
130 <p>Before Netpbm 11.05 (December 2023), the Netpbm common option <b>-plain</b>
131 was not implemented.
132
133
134 <h2 id="seealso">SEE ALSO</h2>
135
136 <b><a href="pamscale.html">pamscale</a></b>,
137
138 <b><a href="pamcat.html">pamcat</a></b>,
139
140 <b><a href="pbmtext.html">pbmtext</a></b>,
141
142 <b><a href="pnmquant.html">pnmquant</a></b>,
143
144 <b><a href="pamcut.html">pamcut</a></b>,
145
146 <b><a href="pamdice.html">pamdice</a></b>,
147
148 <b><a href="pamundice.html">pamundice</a></b>,
149
150 <b><a href="pnmtile.html">pnmtile</a></b>,
151
152 <b><a href="pnm.html">pnm</a></b>
153
154
155 <h2 id="author">AUTHOR</h2>
156
157 <p>Copyright (C) 1991 by Jef Poskanzer.
158
159 <p><b>-title</b> and <b>-noquant</b> added 2000 by John Heidemann.
160
161 <hr>
162 <h2 id="index">Table Of Contents</h2>
163 <ul>
164 <li><a href="#synopsis">SYNOPSIS</a>
165 <li><a href="#description">DESCRIPTION</a>
166 <li><a href="#options">OPTIONS</a>
167 <li><a href="#history">HISTORY</a>
168 <li><a href="#seealso">SEE ALSO</a>
169 <li><a href="#author">AUTHOR</a>
170 </ul>
171 </body>
172 </html>