~ubuntu-branches/ubuntu/trusty/pdfposter/trusty-proposed

« back to all changes in this revision

Viewing changes to pdfposter.rst

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Bläsing
  • Date: 2008-10-07 10:20:20 UTC
  • Revision ID: james.westby@ubuntu.com-20081007102020-s2fwyr62jzvle0tx
Tags: upstream-0.4.4
Import upstream version 0.4.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. -*- mode: rst -*-
 
2
 
 
3
==========================
 
4
pdfposter
 
5
==========================
 
6
-------------------------------------------------------------
 
7
Scale and tile PDF images/pages to print on multiple pages.
 
8
-------------------------------------------------------------
 
9
:Author:  Hartmut Goebel <h.goebel@goebel-consult.de>
 
10
:Version: Version 0.4.4
 
11
:Copyright: GNU Public Licence v3 (GPLv3)
 
12
:Manual section: 1
 
13
 
 
14
.. raw:: manpage
 
15
 
 
16
   .\" disable justification (adjust text to left margin only)
 
17
   .ad l
 
18
 
 
19
 
 
20
SYNOPSIS
 
21
==========
 
22
 
 
23
``pdfposter`` <options> infile outfile
 
24
 
 
25
DESCRIPTION
 
26
============
 
27
 
 
28
``Pdfposter`` can be used to create a large poster by building it from
 
29
multple pages and/or printing it on large media. It expects as input a
 
30
PDF file, normally printing on a single page. The output is again a
 
31
PDF file, maybe containing multiple pages together building the
 
32
poster.
 
33
The input page will be scaled to obtain the desired size.
 
34
 
 
35
.. comment
 
36
  The output pages bear cutmarks and have slightly overlapping
 
37
  images for easier assembling.
 
38
 
 
39
The program uses a simple but efficient method which is possible with
 
40
PDF: All new pages share the same data stream of the scaled page. Thus
 
41
resulting file grows moderatly.
 
42
 
 
43
To control its operation, you need to specify either the size of the
 
44
desired poster or a scale factor for the image:
 
45
 
 
46
- Given the poster size, it calculates the required number of sheets
 
47
  to print on, and from that a scale factor to fill these sheets
 
48
  optimally with the input image.
 
49
 
 
50
- Given a scale factor, it derives the required number of pages from
 
51
  the input image size, and positions the scaled image centered on
 
52
  this area.
 
53
 
 
54
 
 
55
 
 
56
OPTIONS
 
57
========
 
58
 
 
59
General Options
 
60
--------------------
 
61
 
 
62
--version             Show program's version number and exit
 
63
-h, --help            Show help message and exit
 
64
--help-media-names    List available media and disctance names and exit
 
65
-v, --verbose         Be verbose. Tell about scaling, rotation and number of
 
66
                      pages. Can be used more than once to increase the
 
67
                      verbosity.
 
68
-n, --dry-run     Show what would have been done, but do not generate files.
 
69
 
 
70
Defining Output
 
71
-----------------
 
72
 
 
73
-m BOX, --media-size=BOX  Specify the desired media size to print on.
 
74
          See below for *BOX*. The default is A4 in the standard
 
75
          package.
 
76
 
 
77
-p BOX, --poster-size=BOX    Specify the poster size. See below for *BOX*. 
 
78
         pdfposter will autonomously choose scaling and rotation to
 
79
         best fit the input onto the poster (see EXAMPLES below).
 
80
 
 
81
         If you give neither the *-s* nor the *-p* option, the default
 
82
         poster size is identical to the media size.
 
83
 
 
84
-s NUMBER   Specify a linear scaling factor to produce the poster.
 
85
          Together with the input image size and optional margins,
 
86
          this induces an output poster size. So don't specify both *-s*
 
87
          and *-p*. 
 
88
 
 
89
          Default is deriving the scale factor to fit a given poster
 
90
          size.
 
91
 
 
92
Box Definition
 
93
-----------------
 
94
 
 
95
The *BOX* mentioned above is a specification of horizontal and
 
96
vertical size. The syntax is as follows (with multipier being
 
97
specified optionally):
 
98
 
 
99
  *box* = [ *multiplier* ] *unit*
 
100
 
 
101
  *multiplier* = *number* "x" *number*
 
102
 
 
103
  *unit* = *medianame* or *distancename*
 
104
 
 
105
..
 
106
   Only in combination with the *-i* option, the program
 
107
   also understands the offset specification in the *BOX*.
 
