NAME
pdfjam - A shell script for manipulating PDF files
SYNOPSIS
pdfjam [OPTIONS] [--] [FILE1 [SEL1]] [FILE2 [SEL2]]...
DESCRIPTION
pdfjam provides a front end to most capabilities of the "pdfpages"
package (by Andreas Matthias) of pdflatex. Detailed information can be
found via "pdfjam --help", and also in the web page mentioned below .
A working installation of pdflatex, with the pdfpages package, is
required.
The pdfjam script is distributed as (the main) part of the PDFjam
package. The homepage of PDFjam is at http://go.warwick.ac.uk/pdfjam .
USAGE
´FILE1’ etc. in the example above are PDF files. For input from
/dev/stdin, use the special name
’/dev/stdin’ in place of any of FILE1, FILE2, etc: this can be
mixed with ’real’ files as needed, to allow PDF data to be input
through a pipe (note that if /dev/stdin is connected to tty, an
error results). If ’FILE1’ is absent, pdfjam will use
’/dev/stdin’ (and will use ’-’ for the page selection -- see
next item).
´SEL1’ is a page selection for FILE1, etc. To select all pages (the
default) use ’-’.
See the pdfpages manual for more details. An example:
... file1 ’{},2,4-5,9-’ ...
makes an empty page, followed by pages 2,4,5,6 of file1, followed by
pages 9 onwards (up to the end of file1). A page selection can be
applied to more than one file, e.g.,
... file1 file2 file3 1-7 ...
applies page selection ’1-7’ to all three files; but for example
... file1 file2 2- file3 1-7 ...
would apply the page selection ’2-’ to file1 and file2, and ’1-7’ to
file3. A page selection applies to all the files *immediately*
preceding it in the argument list. A missing page selection defaults
to ’-’; this includes the case where ’FILE1’ is absent and so
/dev/stdin gets used by default. ’options’ are pdfpages specifications
in the form ’--KEY VALUE’ (see below), or
--help (or -h, or -u)
Output this text only; no processing of PDF files.
--configpath
Output the ’configpath’ variable and exit immediately; no
processing of PDF files.
--quiet
(or -q)
Suppress verbose commentary on progress.
--batch
Run pdfjam sequentially on each input file in turn, and produce
a separate output file for each input, rather than the default
behaviour (which is a single run of pdfjam on all of the input
files, producing a single output document). For the location of
output files, see ’--outfile’. The --batch option cannot be
used in the case of input fron stdin.
--outfile PATH
(or -o PATH)
Specifies where the output file(s) will go. If PATH is an
existing directory, pdfjam will attempt to write its output PDF
file(s) there, with name(s) derived from the input file name(s)
and the --suffix option (see below). Otherwise the output file
will be PATH. If ’/dev/stdin’ is the only or last input file,
PATH cannot be a directory. Your current default PATH for
output is: /home/ed/debian/dev/pdfjam
--suffix STRING
Specifies a suffix for output file names, to be used when
--outfile is either (a) a directory, or (b) not specified in a
--batch call.
A good STRING should be descriptive: for example,
--suffix ’rotated’
would append the text ’-rotated’ to the name of the input file
in order to make the output file name, as in
’myfile-rotated.pdf’. The STRING must not have zero length.
[Default for you at this site: suffix=pdfjam]
--checkfiles
--no-checkfiles
If the Unix ’file’ utility is available, with options -L and -b,
the output of ’file -Lb FILE1’ should be ’PDF document...’ where
’...’ gives version information. If this is the case on your
system you should use ’--checkfiles’; otherwise use
’--no-checkfiles’, in which case all input PDF files must have
.pdf or .PDF as their name extension. [Default for you at this
site: checkfiles=false]
--preamble STRING
Append the supplied STRING to the preamble of the LaTeX source
file(s), immediately before the ’\begin{document}’ line. An
example:
pdfjam --nup 2x2 myfile.pdf -o myfile-4up.pdf \
--preamble ’\usepackage{fancyhdr} \pagestyle{fancy}’
The --preamble option can be used, for example, to load LaTeX
packages and/or to set global options.
--keepinfo
--no-keepinfo
Preserve (or not) Title, Author, Subject and Keywords (from the
last input PDF file, if more than one) in the output PDF file.
This requires the pdfinfo utility, from the xpdf package, and
the LaTeX ’hyperref’ package; if either of those is not
available, ’--keepinfo’ is ignored. [Default for you at this
site: keepinfo=false]
--pdftitle STRING
--pdfauthor STRING
--pdfsubject STRING
--pdfkeywords STRING
Provide text for the Title, Author, Subject and Keywords in the
output PDF file. Requires the LaTeX ’hyperref’ package. These
options, individually, over-ride --keepinfo.
--landscape
--no-landscape
Specify landscape page orientation (or not) in the output PDF
file. [Default for you at this site: landscape=]
--twoside
--no-twoside
Specify (or not) the ’twoside’ document class option. [Default
for you at this site: twoside=]
--paper PAPERSPEC
(or simply --PAPERSPEC)
Specify a LaTeX paper size, for example ’--paper a4paper’ or
simply ’--a4paper’ for ISO A4 paper. If the LaTeX ’geometry’
package is installed, a wider range of paper sizes is available.
For details see documentation for LaTeX and/or the ’geometry’
package. [Default for you at this site: paper=a4paper]
--papersize ’{WIDTH,HEIGHT}’
Specify a custom paper size, e.g.,
--papersize ’{10in,18cm}’
(Note the braces, and the comma!) If the ’geometry’ package is
not found, this has no effect.
--pagecolor RGBSPEC
Specify a background colour for the output pages. The RGBSPEC
must be a comma-separated trio of integers between 0 and 255.
An example:
--pagecolor 150,200,150
[Default is no background colour]
--tidy
--no-tidy
Specify whether the temporary directory created by pdfjam should
be deleted. Use ’--no-tidy’ to help debug most errors.
[Default for you at this site: tidy=true]
--vanilla
Suppress the reading of any site-wide or user-specific
configuration files.
--KEY VALUE
Specify options to ’\includepdfmerge’, in the LaTeX ’pdfpages’
package. Here KEY is the name of any of the many options for
’\includepdfmerge’, and VALUE is a corresponding value.
Examples are:
--nup 2x1
(for 2-up side-by-side imposition)
--scale 0.7
(to scale all input pages to 70% size)
--offset ’1cm 0.5cm’
(to offset all pages -- note the quotes!)
--frame true
(to put a frame round each input page)
--trim ’1cm 2cm 1cm 2cm’ --clip true
(to trim those amounts from left, bottom,
right and top, respectively, of input pages)
etc., etc.
For more information see the manual for
the ’pdfpages’ package, at
http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages
Argument ’--’ can be used to signal that there are no more options to
come.
Defaults for the options ’--suffix’, ’--keepinfo’, ’--paper’,
’--outfile’, ’--landscape’, ’--twoside’, ’--tidy’ and ’--checkfiles’
can be set in site-wide or user-specific configuration files. The path
that is searched for site-wide configuration files (named pdfjam.conf)
at this installation is
/etc:/usr/share/etc:/usr/local/share:/usr/local/etc
This configuration path can be changed by editing the pdfjam script if
necessary. Any user-specific configuration should be put in a file
named .pdfjam.conf in your home directory. (All of these files are
ignored if the ’--vanilla’ argument is used.)
For more information, including an example configuration file, see
http://go.warwick.ac.uk/pdfjam.
SETUP
See http://go.warwick.ac.uk/pdfjam .
For further information and some examples see
http://go.warwick.ac.uk/pdfjam .
CONFIGURATION FILES
Configuration of the PDFjam utilities involves specifying the location
of pdflatex, the location of temporary files, specification of default
page size, etc. This is done in a block of lines near the top of the
pdfjam script; settings made there are over-ridden by any that are
found at a site-wide configuration file (at /etc/pdfjam.conf,
/usr/share/etc/pdfjam.conf, /usr/local/share/pdfjam.conf, or
/usr/local/etc/pdfjam.conf), which in turn are over-ridden by any that
are found in a user-defaults file at ~/.pdfjam.conf.
LIMITATIONS AND BUGS
pdfjam does not work with encrypted PDF files, and does not preserve
hyperlinks.
Please report bugs! See the website at http://go.warwick.ac.uk/pdfjam .
LICENSE
PDFjam is distributed under the GNU public license.
AUTHOR
The PDFjam package is written and maintained by David Firth.
The USAGE chapter was inserted by Eduard Bloch <blade@debian.org> using
pdfjam output processed with help2man and with manual corrections
applied.
10 March 2010 pdfjam(1)