OCRmyPDF documentation

OCRmyPDF adds an OCR text layer to scanned PDF files, allowing them to be searched.

PDF is the best format for storing and exchanging scanned documents. Unfortunately, PDFs can be difficult to modify. OCRmyPDF makes it easy to apply image processing and OCR to existing PDFs.

• Introduction
• Release notes
• Installing OCRmyPDF
• Installing additional language packs
• Installing the JBIG2 encoder

Usage

• Cookbook
  • Basic examples
  • Image processing
  • Don’t actually OCR my PDF
  • Redo existing OCR
  • Improving OCR quality
  • PDF optimization
• OCRmyPDF Docker image
  • Installing the Docker image
  • Using the Docker image on the command line
  • Adding languages to the Docker image
  • Executing the test suite
  • Using the OCRmyPDF web service wrapper
  • Legacy Ubuntu Docker images
• Advanced features
  • Control of unpaper
  • Control of OCR options
  • Changing the PDF renderer
  • Return code policy
  • Debugging the intermediate files
• Batch processing
  • Batch jobs
  • Directory trees
  • Hot (watched) folders
  • macOS Automator
• PDF security issues
  • PDFs may contain malware
  • How OCRmyPDF processes PDFs
  • Using OCRmyPDF online or as a service
  • Password protection, digital signatures and certification
• Common error messages
  • Page already has text
  • Input file ‘filename’ is not a valid PDF

Indices and tables

• Index
• Module Index
• Search Page