.\" 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 \*(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 . .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 .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 .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