summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man1/pnmpaste.1
blob: e16ee9c766f13ecbb817a81312210e085aefe32d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
\
.\" 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 "Pnmpaste User Manual" 1 "16 December 2018" "netpbm documentation"

.SH NAME

pnmpaste - paste a rectangle into a PNM image

.UN synopsis
.SH SYNOPSIS

\fBpnmpaste\fP

[\fB-replace\fP | \fB-or\fP | \fB-and\fP | \fB-xor\fP |
\fB-nor\fP | \fB-nand\fP | \fB-nxor\fP]

\fIfrompnmfile\fP \fIx\fP \fIy\fP
[\fIintopnmfile\fP]
.PP
You can abbreviate all options to their shortest unique prefix.

.UN description
.SH DESCRIPTION
.PP
This program is part of
.BR "Netpbm" (1)\c
\&.
.PP
\fBpnmpaste\fP reads two PNM images as input and inserts the first
image (the "pasted image") into the second (the "base image") at the
specified location, and produces a PNM image the same size and type as
the base image as output.
.PP
Either file name argument (but not both) may be '-' to indicate
Standard Input.  If you don't specify the second file argument at all, that's
the same as '-'.
.PP
\fIx\fP and \fIy\fP specify the location in the base image at
which to put the top left corner of the pasted image, \fIx\fP giving
the horizontal position and \fIx\fP giving the vertical position.  A
nonnegative value indicates the number of pixels right of the right
edge or below the top edge of the base image, while a negative value
indicates the number of pixels right of the right edge or below the
bottom edge (so x = -5 means 5 pixels left of the right edge).
.PP
If any part of the pasted image does not fit within the base image,
\fBpnmpaste\fP fails.
.PP
This tool is most useful in combination with \fIpamcut\fP.  For
instance, if you want to edit a small segment of a large image, and
your image editor cannot edit the large image, you can cut out the
segment you are interested in, edit it, and then paste it back in.
.PP
Another useful companion tool is \fBpbmmask\fP.
.PP
\fBpamcomp\fP is a more general tool, except that it lacks the
"or," "and," and "xor" functions.
\fBpamcomp\fP allows you to specify a transparency mask in order to have
only part of the inserted image get inserted.  So the inserted pixels
need not be a rectangle.  You can also have the inserted image be
translucent, so the resulting image is a mixture of the inserted image
and the base 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
\&), \fBpnmpaste\fP recognizes the following
command line options:


.TP
\fB-replace\fP, \fB-or\fP, \fB-and\fP, \fB-xor\fP,
\fB-nor\fP, \fB-nand\fP, \fB-nxor\fP
.sp
These option specify the operation to use when doing the paste.
The default is \fB-replace\fP, which means to do the obvious paste:
replace pixels of the "into" image with those of the
"from" image.
.sp
\fB-and\fP, \fB-nand\fP, \fB-or\fP, \fB-nor\fP, \fB-xor\fP,
and \fBnxor\fP are allowed only if both input images are PBM images.  They
say to combine the "from" and "into" images by performing boolean operations:
Each pixel of the output image is the result of the boolean operation on the
corresponding pixels of the two input images, where white is TRUE and black
is FALSE.
.sp
Note that this is different from what you would get by doing a bit
arithmetic on the bits in the PBM images, because in PBM, white is
represented by a 0 bit, and 0 in bit arithmetic corresponds to FALSE
in boolean arithmetic.
.sp
\fB-nand\fP, \fB-nor\fP, and \fB-nxor\fP were new in Netpbm 10.85
(December 2018).


  
.UN seealso
.SH SEE ALSO
.BR "pamcomp" (1)\c
\&,
.BR "pamcut" (1)\c
\&,
.BR "pnminvert" (1)\c
\&,
.BR "pnmarith" (1)\c
\&,
.BR "pbmmask" (1)\c
\&,
.BR "pnm" (1)\c
\&

.UN author
.SH AUTHOR

Copyright (C) 1989, 1991 by Jef Poskanzer.
.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/pnmpaste.html
.PP