summaryrefslogtreecommitdiff
path: root/support/pdfjam/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/pdfjam/README.md')
-rw-r--r--support/pdfjam/README.md249
1 files changed, 15 insertions, 234 deletions
diff --git a/support/pdfjam/README.md b/support/pdfjam/README.md
index cf7b248d49..f73a854348 100644
--- a/support/pdfjam/README.md
+++ b/support/pdfjam/README.md
@@ -1,4 +1,4 @@
-[![](https://travis-ci.com/rrthomas/pdfjam.svg?branch=master)](https://travis-ci.com/rrthomas/pdfjam)
+![GitHub CI](https://github.com/rrthomas/pdfjam/actions/workflows/ci.yml/badge.svg)
# pdfjam
_Reuben Thomas_ <https://rrt.sc3d.org/>
@@ -43,11 +43,14 @@ 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.
+Alternatives to `pdfjam` which are widely packaged in GNU/Linux distributions and other free software collections include:
+
+* [PDFtk](https://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) (Java-based)
+* [PDFsam](https://pdfsam.org) (Java-based)
+* [PSPDFUtils](https://pypi.org/project/pspdfutils/) (Python-based, also supports PostScript files)
+
+Those alternatives do many of 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).
@@ -90,12 +93,12 @@ For those scripts and for more information on them, please now see
- 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)
+ [**pdfpages**](https://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).
+ and
+[**geometry**](https://www.ctan.org/tex-archive/macros/latex/contrib/geometry).
+
+With [libpaper](https://github.com/rrthomas/libpaper) version 2 or later installed, `pdfjam` will be able to find your default paper size, which you can configure if desired.
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.
@@ -399,12 +402,7 @@ Please report any bugs found in `pdfjam`, either
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 the preamble needs to set further options to the _geometry_ package, be sure to use the `\geometry{}` 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`.
@@ -478,220 +476,3 @@ who knows? The wrapper scripts (**no longer maintained**) can now be found at
----------
_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`.
-
-