diff options
| author | Karl Berry <karl@freefriends.org> | 2019-11-19 00:11:53 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2019-11-19 00:11:53 +0000 |
| commit | db76355f7b5a9e9c58d4bb71e9b44d96f6b72fa3 (patch) | |
| tree | 3e395adc1da9237176fbd32020b49887226cb696 /Master/texmf-dist/doc/support | |
| parent | e0f7e24187626cc11a2dfdb9f9e22660f0b536a9 (diff) | |
pdfjam (19nov19)
git-svn-id: svn://tug.org/texlive/trunk@52857 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/PDFjam-README.html | 370 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/README.md | 690 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/VERSION | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/pdfdroplets.png | bin | 34752 -> 0 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/pdfjam.conf | 28 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/pdfjam/tests.zip | bin | 121159 -> 94793 bytes |
6 files changed, 708 insertions, 382 deletions
diff --git a/Master/texmf-dist/doc/support/pdfjam/PDFjam-README.html b/Master/texmf-dist/doc/support/pdfjam/PDFjam-README.html deleted file mode 100644 index fcfdd9ac014..00000000000 --- a/Master/texmf-dist/doc/support/pdfjam/PDFjam-README.html +++ /dev/null @@ -1,370 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" -"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> <html> -<head> -<title>PDFjam-README.html</title> -<!-- pdfmerge, pdfcat, pdfrotate --> -</head> - -<body> - -<p><em>Author</em>: David Firth, <a href="http://go.warwick.ac.uk/dfirth">http://go.warwick.ac.uk/dfirth</a></p> - -<p> <strong> This file is kept up to date at <a href="http://go.warwick.ac.uk/pdfjam" _mce_href="http://go.warwick.ac.uk/pdfjam">http://go.warwick.ac.uk/pdfjam</a>. </strong> </p> -<ul> - <li><a href="#overview">Overview</a> </li> - <li><a href="#prereq">Pre-requisites</a> </li> - <li><a href="#documentation">Documentation</a> </li> - <li><a href="#download">Download</a> </li> - <li><a href="#install">Installation/configuration</a> </li> - <li><a href="#using">Using the scripts</a> </li> - <li><a href="#droplets">Mac OS X only: drag-and-drop</a> </li> - <li><a href="#faq">FAQ</a> </li> - <li><a href="#bugs">Reporting bugs</a> </li> - <li><a href="#history">Version history</a> </li> -</ul> - -<p> <a name="overview"></a> </p> - -<h2 align="justify">Overview</h2> - -<p><strong>PDFjam</strong> is a small collection of shell scripts which provide a simple interface to much of the functionality of the excellent <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf" title="Link to the pdfpages manual (PDF)">pdfpages <img src="http://www2.warwick.ac.uk/brands/icons/acrobat.gif" alt="PDF file" title="PDF file" border="0" height="16" width="16" /></a> package (by Andreas Matthias) for <a href="http://www.tug.org/applications/pdftex/">pdfLaTeX</a>. These scripts take one or more PDF files (and/or JPG/PNG graphics files) as input, and produce one or more PDF files as output. They are useful for joining files together, selecting pages, reducing several source pages onto one output page, etc., etc.</p> - -<p>The main script is named "<strong><tt>pdfjam</tt></strong>". This is the core of the package.</p> - -<p>All of the other scripts provided in the PDFjam package are optional extras. They are simple wrappers for calls to <tt>pdfjam</tt>, designed to perform some common tasks such as joining or n-upping PDF files or to illustrate other features; they are not very elaborate, nor are they extensively tested. They are probably best thought of as simple templates that can be used for constructing more elaborate wrapper scripts as required. At present the wrapper scripts distributed in the PDFjam package are: </p> - -<ul> - <li> <strong><tt>pdfnup</tt></strong>, which allows one or more PDF files to be "n-upped" in roughly the way that <a href="http://www.tardis.ed.ac.uk/~ajcd/psutils/psnup.html"><tt>psnup</tt></a> does for PostScript files. (This was the original motivation: for files that have to be printed, or have to be made available to dozens or hundreds of other people for printing, n-up formatting saves trees!)</li> - <li><strong><tt>pdfpun</tt></strong>, similar to <tt>pdfnup</tt> but arranges the source pages right-to-left on the output page, ie in a format more suitable for right-to-left languages. This script works only on one file at a time. (Thanks to Ido for suggesting this.)</li> - <li> <strong><tt>pdfjoin</tt></strong>, which combines the pages of multiple PDF files together into a single file.</li> - <li> <strong><tt>pdf90</tt></strong>, <strong><tt>pdf180</tt></strong> and <strong><tt>pdf270</tt></strong> which rotate the pages of one or more PDF files.</li> - <li><strong><tt>pdfflip</tt></strong> which reflects the pages of one or more PDF files. (Suitable for making transparencies if you want to write on the back of them!)</li> - <li><strong><tt>pdfbook</tt></strong> which arranges pages into 2-up "signatures" (like <a href="http://www.tardis.ed.ac.uk/~ajcd/psutils/psbook.html"><tt>psbook</tt></a> does for PostScript files), suitable for binding into a book. (Many people have suggested that this would be useful — I hope it is!)</li> - <li><strong><tt>pdfjam-pocketmod</tt></strong> which converts 8 pages from a single PDF file into a pocket-sized booklet. (<a href="http://repocketmod.com/">Folding instructions here!</a> Thanks to Thomas Nemeth for suggesting this.)</li> - <li><strong><tt>pdfjam-slides6up</tt></strong> and <strong><tt>pdfjam-slides3up</tt></strong> which process PDF presentation slides to six-per-page or three-per-page for handout purposes. </li> -</ul> - -<p> A potential drawback of <tt>pdfjam</tt> and other scripts based upon it is that any hyperlinks in the source PDF are lost. On the positive side, there is no appreciable degradation of image quality in processing PDF files with these programs, unlike some other indirect methods such as <tt>pdf2ps | psnup | ps2pdf</tt> (in the author's experience). </p> - -<p> These tools are designed for Unix-like systems, including Linux and Mac OS X. It seems that they will work also on Windows computers with a suitable installation of <a href="http://www.cygwin.com/">Cygwin</a> (with the Cygwin <tt>tetex-extras</tt> package installed), but this has not been extensively tested.</p> - -<p> An alternative set of PDF manipulation tools, which are java-based, is provided by the <a href="http://multivalent.sourceforge.net/">Multivalent</a> project. They do much the same things as <tt>pdfjam</tt>, and quite a bit more. Hyperlinks don't seem to be preserved there either, though, when n-upping a document. </p> - -<p> For Mac OS X, n-up with a more visual interface is provided by <a href="http://evolve.lse.ac.uk/software/PDFNupMaker/">PDF Nup Maker</a>. Like <tt>pdfjam</tt>, this is a front end to pdflatex/pdfpages. </p> - -<p> The PDFjam software is made available free, under GPL version 2 (see the file named <tt>COPYING</tt> that is included with the package). It comes with ABSOLUTELY NO WARRANTY of fitness for any purpose whatever. </p> - -<p> <a name="prereq"></a></p> - -<h2 align="justify">Pre-requisites</h2> - -<ol> - <li>A Unix-like operating system (Linux, Mac OS X, Solaris, etc.; possibly Cygwin)</li> - <li>A working, up-to-date installation of <a href="http://www.tug.org/applications/pdftex">pdfTeX</a> (including <tt>pdflatex</tt> and an up-to-date copy of <a href="http://pdftex-def.berlios.de/"><tt>pdftex.def</tt></a>)</li> - <li>A working installation of the LaTeX package <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages">pdfpages</a> (version 0.4f or later)</li> -</ol> - -<p>Some of the options offered by <tt>pdfjam</tt> also require the LaTeX packages <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/geometry/">geometry</a> and <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref/">hyperref</a>.</p> - -<p> <a name="documentation"></a></p> - -<h2 align="justify">Documentation</h2> - -<p>The primary documentation for <tt>pdfjam</tt>, and hence for the other scripts that call it, is obtained by </p> - -<pre> pdfjam --help -</pre> -<p>This gives information on the arguments to <tt>pdfjam</tt>, and the default settings that apply at your installation. In addition to the arguments that are explicitly documented there, <tt>pdfjam</tt> provides access to all of the options of the pdfpages package: that's a large number of options, and it's a set of options that might change, so users are referred to the current <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf" title="Link to the pdfpages manual (PDF)">pdfpages manual <img src="http://www2.warwick.ac.uk/brands/icons/acrobat.gif" alt="PDF file" title="PDF file" border="0" height="16" width="16" /></a> to see what's available.</p> - -<p>In addition, each of the scripts has a (rather basic) <tt>man</tt> page. For example,</p> - -<pre> man pdfjam-pocketmod -</pre> -<p>gives information about usage and other aspects of the <tt>pdfjam-pocketmod</tt> script.</p> - -<p> <a name="download"></a></p> - -<h2 align="justify">Download</h2> - -<p>PDFjam is a project at <a href="http://freshmeat.net/projects/pdfjam/">freshmeat</a>: please subscribe there to receive update announcements.</p> - -<p>Download the shell scripts as <a href="http://www2.warwick.ac.uk/fac/sci/statistics/staff/academic/firth/software/pdfjam/pdfjam_latest.tgz">pdfjam_latest.tgz</a>. </p> - -<p>(If for some reason you don't want the latest version, you can still get older versions. Since version 2.00 the URLs are all of the form <tt>http://go.warwick.ac.uk/pdfjam/pdfjam_VN.tgz</tt>, with "VN" representing the version number. So "VN" could be 2.00, 2.01, 2.02, 2.03 or 2.04; from PDFjam version 2.05 onwards, the dot will be omitted from the version number in the file name, so "VN" will be 205, 206, etc.)</p> - -<p>Various people have kindly packaged PDFjam for distribution in other ways (and perhaps there are some not listed here?): </p> - -<ul> - <li>Eduard Bloch has packaged <a href="http://packages.debian.org/unstable/text/pdfjam">PDFjam for Debian</a> </li> - <li>Paul Chvostek has made a <a href="http://www.freebsd.org/cgi/ports.cgi?query=pdfjam">port to FreeBSD</a> </li> - <li>Pander has provided a link to <a href="http://packages.ubuntu.com/search?keywords=pdfjam">Ubuntu packages</a> </li> - <li>Petr Uzel has made available <a href="http://software.opensuse.org/search?baseproject=ALL&p=1&q=pdfjam">openSUSE packages</a> </li> - <li>Alexis Ballier has provided a <a href="http://packages.gentoo.org/package/app-text/pdfjam">Gentoo package</a> </li> - <li>Karl Berry has provided a <a href="http://mirror.ctan.org/support/pdfjam">CTAN package</a>.</li> -</ul> - -<p>Cosmin Popescu has written a <a href="http://qt-apps.org/content/show.php/pdfnup-gui?content=134874.">front-end to the pdfnup script, based on Qt</a>.<br /> - </p> - -<p>To download some stand-alone <em>Mac OS X droplets</em> (based on PDFjam version 1.21), see <a href="#droplets">below</a>. </p> - -<p> <a name="install"></a></p> - -<h2 align="justify">Installation/configuration</h2> - -<p>The shell scripts in the <em>bin</em> sub-directory of the package should be placed on the PATH of anyone who needs to use them.</p> - -<p>The man files in the <em>man1</em> sub-directory should be installed on the <tt>MANPATH</tt> of all who need to read them.</p> - -<p> On many unix-like systems the scripts should run without any further configuration, provided that the pre-requisite TeX installation is present. If you want to check (e.g., prior to installation) that <tt>pdfjam</tt> will work on your system, please unzip the <em>tests</em> sub-directory of the package and follow the instructions that appear in <tt>tests/README-tests.txt</tt>.</p> - -<p>If configuration <em>is</em> needed, this can be done through a site-wide or user-specific configuration file. This might be necessary if, for example, your site has a non-standard TeX installation, or a non-standard location for temporary files, or a paper size that is different from the A4 international standard.</p> - -<p>The file <a href="pdfjam.conf" title="Sample pdfjam configuration file, plain text"><tt>pdfjam.conf</tt></a> is a sample configuration file which can be edited as needed. After editing, either install the file for site-wide use (at <tt>/etc/pdfjam.conf</tt>, <tt>/usr/share/etc/pdfjam.conf</tt>, <tt>/usr/local/share/pdfjam.conf</tt>, or <tt>/usr/local/etc/pdfjam.conf</tt>) or as a user-defaults file at <tt>~/.pdfjam.conf</tt>. User settings made at <tt>~/.pdfjam.conf</tt> override corresponding settings made in a site-wide configuration file.</p> - -<p>For example, if you want your own output to be on "US letter" size paper by default, simply put the line </p> - -<pre> paper=letterpaper -</pre> -<p> in a plain text file named file <tt>.pdfnup.conf</tt> in your home directory. (The code word <tt>letterpaper</tt> is how LaTeX refers to that particular page size; for other available paper sizes, please see the output of <tt>pdfjam --help</tt>.)</p> - -<p>On some systems it might even be necessary to change the list of places (i.e., <tt>/etc/pdfjam.conf</tt> and others as listed above) that is searched for site-wide configuration files. This can only be done by editing the <tt>pdfjam</tt> script itself. To see which directories on <em>your</em> system are searched for a file named <tt>pdfjam.conf</tt>, use </p> - -<pre> pdfjam --configpath -</pre> -<p> <a name="using"></a></p> - -<h2 align="justify">Using the scripts</h2> - -<p>For a full overview of what <tt>pdfjam</tt> can do, the importance of the <a href="http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf" title="Link to the pdfpages manual (PDF)">pdfpages manual <img src="http://www2.warwick.ac.uk/brands/icons/acrobat.gif" alt="PDF file" title="PDF file" border="0" height="16" width="16" /></a> cannot be stressed enough! The following examples merely serve as a brief introduction.</p> - -<h3 align="justify">Example 1</h3> - -<p>Consider converting each of two documents to a side-by-side "2-up" format. Since we want the two documents to be processed separately, we'll use the <tt>--batch</tt> option: </p> - -<pre> pdfjam --batch --nup 2x1 --suffix 2up --landscape --outfile . file1.pdf file2.pdf -</pre> -<p> This will produce new files <tt>file1-2up.pdf</tt> and <tt>file2-2up.pdf</tt> in the current working directory. The above call could be shortened a bit, by using <tt>pdfnup</tt>, to</p> - -<pre> pdfnup --batch --suffix 2up file1.pdf file2.pdf -</pre> -<p> In a 'vanilla' installation of <tt>pdfjam</tt>, the default for <tt>--outfile</tt> is the current working directory.</p> - -<h3 align="justify">Example 2</h3> - -<p>Suppose we want a single new document which puts together selected pages from two different files: </p> - -<pre> pdfjam file1.pdf '{},2-' file2.pdf '10,3-6' --outfile ../myNewFile.pdf -</pre> -<p>The new file <tt>myNewFile.pdf</tt>, in the parent directory of the current one, contains an empty page, followed by all pages of <tt>file1.pdf</tt> except the first, followed by pages 10, 3, 4, 5 and 6 from <tt>file2.pdf</tt>. </p> - -<p> The resulting PDF page size will be whatever is the default paper size for you at your site. If instead you want to preserve the page size of (the first included page from) <tt>file1.pdf</tt>, use the option <tt>--fitpaper true</tt>: this is the default action of the <tt>pdfjoin</tt> convenience script. </p> - -<p>(All pages in an output file from <tt>pdfjam</tt> will have the same size and orientation: for joining together PDF files while preserving different page sizes and orientations, <tt>pdfjam</tt> is not the tool to use; and since <tt>pdfjoin</tt> simply calls <tt>pdfjam</tt>, the same comment applies also to <tt>pdfjoin</tt>. I'm told that if you have <a href="http://pages.cs.wisc.edu/~ghost/">Ghostscript</a> installed, something along these lines might more nicely join files with different page sizes and orientations: </p> - -<pre> gs -dBATCH -dNOPAUSE -q -sDEVICE=pdfwrite -sOutputFile=finished.pdf file1.pdf file2.pdf -</pre> -<p>But I haven't tried it.)</p> - -<h3 align="justify">Example 3</h3> - -<p>To make a portrait-oriented 4-up file from the pages of three input files, with a thin-line frame around the input pages,</p> - -<pre> pdfjam file1.pdf file2.pdf file3.pdf --no-landscape --frame true --nup 2x2 \ - --suffix 4up --outfile ~/Documents -</pre> -<p>Here a <em>directory</em> was specified at <tt>--outfile</tt>: the resultant file in this case will be ~/Documents/file3-4up.pdf. (Note that <strong>if there's a writeable file with that name already, it will be overwritten</strong>: no check is made, and no warning given.)</p> - -<h3 align="justify">Example 4</h3> - -<p>Suppose we have a document made up of "US letter" size pages, and we want to convert it to A4:</p> - -<pre> pdfjam 'my US letter file.pdf' --a4paper --outfile 'my A4 file.pdf' -</pre> -<h3 align="justify">Example 5</h3> - -<p>A useful application of <tt>pdfjam</tt> is for producing a handout from a file of presentation slides. For slides made with the standard 4:3 aspect ratio a nice 6-up handout on A4 paper can be made by </p> - -<pre> pdfjam --nup 2x3 --frame true --noautoscale false --delta "0.2cm 0.3cm" \ - --scale 0.95 myslides.pdf --outfile myhandout.pdf -</pre> -<p>The <tt>--delta</tt> option here comes from the pdfpages package; the <tt>--scale</tt> option is passed to LaTeX's <tt>\includegraphics</tt> command. </p> - -<p>The two wrapper scripts <tt>pdfjam-slides6up</tt> and <tt>pdfjam-slides3up</tt> are provided in order to make this particular application of <tt>pdfjam</tt> easy: for example, </p> - -<pre> pdfjam-slides3up --pagenumbering true --batch slides1.pdf slides2.pdf -</pre> -<p>makes a pair of 3-up handouts <tt>slides1-3up.pdf</tt> and <tt>slides2-3up.pdf</tt>, with space for side-notes and with the handout pages numbered.</p> - -<p>(Slides made by LaTeX's <em>beamer</em> package, using the <tt>handout</tt> class option, work especially nicely with this!)</p> - -<h3 align="justify">Example 6</h3> - -<p> Suppose we want to trim the pages of our input file prior to n-upping. This can be done by using a pipe: </p> - -<pre> pdfjam myfile.pdf --trim '1cm 2cm 1cm 2cm' --clip true --outfile /dev/stdout | \ - pdfnup --frame true --outfile myoutput.pdf -</pre> -<p>The <tt>--trim</tt> option specifies an amount to trim from the left, bottom, right and top sides respectively; to work as intended here it needs also <tt>--clip true</tt>. These (i.e., <tt>trim</tt> and <tt>clip</tt>) are in fact options to LaTeX's <tt>\includegraphics</tt> command (in the standard <em>graphics</em> package).</p> - -<p>(Thanks to Christophe Lange and Christian Lohmaier for suggesting an example on this.)</p> - -<h3 align="justify">Example 7</h3> - -<p>To offset the content of double-sided printed pages so that they are suitable for binding with a <a href="http://de.wikipedia.org/wiki/Heftstreifen">Heftstreifen</a>, use the <tt>--twoside</tt> option:</p> - -<pre> pdfjam --twoside myfile.pdf --offset '1cm 0cm' --suffix 'offset' -</pre> -<h3 align="justify">Example 8</h3> - -<p> To use PDF input files whose names do not end in "<tt>.pdf</tt>", you will need to use the <tt>--checkfiles</tt> option. This depends on the availability of the <tt>file</tt> utility, with support for the options <tt>-Lb</tt>; this can be checked by trying </p> - -<pre> file -Lb 'my PDF file' -</pre> -<p> where <tt>'my PDF file'</tt> is the name of a PDF file on your system. The result should be something like "<tt>PDF document, version 1.4</tt>" (possibly with a different version number).</p> - -<p> With "<tt>file -Lb</tt>" available, we can use PDF files whose names lack the usual "<tt>.pdf</tt>" extension. For example, </p> - -<pre> pdfnup --checkfiles 'my PDF file' -</pre> -<p>should result in a file named "<tt>my PDF file-nup.pdf</tt>" in the current working directory.</p> - -<h3 align="justify">Example 9</h3> - -<p>If you want to print a landscape-oriented PDF document on both sides of the paper, using a duplex printer that does not have 'tumble' capability, make a new version with every second page rotated for printing:</p> - -<pre> pdfjam --landscape --doublepagestwistodd true my-landscape-document.pdf -</pre> -<h3 align="justify">Example 10</h3> - -<p> Please feel free to suggest other examples that might help people! (For the email address, see <a href="#bugs">reporting bugs</a>)</p> - -<p> <a name="droplets"></a></p> - -<h2 align="justify">Mac OS X only: drag-and-drop</h2> - -<p>Under <strong>Mac OS X</strong>, <a href="http://www.wsanchez.net/software/">DropScript</a> has been used to make some simple drag-and-drop applications. Some sample droplets are provided in <a href="http://www.warwick.ac.uk/go/pdfjam/pdfdroplets_1.21.dmg">pdfdroplets_1.21.dmg</a>: these may be all you'll need! The sample droplets look like this: </p> - -<center> <img src="pdfdroplets.png" border="0" /> </center> -<p> These droplets assume that your pdflatex is at <tt>/usr/texbin/pdflatex</tt>. If pdflatex lives somewhere else on your system, the droplets won't work until you include in your home directory a file named <tt>.pdfnup.conf</tt> (or there is a system-wide file <tt>pdfnup.conf</tt> at one of the four locations listed above), containing the line </p> - -<pre>pdflatex=/path/to/pdflatex -</pre> -<p>where <tt> /path/to/pdflatex </tt> is the answer you get when you type <tt> which pdflatex </tt> in the Terminal. (If you get no answer, chances are that you do not have <tt>pdflatex</tt> installed on your Mac; if you need to install it, you could just download and install <a href="http://www.tug.org/mactex">MacTeX</a> or one of its slimmed-down variants.) </p> - -<p> <a name="faq"></a></p> - -<h2 align="justify">FAQ</h2> - -<p> <strong>1. Why "PDFjam"?</strong><br /> - Because it's for PDF files, and jam is what I like best on my toast (well, second best after marmalade, anyway). </p> - -<p> <strong>2. The thing runs but the output doesn't look the way it should. Why?</strong><br /> - Most likely either your pdfTeX or your pdfpages installation is an old version. (Check also that <tt>pdftex.def</tt>, to be found in in <tt>.../texmf/tex/latex/graphics/</tt>, is up to date.) If the problem persists even with up-to-date versions of pdfTeX, <tt>pdftex.def</tt> and pdfpages, then please do report it. </p> - -<p> <a name="bugs"></a></p> - -<h2 align="justify">Reporting bugs</h2> - -<p>Please report any bugs found in these scripts, to d.firth (at warwick.ac.uk).</p> - -<h3>Some known problems:</h3> - -<ul> - <li> In <em>Cygwin</em>, using <tt>pdfjam</tt> in a pipeline does not seem to work. Scripts like <tt>pdfjam-pocketmod</tt>, which use pipelines, therefore do not work there. The problem seems to be with <em>Cygwin</em>'s handling of file descriptors within pipelines.</li> -</ul> - -<p>Solving these problems is on the to-do list: if you have solved one of them already please let me know!</p> - -<p> <a name="history"></a></p> - -<h2 align="justify">Version history</h2> - -<p> <strong>2.08</strong>: fixed a bug in one of the tests [2010-11-14] </p> - -<p> <strong>2.07</strong>: two other common graphics formats (JPG and PNG) are now explicitly allowed as input files (i.e., not only PDF files are allowed as inputs). [2010-11-13] </p> - -<p><strong>2.06</strong>: changed the <tt>pdfbook</tt> script to include <tt>--booklet true</tt> as the default behaviour (thanks to Julien Bossert for this good suggestion). [2010-05-11] </p> - -<p> <strong>2.05</strong>: changes to the <tt>pdfbook</tt> script [the <tt>--right-edge-binding</tt> option is now redundant, and there's a new <tt>--short-edge</tt> option for binding along the short edge of pages instead of the long edge (thanks to Marco Pessotto for this)]. The <tt>--preamble</tt> option to <tt>pdfjam</tt> is enhanced, to allow multiple instances which get concatenated. Also various minor corrections to man pages. [2010-04-25] </p> - -<p> <strong>2.04</strong>: various minor improvements suggested by Debian maintainers (thanks to Eduard Bloch for these). The main things are: addition of the <tt>--version</tt> option; liberalisation of <tt>pdfjam</tt> to allow files in <em>JPEG</em> format to be specified as input, as well as PDF (I don't know why or if this might work! but some people have said it does); tidying of the man files; and more use of <tt>exec</tt>, to avoid forking. [2010-04-22] </p> - -<p> <strong>2.03</strong>: fixed a bug which caused problems when your <tt>/bin/sh</tt> is the <em>zsh</em> shell; fixed a bug which prevented the correct representation of many UTF-8 characters in <tt>pdfinfo</tt> data. [2010-04-20] </p> - -<p> <strong>2.02</strong>: more progress on portability; introduced the beginnings of a suite of tests; improvements in the <tt>--keepinfo</tt> functionality, and in the treatment of file permissions (thanks to Marco Pessotto for these). [2010-04-14] </p> - -<p> <strong>2.01</strong>: fixed a silly bug (thoughtless use of "<tt>test -a</tt>" in a couple of places) which seriously affected portability. [2010-04-13] </p> - -<hr color="grey" /> -<p> <strong>2.00</strong>: a <strong>major re-design</strong>. This is not completely backward-compatible with previous versions of the <tt>pdfnup</tt>, <tt>pdfjoin</tt> and <tt>pdf90</tt> scripts. The differences in interface are few, though, and the main ones are listed below. </p> - -<p>The main changes are:</p> - -<ul> - <li> The new script <tt>pdfjam</tt> now does all the work; all the other scripts included with the package are just simple wrappers for <tt>pdfjam</tt>. </li> - <li> <tt>pdfjam</tt> makes available essentially <em>all</em> of the facilities of the pdfpages package (without having to know what they are). </li> - <li> Various security and portability issues have been resolved. (None of the scripts now calls for <tt>/bin/bash</tt>; and the handling of temporary files is now much safer.) </li> - <li> <tt>pdfjam</tt> can take PDF input from <tt>/dev/stdin</tt>, and send output to <tt>/dev/stdout</tt>. (This allows <tt>pdfjam</tt> to be used in a pipeline.) </li> - <li> If the <tt>--outfile</tt> option specifies a relative path, that path is now relative to the <em>current working directory</em> (as is normally expected of unix utilities). <strong>This is different behaviour from previous versions.</strong> </li> - <li> With multiple input files, <tt>pdfjam</tt> offers two distinct methods of processing. The default is to take pages as specified from the input files, and combine them into a single document. If the <tt>--batch</tt> option is used, <tt>pdfjam</tt> operates <em>separately</em> on the input files, producing one output file per input file. <strong>This is different behaviour from previous versions.</strong> </li> - <li> Page selection is available separately for each input file. A <strong>difference from previous versions</strong> is that the <tt>--pages</tt> keyword is no longer used. </li> - <li><tt>pdfjam</tt> uses the <tt>\includepdfmerge</tt> command from <em>pdfpages</em>, as a result of which all pages in an output file have the same size and orientation. <strong>This is different behaviour from previous versions.</strong> </li> - <li> Output page orientation is now controlled by using <tt>--landscape</tt> (negated, if necessary, by <tt>--no-landscape</tt>). The previous <tt>--orient</tt> option is no longer used, and in particular "<tt>--orient auto</tt>" is no longer available. <strong>This is different behaviour from previous versions.</strong> </li> - <li> Other new features include: - <ul> - <li> <tt>--keepinfo</tt> option, to allow preservation of PDF document information, if the <tt>pdfinfo</tt> utility and the LaTeX <tt>hyperref</tt> package are available (thanks to Robert Wenner for suggesting this); </li> - <li> <tt>--pdftitle</tt>, <tt>--pdfauthor</tt>, <tt>--pdfsubject</tt> and <tt>--pdfkeywords</tt> options, to specify new PDF document information (these require the LaTeX <tt>hyperref</tt> package); </li> - <li> many more "named" output page sizes are available if the LaTeX <tt>geometry</tt> package is installed (the full list of allowed paper specifications is: <tt>a0paper, a1paper, a2paper, a3paper, a4paper, a5paper, a6paper b0paper, b1paper, b2paper, b3paper, b4paper, b5paper, b6paper letterpaper, executivepaper, legalpaper</tt>; thanks to Corné Verbruggen and Mel Irizarry for suggesting this) and non-standard page sizes can also be defined; </li> - <li> <tt>--checkfiles</tt> option to request that input files be checked using the <tt>file</tt> utility, rather than requiring the file name to end in "<tt>.pdf</tt>" or "<tt>.PDF</tt>"; </li> - <li> <tt>--twoside</tt> option, to allow the LaTeX <em>twoside</em> class option to be specified (thanks to Johannes Reinhard for suggesting this); </li> - <li> <tt>--pagecolor</tt> option, to allow the background colour of output pages to be changed (thanks to James Fisher for suggesting this); </li> - <li> <tt>--vanilla</tt> option to run <tt>pdfjam</tt> without reading site-wide or user configuration files. </li> - </ul> - - </li> -</ul> - -<p> In addition, various reported bugs have been fixed — many thanks to all those kind people who reported them (too numerous to list here!) [2010-03-14]</p> - -<hr color="grey" /> -<p> <strong>1.21</strong>: bug fixes, including security issues (many thanks to Eduard Bloch, Robert Buchholz and Martin Vaeth for helpful reports on vulnerabilities and for kindly contributing patches); the scripts now call for <tt>/bin/bash</tt> as interpreter; availability of <tt>mktemp</tt> is now also assumed; the Mac OS X droplets now look for <tt>pdflatex</tt> at (by default) <tt>/usr/texbin/pdflatex</tt> [2009-01-19]</p> - -<p> <strong>1.20</strong>: added minimal man pages; added extra possible locations for the site-wide configuration file [2005-01-25] </p> - -<p> <strong>1.11</strong>: added the <tt>--scale</tt> option to pdfnup, which allows page margins either to be enlarged (e.g,. <tt>--scale 0.9</tt>) or reduced (e.g,. <tt>--scale 1.1</tt>) by scaling the page contents. By popular request! [2004-10-13] </p> - -<p> <strong>1.10</strong>: output files now appear by default in same directory as input, rather than in the current working directory; fixed a bug that caused the scripts not to work on some versions of Solaris (thanks to Daniel Gebhart); major improvements to the Mac OS X sample droplets. [2004-06-24] </p> - -<p> <strong>1.03</strong>: minor changes towards POSIX compliance. [2004-05-09] </p> - -<p> <strong>1.02</strong>: added a COPYING file to the package. [2004-05-08] </p> - -<p> <strong>1.00</strong>: package re-named PDFjam. [2004-05-07] </p> - -<p> <strong>0.99a</strong>: a minor change to the output of <tt>pdfnup --help</tt> and <tt>pdfjoin --help</tt> [2004-05-06] </p> - -<p> <strong>0.99</strong>: various improvements to pdfnup, including the handling of multiple PDF input files. Added pdfjoin and pdf90. [2004-05-05] </p> - -<p> <strong>0.97</strong>: corrections to the output of <tt>pdfnup --help</tt> [2004-04-23] </p> - -<p> <strong>0.96</strong>: minor changes to comments in the pdfnup script [2004-02-12] </p> - -<p> <strong>0.95</strong>: added the possibility of site-specific and user-specific configuration files (thanks to Jason Lewis for suggesting this) [2004-01-28] </p> - -<p> <strong>0.9</strong>: added <tt>--openright</tt> (thanks to Jason Lewis for suggesting this) [2004-01-28] </p> - -<p> <strong>0.8</strong>: added <tt>pdfnup --help</tt> facility (thanks to Wilfrid Kendall for this suggestion) [2003-09-12] </p> - -<p> <strong>0.7</strong>: paths involving spaces now permitted; page trimming added (thanks to Alex Montgomery for suggesting that); default output filename now has a dash inserted before the "nup" label (as in <tt> wasteful-2x2.pdf </tt>); sample Mac OS X droplets provided [2003-01-26] </p> - -<p> <strong>0.6</strong>: use of paths involving spaces now reports an error [2002-08-22] </p> - -<p> <strong>0.5</strong>: fixed a bug which caused incompatibility with some types of unix [2002-06-24] </p> - -<p> <strong>0.4</strong>: better error trapping, improved portability [2002-04-30] </p> - -<p> <strong>0.3</strong>: first public release of pdfnup [2002-04-04] </p> - - -</body> </html> diff --git a/Master/texmf-dist/doc/support/pdfjam/README.md b/Master/texmf-dist/doc/support/pdfjam/README.md new file mode 100644 index 00000000000..62f99b2ec5a --- /dev/null +++ b/Master/texmf-dist/doc/support/pdfjam/README.md @@ -0,0 +1,690 @@ +[](https://travis-ci.com/DavidFirth/pdfjam) +# pdfjam + +_David Firth_ <https://warwick.ac.uk/dfirth> + +A snapshot of this page is included as _README.md_ +in the distributed package. The most up-to-date version is maintained online at +<https://github.com/DavidFirth/pdfjam>. + +1. [Overview](#overview) + - [What is pdfjam?](#whatis) + - [Wrapper scripts no longer included here](#wrappers) +2. [Pre-requisites](#prereq) +3. [Documentation](#documentation) +4. [Installation](#install) +5. [Configuration](#config) +6. [Using pdfjam](#using) +7. [FAQ](#faq) +8. [Reporting bugs](#bugs) +9. [Version history](#history) + + +# <a name="overview"> Overview + +## <a name="whatis"> What is pdfjam? + +The **pdfjam** package makes available the `pdfjam` shell script that provides a +simple interface to much of the functionality of the excellent +[pdfpages](http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages) +package (by Andreas Matthias) for _LaTeX_. The `pdfjam` script takes one +or more PDF files (and/or JPG/PNG graphics files) as input, and produces +one or more PDF files as output. It is useful for joining files together, +selecting pages, reducing several source pages onto one output page, etc., etc. + +A potential drawback of `pdfjam` and other scripts based upon it is that any +hyperlinks in the source PDF are lost. On the positive side, there is no +appreciable degradation of image quality in processing PDF files with `pdfjam`, +unlike some other indirect methods such as `pdf2ps|psnup|ps2pdf` +(in the author's experience). + +`pdfjam` is designed for Unix-like systems, including Linux and Mac OS X. +It seems that it will work also on Windows computers with a suitable +installation of [Cygwin](http://www.cygwin.com) (with TeX Live +installed), but this has not been thoroughly tested. + +An alternative set of PDF manipulation tools, which are java-based, is +provided by the [Multivalent](http://multivalent.sourceforge.net) project. +Yet another alternative set of tools is [PDFsam](https://pdfsam.org). +Those alternatives do much the same things as `pdfjam`, and maybe +quite a bit more too. + +The **pdfjam** software is made available free, under GPL version 2 (see the +file named `COPYING` that is included with the package). +It comes with **ABSOLUTELY NO WARRANTY** of fitness for any purpose whatever. + +## <a name="wrappers"> Wrapper scripts no longer included here + +Previous versions of **pdfjam** (before 3.02) included some _other_ scripts too, +in addition to the `pdfjam` script iteslf. +Those other scripts are simple wrappers for calls to `pdfjam`, designed to perform +some common tasks such as joining or n-upping PDF files or to illustrate +other features; they are not very elaborate, and nor are they extensively tested. +They are probably best viewed as simple templates that can be used for +constructing more elaborate wrapper scripts as required. + +Those 'wrapper' scripts are **no longer maintained**. I continue to make +them available in a separate repository +<https://github.com/DavidFirth/pdfjam-extras>, +in case anyone wants to see them, to use them, or to improve and maintain +them independently as a separate project. + +The specific wrapper scripts that were removed from the **pdfjam** package +at version 3.02 are: + +- `pdfnup`, `pdfpun` +- `pdfjoin` +- `pdf90`, `pdf180`, `pdf270` +- `pdfflip` +- `pdfbook` +- `pdfjam-pocketmod` +- `pdfjam-slides3up`, `pdfjam-slides6up` + +For those scripts and for more information on them, please now see +<https://github.com/DavidFirth/pdfjam-extras>. + + +# <a name="prereq"> Pre-requisites + +- A Unix-like operating system (Linux, Mac OS X, FreeBSD, etc.; possibly Cygwin) +- A working, up-to-date installation of LaTeX (including at least one of + `pdflatex`, `lualatex` or `xelatex`) +- A working installation of the LaTeX package + [**pdfpages**](http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages) + (version 0.4f or later) +- Some of the options offered by `pdfjam` also require the LaTeX packages + [**geometry**](http://www.ctan.org/tex-archive/macros/latex/contrib/geometry) + and + [**hyperref**](http://www.ctan.org/tex-archive/macros/latex/contrib/hyperref). + +For some years now, **pdfjam** has been included in the _TeX Live_ distribution, +which includes all the necessary programs and packages to make `pdfjam` run smoothly. +If you have the necessary bandwidth and disk space for it, I do recommend installing +[_TeX Live_](https://tug.org/texlive/). + +# <a name="documentation"></a> Documentation + +The primary documentation for `pdfjam` is obtained (after installation of `pdfjam`) +via the command + +``` +pdfjam --help +``` + +This gives information on the arguments to `pdfjam`, and the default settings +that apply at your installation. In addition to the arguments that are explicitly +documented there, `pdfjam` provides access to all of the options of the +**pdfpages** package: that's a large number of options, and it's a set of options +that might change, so users are referred to the current +[pdfpages manual (PDF)](http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf) to see what's available. + +In case you want to look at the `pdfjam --help` text template online, for example +before you decide whether to install **pdfjam**, the source is available at +<https://github.com/DavidFirth/pdfjam/blob/master/pdfjam-help.txt>. + +There is also a (very basic) `man` page, accessed in the usual way +(after installation) by + +``` +man pdfjam +``` + +# <a name="install"></a> Installation + +There are two main ways: + +1. Install the [current _TeX Live_ distribution](https://tug.org/texlive/) +(how you do this will depend on details of your operating system). +_TeX Live_ will already contain a recent release of **pdfjam**. +Many thanks to Karl Berry +for setting up and maintaining **pdfjam** as a _CTAN_ package that is part of +_TeX Live_. + +2. Install it yourself (e.g., if you don't want _TeX Live_, or if you want a later +release of **pdfjam** than the one that's currently in _TeX Live_). +Download the latest packaged release of **pdfjam** from +<https://github.com/DavidFirth/pdfjam/releases>. +If for some reason you don't want the latest released version, or even a recently released version, you can still get older versions too: see <https://davidfirth.github.io/pdfjam>. + +**The first way, via _TeX Live_, is recommended** as the easiest way for most users. + +If you go the second way, then you will have a bit more to do: + +- The `pdfjam` shell script in the _bin_ sub-directory of the released package + should be placed on the `PATH` of anyone who needs to use it. +- The `man` file in the _man1_ sub-directory should be installed on the `MANPATH` + of all who might need to read it. + +# <a name="config"></a> Configuration + +On many unix-like systems `pdfjam` should run without any further configuration, +provided that the pre-requisite TeX installation (such as _TeX Live_) is present. +If you want to check (e.g., prior to installation) that `pdfjam` will work on +your system, then + +- unzip the `tests.zip` archive (inside the package) +- `cd` to your newly made `tests` sub-directory and follow the instructions that appear there in `README_tests.md`. + +If configuration _is_ needed, this can be done through a site-wide or +user-specific configuration file. This might be necessary if, for example, your +site has a non-standard TeX installation, or a non-standard location for +temporary files, or a specific paper size for output PDFs --- +or some other reason. + +The file +[pdfjam.conf](https://github.com/DavidFirth/pdfjam/raw/master/pdfjam.conf) +is a sample configuration file which can be edited as needed. After editing, +either install the file for site-wide use (at `/etc/pdfjam.conf`, +`/usr/share/etc/pdfjam.conf`, `/usr/local/share/pdfjam.conf`, or +`/usr/local/etc/pdfjam.conf`) or as a user-defaults file at `~/.pdfjam.conf`. +User settings made at `~/.pdfjam.conf` override corresponding settings made +in a site-wide configuration file. + +For example, if you prefer to use `/usr/bin/xelatex` as your default LaTeX engine +(in place of the standard `pdflatex`), and you want your output page size to be +"US letter" size paper by default, you would simply include the lines + +``` +latex=/usr/bin/xelatex +paper=letterpaper +``` + +in a plain text file named '`.pdfjam.conf`' in your home directory. +The path `usr/bin/xelatex` specifies exactly _which_ LaTeX program will be +used: it could be a path to any one of the `pdflatex`, `lualatex` or +`xelatex` executables. (You can get the full path to an executable +by, for example, the command `which xelatex`.) +The code word `letterpaper` is how LaTeX refers to that particular page size. +For other available paper sizes, and all the many +other options that could be set as defaults if you want, please see the output of + +``` +pdfjam --help +``` + +On some systems it might even be necessary to change the list of places +(i.e., `/etc/pdfjam.conf` and others as listed above) that is searched for +site-wide configuration files. This can only be done by editing the +`pdfjam` script itself. To see which directories on _your_ system are +searched for a file named `pdfjam.conf`, look at the output of + +``` +pdfjam --configpath +``` + +# <a name="using"></a> Using pdfjam + +For a full overview of what `pdfjam` can do, the importance of the +[pdfpages manual (PDF)](http://www.ctan.org/tex-archive/macros/latex/contrib/pdfpages/pdfpages.pdf) +cannot be stressed enough! +The following examples merely serve as a brief introduction. + +### Example 1: Batch 2-upping of documents + +Consider converting each of two documents to a side-by-side "2-up" format. +Since we want the two documents to be processed separately, we'll use the +`--batch` option: + +``` +pdfjam --batch --nup 2x1 --suffix 2up --landscape file1.pdf file2.pdf +``` + +This will produce new files `file1-2up.pdf` and `file2-2up.pdf` in the current +working directory. + +### Example 2: Merging pages from 2 documents + +Suppose we want a single new document which puts together selected pages from two different files: + +``` +pdfjam file1.pdf '{},2-' file2.pdf '10,3-6' --outfile ../myNewFile.pdf +``` + +The new file `myNewFile.pdf`, in the parent directory of the current one, +contains an empty page, followed by all pages of `file1.pdf` except the first, +followed by pages 10, 3, 4, 5 and 6 from `file2.pdf`. + +The resulting PDF page size will be whatever is the default paper size for +you at your site. If instead you want to preserve the page size of +(the first included page from) `file1.pdf`, use the option `--fitpaper true`. + +**All pages in an output file from `pdfjam` will have the same size and +orientation.** For joining together PDF files while preserving _different_ page +sizes and orientations, `pdfjam` is not the tool to use. + +### Example 3: A 4-up document with frames + +To make a portrait-oriented 4-up file from the pages of three input files, +with a thin-line frame around the input pages: + +``` +pdfjam file1.pdf file2.pdf file3.pdf --no-landscape --frame true --nup 2x2 --suffix 4up --outfile ~/Documents +``` + +Here a _directory_ was specified at `--outfile`: the resultant file in this +case will be `~/Documents/file3-4up.pdf`. +(Note that **if there's a writeable file with that name already, it will be +overwritten**: no check is made, and no warning given.) + +### Example 4: Convert a 'US letter' document to A4 + +Suppose we have a document made up of 'US letter' size pages, +and we want to convert it to A4: + +``` +pdfjam 'my US letter file.pdf' --a4paper --outfile 'my A4 file.pdf' +``` + +### Example 5: Handouts from presentation slides + +A useful application of `pdfjam` is for producing a handout from a file of +presentation slides. For slides made with the standard 4:3 aspect ratio a +nice 6-up handout on A4 paper can be made by + +``` +pdfjam --nup 2x3 --frame true --noautoscale false --delta "0.2cm 0.3cm" --scale 0.95 myslides.pdf --outfile myhandout.pdf +``` + +The `--delta` option here comes from the pdfpages package; the `--scale` +option is passed to LaTeX's `\includegraphics` command. + +Slides made by LaTeX's _beamer_ package, using the `handout` class option, +work especially nicely with this! The example wrapper scripts `pdfjam-slides3up` +and `pdfjam-slides6up`, in the +[pdfjam-extras](https://github.com/DavidFirth/pdfjam-extras) repository, +are for 3-up and 6-up handouts, respectively. + +### Example 6: Trimming pages; and piped output + +Suppose we want to trim the pages of our input file prior to n-upping. +This can be done by using a pipe: + +``` +pdfjam myfile.pdf --trim '1cm 2cm 1cm 2cm' --clip true --outfile /dev/stdout | pdfjam --nup 2x1 --frame true --outfile myoutput.pdf +``` + +The `--trim` option specifies an amount to trim from the left, bottom, right and +top sides respectively; to work as intended here it needs also `--clip true`. +These (i.e., `trim` and `clip`) are in fact options to LaTeX's +`\includegraphics` command (in the standard _graphics_ package). + +Thanks go to Christophe Lange and Christian Lohmaier for suggesting +an example on this. + +### Example 7: Output pages suitable for binding + +To offset the content of double-sided printed pages so that they are +suitable for binding with a +[Heftstreifen](http://de.wikipedia.org/wiki/Heftstreifen), use +the `--twoside` option: + +``` +pdfjam --twoside myfile.pdf --offset '1cm 0cm' --suffix 'offset' +``` + +### Example 8: Input file with nonstandard name + +To use PDF input files whose names do not end in '`.pdf`', you will need to use +the `--checkfiles` option. This depends on the availability of the `file` +utility, with support for the options `-Lb`; this can be checked by trying + +``` +file -Lb 'my PDF file' +``` + +where `'my PDF file'` is the name of a PDF file on your system. +The result should be something like '`PDF document, version 1.4`' +(possibly with a different version number). + +With '`file -Lb`' available, we can use PDF files whose names lack the usual +'`.pdf`' extension. For example, + +``` +pdfjam --nup 2x1 --checkfiles 'my PDF file' +``` + +will result in a file named '`my PDF file-2x1.pdf`' +in the current working directory. + +### Example 9: Rotate every 2nd page + +If you want to print a landscape-oriented PDF document on both sides of the paper, +using a duplex printer that does not have 'tumble' capability, make a new version +with every second page rotated for printing: + +``` +pdfjam --landscape --doublepagestwistodd true my-landscape-document.pdf +``` + + +# <a name="faq"></a> FAQ + + +**1. The script runs but the output doesn't look the way it should. Why?** + +Most likely either your pdfTeX or your pdfpages installation is an old version. +You could check also that `pdftex.def`, typically to be found in +`.../texmf/tex/latex/graphics/`, +is up to date. If the problem persists even with up-to-date versions of pdfTeX, +`pdftex.def` and pdfpages, then please do report it. + +**2. What can I do to solve a 'Too many open files' error? + +This error has been reported to occur sometimes, when dealing with large numbers of +documents/pages. A suggested solution, if this happens, +is to include additionally (in the call to `pdfjam`): + +``` + -- preamble '\let\mypdfximage\pdfximage \def\pdfximage{\immediate\mypdfximage}' +``` + +See for example +<https://stackoverflow.com/questions/1715677/error-too-many-open-files-in-pdflatex> +for this suggestion and links to more information. + +# <a name="bugs"></a> Reporting bugs + +Please report any bugs found in `pdfjam`, either + +- by reporting as an issue at GitHub, <https://github.com/DavidFirth/pdfjam/issues> +- by email (see <https://warwick.ac.uk/dfirth> for my email address) + +### Some known problems: + +- Sometimes font information (such as ligatures) is lost from the output of + `pdfjam`. It seems that a fairly simple fix when this happens is to add the + option `--preamble '\pdfinclusioncopyfonts=1'` in your call to `pdfjam`. +- In _Cygwin_, using `pdfjam` in a pipeline does not seem to work. + The problem seems to be with _Cygwin_'s handling of file descriptors + within pipelines. +- The `--preamble` option can sometimes clash with other elements of the LaTeX + preamble. Some specific things to watch out for: + + If the preamble needs to set further options to the _geometry_ package, + when the _geometry_ package has already been loaded in order to + set a special page size, be sure to use the `\geometry{}` command for that. + + If the preamble needs to set options to the _hyperref_ package, when + the _hyperref_ package has already been loaded in order to specify PDF + document information, be sure to use the `\hypersetup{}` command for that. + + If options to the _color_ package are to be specified in the preamble, + do not at the same time use the `--pagecolor` option to `pdfjam`. + + +# <a name="history"> Version history + +### Overview of the history + +This all grew originally from a script named `pdfnup`. That was later joined, +in a published package called 'PDFjam', by two further scripts `pdfjoin` and +`pdf90`. + +At version 2.00, everything was unified through a single script `pdfjam`, with +many more options. Along with `pdfjam` various 'wrapper' scripts --- i.e., +other scripts that use `pdfjam` in different ways --- were provided, mainly as +examples. + +From version 3.02, the extra 'wrapper' scripts are removed from the package, +mainly because they are hard to maintain: different users want different +things, and `pdfjam` itself provides all the options in any case. So I have +broken out the wrapper scripts into a separate repository, _unsupported_ --- +so that people can still see and use/adapt them if they want. +And maybe even someone else will +want to take on the task of improving and maintaining some of them, +who knows? The wrapper scripts (**no longer maintained**) can now be found at +<https://github.com/DavidFirth/pdfjam-extras>. + +### Version release notes + +[**3.03**](https://github.com/DavidFirth/pdfjam/releases/tag/v3.03) [2019-11-18]: + +- Built package now (again) has tests in a zip archive. (needed for CTAN) + +[**3.02**](https://github.com/DavidFirth/pdfjam/releases/tag/v3.02) [2019-11-14]: + +- Re-styled the package name to **pdfjam**. (Previously the package --- which then + contained several scripts --- was named PDFjam). +- Moved everything to a new home on the web at + <a href="https://github.com/DavidFirth">github.com/DavidFirth</a>. +- Simplified the package by removal of all the 'wrapper' scripts + (`pdfnup`, `pdfjoin`, etc.). +- Settings specified via `--preamble` are now protected from the normal + tidying of the TeX input file to remove redundant packages. +- The possibility to use `lualatex` or `xelatex` in place of `pdflatex` is + now described explicitly in the README. The specification of which LaTeX + engine to use can be made either in a configuration file, or on the command + line via option (for example) `--latex /usr/bin/xelatex`. Thanks to + Mircea for suggesting this. +- Added new `--runs` option, so as to allow for example `--runs 2` in a situation + where two runs of `pdflatex` (or `lualatex` or `xelatex`) are needed (typically + where the result document is being indexed in some way, so more than one run is + needed). Thanks to Ferdinand for this suggestion (and patch). +- Default paper size is now guessed from the locale where possible, with fallback + default size being ISO A4 ('a4paper' in LaTeX). This can still be over-ridden + in a configuration file, or on the command line. Thanks to Jonathan for this + suggestion. +- Innocuous edits made to make pdfjam work better in Cygwin. Thanks to Lucas for + sending a helpful patch for this. +- Included a note in the FAQ about the (sometimes reported) 'Too many open files' + error. Thanks to George for information about this. +- Tidying of the `pdfjam` script, and better organisation of the `tests` folder. + Thanks to Lucas for help with this. + +---------- + +_Older releases are still available at <https://davidfirth.github.io/pdfjam>._ + +**2.09** [never released]: + +- The default behaviour of `pdfbook` is reverted to its pre-2.06 state, + because `--booklet true` seems to be problematic for some users. + +**2.08** [2010-11-14]: + +- Fixed a bug in one of the tests. + +**2.07** [2010-11-13]: + +- Two other common graphics formats (JPG and PNG) are now explicitly + allowed as input files (i.e., not only PDF files are allowed as inputs). + +**2.06** [2010-05-11]: + +- Changed the `pdfbook` script to include `--booklet true` as the + default behaviour (thanks to Julien Bossert for this good suggestion). + +**2.05** [2010-04-25]: + +- Changes to the `pdfbook` script [the `--right-edge-binding` option is + now redundant, and there's a new `--short-edge` option for binding along the + short edge of pages instead of the long edge (thanks to Marco Pessotto for this). +- The `--preamble` option to `pdfjam` is enhanced, to allow multiple instances + which get concatenated. +- Also various minor corrections to man pages. + +**2.04** [2010-04-22]: + +- Various minor improvements suggested by Debian maintainers + (thanks to Eduard Bloch for these). The main things are: + + addition of the `--version` option; + + liberalisation of `pdfjam` to allow files in _JPEG_ format to be + specified as input, as well as PDF; + + tidying of the man files; + + and more use of `exec`, to avoid forking. + +**2.03** [2010-04-20]: + +- Fixed a bug which caused problems when your `/bin/sh` is the _zsh_ shell. +- Fixed a bug which prevented the correct representation of many UTF-8 characters + in `pdfinfo` data. + +**2.02** [2010-04-14]: + +- More progress on portability. +- Introduced the beginnings of a suite of tests. +- Iimprovements in the `--keepinfo` functionality, and in the treatment of + file permissions (thanks to Marco Pessotto for these). + +**2.01** [2010-04-13]: + +- Fixed a silly bug (thoughtless use of "`test -a`" in a couple of places) + which seriously affected portability. + +--------------------------------------------------------------- + +**2.00** [2010-03-14]: **a major re-design** + +This is not completely backward-compatible with previous versions of the +`pdfnup`, `pdfjoin` and `pdf90` scripts. +The differences in interface are few, though, and the main ones are +listed below. + +- The new script `pdfjam` now does all the work; all the other scripts + included with the package are just simple wrappers for `pdfjam`. +- New `pdfjam` makes available essentially _all_ of the facilities of the + pdfpages package (without having to know what they are). +- Various security and portability issues have been resolved. + (None of the scripts now calls for `/bin/bash`; and the handling of + temporary files is now much safer.) +- `pdfjam` can take PDF input from `/dev/stdin`, and send output to + `/dev/stdout`. (This allows `pdfjam` to be used in a pipeline.) +- If the `--outfile` option specifies a relative path, that path is now + relative to the _current working directory_ (as is normally expected of + unix utilities). **This is different behaviour from previous versions.** +- With multiple input files, `pdfjam` offers two distinct methods of processing. + **This is different behaviour from previous versions.** + 1. The default is to take pages as specified from the input files, and + combine them into a single document. + 2. If the `--batch` option is used, `pdfjam` operates _separately_ on the + input files, producing one output file per input file. +- Page selection is available separately for each input file. A + **difference from previous versions** is that the `--pages` keyword is no + longer used. +- `pdfjam` uses the `\includepdfmerge` command from _pdfpages_, as a result + of which all pages in an output file have the same size and orientation. + **This is different behaviour from previous versions.** +- Output page orientation is now controlled by using `--landscape` (negated, + if necessary, by `--no-landscape`). The previous `--orient` option is no + longer used, and in particular "`--orient auto`" is no longer available. + **This is different behaviour from previous versions.** +- Other new features include: + + `--keepinfo` option, to allow preservation of PDF document information, + if the `pdfinfo` utility and the LaTeX `hyperref` package are + available (thanks to Robert Wenner for suggesting this); + + `--pdftitle`, `--pdfauthor`, `--pdfsubject` and `--pdfkeywords` + options, to specify new PDF document information + (these require the LaTeX `hyperref` package); + + many more "named" output page sizes are available if the LaTeX + `geometry` package is installed (the full list of allowed paper + specifications is: `a0paper, a1paper, a2paper, a3paper, a4paper, + a5paper, a6paper b0paper, b1paper, b2paper, b3paper, b4paper, + b5paper, b6paper letterpaper, executivepaper, legalpaper`; + thanks to Corné Verbruggen and Mel Irizarry for suggesting this) and + non-standard page sizes can also be defined; + + `--checkfiles` option to request that input files be checked using the + `file` utility, rather than requiring the file name to end in + "`.pdf`" or "`.PDF`"; + + `--twoside` option, to allow the LaTeX _twoside_ class option to be + specified (thanks to Johannes Reinhard for suggesting this); + + `--pagecolor` option, to allow the background colour of output pages + to be changed (thanks to James Fisher for suggesting this); + + `--vanilla` option to run `pdfjam` without reading site-wide or user + configuration files. +- In addition, various reported bugs have been fixed — many thanks to all + those kind people who reported them. + +--------------------------------------------------------------- + +**1.21** [2009-01-19]: + +- Bug fixes, including security issues (many thanks to Eduard Bloch, + Robert Buchholz and Martin Vaeth for helpful reports on vulnerabilities and + for kindly contributing patches). +- The scripts now call for `/bin/bash` as interpreter. +- Availability of `mktemp` is now also assumed. +- The Mac OS X droplets now look for `pdflatex` at (by default) + `/usr/texbin/pdflatex` + +**1.20** [2005-01-25] + +- Added minimal man pages. +- Added extra possible locations for the site-wide configuration file. + +**1.11** [2004-10-13]: + +- Added the `--scale` option to `pdfnup`, which allows page margins either to + be enlarged (e.g,. `--scale 0.9`) or reduced (e.g,. `--scale 1.1`) by + scaling the page contents. By popular request! + +**1.10** [2004-06-24]: + +- Output files now appear by default in same directory as input, rather than in + the current working directory; fixed a bug that caused the scripts not to work + on some versions of Solaris (thanks to Daniel Gebhart); major improvements to + the Mac OS X sample droplets. + +**1.03** [2004-05-09]: + +- Minor changes towards POSIX compliance. + +**1.02** [2004-05-08]: + +- Added a COPYING file to the package. + +**1.00** [2004-05-07]: + +- Package re-named PDFjam. + +**0.99a** [2004-05-06]: + +- A minor change to the output of `pdfnup --help` and `pdfjoin --help` + +**0.99** [2004-05-05]: + +- Various improvements to `pdfnup`, including the handling of multiple PDF +input files. Added `pdfjoin` and `pdf90`. + +**0.97** [2004-04-23]: + +- Corrections to the output of `pdfnup --help`. + +**0.96** [2004-02-12]: + +- Minor changes to comments in the `pdfnup` script. + +**0.95** [2004-01-28]: + +- Added the possibility of site-specific and user-specific configuration + files (thanks to Jason Lewis for suggesting this). + +**0.9** [2004-01-28]: + +- Added `--openright` (thanks to Jason Lewis for suggesting this). + +**0.8** [2003-09-12]: + +- Added `pdfnup --help` facility (thanks to Wilfrid Kendall for this suggestion). + +**0.7** [2003-01-26]: + +- Paths involving spaces now permitted. +- Page trimming added (thanks to Alex Montgomery for suggesting that). +- Default output filename now has a dash inserted before the "nup" label + (as in ` wasteful-2x2.pdf `). +- Sample Mac OS X droplets provided. + +**0.6** [2002-08-22]: + +- Use of paths involving spaces now reports an error. + +**0.5** [2002-06-24]: + +- Fixed a bug which caused incompatibility with some types of unix. + +**0.4** [2002-04-30]: + +- Better error trapping, improved portability. + +**0.3** [2002-04-04]: + +- First public release of `pdfnup`. + + diff --git a/Master/texmf-dist/doc/support/pdfjam/VERSION b/Master/texmf-dist/doc/support/pdfjam/VERSION index 1971909e632..798241c6afe 100644 --- a/Master/texmf-dist/doc/support/pdfjam/VERSION +++ b/Master/texmf-dist/doc/support/pdfjam/VERSION @@ -1 +1 @@ -This is PDFjam 2.08
\ No newline at end of file +This is pdfjam 3.03
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/pdfjam/pdfdroplets.png b/Master/texmf-dist/doc/support/pdfjam/pdfdroplets.png Binary files differdeleted file mode 100644 index 850e5802ac6..00000000000 --- a/Master/texmf-dist/doc/support/pdfjam/pdfdroplets.png +++ /dev/null diff --git a/Master/texmf-dist/doc/support/pdfjam/pdfjam.conf b/Master/texmf-dist/doc/support/pdfjam/pdfjam.conf index 9b8f90c12e1..eba54b7322f 100644 --- a/Master/texmf-dist/doc/support/pdfjam/pdfjam.conf +++ b/Master/texmf-dist/doc/support/pdfjam/pdfjam.conf @@ -1,6 +1,6 @@ ############################################################### ## -## This is a sample 'pdfjam.conf' file. +## This is a _sample_ 'pdfjam.conf' file. ## ## Edit lines below (and un-comment them as necessary) to ## override settings made in the 'pdfjam' script itself. @@ -10,19 +10,25 @@ ## A file in this format can be used site-wide (as a file named ## "pdfjam.conf", in an appropriate location), or for a specific ## user (as "~/.pdfjam.conf"). User-specific settings override -## any site-wide settings. +## site-wide settings. ## ## See 'pdfjam --help' for details, including where to put -## this file; or see the file PDFjam-README.html. +## your edited version of this file; or see the file README.md at +## https://github.com/DavidFirth/pdfjam ## ############################################################### ## -## UNUSUAL TEX INSTALLATION? +## UNUSUAL TEX INSTALLATION, OR SPECIFIC LATEX WANTED? ## -## Specify the location of the 'pdflatex' to be used: -# pdflatex='/usr/bin/pdflatex' ## typical unix installation -# pdflatex='/usr/texbin/pdflatex' ## for MacTeX on Mac OS X -# pdflatex='C:/texmf/miktex/bin/pdflatex.exe' ## Windows?? +## Specify the full path to the 'latex' to be used. +## Examples: +# +# latex='/usr/bin/pdflatex' ## typical unix installation +# latex='/usr/texbin/pdflatex' ## for MacTeX on Mac OS X? +# latex='C:/texmf/miktex/bin/pdflatex.exe' ## Windows?? +# +# latex='/usr/bin/xelatex' ## if you want xelatex +# latex='/usr/bin/lualatex' ## if you want lualatex ## ############################################################### ## @@ -61,9 +67,9 @@ checkfiles='false' ## overridden by '--checkfiles' in the call; ## ## DEFAULT PAPER SIZE ## -## Set the default paper size to be used: -paper='a4paper' ## for ISO A4 paper -# paper='letterpaper' ## for 'US letter' paper +## Set the default paper size to be used. Examples: +# paper='a4paper' ## for ISO A4 paper size +# paper='letterpaper' ## for 'US letter' paper size ## ############################################################### ## diff --git a/Master/texmf-dist/doc/support/pdfjam/tests.zip b/Master/texmf-dist/doc/support/pdfjam/tests.zip Binary files differindex 71afaeaee06..1dd2360398e 100644 --- a/Master/texmf-dist/doc/support/pdfjam/tests.zip +++ b/Master/texmf-dist/doc/support/pdfjam/tests.zip |
