Fix CI failure due to spoofers not being updated to Tesseract 3.05 strings

[ci skip]

.travis.yml

@@ -43,6 +43,7 @@ install:
 
 script:
 - mv ocrmypdf dont_import_this_ocrmypdf
+- tesseract --version
 - pytest -n auto
 - mv dont_import_this_ocrmypdf ocrmypdf
 

.travis/osx_brew.sh

@@ -6,7 +6,9 @@ set -x
 pip3 install homebrew-pypi-poet
 python3 .travis/autobrew.py
 cat ocrmypdf.rb
-brew audit ocrmypdf.rb
+
+# brew audit crashes Travis
+#brew audit ocrmypdf.rb
 
 # Important: disable debug output so token is hidden
 set +x

Dockerfile

@@ -20,6 +20,8 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
   tesseract-ocr-spa \
   tesseract-ocr-deu
 
+ENV LANG=C.UTF-8
+
 RUN python3 -m venv --system-site-packages /appenv
 
 # This installs the latest binary wheel instead of the code in the current

Dockerfile.tess4

@@ -30,6 +30,8 @@ RUN apt-get update \
 		tesseract-ocr-rus \
 		tesseract-ocr-chi-sim 
 
+ENV LANG=C.UTF-8
+
 RUN python3 -m venv --system-site-packages /appenv
 
 # This installs the latest binary wheel instead of the code in the current

README.rst

@@ -4,6 +4,12 @@ OCRmyPDF
 .. image:: https://travis-ci.org/jbarlow83/OCRmyPDF.svg?branch=master
     :target: https://travis-ci.org/jbarlow83/OCRmyPDF
 
+.. image:: https://img.shields.io/pypi/v/ocrmypdf.svg   
+    :target: https://pypi.org/project/ocrmypdf/
+
+.. image:: https://img.shields.io/docker/build/jbarlow83/ocrmypdf.svg
+    :target: https://hub.docker.com/r/jbarlow83/ocrmypdf/
+
 OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to
 be searched or copy-pasted.
 

docs/advanced.rst

@@ -33,9 +33,17 @@ If you want to adjust the amount of time spent on OCR, change ``--tesseract-time
 Overriding default tesseract
 """"""""""""""""""""""""""""
 
-OCRmyPDF checks the environment variable ``OCRMYPDF_TESSERACT`` for the full path *to the tesseract executable* first. 
+OCRmyPDF checks the environment variable ``OCRMYPDF_TESSERACT`` for the full path *to the tesseract binary* first. 
 
-For example, if you are testing tesseract 4.00 and don't wish to disturb your tesseract 3.04 installation, you can launch OCRmyPDF as follows:
+.. envvar:: OCRMYPDF_TESSERACT
+
+	Specify the location of the Tesseract binary.
+
+.. envvar:: TESSDATA_PREFIX
+
+	A Tesseract environment variable that overrides the path to Tesseract's data files.
+
+For example, if you are testing tesseract 4.00 and don't wish to disturb use an existing tesseract 3.04 installation, you can launch OCRmyPDF as follows:
 
 .. code-block:: bash
 
@@ -44,8 +52,8 @@ For example, if you are testing tesseract 4.00 and don't wish to disturb your te
 		TESSDATA_PREFIX=/home/user/src/tesseract4 \
 		ocrmypdf --tesseract-oem 2 input.pdf output.pdf
 
-* ``TESSDATA_PREFIX`` directs tesseract 4.0 to use LSTM training data. This is a tesseract environment variable.
-* ``--tesseract-oem 1`` requests tesseract 4.0's new LSTM engine. (Tesseract 4.0 only.)
+In this example ``TESSDATA_PREFIX`` directs tesseract 4.0 to use LSTM training data. ``--tesseract-oem 1`` requests tesseract 4.0's new LSTM engine. (Tesseract 4.0 only.)
+
 
 Overriding other support programs
 """""""""""""""""""""""""""""""""
@@ -56,7 +64,20 @@ In addition to tesseract, OCRmyPDF uses the following external binaries:
 * ``unpaper``
 * ``qpdf``
 
-In each case OCRmyPDF will check the environment variable ``OCRMYPDF_{program}`` before asking the system to find ``{program}`` on the PATH. For example, you could redirect OCRmyPDF to ``OCRMYPDF_GS`` to override Ghostscript.
+In each case OCRmyPDF will check the environment variable ``OCRMYPDF_{program}`` before asking the system to find ``{program}`` on the PATH. For example, you could redirect OCRmyPDF to ``OCRMYPDF_GS`` to override Ghostscript. The full list is below:
+
+.. envvar:: OCRMYPDF_GS
+
+	Specify the location of the Ghostscript binary.
+
+.. envvar:: OCRMYPDF_UNPAPER
+
+	Specify the location of the unpaper binary.
+
+.. envvar:: OCRMYPDF_QPDF
+
+	Specify the location of the qpdf binary.
+
 
 Changing tesseract configuration variables
 """"""""""""""""""""""""""""""""""""""""""

docs/cookbook.rst

@@ -11,7 +11,7 @@ ocrmypdf has built-in help.
 
 .. code-block:: bash
 
-	ocrmypdf --help
+    ocrmypdf --help
 
 
 Add an OCR layer and convert to PDF/A
@@ -19,21 +19,21 @@ Add an OCR layer and convert to PDF/A
 
 .. code-block:: bash
 
-	ocrmypdf input.pdf output.pdf
+    ocrmypdf input.pdf output.pdf
 
 Add an OCR layer and output a standard PDF
 """"""""""""""""""""""""""""""""""""""""""
 
 .. code-block:: bash
 
-	ocrmypdf --output-type pdf input.pdf output.pdf
+    ocrmypdf --output-type pdf input.pdf output.pdf
 
 Create a PDF/A with all color and grayscale images converted to JPEG
 """"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 .. code-block:: bash
 
-	ocrmypdf --output-type pdfa --pdfa-image-compression jpeg input.pdf output.pdf
+    ocrmypdf --output-type pdfa --pdfa-image-compression jpeg input.pdf output.pdf
 
 Modify a file in place
 """"""""""""""""""""""
@@ -42,7 +42,7 @@ The file will only be overwritten if OCRmyPDF is successful.
 
 .. code-block:: bash
 
-	ocrmypdf myfile.pdf myfile.pdf
+    ocrmypdf myfile.pdf myfile.pdf
 
 Correct page rotation
 """""""""""""""""""""
@@ -51,7 +51,7 @@ OCR will attempt to automatic correct the rotation of each page. This can help f
 
 .. code-block:: bash
 
-	ocrmypdf --rotate-pages myfile.pdf myfile.pdf
+    ocrmypdf --rotate-pages myfile.pdf myfile.pdf
 
 You can increase (decrease) the parameter ``--rotate-pages-threshold`` to make page rotation more (less) aggressive.
 
@@ -63,8 +63,8 @@ By default OCRmyPDF assumes the document is English.
 
 .. code-block:: bash
 
-	ocrmypdf -l fre LeParisien.pdf LeParisien.pdf
-	ocrmypdf -l eng+fre Bilingual-English-French.pdf Bilingual-English-French.pdf
+    ocrmypdf -l fre LeParisien.pdf LeParisien.pdf
+    ocrmypdf -l eng+fre Bilingual-English-French.pdf Bilingual-English-French.pdf
 
 Language packs must be installed for all languages specified. See :ref:`Installing additional language packs <lang-packs>`.
 
@@ -72,19 +72,11 @@ Language packs must be installed for all languages specified. See :ref:`Installi
 Produce PDF and text file containing OCR text
 """""""""""""""""""""""""""""""""""""""""""""
 
-This produces a file named "output.pdf" and a companion text file named "output.txt". The ``pdftotext`` program from 
-`Poppler <https://poppler.freedesktop.org/>`_ is used to extract text from the finished PDF.
-
+This produces a file named "output.pdf" and a companion text file named "output.txt".
 
 .. code-block:: bash
 
-	ocrmypdf input.pdf - | tee output.pdf | pdftotext - output.txt
-
-.. note::
-
-	To get pdftotext, Debian/Ubuntu users may ``apt-get install poppler-utils`` 
-	and macOS users may ``brew install poppler`` respectively.
-
+    ocrmypdf --sidecar output.txt input.pdf output.pdf
 
 OCR images, not PDFs
 --------------------
@@ -93,7 +85,7 @@ Use a program like `img2pdf <https://gitlab.mister-muffin.de/josch/img2pdf>`_ to
 
 .. code-block:: bash
 
-	img2pdf my-images*.jpg | ocrmypdf - myfile.pdf
+    img2pdf my-images*.jpg | ocrmypdf - myfile.pdf
 
 ``img2pdf`` also has features to control the position of images on a page, if desired.
 
@@ -101,7 +93,7 @@ For convenience, OCRmyPDF can convert single images to PDFs on its own. If the r
 
 .. code-block:: bash
 
-	ocrmypdf --image-dpi 300 image.png myfile.pdf
+    ocrmypdf --image-dpi 300 image.png myfile.pdf
 
 If you have multiple images, you must use ``img2pdf`` to convert the images to PDF.
 
@@ -113,7 +105,7 @@ You can also use Tesseract 3.04+ directly to convert single page images or multi
 
 .. code-block:: bash
 
-	tesseract my-image.jpg output-prefix pdf 
+    tesseract my-image.jpg output-prefix pdf
 
 Image processing
 ----------------
@@ -132,11 +124,11 @@ OCRmyPDF perform some image processing on each page of a PDF, if desired.  The s
 
 .. note::
 
-	In many cases image processing will rasterize PDF pages as images, potentially losing quality.
+    In many cases image processing will rasterize PDF pages as images, potentially losing quality.
 
 .. warning::
 
