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