File Coverage

blib/lib/App/PDF/Overlay.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1				#! perl
2
3				package App::PDF::Overlay;
4
5	1	1	49010	use warnings;
	1		2
	1		26
6	1	1	4	use strict;
	1		2
	1		55
7
8				=head1 NAME
9
10				pdfolay - insert a PDF document over/under another document
11
12				=cut
13
14				our $VERSION = '0.002';
15
16				=head1 SYNOPSIS
17
18				pdfolay [options] [file ...]
19
20				Options:
21				--output=XXX output document (default "__new__.pdf")
22				--overlay=XXX name of the overlay PDF document
23				--back overlay behind the source document
24				--behind same as --back
25				--restart restart the overlay at every source
26				--repeat cycle overlay pages if source hase more pages
27				--ident shows identification
28				--help shows a brief help message and exits
29				--man shows full documentation and exits
30				--verbose provides more verbose information
31				--quiet runs as silently as possible
32
33				=head1 OPTIONS
34
35				=over 8
36
37				=item B<--output=>I
38
39				Name of the resultant PDF document.
40
41				Default is C<__new__.pdf>.
42
43				=item B<--overlay=>I
44
45				Name of the PDF document to overlay.
46
47				=item B<--back>
48
49				Insert the overlay document I the source documents.
50
51				=item B<--repeat>
52
53				Repeat (cycle through) the pages of the overlay document when the
54				source document has more pages than the overlay.
55
56				Default is to stop overlaying when the pages of the overlay document
57				are exhausted.
58
59				=item B<--restart>
60
61				Restart overlaying with the first page of the overlay document when a
62				new source document is processed.
63
64				=item B<--help>
65
66				Prints a brief help message and exits.
67
68				=item B<--man>
69
70				Prints the manual page and exits.
71
72				=item B<--ident>
73
74				Prints program identification.
75
76				=item B<--verbose>
77
78				Provides more verbose information.
79				This option may be repeated to increase verbosity.
80
81				=item B<--quiet>
82
83				Suppresses all non-essential information.
84
85				=item I
86
87				The input PDF documents.
88
89				=back
90
91				=head1 DESCRIPTION
92
93				B will read the given input PDF file(s) and copy them
94				into a new output document.
95
96				Optionally, an overlay PDF document can be specified. If so, the pages
97				of the overlay document are inserted over (or, with option
98				B<--behind>, behind) the pages of the source documents.
99
100				When the source documents have more pages than the overlay document,
101				there are a couple of ways to reuse the overlay pages. These can be
102				controlled with the options B<--restart> and B<--repeat>.
103
104				Assuming the source documents have pages A B C and D E F, and the
105				overlay document has pages X Y, then the combinations are:
106
107				default: AX BY C D E F
108				repeat: AX BY CX DY EX FY
109				restart: AX BY C DX EY F
110				repeat+restart: AX BY CX DX EY FX
111
112				=head1 AUTHOR
113
114				Johan Vromans, C<< >>
115
116				=head1 SUPPORT AND DOCUMENTATION
117
118				Development of this module takes place on GitHub:
119				https://github.com/sciurius/perl-App-PDF-Overlay.
120
121				You can find documentation for this module with the perldoc command.
122
123				perldoc App::PDF::Overlay
124
125				Please report any bugs or feature requests using the issue tracker on
126				GitHub.
127
128				=head1 ACKNOWLEDGEMENTS
129
130				=head1 COPYRIGHT & LICENSE
131
132				Copyright 2022 Johan Vromans, all rights reserved.
133
134				This program is free software; you can redistribute it and/or modify it
135				under the same terms as Perl itself.
136
137				=cut
138
139				1; # End of App::PDF::Overlay