-	``--clean-final`` and ``-remove-background`` may leave undesirable visual artifacts in some images where their algorithms have shortcomings. Files should be visually reviewed after using these options.
+    ``--clean-final`` and ``-remove-background`` may leave undesirable visual artifacts in some images where their algorithms have shortcomings. Files should be visually reviewed after using these options.
 
 
 OCR and correct document skew (crooked scan)
@@ -146,13 +138,23 @@ Deskew:
 
 .. code-block:: bash
 
-	ocrmypdf --deskew input.pdf output.pdf
+    ocrmypdf --deskew input.pdf output.pdf
 
 Image processing commands can be combined. The order in which options are given does not matter. OCRmyPDF always applies the steps of the image processing pipeline in the same order (rotate, remove background, deskew, clean).
 
 .. code-block:: bash
 
-	ocrmypdf --deskew --clean --rotate-pages input.pdf output.pdf
+    ocrmypdf --deskew --clean --rotate-pages input.pdf output.pdf
+
+
+Don't actually OCR my PDF
+"""""""""""""""""""""""""
+
+If you set ``--tesseract-timeout 0`` OCRmyPDF will apply its image processing without performing OCR, if all you want to is to apply image processing or PDF/A conversion.
+
+.. code-block:: bash
+
+    ocrmypdf --tesseract-timeout=0 --remove-background input.pdf output.pdf
 
 
 Improving OCR quality

docs/installation.rst

@@ -214,15 +214,8 @@ follow these steps.
 Installing on Ubuntu 14.04 LTS
 ------------------------------
 
-Installing on Ubuntu 14.04 LTS (trusty) is more difficult than some other options, because of bugs in Python package installation and because OCRmyPDF depends on some packages newer than are available in the main distribution.
-
-Add new "apt" repositories needed for backports of Ghostscript 9.16, libav-11 (for unpaper 6.1) and Tesseract 4.00 (alpha). This will replace Ghostscript and Tesseract 3.x on your system. If you prefer to not modify your system in this matter, consider using a Docker container.
-
-.. code-block:: bash
-
-    sudo add-apt-repository ppa:vshn/ghostscript -y
-    sudo add-apt-repository ppa:heyarje/libav-11 -y
-    sudo add-apt-repository ppa:alex-p/tesseract-ocr
+Installing on Ubuntu 14.04 LTS (trusty) is more difficult than some other options,
+because it is older.
 
 Update apt-get:
 
@@ -239,39 +232,38 @@ Install system dependencies:
         zlib1g-dev \
         libjpeg-dev \
         libffi-dev \
-        libavformat56 libavcodec56 libavutil54 \
+        qpdf
+
+We will need backports of Ghostscript 9.16, libav-11 (for unpaper 6.1),
+Tesseract 4.00 (alpha), and Python 3.6. This will replace Ghostscript and
+Tesseract 3.x on your system. Python 3.6 will be installed alongside the system
+Python 3.
+
+If you prefer to not modify your system in this matter, consider using a Docker container.
+
+.. code-block:: bash
+
+    sudo add-apt-repository ppa:vshn/ghostscript -y
+    sudo add-apt-repository ppa:heyarje/libav-11 -y
+    sudo add-apt-repository ppa:alex-p/tesseract-ocr -y
+    sudo add-apt-repository ppa:jonathonf/python-3.6 -y
+
+    sudo apt-get update
+
+    sudo apt-get install \
+        python3.6 \
         ghostscript \
-        qpdf \
-        python3-pip \
-        python3-pil \
-        python3-pytest \
-        python3-reportlab \
-        python3-wheel \
-        python3-venv \
         tesseract-ocr \
-        tesseract-ocr-eng
+        tesseract-ocr-eng \
+        libavformat56 libavcodec56 libavutil54 \
+        wget
 
-If you wish install OCRmyPDF to the system Python, then install as follows (note this installs new packages
-into your system Python, which could interfere with other programs):
+Now we need to install ``pip`` and let it install ocrmypdf:
 
 .. code-block:: bash
 
-    sudo pip3 install ocrmypdf
-
-If you wish to install OCRmyPDF to a virtual environment to isolate the system Python, you can
-follow these steps.  This includes a workaround `for a known, unresolved issue in Ubuntu 14.04's ensurepip
-package <http://www.thefourtheye.in/2014/12/Python-venv-problem-with-ensurepip-in-Ubuntu.html>`_:
-
-.. code-block:: bash
-
-    sudo apt-get install python3-venv
-    python3 -m venv venv-ocrmypdf --without-pip
-    source venv-ocrmypdf/bin/activate
-    wget -O - -o /dev/null https://bootstrap.pypa.io/get-pip.py | python
-    deactivate
-    python3 -m venv --system-site-packages venv-ocrmypdf
-    source venv-ocrmypdf/bin/activate
-    pip install ocrmypdf
+    wget -O - -o /dev/null https://bootstrap.pypa.io/get-pip.py | python3.6
+    pip3.6 install ocrmypdf
 
 These installation instructions omit the optional dependency ``unpaper``, which is only available at version 0.4.2 in Ubuntu 14.04. The author could not find a backport of ``unpaper``, and created a .deb package to do the job of installing unpaper 6.1 (for x86 64-bit only):
 

docs/release_notes.rst

@@ -6,6 +6,36 @@ OCRmyPDF uses `semantic versioning <http://semver.org/>`_ for its command line i
 The OCRmyPDF package itself does not contain a public API, although it is fairly stable and breaking changes are usually timed with a major release. A future release will clearly define the stable public API.
 
 
