\
.\" 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 "Pnmindex User Manual" 1 "23 November 2023" "netpbm documentation"

.SH NAME
pnmindex - build a visual index of a bunch of PNM images

.UN synopsis
.SH SYNOPSIS

\fBpnmindex\fP

[\fB-size=\fP\fIN\fP]

[\fB-across=\fP\fIN\fP]

[\fB-black\fP]

[\fB-title=\fP\fItitle\fP]

[\fB-quant\fP|\fB-noquant\fP]

[\fB-colors=\fP\fIN\fP]

\fIpnmfile\fP ...
.PP
You can use the minimum unique abbreviation of the options.  You can use
two hyphens instead of one.  You can separate an option name from its value
with white space instead of an equals sign.


.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpnmindex\fP creates an index image containing thumbnail (small)
versions of a bunch of PNM files you supply (akin to a photographic
"contact sheet").
.PP
\fBpnmindex\fP labels each thumbnail and, optionally, contains a
title.
.PP
If you just want to concatenate some images together in a grid, use
\fBpamundice\fP for that.
.PP
If you want to take apart the image you generated with \fBpnmindex\fP,
use \fBpamdice\fP or \fBpamcut\fP.
.PP
The program can generate large temporary files.  By default, these go in
directory \fB/tmp\fP, but you can usse the \fBTMPDIR\fP environment variable
to have them somewhere else.


.UN options
.SH OPTIONS
.PP
In addition to the options common to all programs based on libnetpbm
(most notably \fB-quiet\fP, see 
.UR index.html#commonoptions
 Common Options
.UE
\&), \fBpnmindex\fP recognizes the following
command line options:


.TP
\fB-size=\fP\fIN\fP
The size of each thumbnail.  The image is scaled down to fit maximally
inside a \fIN\fP x \fIN\fP pixel box without changing its aspect ratio.
.sp
If the input image is already smaller than this, its size remains the same
in the output.
.sp
The value must be at least 1.
.sp
The default is 100.

.TP
\fB-across=\fP\fIN\fP
This is the number of thumbnails in each row.
.sp
The value must be at least 1.
.sp
The default is 6.
  
.TP
\fB-black\fP
This controls the color of the padding between the images; by default it
is white and the labels are black lettering on white background, but the
\fB-black\fP option reverses this.

.TP
\fB-title=\fP\fItitle\fP
This specifies a title to be placed at the top of the image.
.sp
The \fItitle\fP value must be in ASCII.  Characters that are not valid
ASCII are not rendered.
.sp
Default is no title.

.TP
\fB-noquant\fP
Disables color quantization.  By default, if any input image is PPM, the
program reduces the number of colors to the number of colors specified
by \fB-colors\fP).

.TP
\fB-quant\fP
This option has no effect; it explicitly selects the default behavior of
quantizing colors.  See \fB-noquant\fP.

.TP
\fB-colors=\fP\fIN\fP
The maximum number of colors allowed in the overall image.  If it would
otherwise have more colors than these, \fBpnmindex\fP quantizes the result.
To reduce the effect of the colors in one thumbnail on the colors used for
another, the program quantizes colors to this number in each thumbnail
independently, then quantizes the colors in each row of thumbnails to this
number, then quantizes the colors in the entire output image to this number.
.sp
This value is meaningless if you specify the \fB-noquant\fP option or if
no input image is PPM.
.sp
The default is 256.




.UN history
.SH HISTORY
.PP
Before Netpbm 11.05 (December 2023), the Netpbm common option \fB-plain\fP
was not implemented.


  .UN seealso
.SH SEE ALSO
.BR "pamscale" (1)\c
\&,
.BR "pamcat" (1)\c
\&,
.BR "pbmtext" (1)\c
\&,
.BR "pnmquant" (1)\c
\&,
.BR "pamcut" (1)\c
\&,
.BR "pamdice" (1)\c
\&,
.BR "pamundice" (1)\c
\&,
.BR "pnmtile" (1)\c
\&,
.BR "pnm" (1)\c
\&


.UN author
.SH AUTHOR
.PP
Copyright (C) 1991 by Jef Poskanzer.
.PP
\fB-title\fP and \fB-noquant\fP added 2000 by John Heidemann.
.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/pnmindex.html
.PP