pdfcpu

A PDF processor written in Go.

View the Project on GitHub hhrutter/pdfcpu


Changelog

Stamp

Add a stamp to selected pages of inFile. Have a look at some examples.

The stamp is centered on the page and using description you can configure various aspects like rotation, scaling and opacity. For text based stamps you can also configure font name, font size, fill color and render mode.

Usage

pdfcpu stamp [-v(erbose)|vv] [-pages pageSelection] [-upw userpw] [-opw ownerpw] description inFile [outFile]

You can stamp or watermark inFile exactly once. It is highly recommended to make a backup of inFile before running this command or even better use outFile.


NOTE

In the Adobe world a watermark is text or an image that appears either in front of or behind existing document content, like a stamp comment aka stamp annotation that anybody reading the PDF can open, edit, move around and delete. The difference here is that a watermark is integrated into a PDF page as a fixed element. Within pdfcpu the meaning of these terms is slightly different:

where content may be text, an image or a PDF page.



Flags

flag description required
verbose turn on logging no
vv verbose logging no
pages page selection no
upw user password no
opw owner password no


Arguments

name description required default
description configuration string yes  
inFile PDF input file yes  
outFile PDF output file no inFile_new.pdf


Description

A configuration string to specify the stamp parameters.

The first entry of the description configures the type. It is one of the following:

parameter description values default
f fontname, a basefont Helvetica, Times-Roman, Courier Helvetica
p fontsize in points in combination with absolute scaling only 24
s scale factor 0.0 < i <= 1.0 followed by optional abs or rel 0.5 rel
c color, 3 fill color intensities 0.0 <= r,g,b <= 1.0, eg. 1.0, 0.0 0.0 = red 0.5 0.5 0.5 = gray
r rotation angle -180.0 <= i <= 180.0 0.0
d render along diagonal 1 .. lower left to upper right 1
    2 .. upper left to lower right  
o opacity 0.0 <= i <= 1.0 1
m render mode 0 .. fill 0
    1 .. stroke  
    2 .. fill & stroke  

Only one of rotation and diagonal is allowed.

The following description parameters are for text based stamps only:


Default description

'f:Helvetica, p:24, s:0.5 rel, c:0.5 0.5 0.5, r:0, d:1, o:1, m:0'

The default stamp configuration is:

In addition for text based stamps:

You only have to specify parameters that differ from the default.


Examples

Text Based Stamps

Create a stamp using defaults only:

pdfcpu stamp 'This is a stamp' test.pdf out.pdf


Create a stamp using scale factor 1:

pdfcpu stamp 'This is a stamp, s:1' test.pdf out.pdf

       


Create a stamp along the second diagonale using scale factor 0.9, default render mode fill and a fill color:

pdfcpu stamp 'This is a stamp, s:.9, d:2, c:.6 .2 .9' test.pdf out.pdf


Create a stamp with 0 degree rotation using scale factor 0.9 and render mode stroke:

pdfcpu stamp 'This is a stamp, s:.9, r:0, m:1' test.pdf out.pdf


Create a stamp with a counterclockwise rotation of 45 degrees using scale factor 1, render mode fill & stroke and a fill color:

pdfcpu stamp 'This is a stamp, s:1, r:45, m:2, c:.2 .7 .9' test.pdf out.pdf


Create a stamp with default rotation, using scale factor 1, font size 48, default render mode fill, a fill color and increasing opacity from 0.3 to 1. By setting an opacity < 1 you can fake a watermark. This may be useful in scenarios where pdfcpu watermark does not produce satisfying results for a particular PDF file:

pdfcpu stamp 'Draft, p:48, s:1, c:.8 .8 .4, o:.3' test.pdf out1.pdf
pdfcpu stamp 'Draft, p:48, s:1, c:.8 .8 .4, o:0.6' test.pdf out2.pdf
pdfcpu stamp 'Draft, p:48, s:1, c:.8 .8 .4, o:1' test.pdf out3.pdf

   


Image Based Stamps

Create a stamp using defaults only:

pdfcpu stamp 'pic.jpg' test.pdf out.pdf


Create a stamp using 0 degree rotation and relative scaling of 1.0:

pdfcpu stamp 'pic.jpg, s:1 rel, r:0' test.pdf out.pdf


PDF Based Stamps

Create a stamp using defaults only. This will apply page 1 of some.pdf:

pdfcpu stamp 'some.pdf' test.pdf out.pdf


Create a stamp using defaults and page 2 of some.pdf, apply a 0 degree rotation and 0.3 relative scaling:

pdfcpu stamp 'some.pdf:2, r:0, s:.3' test.pdf out.pdf