> For the complete documentation index, see [llms.txt](https://docs.jabref.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.jabref.org/advanced/ocr.md).

# OCR

[OCR](https://en.wikipedia.org/wiki/Optical_character_recognition) (Optical Character Recognition) is defined as the electronic or mechanic conversion of images of typed, handwritten or printed text into machine-encoded text. Consequently, with this technology it is possible to add editable and searchable data to PDFs and other files in your Jabref library. OCR can be used via multiple tools and engines. Currently, JabRef provides OCR using [OCRmyPDF](https://ocrmypdf.readthedocs.io/en/latest/).

## How to install [OCRmyPDF](https://github.com/ocrmypdf/ocrmypdf)

* Please check the [installation guide](https://ocrmypdf.readthedocs.io/en/latest/installation.html) and follow the instructions for your operating system.

## How to perform OCR on a scanned PDF file in JabRef

{% hint style="warning" %}
OCRmyPDF must be installed on your system to use this feature.
{% endhint %}

1. Open JabRef and select the entry with the scanned PDF you want to OCR.
2. Open the General Tab of the Entry Editor.
3. Right-click on the File and select "Perform OCR and embed text into new PDF file". ![perform-ocr.png](/files/LIXn9OxmOVvaEkbSDPfO)

* After performing OCR, JabRef creates a new PDF file with the OCR text embedded, and it will be linked to all the entries that have the old file linked to them. The original scanned PDF will remain unchanged.

  ![original-and-ocred-files.png](/files/tAxlbeApUYQzqytXLfRH)
* Now you can select and search text in the new PDF file.

  ![comparison-between-original-and-ocred-file.png](/files/Owfm827Uo1MkctNOEXKw)

## OCR Preferences

* The OCR preferences can be accessed via **File → Preferences → OCR**.

  ![ocr-preferences.png](/files/9W3icDNRf91UBS18tv2L)

### Engine Path

{% hint style="warning" %}
Performing OCR will fail if wrong engine path is provided, make sure that the correct path is provided.
{% endhint %}

* JabRef needs to know the location of the OCRmyPDF executable to run OCR. By default, JabRef assumes `ocrmypdf` is available on your system PATH, which is the case for most standard installations.
* If OCRmyPDF is installed in a non-standard location, or if it needs to be invoked through Python, you can configure the path manually in this preference tab.
* There are three ways to set the engine path:

1. **Type the path manually**: Enter the path directly into the text field. This can be a bare command name (e.g. `ocrmypdf` or `python -m ocrmypdf`) if it is available on your system PATH, or a full absolute path to the executable (e.g. `/home/user/.local/bin/ocrmypdf`).

   ![text-field-for-engine-path.png](/files/Jk10nqTGkronYLwkKAX7)
2. **Browse**: Click the folder icon to open a file chooser and navigate to the OCRmyPDF executable on your system.

   ![browse-engine-path-button.png](/files/pKN2oxDPAn3WZPIRxnUz)
3. **Auto-detect**: Click the magnifier icon to have JabRef automatically search for a working OCRmyPDF installation. JabRef will try the following commands in order and use the first one that works:

   ![auto-detect-engine-path-button.png](/files/Usk8IM4OXNUQgNsFighS)

   1. `ocrmypdf`
   2. `python -m ocrmypdf`
   3. `py -m ocrmypdf`
   4. `python3 -m ocrmypdf`

If none of these succeed, the path field will remain unchanged and you will need to set the path manually.