docs: mention completions

This commit is contained in:
James R. Barlow
2019-05-06 18:07:41 -07:00
parent 7ed0f8f50e
commit 4d5e0eb749
2 changed files with 14 additions and 1 deletions
+1 -1
View File
@@ -3,4 +3,4 @@ repos:
rev: stable
hooks:
- id: black
language_version: python3.6
language_version: python3.7
+13
View File
@@ -490,3 +490,16 @@ To install all of the development and test requirements:
pip install -r requirements/dev.txt -r requirements/test.txt
To add JBIG2 encoding, see :ref:`jbig2`.
Shell completions
-----------------
Completions for ``bash`` and ``fish`` are available in the project's ``misc/`` folder.
The ``bash`` completions are likely ``zsh`` compatible but this has not been confirmed.
Package maintainers, please install these at the appropriate locations for your system.
To manually install the ``bash`` completion, copy ``misc/ocrmypdf`` to
``/etc/bash_completion.d/``.
To manually install the ``fish`` completion, copy ``misc/completions.fish`` to
``~/.config/fish/completions/ocrmypdf.fish``.