108
    <offset> = +<number>,<number>
 
109
    [<offset>]
 
110
    and offset
 
111
 
 
112
Many international media names are recognised by the program, in upper
 
113
and lower case, and can be shortened to their first few characters, as
 
114
long as unique. For instance 'A0', 'Let'. Distance names are like
 
115
'cm', 'inch', 'ft'.
 
116
 
 
117
Medias are typically not quadratic but rectangular, which means width
 
118
and hight differ. Thus using medianames is a bit tricky:
 
119
 
 
120
:10x20cm: obviuos: 10 cm x 20 cm (portrait)
 
121
:20x10cm: same as 10x20cm, since all boxes are rotated to portrait
 
122
          format
 
123
 
 
124
Now when using medianames it gets tricky:
 
125
 
 
126
:1x1a4: same as approx. 21x29cm (21 cm x 29 cm, portrait)
 
127
:1x2a4: same as approx. 21x58cm (21 cm x 58 cm, portrait)
 
128
 
 
129
        This are two a4 pages put together at the *small* side: One
 
130
        portrait page wide and two portrait pages high.
 
131
 
 
132
:2x1a4: same as approx. 42x29cm, which is rotated to portrait and is
 
133
        the same a 29x42cm (29 cm x 42 cm)
 
134
 
 
135
        This are two a4 pages put together at the *long* side: Two
 
136
        portrait pages wide and one portrait page high.
 
137
 
 
138
 
 
139
EXAMPLES
 
140
============
 
141
 
 
142
:pdfposter -mA3 -pA0 a4.pdf out.pdf:
 
143
       Prints an A4 input file on 8 A3 pages, forming an A0 poster.
 
144
 
 
145
:pdfposter -p3x3Let a4.pdf out.pdf:
 
146
       Prints an inputfile on a poster of 3x3 Letter pages.
 
147
 
 
148
..
 
149
  not yet implemented: margins
 
150
  :pdfposter -mA0 -w2x2i input.pdf out.pdf:
 
151
       Enlarges an inputfile to print on a large-media A0 capable
 
152
       device, maintaining 2 inch margins:
 
153
 
 
154
:pdfposter -mA0 input.pdf out.pdf:
 
155
       Enlarges an inputfile to print on a large-media A0 capable
 
156
       device.
 
157
 
 
158
:pdfposter -s4 input.pdf out.pdf:
 
159
       Enlarge an inputfile exactly 4 times, print on the default A4
 
160
       media, and let ``pdfposter`` determine the number of pages
 
161
       required.
 
162
 
 
163
..
 
164
   not yet implemented
 
165
   :pdfposter -mLegal -p1x1m -w10% -C5 input.pdf out.pdf:
 
166
       Scale a postscript image to a poster of about 1 square meter,
 
167
       printing on 'Legal' media, maintaining a 10% of 'Legal' size
 
168
       as white margin around the poster. Print cutmark lines and grid
 
169
       labels, but don't print cut mark arrow heads.
 
170
 
 
171
 
 
172
:pdfposter -m10x10cm -pa0 a4.pdf out.pdf:
 
173
  Just to show how efficient ``pdfposter`` is: This will create a file
 
174
  containing 192 pages, but only 15 times as big as the single page.
 
175
  With a4.pdf being a quite empty page, this ratio should be even
 
176
  better for filled pages.
 
177
 
 
178
More examples including sample pictures can be found at
 
179
http://pdfposter.origo.ethz.ch/wiki/examples
 
180
 
 
181
Examples for automatic scaling
 
182
------------------------------------
 
183
 
 
184
* For printing 2 *portrait* A4 pages high (approx. 58cm) and let
 
185
  pdfposter determine how many portrait pages wide, specify a lage
 
186
  number of *vertical* pages. eg:
 
187
 
 
188
     :pdfposter -p999x2a4 testpage-wide.pdf out.pdf:
 
189
 
 
190
* For printing 2 *landscape* A4 pages high (approx. 20cm) and let
 
191
  pdfposter determine how many landscape pages wide, specify a lage
 
192
  number of *horizontal* pages. eg:
 
193
 
 
194
     :pdfposter -p2x999a4 testpage-wide.pdf out.pdf:
 
195
 
 
196
 
 
197
SEE ALSO
 
198
=============
 
199
 
 
200
``poster``\(1)
 
201
 
 
202
Project Homepage http://pdfposter.origo.ethz.ch/