summaryrefslogtreecommitdiff
path: root/support/wheretotrim/wheretotrim.1
blob: 2cf8ba4debb3c7196b7a0f46d04cb3fa1ab6df6c (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "WHERETOTRIM 1"
.TH WHERETOTRIM 1 "2013-05-14" "v1.0" ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
wheretotrim \- Help reduce the page count of a LaTeX document
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
wheretotrim
[\fB\-\-verbose\fR | \fB\-\-quiet\fR]
[\fB\-\-allpages\fR]
[\fB\-\-debug\fR=\fIpage\fR,\fIcolumn\fR,\fIlines\fR]
\&\fIlatex command\fR
.PP
wheretotrim [\fB\-\-verbose\fR] \fB\-\-help\fR|\fB\-\-version\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBwheretotrim\fR is a tool to help LaTeX users reduce their document's
page count.  It is intended to be used with documents that exceed a
publisher's specified page-length limitation by a small amount (much
less than a full column or page).  \fBwheretotrim\fR operates by building
the document repeatedly, successively expanding each column on each
page by one line height to mimic reducing the amount of text in that
column by an equivalent amount.  If doing so does not reduce the page
count, \fBwheretotrim\fR repeats the process with two line heights'
expansion of each column, then three, and so forth until it expands
each column in turn by the full height of the column.  The following
is some sample output:
.PP
.Vb 1
\&    To reduce the page count from 10 to 9, do any of the following:
\&
\&      * Reduce page 9, column 1 by 12 lines.
\&      * Reduce page 9, column 2 by 12 lines.
\&      * Reduce page 10, column 1 by 12 lines.
\&
\&    Note: 12 lines = 2.4" = 6.1 cm = 26.8% of the column height
.Ve
.PP
That is, reducing either column on page\ 9 or the first column on
page\ 10 by 12 lines is the most expedient way to reduce the
document's page count.  More than 12\ lines would need to be cut on
other columns and other pages to achieve the same effect.
.SH "OPTIONS"
.IX Header "OPTIONS"
\&\fBwheretotrim\fR accepts the following command-line options:
.IP "\fB\-a\fR, \fB\-\-allpages\fR" 4
.IX Item "-a, --allpages"
Perform enough extra runs of \fBlatex\fR to report the amount of space
that must be trimmed from \fIeach\fR column or page to reduce page count,
not just the columns or pages to which the page count is the most
sensitive.
.IP "\fB\-v\fR, \fB\-\-verbose\fR" 4
.IX Item "-v, --verbose"
Display the output of each run of \fBlatex\fR.  This is useful for
troubleshooting and to help monitor the progress of long \fBlatex\fR
runs.
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
.IX Item "-q, --quiet"
Suppress progress updates and output only the final report.
.IP "\fB\-d\fR \fIpage\fR,\fIcolumn\fR,\fIlines\fR, \fB\-\-debug\fR=\fIpage\fR,\fIcolumn\fR,\fIlines\fR" 4
.IX Item "-d page,column,lines, --debug=page,column,lines"
Debug \fBwheretotrim\fR's execution by expanding page \fIpage\fR, column
\&\fIcolumn\fR by \fIlines\fR line heights and leaving the \fBlatex\fR output in
that state.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Summarize usage information and exit.  These may be used with
\&\fB\-\-verbose\fR to display more extended documentation.
.IP "\fB\-V\fR, \fB\-\-version\fR" 4
.IX Item "-V, --version"
Display \fBwheretotrim\fR's version number and exit.
.PP
In addition to the preceding options, \fBwheretotrim\fR requires a
\&\fIlatex command\fR argument that specifies how to build the document.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
For the most basic usage, simply provide a \fBlatex\fR command to run:
.PP
.Vb 1
\&    wheretotrim latex myfile.tex
.Ve
.PP
or, for example,
.PP
.Vb 1
\&    wheretotrim pdflatex myfile.tex
.Ve
.PP
\&\fBwheretotrim\fR executes the specified command a large number of times
and finally terminates with a report resembling the following:
.PP
.Vb 1
\&    To reduce the page count from 10 to 9, do any of the following:
\&
\&      * Reduce page 9, column 1 by 12 lines.
\&      * Reduce page 9, column 2 by 12 lines.
\&      * Reduce page 10, column 1 by 12 lines.
\&
\&    Note: 12 lines = 2.4" = 6.1 cm = 26.8% of the column height
.Ve
.PP
To ask \fBwheretotrim\fR to report how much space needs to be trimmed on
each column and page to reduce the total page count, specify the
\&\fB\-\-allpages\fR option:
.PP
.Vb 1
\&    wheretotrim \-\-allpages latex myfile.tex
.Ve
.PP
The output now looks like the following:
.PP
.Vb 1
\&    To reduce the page count from 10 to 9, do any of the following:
\&
\&      * Reduce page 1, column 1 by 13 lines.
\&      * Reduce page 1, column 2 by 13 lines.
\&      * Reduce page 2, column 1 by 13 lines.
\&      * Reduce page 2, column 2 by 13 lines.
\&      * Reduce page 4, column 1 by 13 lines.
\&      * Reduce page 4, column 2 by 13 lines.
\&      * Reduce page 5, column 1 by 13 lines.
\&      * Reduce page 5, column 2 by 13 lines.
\&      * Reduce page 6, column 1 by 13 lines.
\&      * Reduce page 6, column 2 by 13 lines.
\&      * Reduce page 7, column 1 by 13 lines.
\&      * Reduce page 7, column 2 by 13 lines.
\&      * Reduce page 8, column 1 by 13 lines.
\&      * Reduce page 8, column 2 by 13 lines.
\&      * Reduce page 9, column 1 by 12 lines.
\&      * Reduce page 9, column 2 by 12 lines.
\&      * Reduce page 10, column 1 by 12 lines.
\&
\&    Note: 12 lines = 2.4" = 6.1 cm = 26.8% of the column height
.Ve
.PP
If you're curious how the document managed to shrink substantially as
the result of a relatively minor text reduction, you can typeset the
document with a particular page and column enlarged by a given amount:
.PP
.Vb 1
\&    wheretotrim \-\-debug=9,1,12 latex myfile.tex
.Ve
.SH "CAVEATS"
.IX Header "CAVEATS"
\&\fBwheretotrim\fR hooks into LaTeX's output routines, which are
notoriously arcane and somewhat fragile.  As a result, it is quite
likely that \fBwheretotrim\fR will fail to analyze a large set of
documents.  Use the \fB\-\-verbose\fR flag to help identify any problems
that \fBlatex\fR encounters.
.PP
In many cases, \fBwheretotrim\fR will recover by simply ignoring a few
possible page and column expansions.  For example, certain expansions
may result in a \f(CW\*(C`Float(s)
lost <http://www.tex.ac.uk/cgi-bin/texfaq2html?label=fllost>\*(C'\fR message.
In other cases, \fBwheretotrim\fR will fail to analyze any modification
to the document.  For example, it may receive an \f(CW\*(C`Infinite glue
shrinkage found in box being split\*(C'\fR error from every page and column
variation it tries.  In this particular case, see the discussion at
<http://www.michaelshell.org/tex/ieeetran/>.
.PP
When \fBwheretotrim\fR is used with a \fBlatex\fR auto-build script you may
need to take measures to force the script to rebuild the document even
if it appears that no files have changed.  For example, \fBlatexmk\fR
should be given the \fB\-CF\fR option to force rebuilding:
.PP
.Vb 1
\&    wheretotrim latexmk \-CF myfile.tex
.Ve
.SH "RESTRICTIONS"
.IX Header "RESTRICTIONS"
\&\fBwheretotrim\fR is implemented as a Perl script with an auxiliary LaTeX
package.  It has been tested only on Linux, but I suspect that it
should also work on \s-1OS\s0\ X.  I doubt it will work under Windows,
though, due to the way the script uses a \fBbash\fR\-specific technique
for redirecting the standard error device into the standard output
device.
.SH "AUTHOR"
.IX Header "AUTHOR"
Scott Pakin, \fIscott+wtt@pakin.org\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2013, Scott Pakin <scott+wtt@pakin.org>
.PP
This file may be distributed and/or modified under the conditions of
the LaTeX Project Public License, either version 1.3c of this license
or (at your option) any later version.  The latest version of this
license is in:
.IP "\" 4
http://www.latex\-project.org/lppl.txt <http://www.latex-project.org/lppl.txt>
.PP
and version 1.3c or later is part of all distributions of LaTeX
version 2008/05/04 or later.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIlatex\fR\|(1),
the savetrees package <http://www.ctan.org/pkg/savetrees/>