Add Context from Cory's website
[ccbib.git] / psutils / pstops.man
blob350af6c299060ba6575520fa1eabd33c892c6888
1 .TH PSTOPS 1 "PSUtils Release @RELEASE@ Patchlevel @PATCHLEVEL@"
2 .SH NAME
3 pstops \- shuffle pages in a PostScript file
4 .SH SYNOPSIS
5 .B pstops
7 .B \-q
8 ] [
9 .B \-b
10 ] [
11 .B \-w\fIwidth\fR
12 ] [
13 .B \-h\fIheight\fR
14 ] [
15 .B \-p\fIpaper\fR
16 ] [
17 .B \-d\fIlwidth\fR
19 .I pagespecs
21 .I infile
23 .I outfile
24 ] ]
25 .SH DESCRIPTION
26 .I Pstops
27 rearranges pages from a PostScript document, creating a new PostScript file.
28 The input PostScript file should follow the Adobe Document Structuring
29 Conventions.
30 .I Pstops
31 can be used to perform a large number of arbitrary re-arrangements of
32 Documents, including arranging for printing 2-up, 4-up, booklets, reversing,
33 selecting front or back sides of documents, scaling, etc.
34 .PP
35 .I pagespecs
36 follow the syntax:
37 .RS
38 .TP 12
39 .I pagespecs
40 .I = [modulo:]specs
41 .TP
42 .I specs
43 .I = spec[+specs][,specs]
44 .TP
45 .I spec
46 .I = [-]pageno[L][R][U][@scale][(xoff,yoff)]
47 .RE
48 .sp
49 .I modulo
50 is the number of pages in each block. The value of
51 .I modulo
52 should be greater than 0; the default value is 1.
53 .I specs
54 are the page specifications for the pages in each block. The value of the
55 .I pageno
56 in each
57 .I spec
58 should be between 0 (for the first page in the block) and \fImodulo\fR-1
59 (for the last page in each block) inclusive.
60 The optional dimensions
61 .I xoff
62 and
63 .I yoff
64 shift the page by the specified amount.
65 .I xoff
66 and
67 .I yoff
68 are in PostScript's points, but may be followed by the units
69 .B "cm"
71 .B "in"
72 to convert to centimetres or inches, or the flag
73 .B "w"
75 .B "h"
76 to specify as a multiple of the width or height.
77 The optional parameters \fIL\fR, \fIR\fR, and \fIU\fR rotate the page left,
78 right, or upside-down.
79 The optional
80 .I scale
81 parameter scales the page by the fraction specified.
82 If the optional minus sign is specified, the page is relative to the end of
83 the document, instead of the start.
85 If page \fIspec\fRs are separated by
86 .B \+
87 the pages will be merged into one page; if they are separated by
88 .B \,
89 they will be on separate pages.
90 If there is only one page specification, with
91 .I pageno
92 zero, the \fIpageno\fR may be omitted.
94 The shift, rotation, and scaling are performed
95 in that order regardless of which order
96 they appear on the command line.
97 .PP
98 The
99 .I \-w
100 option gives the width which is used by the
101 .B "w"
102 dimension specifier, and the
103 .I \-h
104 option gives the height which is used by the
105 .B "h"
106 dimension specifier. These dimensions are also used (after scaling) to set the
107 clipping path for each page.
108 The 
109 .I \-p
110 option can be used as an alternative, to set the paper size to
111 .B a3, a4, a5, b5, letter, legal, tabloid, statement, executive, folio, quarto
113 .B 10x14.
114 The default paper size is
115 .B @PAPER@.
118 .I \-b
119 option prevents any
120 .B bind
121 operators in the PostScript prolog from binding. This may be needed in cases
122 where complex multi-page re-arrangements are being done.
125 .I \-d
126 option draws a line around the border of each page, of the specified width.
127 If the \fIlwidth\fR parameter is omitted, a default linewidth of 1 point is
128 assumed. The linewidth is relative to the original page dimensions,
129 \fIi.e.\fR it is scaled up or down with the rest of the page.
131 Pstops normally prints the page numbers of the pages re-arranged; the
132 .I \-q
133 option suppresses this.
134 .SH EXAMPLES
135 This section contains some sample re-arrangements. To put two pages on one
136 sheet (of A4 paper), the pagespec to use is:
139 2:0L@.7(21cm,0)+1L@.7(21cm,14.85cm)
141 To select all of the odd pages in reverse order, use:
144 2:-0
146 To re-arrange pages for printing 2-up booklets, use
149 4:-3L@.7(21cm,0)+0L@.7(21cm,14.85cm)
151 for the front sides, and
154 4:1L@.7(21cm,0)+-2L@.7(21cm,14.85cm)
156 for the reverse sides (or join them with a comma for duplex printing).
157 .SH AUTHOR
158 Copyright (C) Angus J. C. Duggan 1991-1995
159 .SH "SEE ALSO"
160 @MAN@
161 .SH TRADEMARKS
162 .B PostScript
163 is a trademark of Adobe Systems Incorporated.
164 .SH BUGS
165 .I Pstops
166 does not accept all DSC comments.