branch: externals/scanner
commit c63d2f981e91a078dc02fae63c8f3091f21bea80
Author: Raffael Stocker <[email protected]>
Commit: Raffael Stocker <[email protected]>
update Readme.org
---
Readme.org | 63 +++++++++++++++++++++++++++++++++++++-------------------------
1 file changed, 38 insertions(+), 25 deletions(-)
diff --git a/Readme.org b/Readme.org
index 25a4d6d..b82e476 100644
--- a/Readme.org
+++ b/Readme.org
@@ -1,27 +1,40 @@
* Scanner: scan documents and images with Emacs
- Scan documents and images using scanimage(1) from the SANE distribution and
- tesseract(1) for OCR.
-
- In image mode, one scan is performed with customizable resolution and file
- format. An image scan is started with the command ‘scanner-scan-image’.
- This function tries to guess the file format from the chosen file name or
- falls back to the configured default.
-
- In document mode, one or multiple pages can be scanned that are then written
- in a customizable output format, e.g. PDF (searchable) or text. Resolution,
- intermediate image format and paper size are customizable as well. A
- document scan is started with the command ‘scanner-scan-document’; without a
- prefix argument, one page is scanned. With a non-numeric argument, the user
- is asked after each scanned page for confirmation to scan another page.
- With a numeric argument, that many pages are scanned. In the latter mode, a
- delay customizable using ‘scanner-scan-delay’ is observed between scans.
-
- As a backend, tesseract(1) is used for document scans to provide optical
- character recognition (OCR). The languages to use can be customized.
-
- For both images and documents, the scan mode (e.g. "Color" or "Gray") can be
- customized, if the used scanner supports it.
-
- Additional options can be passed to the backends using the customization
- variables ‘scanner-scanimage-switches’ and ‘scanner-tesseract-switches’.
+ Scan documents and images using ~scanimage(1)~ from the SANE distribution
+ and ~tesseract(1)~ for OCR and PDF export.
+
+ The scanner package uses two sets of customizations for image mode and
+ document mode, with the former usually configured to use high resolution and
+ an image file format, like JPEG, and the latter to use lower resolution and
+ a document format, like PDF or text. The available file formats are
+ provided by ~scanimage(1)~ for image mode and ~tesseract(1)~ for document
+ mode. The scanner package uses ~tesseract(1)~ to provide optical character
+ recognition (OCR). You can select the language plugins with
+ ~scanner-tesseract-languages~.
+
+ The ~scanner-scan-image~ command performs one scan in image mode. This
+ function tries to guess the file format from the chosen file name or falls
+ back to the configured default, see ~scanner-image-format~.
+
+ In document mode, you can scan one or multiple pages that are then written
+ in a customizable output format, e.g. (searchable) PDF or text, or whatever
+ tesseract provides. You can also customize resolution, intermediate image
+ format, and paper size. The command ~scanner-scan-document~ starts a
+ document scan. Without a prefix argument, it scans one page. With a
+ non-numeric argument, it asks the user after each scanned page for
+ confirmation to scan another page. With a numeric argument, it scans that
+ many pages. In the latter case, it observes a delay between scans that is
+ customizable using ~scanner-scan-delay~.
+
+ For both images and documents, you can customize the scan mode (e.g. "Color"
+ or "Gray") if your scanning device supports it.
+
+ Finally, you can pass additional options to the backends using the
+ customization variables ~scanner-scanimage-switches~ and
+ ~scanner-tesseract-switches~. The former variable is helpful for tuning
+ brightness and contrast, for instance.
+
+
+* Bugs
+
+ - This package doesn't support document feeders yet.
