mirror of
https://github.com/ocrmypdf/OCRmyPDF.git
synced 2025-08-14 11:42:14 +00:00
1d91c09963
These files were contributed when the project license was GPLv3. On discussion, all known authors of these files agreed to place them under MIT license. See https://github.com/jbarlow83/OCRmyPDF/issues/600
139 lines
7.0 KiB
Fish
139 lines
7.0 KiB
Fish
# Copyright 2020 James R. Barlow
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
# SOFTWARE.
|
|
|
|
complete -c ocrmypdf -x -n '__fish_is_first_arg' -l version
|
|
complete -c ocrmypdf -x -n '__fish_is_first_arg' -s h -s "?" -l help
|
|
|
|
complete -c ocrmypdf -r -l sidecar -d "write OCR to text file"
|
|
complete -c ocrmypdf -x -s q -l quiet
|
|
|
|
complete -c ocrmypdf -s r -l rotate-pages -d "rotate pages to correct orientation"
|
|
complete -c ocrmypdf -s d -l deskew -d "fix small horizontal alignment skew"
|
|
complete -c ocrmypdf -s c -l clean -d "clean document images before OCR"
|
|
complete -c ocrmypdf -s i -l clean-final -d "clean document images and keep result"
|
|
complete -c ocrmypdf -l remove-vectors -d "don't send vector objects to OCR"
|
|
complete -c ocrmypdf -l threshold -d "threshold images before OCR"
|
|
|
|
complete -c ocrmypdf -s f -l force-ocr -d "OCR documents that already have printable text"
|
|
complete -c ocrmypdf -s s -l skip-ocr -d "skip OCR on pages that text, otherwise try OCR"
|
|
complete -c ocrmypdf -l redo-ocr -d "redo OCR on any pages that seem to have OCR already"
|
|
|
|
complete -c ocrmypdf -s k -l keep-temporary-files -d "keep temporary files (debug)"
|
|
|
|
function __fish_ocrmypdf_languages
|
|
set langs (tesseract --list-langs ^/dev/null)
|
|
set arr (string split '\n' $langs)
|
|
for lang in $arr[2..-1]
|
|
echo $lang
|
|
end
|
|
end
|
|
complete -c ocrmypdf -x -s l -l language -a '(__fish_ocrmypdf_languages)' -d "language"
|
|
|
|
complete -c ocrmypdf -x -l image-dpi -d "assume this DPI if input image DPI is unknown"
|
|
|
|
function __fish_ocrmypdf_output_type
|
|
echo -e "pdfa\t"(_ "output a PDF/A (default)")
|
|
echo -e "pdf\t"(_ "output a standard PDF")
|
|
echo -e "pdfa-1\t"(_ "output a PDF/A-1b")
|
|
echo -e "pdfa-2\t"(_ "output a PDF/A-2b")
|
|
echo -e "pdfa-3\t"(_ "output a PDF/A-3b")
|
|
end
|
|
complete -c ocrmypdf -x -l output-type -a '(__fish_ocrmypdf_output_type)' -d "select PDF output options"
|
|
|
|
function __fish_ocrmypdf_pdf_renderer
|
|
echo -e "auto\t"(_ "auto select PDF renderer")
|
|
echo -e "hocr\t"(_ "use hocr renderer")
|
|
echo -e "sandwich\t"(_ "use sandwich renderer")
|
|
end
|
|
complete -c ocrmypdf -x -l pdf-renderer -a '(__fish_ocrmypdf_pdf_renderer)' -d "select PDF renderer options"
|
|
|
|
function __fish_ocrmypdf_optimize
|
|
echo -e "0\t"(_ "do not optimize")
|
|
echo -e "1\t"(_ "do safe, lossless optimizations (default)")
|
|
echo -e "2\t"(_ "do some lossy optimizations")
|
|
echo -e "3\t"(_ "do aggressive lossy optimizations (including lossy JBIG2)")
|
|
end
|
|
complete -c ocrmypdf -x -s O -l optimize -a '(__fish_ocrmypdf_optimize)' -d "select optimization level"
|
|
|
|
function __fish_ocrmypdf_verbose
|
|
echo -e "0\t"(_ "standard output messages")
|
|
echo -e "1\t"(_ "troubleshooting output messages")
|
|
echo -e "2\t"(_ "debugging output messages")
|
|
end
|
|
complete -c ocrmypdf -x -s v -l verbose -a '(__fish_ocrmypdf_verbose)' -d "set verbosity level"
|
|
|
|
complete -c ocrmypdf -x -l no-progress-bar -d "disable the progress bar"
|
|
|
|
function __fish_ocrmypdf_pdfa_compression
|
|
echo -e "auto\t"(_ "let Ghostscript decide how to compress images")
|
|
echo -e "jpeg\t"(_ "convert color and grayscale images to JPEG")
|
|
echo -e "lossless\t"(_ "convert color and grayscale images to lossless (PNG)")
|
|
end
|
|
complete -c ocrmypdf -x -l pdfa-image-compression -a '(__fish_ocrmypdf_pdfa_compression)' -d "set PDF/A image compression options"
|
|
|
|
complete -c ocrmypdf -x -s j -l jobs -d "how many worker processes to use"
|
|
complete -c ocrmypdf -x -l title -d "set metadata"
|
|
complete -c ocrmypdf -x -l author -d "set metadata"
|
|
complete -c ocrmypdf -x -l subject -d "set metadata"
|
|
complete -c ocrmypdf -x -l keywords -d "set metadata"
|
|
complete -c ocrmypdf -x -l oversample -d "oversample images to this DPI"
|
|
complete -c ocrmypdf -x -l skip-big -d "skip OCR on pages larger than this many MPixels"
|
|
|
|
complete -c ocrmypdf -x -l jpeg-quality -d "JPEG quality [0..100]"
|
|
complete -c ocrmypdf -x -l png-quality -d "PNG quality [0..100]"
|
|
complete -c ocrmypdf -x -l jbig2-lossy -d "enable lossy JBIG2 (see docs)"
|
|
complete -c ocrmypdf -x -l max-image-mpixels -d "image decompression bomb threshold"
|
|
complete -c ocrmypdf -x -l pages -d "apply OCR to only the specified pages"
|
|
complete -c ocrmypdf -x -l tesseract-config -d "set custom tesseract config file"
|
|
|
|
function __fish_ocrmypdf_tesseract_pagesegmode
|
|
echo -e "0\t"(_ "orientation and script detection (OSD) only")
|
|
echo -e "1\t"(_ "automatic page segmentation with OSD")
|
|
echo -e "2\t"(_ "automatic page segmentation, but no OSD, or OCR")
|
|
echo -e "3\t"(_ "fully automatic page segmentation, but no OSD (default)")
|
|
echo -e "4\t"(_ "assume a single column of text of variable sizes")
|
|
echo -e "5\t"(_ "assume a single uniform block of vertically aligned text")
|
|
echo -e "6\t"(_ "assume a single uniform block of text")
|
|
echo -e "7\t"(_ "treat the image as a single text line")
|
|
echo -e "8\t"(_ "treat the image as a single word")
|
|
echo -e "9\t"(_ "treat the image as a single word in a circle")
|
|
echo -e "10\t"(_ "treat the image as a single character")
|
|
echo -e "11\t"(_ "sparse text - find as much text as possible in no particular order")
|
|
echo -e "12\t"(_ "sparse text with OSD")
|
|
echo -e "13\t"(_ "raw line - treat the image as a single text line")
|
|
end
|
|
complete -c ocrmypdf -x -l tesseract-pagesegmode -a '(__fish_ocrmypdf_tesseract_pagesegmode)' -d "set tesseract --psm"
|
|
|
|
function __fish_ocrmypdf_tesseract_oem
|
|
echo -e "0\t"(_ "legacy engine only")
|
|
echo -e "1\t"(_ "neural nets LSTM engine only")
|
|
echo -e "2\t"(_ "legacy + LSTM engines")
|
|
echo -e "3\t"(_ "default, based on what is available")
|
|
end
|
|
complete -c ocrmypdf -x -l tesseract-oem -a '(__fish_ocrmypdf_tesseract_oem)' -d "set tesseract --oem"
|
|
complete -c ocrmypdf -x -l tesseract-timeout -d "maximum number of seconds to wait for OCR"
|
|
complete -c ocrmypdf -x -l rotate-pages-threshold -d "page rotation confidence"
|
|
|
|
complete -c ocrmypdf -r -l user-words -d "specify location of user words file"
|
|
complete -c ocrmypdf -r -l user-patterns -d "specify location of user patterns file"
|
|
complete -c ocrmypdf -x -l fast-web-view -d "if file size if above this amount in MB, linearize PDF"
|
|
|
|
complete -c ocrmypdf -x -a "(__fish_complete_suffix .pdf)"
|