Remove the OCRMYPDF_program environment variables

Really, this was just replicating the functionality of the PATH
environment variable, and users probably do that anyway.
This commit is contained in:
James R. Barlow
2018-03-24 15:07:02 -07:00
parent cbdf9c88c5
commit 11d74dea09
16 changed files with 119 additions and 101 deletions
+4 -20
View File
@@ -33,11 +33,7 @@ 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 binary* first.
.. envvar:: OCRMYPDF_TESSERACT
Specify the location of the Tesseract binary.
OCRmyPDF checks the system ``PATH`` for the ``tesseract`` binary.
.. envvar:: TESSDATA_PREFIX
@@ -48,11 +44,11 @@ For example, if you are testing tesseract 4.00 and don't wish to use an existing
.. code-block:: bash
env \
OCRMYPDF_TESSERACT=/home/user/src/tesseract4/api/tesseract \
PATH=/home/user/src/tesseract4/api:$PATH \
TESSDATA_PREFIX=/home/user/src/tesseract4 \
ocrmypdf --tesseract-oem 2 input.pdf output.pdf
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.)
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
@@ -64,19 +60,7 @@ 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. 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.
In each case OCRmyPDF will search the ``PATH`` environment variable to locate the binaries.
Changing tesseract configuration variables
+12 -1
View File
@@ -8,16 +8,27 @@ The OCRmyPDF package itself does not contain a public API, although it is fairly
v6.0.0
------
- The software license has been changed to GPLv3. The license of test files
- The software license has been changed to GPLv3. Test resource files and some individual sources may have other licenses.
- OCRmyPDF now depends on `PyMuPDF <https://pymupdf.readthedocs.io/en/latest/installation/>`_. Including PyMuPDF is the primary reason for the change to GPLv3.
- Other backward incompatible changes
+ The ``OCRMYPDF_TESSERACT``, ``OCRMYPDF_QPDF``, ``OCRMYPDF_GS`` and ``OCRMYPDF_UNPAPER`` environment variables are no longer used. Change ``PATH`` if you need to override the external programs OCRmyPDF uses.
+ The function ``ocrmypdf.exec.get_program`` was removed.
+ The deprecated module ``ocrmypdf.pageinfo`` was removed.
- Fixed an issue where OCRmyPDF failed to detect existing text on pages, depending on how the text and fonts were stored within the PDF. (#233, #232)
- Fixed an issue that caused dramatic inflation of file sizes when ``--skip-text --output-type pdf`` was used. OCRmyPDF now removes duplicate resources such as fonts, images and other objects that it generates. (#237)
- Improved performance of the inital page splitting step. Originally this step was not believed to be expensive and ran in a process. Large file testing revealed it to be a bottleneck, so it is now parallelized. (#234)
-
v5.7.0
------