+v5.3.3
+------
+
+-   Fixed missing error message that should occur when trying to force ``--pdf-renderer sandwich`` on old versions of Tesseract
+-   Update copyright information in test files
+-   Set system ``LANG`` to UTF-8 in Dockerfiles to avoid UTF-8 encoding errors
+
+
+v5.3.2
+------
+
+-   Fixed a broken test case related to language packs
+
+
+v5.3.1
+------
+
+-   Fixed wrong return code given for missing Tesseract language packs
+-   Fixed "brew audit" crashing on Travis when trying to auto-brew
+
+
+v5.3
+----
+
+-   Added ``--user-words`` and ``--user-patterns`` arguments which are forwarded to Tesseract OCR as words and regular expressions respective to use to guide OCR. Supplying a list of subject-domain words should assist Tesseract with resolving words. (#165)
+-   Using a non Latin-1 language with the "hocr" renderer now warns about possible OCR quality and recommends workarounds (#176)
+-   Output file path added to error message when that location is not writable (#175)
+-   Otherwise valid PDFs with leading whitespace at the beginning of the file are now accepted
+
+
 v5.2
 ----
 
@@ -31,9 +61,9 @@ v5.0
 
 -   Backward incompatible changes
 
-    + Support for Python 3.4 dropped. Python 3.5 is now required.
-    + Support for Tesseract 3.02 and 3.03 dropped. Tesseract 3.04 or newer is required. Tesseract 4.00 (alpha) is supported.
-    + The OCRmyPDF.sh script was removed.
+     + Support for Python 3.4 dropped. Python 3.5 is now required.
+     + Support for Tesseract 3.02 and 3.03 dropped. Tesseract 3.04 or newer is required. Tesseract 4.00 (alpha) is supported.
+     + The OCRmyPDF.sh script was removed.
 
 -   Add a new feature, ``--sidecar``, which allows creating "sidecar" text files which contain the OCR results in plain text. These OCR text is more reliable than extracting text from PDFs. Closes #126.
 -   New feature: ``--pdfa-image-compression``, which allows overriding Ghostscript's lossy-or-lossless image encoding heuristic and making all images JPEG encoded or lossless encoded as desired. Fixes #163.
@@ -67,242 +97,242 @@ v4.5.4
 v4.5.3
 ------
 
--  Added a workaround for Ghostscript 9.21 and probably earlier versions would fail with the error message "VMerror -25", due to a Ghostscript bug in XMP metadata handling
--  High Unicode characters (U+10000 and up) are no longer accepted for setting metadata on the command line, as Ghostscript may not handle them correctly.
--  Fixed an issue where the ``tess4`` renderer would duplicate content onto output pages if tesseract failed or timed out
--  Fixed ``tess4`` renderer not recognized when lossless reconstruction is possible
+-   Added a workaround for Ghostscript 9.21 and probably earlier versions would fail with the error message "VMerror -25", due to a Ghostscript bug in XMP metadata handling
+-   High Unicode characters (U+10000 and up) are no longer accepted for setting metadata on the command line, as Ghostscript may not handle them correctly.
+-   Fixed an issue where the ``tess4`` renderer would duplicate content onto output pages if tesseract failed or timed out
+-   Fixed ``tess4`` renderer not recognized when lossless reconstruction is possible
 
 
 v4.5.2
 ------
 
--  Fix issue #147. ``--pdf-renderer tess4 --clean`` will produce an oversized page containing the original image in the bottom left corner, due to loss DPI information.
--  Make "using Tesseract 4.0" warning less ominous
--  Set up machinery for homebrew OCRmyPDF tap
+-   Fix issue #147. ``--pdf-renderer tess4 --clean`` will produce an oversized page containing the original image in the bottom left corner, due to loss DPI information.
+-   Make "using Tesseract 4.0" warning less ominous
+-   Set up machinery for homebrew OCRmyPDF tap
 
 
 v4.5.1
 ------
 
--  Fix issue #137, proportions of images with a non-square pixel aspect ratio would be distorted in output for ``--force-ocr`` and some other combinations of flags
+-   Fix issue #137, proportions of images with a non-square pixel aspect ratio would be distorted in output for ``--force-ocr`` and some other combinations of flags
 
 
 v4.5
 ----
 
--  Exotic PDFs containing "Form XObjects" are now supported (issue #134; PDF reference manual 8.10), and images they contain are taken into account when determining the resolution for rasterizing
--  The Tesseract 4 Docker image no longer includes all languages, because it took so long to build something would tend to fail
--  OCRmyPDF now warns about using ``--pdf-renderer tesseract`` with Tesseract 3.04 or lower due to issues with Ghostscript corrupting the OCR text in these cases
+-   Exotic PDFs containing "Form XObjects" are now supported (issue #134; PDF reference manual 8.10), and images they contain are taken into account when determining the resolution for rasterizing
+-   The Tesseract 4 Docker image no longer includes all languages, because it took so long to build something would tend to fail
+-   OCRmyPDF now warns about using ``--pdf-renderer tesseract`` with Tesseract 3.04 or lower due to issues with Ghostscript corrupting the OCR text in these cases
 
 
 v4.4.2
 ------
 
--  The Docker images (ocrmypdf, ocrmypdf-polyglot, ocrmypdf-tess4) are now based on Ubuntu 16.10 instead of Debian stretch
+-   The Docker images (ocrmypdf, ocrmypdf-polyglot, ocrmypdf-tess4) are now based on Ubuntu 16.10 instead of Debian stretch
 
-   + This makes supporting the Tesseract 4 image easier
-   + This could be a disruptive change for any Docker users who built customized these images with their own changes, and made those changes in a way that depends on Debian and not Ubuntu
+    + This makes supporting the Tesseract 4 image easier
+    + This could be a disruptive change for any Docker users who built customized these images with their own changes, and made those changes in a way that depends on Debian and not Ubuntu
 
--  OCRmyPDF now prevents running the Tesseract 4 renderer with Tesseract 3.04, which was permitted in v4.4 and v4.4.1 but will not work
+-   OCRmyPDF now prevents running the Tesseract 4 renderer with Tesseract 3.04, which was permitted in v4.4 and v4.4.1 but will not work
 
 
 v4.4.1
 ------
 
--  To prevent a `TIFF output error <https://github.com/python-pillow/Pillow/issues/2206>`_ caused by img2pdf >= 0.2.1 and Pillow <= 3.4.2, dependencies have been tightened
--  The Tesseract 4.00 simultaneous process limit was increased from 1 to 2, since it was observed that 1 lowers performance
--  Documentation improvements to describe the ``--tesseract-config`` feature 
--  Added test cases and fixed error handling for ``--tesseract-config``
--  Tweaks to setup.py to deal with issues in the v4.4 release
+-   To prevent a `TIFF output error <https://github.com/python-pillow/Pillow/issues/2206>`_ caused by img2pdf >= 0.2.1 and Pillow <= 3.4.2, dependencies have been tightened
+-   The Tesseract 4.00 simultaneous process limit was increased from 1 to 2, since it was observed that 1 lowers performance
+-   Documentation improvements to describe the ``--tesseract-config`` feature 
+-   Added test cases and fixed error handling for ``--tesseract-config``
+-   Tweaks to setup.py to deal with issues in the v4.4 release
 
 v4.4
 ----
 
--  Tesseract 4.00 is now supported on an experimental basis.
+-   Tesseract 4.00 is now supported on an experimental basis.
 
-   +  A new rendering option ``--pdf-renderer tess4`` exploits Tesseract 4's new text-only output PDF mode. See the documentation on PDF Renderers for details.
-   +  The ``--tesseract-oem`` argument allows control over the Tesseract 4 OCR engine mode (tesseract's ``--oem``). Use ``--tesseract-oem 2`` to enforce the new LSTM mode.
-   +  Fixed poor performance with Tesseract 4.00 on Linux
+    +  A new rendering option ``--pdf-renderer tess4`` exploits Tesseract 4's new text-only output PDF mode. See the documentation on PDF Renderers for details.
+    +  The ``--tesseract-oem`` argument allows control over the Tesseract 4 OCR engine mode (tesseract's ``--oem``). Use ``--tesseract-oem 2`` to enforce the new LSTM mode.
+    +  Fixed poor performance with Tesseract 4.00 on Linux
 
--  Fixed an issue that caused corruption of output to stdout in some cases
--  Removed test for Pillow JPEG and PNG support, as the minimum supported version of Pillow now enforces this
--  OCRmyPDF now tests that the intended destination file is writable before proceeding
--  The test suite now requires ``pytest-helpers-namespace`` to run (but not install)
--  Significant code reorganization to make OCRmyPDF re-entrant and improve performance. All changes should be backward compatible for the v4.x series.
+-   Fixed an issue that caused corruption of output to stdout in some cases
+-   Removed test for Pillow JPEG and PNG support, as the minimum supported version of Pillow now enforces this
+-   OCRmyPDF now tests that the intended destination file is writable before proceeding
+-   The test suite now requires ``pytest-helpers-namespace`` to run (but not install)
+-   Significant code reorganization to make OCRmyPDF re-entrant and improve performance. All changes should be backward compatible for the v4.x series.
 
-   + However, OCRmyPDF's dependency "ruffus" is not re-entrant, so no Python API is available. Scripts should continue to use the command line interface.
+    + However, OCRmyPDF's dependency "ruffus" is not re-entrant, so no Python API is available. Scripts should continue to use the command line interface.
 
 
 v4.3.5
 ------
 
--  Update documentation to confirm Python 3.6.0 compatibility. No code changes were needed, so many earlier versions are likely supported.
+-   Update documentation to confirm Python 3.6.0 compatibility. No code changes were needed, so many earlier versions are likely supported.
 
 
 v4.3.4
 ------
 
--  Fixed "decimal.InvalidOperation: quantize result has too many digits" for high DPI images
+-   Fixed "decimal.InvalidOperation: quantize result has too many digits" for high DPI images
 
 
 v4.3.3
 ------
 
--  Fixed PDF/A creation with Ghostscript 9.20 properly
--  Fixed an exception on inline stencil masks with a missing optional parameter
+-   Fixed PDF/A creation with Ghostscript 9.20 properly
+-   Fixed an exception on inline stencil masks with a missing optional parameter
 
 
 v4.3.2
 ------
 
--  Fixed a PDF/A creation issue with Ghostscript 9.20 (note: this fix did not actually work)
+-   Fixed a PDF/A creation issue with Ghostscript 9.20 (note: this fix did not actually work)
 
 
 v4.3.1
 ------
 
--  Fixed an issue where pages produced by the "hocr" renderer after a Tesseract timeout would be rotated incorrectly if the input page was rotated with a /Rotate marker
--  Fixed a file handle leak in LeptonicaErrorTrap that would cause a "too many open files" error for files around hundred pages of pages long when ``--deskew`` or ``--remove-background`` or other Leptonica based image processing features were in use, depending on the system value of ``ulimit -n``
--  Ability to specify multiple languages for multilingual documents is now advertised in documentation
--  Reduced the file sizes of some test resources
--  Cleaned up debug output
--  Tesseract caching in test cases is now more cautious about false cache hits and reproducing exact output, not that any problems were observed
+-   Fixed an issue where pages produced by the "hocr" renderer after a Tesseract timeout would be rotated incorrectly if the input page was rotated with a /Rotate marker
+-   Fixed a file handle leak in LeptonicaErrorTrap that would cause a "too many open files" error for files around hundred pages of pages long when ``--deskew`` or ``--remove-background`` or other Leptonica based image processing features were in use, depending on the system value of ``ulimit -n``
+-   Ability to specify multiple languages for multilingual documents is now advertised in documentation
+-   Reduced the file sizes of some test resources
+-   Cleaned up debug output
+-   Tesseract caching in test cases is now more cautious about false cache hits and reproducing exact output, not that any problems were observed
 
 
 v4.3
 ----
 
--  New feature ``--remove-background`` to detect and erase the background of color and grayscale images
--  Better documentation
--  Fixed an issue with PDFs that draw images when the raster stack depth is zero 
--  ocrmypdf can now redirect its output to stdout for use in a shell pipeline
+-   New feature ``--remove-background`` to detect and erase the background of color and grayscale images
+-   Better documentation
+-   Fixed an issue with PDFs that draw images when the raster stack depth is zero 
+-   ocrmypdf can now redirect its output to stdout for use in a shell pipeline
 
-   +  This does not improve performance since temporary files are still used for buffering
-   +  Some output validation is disabled in this mode
+    +  This does not improve performance since temporary files are still used for buffering
+    +  Some output validation is disabled in this mode
 
 v4.2.5
 ------
 
--  Fixed an issue (#100) with PDFs that omit the optional /BitsPerComponent parameter on images
--  Removed non-free file milk.pdf
+-   Fixed an issue (#100) with PDFs that omit the optional /BitsPerComponent parameter on images
+-   Removed non-free file milk.pdf
 
 
 v4.2.4
 ------
 
--  Fixed an error (#90) caused by PDFs that use stencil masks properly
--  Fixed handling of PDFs that try to draw images or stencil masks without properly setting up the graphics state (such images are now ignored for the purposes of calculating DPI)
+-   Fixed an error (#90) caused by PDFs that use stencil masks properly
+-   Fixed handling of PDFs that try to draw images or stencil masks without properly setting up the graphics state (such images are now ignored for the purposes of calculating DPI)
 
 v4.2.3
 ------
 
--  Fixed an issue with PDFs that store page rotation (/Rotate) in an indirect object
--  Integrated a few fixes to simplify downstream packaging (Debian)
+-   Fixed an issue with PDFs that store page rotation (/Rotate) in an indirect object
+-   Integrated a few fixes to simplify downstream packaging (Debian)
 
-   +  The test suite no longer assumes it is installed
-   +  If running Linux, skip a test that passes Unicode on the command line
+    +  The test suite no longer assumes it is installed
+    +  If running Linux, skip a test that passes Unicode on the command line
 
--  Added a test case to check explicit masks and stencil masks
--  Added a test case for indirect objects and linearized PDFs
--  Deprecated the OCRmyPDF.sh shell script
+-   Added a test case to check explicit masks and stencil masks
+-   Added a test case for indirect objects and linearized PDFs
+-   Deprecated the OCRmyPDF.sh shell script
 
 
 v4.2.2
 ------
 
--  Improvements to documentation
+-   Improvements to documentation
 
 
 v4.2.1
 ------
 
--  Fixed an issue where PDF pages that contained stencil masks would report an incorrect DPI and cause Ghostscript to abort
--  Implemented stdin streaming
+-   Fixed an issue where PDF pages that contained stencil masks would report an incorrect DPI and cause Ghostscript to abort
+-   Implemented stdin streaming
 
 
 v4.2
 ----
 
--  ocrmypdf will now try to convert single image files to PDFs if they are provided as input (#15)
+-   ocrmypdf will now try to convert single image files to PDFs if they are provided as input (#15)
 
-   +  This is a basic convenience feature. It only supports a single image and always makes the image fill the whole page.
-   +  For better control over image to PDF conversion, use ``img2pdf`` (one of ocrmypdf's dependencies)
+    +  This is a basic convenience feature. It only supports a single image and always makes the image fill the whole page.
+    +  For better control over image to PDF conversion, use ``img2pdf`` (one of ocrmypdf's dependencies)
 
--  New argument ``--output-type {pdf|pdfa}`` allows disabling Ghostscript PDF/A generation
+-   New argument ``--output-type {pdf|pdfa}`` allows disabling Ghostscript PDF/A generation
 
-   +  ``pdfa`` is the default, consistent with past behavior
-   +  ``pdf`` provides a workaround for users concerned about the increase in file size from Ghostscript forcing JBIG2 images to CCITT and transcoding JPEGs
-   +  ``pdf`` preserves as much as it can about the original file, including problems that PDF/A conversion fixes
+    +  ``pdfa`` is the default, consistent with past behavior
+    +  ``pdf`` provides a workaround for users concerned about the increase in file size from Ghostscript forcing JBIG2 images to CCITT and transcoding JPEGs
+    +  ``pdf`` preserves as much as it can about the original file, including problems that PDF/A conversion fixes
 
--  PDFs containing images with "non-square" pixel aspect ratios, such as 200x100 DPI, are now handled and converted properly (fixing a bug that caused to be cropped)
--  ``--force-ocr`` rasterizes pages even if they contain no images
+-   PDFs containing images with "non-square" pixel aspect ratios, such as 200x100 DPI, are now handled and converted properly (fixing a bug that caused to be cropped)
+-   ``--force-ocr`` rasterizes pages even if they contain no images
 
-   +  supports users who want to use OCRmyPDF to reconstruct text information in PDFs with damaged Unicode maps (copy and paste text does not match displayed text)
-   +  supports reinterpreting PDFs where text was rendered as curves for printing, and text needs to be recovered
-   +  fixes issue #82
+    +  supports users who want to use OCRmyPDF to reconstruct text information in PDFs with damaged Unicode maps (copy and paste text does not match displayed text)
+    +  supports reinterpreting PDFs where text was rendered as curves for printing, and text needs to be recovered
+    +  fixes issue #82
 
--  Fixes an issue where, with certain settings, monochrome images in PDFs would be converted to 8-bit grayscale, increasing file size (#79)
--  Support for Ubuntu 12.04 LTS "precise" has been dropped in favor of (roughly) Ubuntu 14.04 LTS "trusty" 
+-   Fixes an issue where, with certain settings, monochrome images in PDFs would be converted to 8-bit grayscale, increasing file size (#79)
+-   Support for Ubuntu 12.04 LTS "precise" has been dropped in favor of (roughly) Ubuntu 14.04 LTS "trusty" 
 
-   +  Some Ubuntu "PPAs" (backports) are needed to make it work
-      
--  Support for some older dependencies dropped
+    +  Some Ubuntu "PPAs" (backports) are needed to make it work
 
-   +  Ghostscript 9.15 or later is now required (available in Ubuntu trusty with backports)
-   +  Tesseract 3.03 or later is now required (available in Ubuntu trusty)
+-   Support for some older dependencies dropped
 
--  Ghostscript now runs in "safer" mode where possible
+    +  Ghostscript 9.15 or later is now required (available in Ubuntu trusty with backports)
+    +  Tesseract 3.03 or later is now required (available in Ubuntu trusty)
+
+-   Ghostscript now runs in "safer" mode where possible
 
 v4.1.4
 ------
 
--  Bug fix: monochrome images with an ICC profile attached were incorrectly converted to full color images if lossless reconstruction was not possible due to other settings; consequence was increased file size for these images
+-   Bug fix: monochrome images with an ICC profile attached were incorrectly converted to full color images if lossless reconstruction was not possible due to other settings; consequence was increased file size for these images
 
 
 v4.1.3
 ------
 
--  More helpful error message for PDFs with version 4 security handler
--  Update usage instructions for Windows/Docker users
--  Fix order of operations for matrix multiplication (no effect on most users)
--  Add a few leptonica wrapper functions (no effect on most users)
+-   More helpful error message for PDFs with version 4 security handler
+-   Update usage instructions for Windows/Docker users
+-   Fix order of operations for matrix multiplication (no effect on most users)
+-   Add a few leptonica wrapper functions (no effect on most users)
 
 
 v4.1.2
 ------
 
--  Replace IEC sRGB ICC profile with Debian's sRGB (from icc-profiles-free) which is more compatible with the MIT license
--  More helpful error message for an error related to certain types of malformed PDFs
+-   Replace IEC sRGB ICC profile with Debian's sRGB (from icc-profiles-free) which is more compatible with the MIT license
+-   More helpful error message for an error related to certain types of malformed PDFs
 
 
 v4.1
 ----
 
--  ``--rotate-pages`` now only rotates pages when reasonably confidence in the orientation. This behavior can be adjusted with the new argument ``--rotate-pages-threshold``
--  Fixed problems in error checking if ``unpaper`` is uninstalled or missing at run-time
--  Fixed problems with "RethrownJobError" errors during error handling that suppressed the useful error messages
+-   ``--rotate-pages`` now only rotates pages when reasonably confidence in the orientation. This behavior can be adjusted with the new argument ``--rotate-pages-threshold``
+-   Fixed problems in error checking if ``unpaper`` is uninstalled or missing at run-time
+-   Fixed problems with "RethrownJobError" errors during error handling that suppressed the useful error messages
 
 
 v4.0.7
 ------
 
--  Minor correction to Ghostscript output settings
+-   Minor correction to Ghostscript output settings
 
 
 v4.0.6
 ------
 
--  Update install instructions
--  Provide a sRGB profile instead of using Ghostscript's
+-   Update install instructions
+-   Provide a sRGB profile instead of using Ghostscript's
 
 
 v4.0.5
 ------
 
--  Remove some verbose debug messages from v4.0.4
--  Fixed temporary that wasn't being deleted
--  DPI is now calculated correctly for cropped images, along with other image transformations
--  Inline images are now checked during DPI calculation instead of rejecting the image
+-   Remove some verbose debug messages from v4.0.4
+-   Fixed temporary that wasn't being deleted
+-   DPI is now calculated correctly for cropped images, along with other image transformations
+-   Inline images are now checked during DPI calculation instead of rejecting the image
 
 v4.0.4
 ------
@@ -316,16 +346,16 @@ v4.0.3
 New features
 ^^^^^^^^^^^^
 
--  Page orientations detected are now reported in a summary comment
+-   Page orientations detected are now reported in a summary comment
 
 
 Fixes
 ^^^^^
 
--  Show stack trace if unexpected errors occur
--  Treat "too few characters" error message from Tesseract as a reason to skip that page rather than
-   abort the file
--  Docker: fix blank JPEG2000 issue by insisting on Ghostscript versions that have this fixed
+-   Show stack trace if unexpected errors occur
+-   Treat "too few characters" error message from Tesseract as a reason to skip that page rather than
+    abort the file
+-   Docker: fix blank JPEG2000 issue by insisting on Ghostscript versions that have this fixed
 
 
 v4.0.2
@@ -334,10 +364,10 @@ v4.0.2
 Fixes
 ^^^^^
 
--  Fixed compatibility with Tesseract 3.04.01 release, particularly its different way of outputting
-   orientation information
--  Improved handling of Tesseract errors and crashes
--  Fixed use of chmod on Docker that broke most test cases
+-   Fixed compatibility with Tesseract 3.04.01 release, particularly its different way of outputting
+    orientation information
+-   Improved handling of Tesseract errors and crashes
+-   Fixed use of chmod on Docker that broke most test cases
 
 
 v4.0.1
@@ -346,7 +376,7 @@ v4.0.1
 Fixes
 ^^^^^
 
--  Fixed a KeyError if tesseract fails to find page orientation information
+-   Fixed a KeyError if tesseract fails to find page orientation information
 
 
 v4.0
@@ -355,33 +385,33 @@ v4.0
 New features
 ^^^^^^^^^^^^
 
--  Automatic page rotation (``-r``) is now available. It uses ignores any prior rotation information
-   on PDFs and sets rotation based on the dominant orientation of detectable text. This feature is
-   fairly reliable but some false positives occur especially if there is not much text to work with. (#4) 
--  Deskewing is now performed using Leptonica instead of unpaper. Leptonica is faster and more reliable
-   at image deskewing than unpaper.
+-   Automatic page rotation (``-r``) is now available. It uses ignores any prior rotation information
+    on PDFs and sets rotation based on the dominant orientation of detectable text. This feature is
+    fairly reliable but some false positives occur especially if there is not much text to work with. (#4) 
+-   Deskewing is now performed using Leptonica instead of unpaper. Leptonica is faster and more reliable
+    at image deskewing than unpaper.
 
 
 Fixes
 ^^^^^
 
--  Fixed an issue where lossless reconstruction could cause some pages to be appear incorrectly
-   if the page was rotated by the user in Acrobat after being scanned (specifically if it a /Rotate tag)
--  Fixed an issue where lossless reconstruction could misalign the graphics layer with respect to
-   text layer if the page had been cropped such that its origin is not (0, 0) (#49)
+-   Fixed an issue where lossless reconstruction could cause some pages to be appear incorrectly
+    if the page was rotated by the user in Acrobat after being scanned (specifically if it a /Rotate tag)
+-   Fixed an issue where lossless reconstruction could misalign the graphics layer with respect to
+    text layer if the page had been cropped such that its origin is not (0, 0) (#49)
 
 
 Changes
 ^^^^^^^
 
--  Logging output is now much easier to read
--  ``--deskew`` is now performed by Leptonica instead of unpaper (#25)
--  libffi is now required
--  Some changes were made to the Docker and Travis build environments to support libffi
--  ``--pdf-renderer=tesseract`` now displays a warning if the Tesseract version is less than 3.04.01,
-   the planned release that will include fixes to an important OCR text rendering bug in Tesseract 3.04.00.
-   You can also manually install ./share/sharp2.ttf on top of pdf.ttf in your Tesseract tessdata folder
-   to correct the problem.
+-   Logging output is now much easier to read
+-   ``--deskew`` is now performed by Leptonica instead of unpaper (#25)
+-   libffi is now required
+-   Some changes were made to the Docker and Travis build environments to support libffi
+-   ``--pdf-renderer=tesseract`` now displays a warning if the Tesseract version is less than 3.04.01,
+    the planned release that will include fixes to an important OCR text rendering bug in Tesseract 3.04.00.
+    You can also manually install ./share/sharp2.ttf on top of pdf.ttf in your Tesseract tessdata folder
+    to correct the problem.
 
 
 v3.2.1
@@ -390,8 +420,8 @@ v3.2.1
 Changes
 ^^^^^^^
 
--  Fixed issue #47 "convert() got and unexpected keyword argument 'dpi'" by upgrading to img2pdf 0.2
--  Tweaked the Dockerfiles
+-   Fixed issue #47 "convert() got and unexpected keyword argument 'dpi'" by upgrading to img2pdf 0.2
+-   Tweaked the Dockerfiles
 
 
 v3.2
@@ -400,19 +430,19 @@ v3.2
 New features
 ^^^^^^^^^^^^
 
--  Lossless reconstruction: when possible, OCRmyPDF will inject text layers without 
-   otherwise manipulating the content and layout of a PDF page. For example, a PDF containing a mix
-   of vector and raster content would see the vector content preserved. Images may still be transcoded
-   during PDF/A conversion.  (``--deskew`` and ``--clean-final`` disable this mode, necessarily.)
--  New argument ``--tesseract-pagesegmode`` allows you to pass page segmentation arguments to Tesseract OCR.
-   This helps for two column text and other situations that confuse Tesseract.
--  Added a new "polyglot" version of the Docker image, that generates Tesseract with all languages packs installed,
-   for the polyglots among us. It is much larger.
+-   Lossless reconstruction: when possible, OCRmyPDF will inject text layers without 
+    otherwise manipulating the content and layout of a PDF page. For example, a PDF containing a mix
+    of vector and raster content would see the vector content preserved. Images may still be transcoded
+    during PDF/A conversion.  (``--deskew`` and ``--clean-final`` disable this mode, necessarily.)
+-   New argument ``--tesseract-pagesegmode`` allows you to pass page segmentation arguments to Tesseract OCR.
+    This helps for two column text and other situations that confuse Tesseract.
+-   Added a new "polyglot" version of the Docker image, that generates Tesseract with all languages packs installed,
+    for the polyglots among us. It is much larger.
 
 Changes
 ^^^^^^^
 
--  JPEG transcoding quality is now 95 instead of the default 75. Bigger file sizes for less degradation.
+-   JPEG transcoding quality is now 95 instead of the default 75. Bigger file sizes for less degradation.
 
 
 
@@ -422,7 +452,7 @@ v3.1.1
 Changes
 ^^^^^^^
 
--  Fixed bug that caused incorrect page size and DPI calculations on documents with mixed page sizes
+-   Fixed bug that caused incorrect page size and DPI calculations on documents with mixed page sizes
 
 v3.1
 ----
@@ -430,17 +460,17 @@ v3.1
 Changes
 ^^^^^^^
 
--  Default output format is now PDF/A-2b instead of PDF/A-1b
--  Python 3.5 and macOS El Capitan are now supported platforms - no changes were
-   needed to implement support
--  Improved some error messages related to missing input files
--  Fixed issue #20 - uppercase .PDF extension not accepted
--  Fixed an issue where OCRmyPDF failed to text that certain pages contained previously OCR'ed text, 
-   such as OCR text produced by Tesseract 3.04
--  Inserts /Creator tag into PDFs so that errors can be traced back to this project
--  Added new option ``--pdf-renderer=auto``, to let OCRmyPDF pick the best PDF renderer. 
-   Currently it always chooses the 'hocrtransform' renderer but that behavior may change.
--  Set up Travis CI automatic integration testing
+-   Default output format is now PDF/A-2b instead of PDF/A-1b
+-   Python 3.5 and macOS El Capitan are now supported platforms - no changes were
+    needed to implement support
+-   Improved some error messages related to missing input files
+-   Fixed issue #20 - uppercase .PDF extension not accepted
+-   Fixed an issue where OCRmyPDF failed to text that certain pages contained previously OCR'ed text, 
+    such as OCR text produced by Tesseract 3.04
+-   Inserts /Creator tag into PDFs so that errors can be traced back to this project
+-   Added new option ``--pdf-renderer=auto``, to let OCRmyPDF pick the best PDF renderer. 
+    Currently it always chooses the 'hocrtransform' renderer but that behavior may change.
+-   Set up Travis CI automatic integration testing
 
 v3.0
 ----
@@ -448,55 +478,55 @@ v3.0
 New features
 ^^^^^^^^^^^^
 
--  Easier installation with a Docker container or Python's ``pip`` package manager 
--  Eliminated many external dependencies, so it's easier to setup
--  Now installs ``ocrmypdf`` to ``/usr/local/bin`` or equivalent for system-wide
-   access and easier typing
--  Improved command line syntax and usage help (``--help``)
--  Tesseract 3.03+ PDF page rendering can be used instead for better positioning
-   of recognized text (``--pdf-renderer tesseract``)
--  PDF metadata (title, author, keywords) are now transferred to the 
-   output PDF
--  PDF metadata can also be set from the command line (``--title``, etc.)
--  Automatic repairs malformed input PDFs if possible
--  Added test cases to confirm everything is working
--  Added option to skip extremely large pages that take too long to OCR and are 
-   often not OCRable (e.g. large scanned maps or diagrams); other pages are still
-   processed (``--skip-big``)
--  Added option to kill Tesseract OCR process if it seems to be taking too long on
-   a page, while still processing other pages (``--tesseract-timeout``)
--  Less common colorspaces (CMYK, palette) are now supported by conversion to RGB
--  Multiple images on the same PDF page are now supported
+-   Easier installation with a Docker container or Python's ``pip`` package manager 
+-   Eliminated many external dependencies, so it's easier to setup
+-   Now installs ``ocrmypdf`` to ``/usr/local/bin`` or equivalent for system-wide
+    access and easier typing
+-   Improved command line syntax and usage help (``--help``)
+-   Tesseract 3.03+ PDF page rendering can be used instead for better positioning
+    of recognized text (``--pdf-renderer tesseract``)
+-   PDF metadata (title, author, keywords) are now transferred to the 
+    output PDF
+-   PDF metadata can also be set from the command line (``--title``, etc.)
+-   Automatic repairs malformed input PDFs if possible
+-   Added test cases to confirm everything is working
+-   Added option to skip extremely large pages that take too long to OCR and are 
+    often not OCRable (e.g. large scanned maps or diagrams); other pages are still
+    processed (``--skip-big``)
+-   Added option to kill Tesseract OCR process if it seems to be taking too long on
+    a page, while still processing other pages (``--tesseract-timeout``)
+-   Less common colorspaces (CMYK, palette) are now supported by conversion to RGB
+-   Multiple images on the same PDF page are now supported
 
 Changes
 ^^^^^^^
 
--  New, robust rewrite in Python 3.4+ with ruffus_ pipelines
--  Now uses Ghostscript 9.14's improved color conversion model to preserve PDF colors
--  OCR text is now rendered in the PDF as invisible text. Previous versions of OCRmyPDF
-   incorrectly rendered visible text with an image on top.
--  All "tasks" in the pipeline can be executed in parallel on any
-   available CPUs, increasing performance
--  The ``-o DPI`` argument has been phased out, in favor of ``--oversample DPI``, in
-   case we need ``-o OUTPUTFILE`` in the future
--  Removed several dependencies, so it's easier to install.  We no 
-   longer use:
-   
-   - GNU parallel_
-   - ImageMagick_
-   - Python 2.7
-   - Poppler
-   - MuPDF_ tools
-   - shell scripts
-   - Java and JHOVE_
-   - libxml2
+-   New, robust rewrite in Python 3.4+ with ruffus_ pipelines
+-   Now uses Ghostscript 9.14's improved color conversion model to preserve PDF colors
+-   OCR text is now rendered in the PDF as invisible text. Previous versions of OCRmyPDF
+    incorrectly rendered visible text with an image on top.
+-   All "tasks" in the pipeline can be executed in parallel on any
+    available CPUs, increasing performance
+-   The ``-o DPI`` argument has been phased out, in favor of ``--oversample DPI``, in
+    case we need ``-o OUTPUTFILE`` in the future
+-   Removed several dependencies, so it's easier to install.  We no 
+    longer use:
+    
+    - GNU parallel_
+    - ImageMagick_
+    - Python 2.7
+    - Poppler
+    - MuPDF_ tools
+    - shell scripts
+    - Java and JHOVE_
+    - libxml2
 
--  Some new external dependencies are required or optional, compared to v2.x:
+-   Some new external dependencies are required or optional, compared to v2.x:
 
-   - Ghostscript 9.14+
-   - qpdf_ 5.0.0+
-   - Unpaper_ 6.1 (optional)
-   - some automatically managed Python packages
+    - Ghostscript 9.14+
+    - qpdf_ 5.0.0+
+    - Unpaper_ 6.1 (optional)
+    - some automatically managed Python packages
   
 .. _ruffus: http://www.ruffus.org.uk/index.html
 .. _parallel: https://www.gnu.org/software/parallel/
@@ -509,87 +539,87 @@ Changes
 Release candidates
 ^^^^^^^^^^^^^^^^^^
 
--  rc9:
+-   rc9:
 
-   - fix issue #118: report error if ghostscript iccprofiles are missing
-   - fixed another issue related to #111: PDF rasterized to palette file
-   - add support image files with a palette
-   - don't try to validate PDF file after an exception occurs
+    - fix issue #118: report error if ghostscript iccprofiles are missing
+    - fixed another issue related to #111: PDF rasterized to palette file
+    - add support image files with a palette
+    - don't try to validate PDF file after an exception occurs
 
--  rc8:
+-   rc8:
 
-   - fix issue #111: exception thrown if PDF is missing DocumentInfo dictionary
+    - fix issue #111: exception thrown if PDF is missing DocumentInfo dictionary
 
--  rc7:
+-   rc7:
 
-   - fix error when installing direct from pip, "no such file 'requirements.txt'"
+    - fix error when installing direct from pip, "no such file 'requirements.txt'"
 
--  rc6:
+-   rc6:
 
-   - dropped libxml2 (Python lxml) since Python 3's internal XML parser is sufficient
-   - set up Docker container
-   - fix Unicode errors if recognized text contains Unicode characters and system locale is not UTF-8
+    - dropped libxml2 (Python lxml) since Python 3's internal XML parser is sufficient
+    - set up Docker container
+    - fix Unicode errors if recognized text contains Unicode characters and system locale is not UTF-8
 
--  rc5:
+-   rc5:
 
-   - dropped Java and JHOVE in favour of qpdf
-   - improved command line error output
-   - additional tests and bug fixes
-   - tested on Ubuntu 14.04 LTS
+    - dropped Java and JHOVE in favour of qpdf
+    - improved command line error output
+    - additional tests and bug fixes
+    - tested on Ubuntu 14.04 LTS
 
--  rc4:
+-   rc4:
 
-   - dropped MuPDF in favour of qpdf
-   - fixed some installer issues and errors in installation instructions
-   - improve performance: run Ghostscript with multithreaded rendering
-   - improve performance: use multiple cores by default
-   - bug fix: checking for wrong exception on process timeout 
+    - dropped MuPDF in favour of qpdf
+    - fixed some installer issues and errors in installation instructions
+    - improve performance: run Ghostscript with multithreaded rendering
+    - improve performance: use multiple cores by default
+    - bug fix: checking for wrong exception on process timeout 
 
--  rc3: skipping version number intentionally to avoid confusion with Tesseract
--  rc2: first release for public testing to test-PyPI, Github
--  rc1: testing release process
+-   rc3: skipping version number intentionally to avoid confusion with Tesseract
+-   rc2: first release for public testing to test-PyPI, Github
+-   rc1: testing release process
 
 Compatibility notes
 -------------------
 
--  ``./OCRmyPDF.sh`` script is still available for now
--  Stacking the verbosity option like ``-vvv`` is no longer supported
+-   ``./OCRmyPDF.sh`` script is still available for now
+-   Stacking the verbosity option like ``-vvv`` is no longer supported
 
--  The configuration file ``config.sh`` has been removed.  Instead, you can
-   feed a file to the arguments for common settings:
+-   The configuration file ``config.sh`` has been removed.  Instead, you can
+    feed a file to the arguments for common settings:
 
 ::
 
-   ocrmypdf input.pdf output.pdf @settings.txt
+    ocrmypdf input.pdf output.pdf @settings.txt
 
 where ``settings.txt`` contains *one argument per line*, for example:
 
 ::
 
-   -l 
-   deu 
-   --author 
-   A. Merkel 
-   --pdf-renderer 
-   tesseract
+    -l 
+    deu 
+    --author 
+    A. Merkel 
+    --pdf-renderer 
+    tesseract
 
 
 Fixes
 ^^^^^
 
--  Handling of filenames containing spaces: fixed
+-   Handling of filenames containing spaces: fixed
 
 Notes and known issues
 ^^^^^^^^^^^^^^^^^^^^^^
 
--  Some dependencies may work with lower versions than tested, so try
-   overriding dependencies if they are "in the way" to see if they work.
+-   Some dependencies may work with lower versions than tested, so try
+    overriding dependencies if they are "in the way" to see if they work.
 
--  ``--pdf-renderer tesseract`` will output files with an incorrect page size in Tesseract 3.03,
-   due to a bug in Tesseract.
+-   ``--pdf-renderer tesseract`` will output files with an incorrect page size in Tesseract 3.03,
+    due to a bug in Tesseract.
 
--  PDF files containing "inline images" are not supported and won't be for the 3.0 release. Scanned
-   images almost never contain inline images.
+-   PDF files containing "inline images" are not supported and won't be for the 3.0 release. Scanned
+    images almost never contain inline images.
 
 
 v2.2-stable (2014-09-29)

ocrmypdf/__main__.py

@@ -41,6 +41,9 @@ warnings.simplefilter('ignore', pypdf.utils.PdfReadWarning)
 
 MINIMUM_TESS_VERSION = '3.04'
 
+HOCR_OK_LANGS = frozenset([
+    'eng', 'deu', 'spa', 'ita', 'por'
+])
 
 def complain(message):
     print(*textwrap.wrap(message), file=sys.stderr)
@@ -281,6 +284,15 @@ advanced.add_argument(
          "are applied to all pages, including those for which OCR was "
          "skipped.  Not supported for --output-type=pdf ; that setting "
          "preserves the original compression of all images.")
+advanced.add_argument(
+    '--user-words', metavar='FILE',
+    help="Specify the location of the Tesseract user words file. This is a "
+         "list of words Tesseract should consider while performing OCR in "
+         "addition to its standard language dictionaries. This can improve "
+         "OCR quality especially for specialized and technical documents.")
+advanced.add_argument(
+    '--user-patterns', metavar='FILE',
+    help="Specify the location of the Tesseract user patterns file.")
 
 debugging = parser.add_argument_group(
     "Debugging",
@@ -310,7 +322,7 @@ def check_options_languages(options, _log):
             "data for the following requested languages: \n")
         for lang in (set(options.language) - tesseract.languages()):
             msg += lang + '\n'
-        raise argparse.ArgumentError(None, msg)
+        raise MissingDependencyError(msg)
 
 
 def check_options_output(options, log):
@@ -320,6 +332,11 @@ def check_options_output(options, log):
         else:
             options.pdf_renderer = 'hocr'
 
+    if options.pdf_renderer == 'sandwich' and not tesseract.has_textonly_pdf():
+        raise MissingDependencyError(
+            "The 'sandwich' renderer requires Tesseract 3.05.01 or newer; "
+            "or Tesseract 4.00 alpha newer than February 2017.")
+
     if options.pdf_renderer == 'tess4':
         log.warning("The 'tess4' PDF renderer has been renamed to 'sandwich'. "
                     "Please use --pdf-renderer=sandwich.")
@@ -386,12 +403,20 @@ def check_options_ocr_behavior(options, log):
     #     raise argparse.ArgumentError(
     #         "Error: --redo-ocr and other OCR options are incompatible.")
 
-    if set(options.language) & {'chi_sim', 'chi_tra'} and \
-            (options.pdf_renderer == 'hocr' or options.output_type == 'pdfa'):
-        log.warning(
-            "Your settings are known to cause problems with OCR of Chinese text. "
-            "Try adding these arguments: "
-            "    ocrmypdf --pdf-renderer tesseract --output-type pdf")
+    if options.pdf_renderer == 'hocr' and \
+            not set(options.language).issubset(HOCR_OK_LANGS):
+        msg = (
+            "The 'hocr' PDF renderer is known to cause problems with one "
+            "or more of the languages in your document. ")
+
+        if tesseract.has_textonly_pdf():
+            msg += (
+                "Use --pdf-renderer auto (the default) to avoid this issue.")
+        else:
+            msg += (
+                "Use --pdf-renderer tesseract --output-type pdf to avoid "
+                "this issue")
+        log.warning(msg)
 
 
 def check_options_advanced(options, log):
@@ -666,8 +691,9 @@ def run_pipeline():
                     file."""))
                 return ExitCode.bad_args
         elif not is_file_writable(options.output_file):
-            _log.error(textwrap.dedent("""\
-                Output file location is not writable."""))
+            _log.error(
+                "Output file location (" + options.output_file + ") " +
+                "is not writable.")
             return ExitCode.file_access_error
 
         manager = JobContextManager()

ocrmypdf/exec/ghostscript.py

@@ -10,6 +10,7 @@ import sys
 from . import get_program
 from ..exceptions import SubprocessOutputError
 from PIL import Image
+from ..helpers import fspath
 
 
 @lru_cache(maxsize=1)
@@ -43,8 +44,8 @@ def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
     (xres, yres) even if those numbers are noninteger. The image's DPI will
      be overridden with the values in page_dpi.
     
-    :param input_file: 
-    :param output_file: 
+    :param input_file: pathlike
+    :param output_file: pathlike
     :param xres: resolution at which to rasterize page
     :param yres: 
     :param raster_device: 
@@ -69,7 +70,7 @@ def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
             '-dLastPage=%i' % pageno,
             '-o', tmp.name,
             '-r{0}x{1}'.format(str(int_res[0]), str(int_res[1])),
-            input_file
+            fspath(input_file)
         ]
 
         p = run(args_gs, stdout=PIPE, stderr=STDOUT,
@@ -95,9 +96,10 @@ def rasterize_pdf(input_file, output_file, xres, yres, raster_device, log,
                 log.debug(
                     "Ghostscript: resize output image {} -> {}".format(
                         im.size, expected_size))
-                im.resize(expected_size).save(output_file, dpi=page_dpi)
+                im.resize(expected_size).save(
+                    fspath(output_file), dpi=page_dpi)
             else:
-                copy(tmp.name, output_file)
+                copy(tmp.name, fspath(output_file))
 
 
 def generate_pdfa(pdf_pages, output_file, compression, log,

ocrmypdf/exec/tesseract.py

@@ -213,7 +213,8 @@ def _generate_null_hocr(output_hocr, output_sidecar, image):
 
 def generate_hocr(input_file, output_files, language: list, engine_mode,
                   tessconfig: list,
-                  timeout: float, pagesegmode: int, log):
+                  timeout: float, pagesegmode: int, user_words, user_patterns,
+                  log):
 
     output_hocr = next(o for o in output_files if o.endswith('.hocr'))
     output_sidecar = next(o for o in output_files if o.endswith('.txt'))
@@ -224,10 +225,17 @@ def generate_hocr(input_file, output_files, language: list, engine_mode,
     if pagesegmode is not None:
         args_tesseract.extend([psm(), str(pagesegmode)])
 
+    if user_words:
+        args_tesseract.extend(['--user-words', user_words])
+
+    if user_patterns:
+        args_tesseract.extend(['--user-patterns', user_patterns])
+
     # Reminder: test suite tesseract spoofers will break after any changes
     # to the number of order parameters here
     # Tesseract 3.04 requires the order here to be "hocr txt" and will fail
     # on "txt hocr"
+
     args_tesseract.extend([
         input_file,
         prefix,
@@ -285,7 +293,8 @@ def use_skip_page(text_only, skip_pdf, output_pdf, output_text):
 
 def generate_pdf(*, input_image, skip_pdf, output_pdf, output_text,
                  language: list, engine_mode, text_only: bool,
-                 tessconfig: list, timeout: float, pagesegmode: int, log):
+                 tessconfig: list, timeout: float, pagesegmode: int,
+                 user_words, user_patterns, log):
     '''Use Tesseract to render a PDF.
 
     input_image -- image to analyze
@@ -308,10 +317,17 @@ def generate_pdf(*, input_image, skip_pdf, output_pdf, output_text,
     if text_only:
         args_tesseract.extend(['-c', 'textonly_pdf=1'])
 
+    if user_words:
+        args_tesseract.extend(['--user-words', user_words])
+
+    if user_patterns:
+        args_tesseract.extend(['--user-patterns', user_patterns])
+
     prefix = os.path.splitext(output_pdf)[0]  # Tesseract appends suffixes
 
-    # Reminder: test suite tesseract spoofers will break after any changes
+    # Reminder: test suite tesseract spoofers might break after any changes
     # to the number of order parameters here
+
     args_tesseract.extend([
         input_image,
         prefix,

ocrmypdf/helpers.py

@@ -79,10 +79,43 @@ def is_file_writable(test_file):
         return True
 
 
-@contextmanager
-def universal_open(p, *args, **kwargs):
-    "Work around Python 3.5's inability to open(pathlib.Path())"
-    try:
-        yield p.open(*args, **kwargs)
-    except AttributeError:
-        yield open(p, *args, **kwargs)
+if sys.version_info[0:2] <= (3, 5):
+    def universal_open(p, *args, **kwargs):
+        "Work around Python 3.5's inability to open(pathlib.Path())"
+        try:
+            return p.open(*args, **kwargs)
+        except AttributeError:
+            return open(p, *args, **kwargs)
+
+
+    def fspath(path):
+        import pathlib
+        '''https://www.python.org/dev/peps/pep-0519/#os'''
+        if isinstance(path, (str, bytes)):
+            return path
+
+        # Work from the object's type to match method resolution of other magic
+        # methods.
+        path_type = type(path)
+        try:
+            path = path_type.__fspath__(path)
+        except AttributeError:
+            # Added for Python 3.5 support.
+            if isinstance(path, pathlib.Path):
+                return str(path)
+            elif hasattr(path_type, '__fspath__'):
+                raise
+        else:
+            if isinstance(path, (str, bytes)):
+                return path
+            else:
+                raise TypeError("expected __fspath__() to return str or bytes, "
+                                "not " + type(path).__name__)
+
+        raise TypeError(
+            "expected str, bytes, pathlib.Path or os.PathLike object, not "
+            + path_type.__name__)
+
+else:
+    universal_open = open
+    fspath = os.fspath

ocrmypdf/leptonica.py

@@ -14,6 +14,7 @@ from ctypes.util import find_library
 from .lib._leptonica import ffi
 from functools import lru_cache
 from enum import Enum
+from .helpers import fspath
 
 lept = ffi.dlopen(find_library('lept'))
 
@@ -208,26 +209,27 @@ class Pix:
             return 'P'
 
     @classmethod
-    def read(cls, filename):
+    def read(cls, path):
         """Load an image file into a PIX object.
 
         Leptonica can load TIFF, PNM (PBM, PGM, PPM), PNG, and JPEG.  If
         loading fails then the object will wrap a C null pointer.
         """
+        filename = fspath(path)
         with LeptonicaErrorTrap():
-            return cls(lept.pixRead(
-                filename.encode(sys.getfilesystemencoding())))
+            return cls(lept.pixRead(os.fsencode(filename)))
 
     def write_implied_format(
-            self, filename, jpeg_quality=0, jpeg_progressive=0):
+            self, path, jpeg_quality=0, jpeg_progressive=0):
         """Write pix to the filename, with the extension indicating format.
 
         jpeg_quality -- quality (iff JPEG; 1 - 100, 0 for default)
         jpeg_progressive -- (iff JPEG; 0 for baseline seq., 1 for progressive)
         """
+        filename = fspath(path)
         with LeptonicaErrorTrap():
             lept.pixWriteImpliedFormat(
-                filename.encode(sys.getfilesystemencoding()),
+                os.fsencode(filename),
                 self._pix, jpeg_quality, jpeg_progressive)
 
     def topil(self):

ocrmypdf/pipeline.py

@@ -165,8 +165,8 @@ def triage(
     options = context.get_options()
     try:
         with open(input_file, 'rb') as f:
-            signature = f.read(4)
-            if signature == b'%PDF':
+            signature = f.read(1024)
+            if b'%PDF' in signature:
                 if options.image_dpi:
                     log.warning("Argument --image-dpi ignored because the "
                                 "input file is a PDF, not an image.")
@@ -202,7 +202,7 @@ def repair_pdf(
 
 
 def get_pageinfo(input_file, context):
-    pageno = int(os.path.basename(input_file)[0:6]) - 1
+    pageno = page_number(input_file) - 1
     pageinfo = context.get_pdfinfo()[pageno]
     return pageinfo
 
@@ -406,7 +406,7 @@ def orient_page(
         with open(output_file, 'wb') as out:
             writer.write(out)
 
-        pageno = int(os.path.basename(page_pdf)[0:6]) - 1
+        pageno = page_number(page_pdf) - 1
         pdfinfo = context.get_pdfinfo()
         pdfinfo[pageno].rotation = orient_conf.angle
         context.set_pdfinfo(pdfinfo)
@@ -525,6 +525,8 @@ def ocr_tesseract_hocr(
         tessconfig=options.tesseract_config,
         timeout=options.tesseract_timeout,
         pagesegmode=options.tesseract_pagesegmode,
+        user_words=options.user_words,
+        user_patterns=options.user_patterns,
         log=log
         )
 
@@ -755,6 +757,8 @@ def ocr_tesseract_and_render_pdf(
         tessconfig=options.tesseract_config,
         timeout=options.tesseract_timeout,
         pagesegmode=options.tesseract_pagesegmode,
+        user_words=options.user_words,
+        user_patterns=options.user_patterns,
         log=log)
 
 
@@ -783,6 +787,8 @@ def ocr_tesseract_textonly_pdf(
         tessconfig=options.tesseract_config,
         timeout=options.tesseract_timeout,
         pagesegmode=options.tesseract_pagesegmode,
+        user_words=options.user_words,
+        user_patterns=options.user_patterns,
         log=log)
 
 
@@ -863,7 +869,7 @@ def merge_pages_ghostscript(
         right that way.'''
         if s.endswith('.ps'):
             return 99999999
-        key = int(os.path.basename(s)[0:6]) * 10
+        key = page_number(s) * 10
         if 'debug' in os.path.basename(s):
             key += 1
         return key
@@ -898,7 +904,7 @@ def merge_pages_qpdf(
     def input_file_order(s):
         '''Sort order: All rendered pages followed
         by their debug page.'''
-        key = int(os.path.basename(s)[0:6]) * 10
+        key = page_number(s) * 10
         if 'debug' in os.path.basename(s):
             key += 1
         return key

setup.py

@@ -185,9 +185,15 @@ if 'upload' in sys.argv[1:]:
 
 tests_require = open('test_requirements.txt').read().splitlines()
 
+
+def readme():
+    with open('README.rst') as f:
+        return f.read()
+
 setup(
     name='ocrmypdf',
     description='OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched',
+    long_description=readme(),
     url='https://github.com/jbarlow83/OCRmyPDF',
     author='James R. Barlow',
     author_email='jim@purplerock.ca',

tests/conftest.py

@@ -129,7 +129,8 @@ def run_ocrmypdf(input_file, output_file, *args, env=None):
     if env is None:
         env = os.environ
 
-    p_args = OCRMYPDF + list(args) + [str(input_file), str(output_file)]
+    p_args = OCRMYPDF + [str(arg) for arg in args] + \
+             [str(input_file), str(output_file)]
     p = Popen(
         p_args, close_fds=True, stdout=PIPE, stderr=PIPE,
         universal_newlines=True, env=env)

tests/resources/README.rst

@@ -88,14 +88,18 @@ under the terms of the license in LICENSE.rst.
     *   - overlay.pdf
         - @maxandersen
         - PDF file generated by PDFPen pro that triggered content stream parse errors
-    *   - no_conentes.pdf
+    *   - no_contents.pdf
         - @jbarlow83
         - synthetic PDF with a blank page that has no /Contents entry
+    *   - crom.png
+        - @jbarlow83
+        - test for non-dictionary words
+
 
 Assemblies
 ==========
 
-These test resources are assemblies from other previously mentioned files, released under the same license terms as their input files.
+These test resources are assemblies or derivatives from other previously mentioned files, released under the same license terms as their input files.
 
 - cardinal.pdf (four cardinal directions, baked-in rotated copies of LinnSequencer.jpg)
 - ccitt.pdf (LinnSequencer.jpg, converted to CCITT encoding)
@@ -107,6 +111,9 @@ These test resources are assemblies from other previously mentioned files, relea
 - rotated_skew.pdf (a /Rotate'd and skewed document from LinnSequencer.jpg)
 - skew.pdf (from LinnSequencer.jpg, skew simulated by adjusting the transformation matrix)
 - skew-encrypted.pdf (skew.pdf with encryption - access supported by PyPDF2)
+- baiona_gray.png (from baiona.png)
+- poster.pdf (from LinnSequencer.jpg)
+
 
 
 .. _`Wikimedia: LinnSequencer`: https://upload.wikimedia.org/wikipedia/en/b/b7/LinnSequencer_hardware_MIDI_sequencer_brochure_page_2_300dpi.jpg

tests/spoof/tesseract_big_image_error.py

@@ -4,9 +4,9 @@
 import sys
 
 
-VERSION_STRING = '''tesseract 3.04.00
- leptonica-1.72
-  libjpeg 8d : libpng 1.6.19 : libtiff 4.0.6 : zlib 1.2.5
+VERSION_STRING = '''tesseract 3.05.01
+ leptonica-1.74.4
+  libjpeg 9b : libpng 1.6.32 : libtiff 4.0.8 : zlib 1.2.8
 SPOOFED: return error claiming image too big
 '''
 
@@ -20,10 +20,10 @@ def main():
         print(VERSION_STRING, file=sys.stderr)
         sys.exit(0)
     elif sys.argv[1] == '--list-langs':
-        print('List of available languages (1):\neng', file=sys.stderr)
+        print('List of available languages (1):\neng\n', file=sys.stderr)
         sys.exit(0)
     elif sys.argv[1] == '--print-parameters':
-        print('A parameter list would go here', file=sys.stderr)
+        print('A parameter list would go here\ntextonly_pdf 0\n', file=sys.stderr)
         sys.exit(0)
     elif sys.argv[-2] == 'hocr':
         print("Image too large: (33830, 14959)\n"

tests/spoof/tesseract_crash.py

@@ -5,9 +5,9 @@ import os
 import signal
 
 
-VERSION_STRING = '''tesseract 3.04.00
- leptonica-1.72
-  libjpeg 8d : libpng 1.6.19 : libtiff 4.0.6 : zlib 1.2.5
+VERSION_STRING = '''tesseract 3.05.01
+ leptonica-1.74.4
+  libjpeg 9b : libpng 1.6.32 : libtiff 4.0.8 : zlib 1.2.8
 SPOOFED: CRASH ON OCR or -psm 0
 '''
 
@@ -30,7 +30,8 @@ def main():
         print('List of available languages (1):\neng', file=sys.stderr)
         sys.exit(0)
     elif sys.argv[1] == '--print-parameters':
-        print('List of parameters would go here', file=sys.stderr)
+        print('A parameter list would go here\ntextonly_pdf 0\n',
+              file=sys.stderr)
         sys.exit(0)
     elif sys.argv[-2] == 'hocr':
         print("KABOOM! Tesseract failed for some reason", file=sys.stderr)

tests/test_main.py

@@ -77,8 +77,8 @@ def test_deskew(spoof_tesseract_noop, resources, outdir):
     deskewed_png = outdir / 'deskewed.png'
 
     ghostscript.rasterize_pdf(
-        str(deskewed_pdf),
-        str(deskewed_png),
+        deskewed_pdf,
+        deskewed_png,
         xres=150,
         yres=150,
         raster_device='pngmono',
@@ -116,8 +116,8 @@ def test_remove_background(spoof_tesseract_noop, resources, outdir):
     output_png = outdir / 'remove_bg.png'
 
     ghostscript.rasterize_pdf(
-        str(output_pdf),
-        str(output_png),
+        output_pdf,
+        output_png,
         xres=100,
         yres=100,
         raster_device='png16m',
@@ -270,9 +270,7 @@ def check_monochrome_correlation(
             print(png)
             return
         ghostscript.rasterize_pdf(
-            str(pdf),
-            str(png),
-            xres=100, yres=100,
+            pdf, png, xres=100, yres=100,
             raster_device='pngmono', log=gslog, pageno=pageno)
 
     rasterize(reference_pdf, reference_pageno, reference_png)
@@ -406,9 +404,13 @@ def test_force_ocr_on_pdf_with_no_images(spoof_tesseract_crash, resources,
 @pytest.mark.skipif(
     pytest.helpers.is_macos() and pytest.helpers.running_in_travis(),
     reason="takes too long to install language packs in Travis macOS homebrew")
-def test_french(spoof_tesseract_cache, resources, outpdf):
+def test_french(spoof_tesseract_cache, resources, outdir):
+    # Produce a sidecar too - implicit test that system locale is set up
+    # properly
+    sidecar = outdir / 'francais.txt'
     p, out, err = run_ocrmypdf(
-        resources / 'francais.pdf', outpdf, '-l', 'fra',
+        resources / 'francais.pdf', outdir / 'francais.pdf', '-l', 'fra',
+        '--sidecar', sidecar,
         env=spoof_tesseract_cache)
     print(os.environ)
     assert p.returncode == ExitCode.ok, \
@@ -418,7 +420,7 @@ def test_french(spoof_tesseract_cache, resources, outpdf):
 def test_klingon(resources, outpdf):
     p, out, err = run_ocrmypdf(
         resources / 'francais.pdf', outpdf, '-l', 'klz')
-    assert p.returncode == ExitCode.bad_args
+    assert p.returncode == ExitCode.missing_dependency
 
 
 def test_missing_docinfo(spoof_tesseract_noop, resources, outpdf):
@@ -485,10 +487,7 @@ def test_pagesegmode(renderer, spoof_tesseract_cache, resources, outpdf):
         '--pdf-renderer', renderer, env=spoof_tesseract_cache)
 
 
-@pytest.mark.parametrize('renderer', [
-    'hocr',
-    'tesseract',
-    ])
+@pytest.mark.parametrize('renderer', RENDERERS)
 def test_tesseract_crash(renderer, spoof_tesseract_crash,
                          resources, no_outpdf):
     p, out, err = run_ocrmypdf(
@@ -760,7 +759,7 @@ language_model_penalty_non_freq_dict_word 0
 
     check_ocrmypdf(
         resources / 'ccitt.pdf', outdir / 'out.pdf',
-        '--tesseract-config', str(cfg_file))
+        '--tesseract-config', cfg_file)
 
 
 @pytest.mark.parametrize('renderer', RENDERERS)
@@ -770,7 +769,7 @@ def test_tesseract_config_notfound(renderer, resources, outdir):
     p, out, err = run_ocrmypdf(
         resources / 'ccitt.pdf', outdir / 'out.pdf',
         '--pdf-renderer', renderer,
-        '--tesseract-config', str(cfg_file))
+        '--tesseract-config', cfg_file)
     assert "Can't open" in err, "No error message about missing config file"
     assert p.returncode == ExitCode.ok
 
@@ -786,11 +785,43 @@ THIS FILE IS INVALID
     p, out, err = run_ocrmypdf(
         resources / 'ccitt.pdf', outdir / 'out.pdf',
         '--pdf-renderer', renderer,
-        '--tesseract-config', str(cfg_file))
+        '--tesseract-config', cfg_file)
     assert "parameter not found" in err, "No error message"
     assert p.returncode == ExitCode.invalid_config
 
 
+def test_user_words(resources, outdir):
+    word_list = outdir / 'wordlist.txt'
+    sidecar_before = outdir / 'sidecar_before.txt'
+    sidecar_after = outdir / 'sidecar_after.txt'
+
+    # Don't know how to make this test pass on various versions and platforms
+    # so weaken to merely testing that the argument is accepted
+    consistent = False
+
+    if consistent:
+        check_ocrmypdf(
+            resources / 'crom.png', outdir / 'out.pdf',
+            '--image-dpi', 150,
+            '--sidecar', sidecar_before
+        )
+
+        assert 'cromulent' not in sidecar_before.open().read()
+
+    with word_list.open('w') as f:
+        f.write('cromulent\n')  # a perfectly cromulent word
+
+    check_ocrmypdf(
+        resources / 'crom.png', outdir / 'out.pdf',
+        '--image-dpi', 150,
+        '--sidecar', sidecar_after,
+        '--user-words', word_list
+    )
+
+    if consistent:
+        assert 'cromulent' in sidecar_after.open().read()
+
+
 def test_form_xobject(spoof_tesseract_noop, resources, outpdf):
     check_ocrmypdf(resources / 'formxobject.pdf', outpdf,
                    '--force-ocr',