summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/pamundice.1
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man1/pamundice.1')
-rw-r--r--upstream/debian-unstable/man1/pamundice.1268
1 files changed, 268 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man1/pamundice.1 b/upstream/debian-unstable/man1/pamundice.1
new file mode 100644
index 00000000..72df5a6a
--- /dev/null
+++ b/upstream/debian-unstable/man1/pamundice.1
@@ -0,0 +1,268 @@
+\
+.\" 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 "Pamundice User Manual" 1 "26 April 2020" "netpbm documentation"
+
+.SH NAME
+pamundice - combine grid of images (tiles) into one
+
+.UN example
+.SH EXAMPLE
+
+.nf
+\f(CW
+ $ pamdice myimage.ppm -outstem=myimage_part -width=10 -height=8
+ $ pamundice myimage_part_%1d_%1a.ppm -across=10 -down=8 >myimage.ppm
+
+ $ pamundice myimage.ppm myimage_part_%2a -across=13 -hoverlap=9
+\fP
+
+.fi
+
+
+.UN synopsis
+.SH SYNOPSIS
+
+\fBpamundice\fP
+
+[\fB-across=\fP\fIn\fP]
+
+[\fB-down=\fP\fIn\fP]
+
+[\fB-hoverlap=\fP\fIpixels\fP]
+
+[\fB-voverlap=\fP\fIpixels\fP]
+
+[\fB-verbose\fP]
+
+{\fIinput_filename_pattern\fP,
+\fB-listfile=\fP\fIfilename\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
+\fBpamundice\fP reads a bunch of Netpbm images as input and combines them
+as a grid of tiles into a single output image of the same kind on Standard
+Output.
+.PP
+You can optionally make the pieces overlap.
+.PP
+The images can either be in files whose names indicate where they go in the
+ output (e.g. 'myimage_part_03_04' could be the image for Row 3,
+ Column 4 - see the \fIinput_filename_pattern\fP argument) or listed in a
+ file, with a \fB-listfile\fP option.
+.PP
+The input images must all have the same format (PAM, PPM, etc.)
+and maxval and for PAM must have the same depth and tuple type.
+All the images in a rank (horizontal row of tiles) must have the
+same height. All the images in a file (vertical column of tiles)
+must have the same width. But it is not required that every rank
+have the same height or every file have the same width.
+.PP
+\fBpamdice\fP is the inverse of \fBpamundice\fP. You can use
+\fBpamundice\fP to reassemble an image sliced up by \fBpamdice\fP.
+You can use \fBpamdice\fP to recreate the tiles of an image created
+by \fBpamundice\fP, but to do this, the original ranks must all have
+been the same height except for the bottom one and the original files
+must all have been the same width except the right one.
+.PP
+One use for this is to process an image in pieces when the whole image is
+too large to process. For example, you might have an image so large that an
+image editor can't read it all into memory or processes it very slowly. You
+can split it into smaller pieces with \fBpamdice\fP, edit one at a time, and
+then reassemble them with \fBpamundice\fP.
+.PP
+Of course, you can also use \fBpamundice\fP to compose various kinds of
+checkerboard images, for example, you could write a program to render a
+chessboard by computing an image of each square, then using \fBpamundice\fP
+to assemble them into a board.
+
+.PP
+An alternative to join images in a single direction (i.e. a single
+rank or a single file) is \fBpamcat\fP. \fBpamcat\fP gives you more
+flexibility than \fBpamundice\fP in identifying the input images: you
+can supply them on Standard Input or as a list of arbitrarily named
+files.
+.PP
+To join piecewise photographs, use \fBpnmstitch\fP instead of
+\fBpamundice\fP, because it figures out where the pieces overlap,
+even if they don't overlap exactly vertically or horizontally.
+.PP
+To create an image of the same tile repeated in a grid, that's
+\fBpnmtile\fP.
+.PP
+\fBpnmindex\fP does a similar thing to \fBpamundice\fP: it
+combines a bunch of small images in a grid into a big one. But its
+purpose is to produce a an index image of the input images. So it
+leaves space between them and has labels for them, for example.
+
+
+.UN arguments
+.SH ARGUMENTS
+.PP
+Unless you use a \fB-listfile\fP option,, there is one non-option
+argument, and it is mandatory: \fIinput_filename_pattern\fP. This
+tells \fBpamundice\fP what files contain the input tiles.
+.PP
+\fBpamundice\fP reads the input images from files which are named
+with a pattern that indicates their positions in the combined image.
+For example, \fBtile_00_05.ppm\fP could be the 6th tile over in the
+1st rank, while \fBtile_04_01\fP is the 2nd tile over in the 5th rank.
+.PP
+You cannot supply any of the data on Standard Input, and the files
+must be the kind that \fBpamundice\fP can close and reopen and read
+the same image a second time (e.g. a regular file is fine; a named
+pipe is probably not).
+.PP
+\fIinput_filename_pattern\fP is a printf-style pattern. (See the
+standard C library \fBprintf\fP subroutine). For the example above,
+it would be \fBtile_%2d_%2a.ppm\fP. The only possible conversion
+specifiers are:
+
+
+
+.TP
+\fBd\fP
+"down": The rank (row) number, starting with 0.
+
+.TP
+\fBa\fP
+"across": The file (column) number, starting with 0.
+
+.TP
+\fB%\fP
+The per cent character (%).
+
+
+.PP
+The number between the % and the conversion specifier is the
+precision and is required. It says how many characters of the file
+name are described by that conversion. The rank or file number is
+filled with leading zeroes as necessary.
+.PP
+So the example \fBtile_%2d_%2a.ppm\fP means to get the name of
+the file that contains the tile at Rank 0, File 5, you:
+
+
+
+.IP \(bu
+replace the "%2d" with the rank number, as a 2 digit
+decimal number: "00"
+
+.IP \(bu
+Replace the "%2a" with the file number, as a 2 digit
+decimal number: "05"
+
+.PP
+Note that this pattern describes file names that \fBpamdice\fP
+produces, except that the precision may be more or less.
+(\fBpamdice\fP uses however many digits are required for the highest
+numbered image).
+
+
+.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
+\&), \fBpamundice\fP recognizes the following
+command line options:
+
+
+.TP
+\fB-across=\fP\fIN\fP
+This is the number of tiles across in the grid, i.e. the number of
+tiles in each rank, or the number of files.
+.sp
+Default is 1.
+
+
+.TP
+\fB-down=\fP\fIN\fP
+This is the number of tiles up and down in the grid, i.e. the
+number of tiles in each file, or the number of ranks.
+.sp
+Default is 1.
+
+.TP
+\fB-hoverlap=\fP\fIpixels\fP
+This is the amount in pixels to overlap the tiles horizontally.
+\fBpamundice\fP clips this much off the right edge of every tile
+before joining it to the adjacent image to the right. The tiles along
+the right edge remain whole.
+.sp
+There must not be any input image narrower than this.
+.sp
+Note that this undoes the effect of the same \fB-hoverlap\fP
+option of \fBpamdice\fP.
+.sp
+Default is zero -- no overlap.
+
+.TP
+\fB-voverlap=\fP\fIpixels\fP
+This is analogous to \fB-hoverlap\fP, but \fBpamundice\fP
+clips the bottom edge of each image before joining it to the one below.
+
+.TP
+\fB-listfile=\fP\fIfilename\fP
+This option names a file that contains the names of all the input files.
+This is an alternative to specifying a file name pattern as an argument.
+.sp
+The named file contains file name, one per line. Each file contains the
+ image for one tile, in row-major order, top to bottom, left to right. So
+ the first file is the upper left tile, the second is the one to right of
+ that, etc. The number of lines in the file must be equal to the number of
+ tiles in the output, the product of the \fB-across\fP and \fB-down\fP
+ values.
+.sp
+The file names have no meaning to \fBpamundice\fP. You can use the same
+ file multiple times to have identical tiles in the output.
+.sp
+This option was new in Netpbm 10.90 (March 2020).
+
+.TP
+\fB-verbose\fP
+Print information about the processing to Standard Error.
+
+
+
+.UN history
+.SH HISTORY
+.PP
+\fBpamundice\fP was new in Netpbm 10.39 (June 2007). Before that,
+\fBpamcat\fP is the best substitute.
+
+
+.UN seealso
+.SH SEE ALSO
+.BR "pamdice" (1)\c
+\&,
+.BR "pamcat" (1)\c
+\&,
+.BR "pnmindex" (1)\c
+\&,
+.BR "pnmtile" (1)\c
+\&,
+.BR "pnm" (1)\c
+\&
+.BR "pam" (1)\c
+\&
+.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/pamundice.html
+.PP \ No newline at end of file