From 87c17a74e9ae17ad3e22d6eaea4dd5695593b46c Mon Sep 17 00:00:00 2001
From: Felix Stupp <felix.stupp@outlook.com>
Date: Sat, 21 Mar 2020 12:12:04 +0100
Subject: [PATCH] Initial commit

---
 LICENSE               |  13 +++++
 README.md             | 107 ++++++++++++++++++++++++++++++++++++++++++
 images2pdf.plugin.zsh |  10 ++++
 3 files changed, 130 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md
 create mode 100644 images2pdf.plugin.zsh

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..ff9e935
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+ 
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+ 
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7c5e046
--- /dev/null
+++ b/README.md
@@ -0,0 +1,107 @@
+# images2pdf Plugin for ZSH
+
+Allows combining images to a searchable pdf using local ocr.
+
+You can use this command if you have a bunch of images showing pages of a paper document
+you want to share with others.
+The resulting pdf document will show the images page per page
+but also enable the user to search through recognized text parts for faster navigation.
+The usage is simple, e.g. `images2pdf eng attachment.pdf *.jpg` or `images2pdf deu Rechnung.pdf page1.png page2.png`
+
+## Repository clones
+
+The original repository will be stored on [GitHub](https://github.com/Zocker1999NET/zsh-images2pdf).
+You can use the original reopsitory if you want to use GitHub.
+Also issues and pull requests will be collected there for convenience.
+
+This repository will be cloned to my own server.
+You can use the [clone](https://git.banananet.work/zsh-plugins/images2pdf) instead of this repository
+if you want to avoid use GitHub.
+
+## Installation
+
+### Prerequisites
+
+- `convert` (from ImageMagick)
+- [`ocrmypdf`](https://github.com/jbarlow83/OCRmyPDF)
+
+### zsh (without plugin support)
+
+1. Clone project
+2. Add following line to your `.zshrc`:
+```sh
+SOURCE "path/to/repo/images2pdf.plugin.zsh"
+```
+
+### oh-my-zsh
+
+1. Clone project into `~/.oh-my-zsh/custom/plugins/images2pdf`
+2. Add `images2pdf` to your plugin list
+```sh
+plugins=(… images2pdf …)
+```
+
+### Antigen
+
+1. Add following line to your `.zshrc`:
+```sh
+antigen bundle Zocker1999NET/zsh-images2pdf # GitHub if default repository unchanged
+antigen bundle https://git.banananet.work/zsh-plugins/images2pdf # Own Server
+```
+
+or
+
+1. Add the repository to your plugin list
+```sh
+antigen bundles <<EOBUNDLES
+  …
+  Zocker1999NET/zsh-images2pdf # GitHub if default repository unchanged
+  https://git.banananet.work/zsh-plugins/images2pdf # Own Server
+  …
+EOBUNDLES
+```
+
+### Antibody
+
+1. Add following line to your `.zshrc`:
+```sh
+antibody bundle Zocker1999NET/zsh-images2pdf # GitHub if default repository unchanged
+antibody bundle https://git.banananet.work/zsh-plugins/images2pdf # Own Server
+```
+
+or
+
+1. Add the repository to your plugin list
+```sh
+antibody bundles <<EOBUNDLES
+  …
+  Zocker1999NET/zsh-images2pdf # GitHub if default repository unchanged
+  https://git.banananet.work/zsh-plugins/images2pdf # Own Server
+  …
+EOBUNDLES
+```
+
+## Usage
+
+`image2pdf LANG[+LANG…] OUTPUT [OPTS] INPUT…`
+
+- `LANG`: Languages to detect for `ocrmypdf` given in standardized three-letter codes (ISO 639-2 Alpha-3).
+  Multiple languages may be given by concatenating them using `+`, like `deu+eng`.
+  Additional language packs may be installed following [this documentation of `ocrmypdf`](https://ocrmypdf.readthedocs.io/en/latest/languages.html#lang-packs)
+- `OUTPUT`: The output name of the pdf document.
+- `OPTS`: Additional options given to `convert`
+  **Warning**: These options cannot be given before `OUTPUT` due to the way of processing the arguments given to the command.
+- `INPUT`: All input files.
+  These should be images supported by ImageMagick, otherwise the command may fail.
+  The order the images were given to the command will be the resulting page order in the output document.
+
+## License
+
+This plugin is licensed under WTFPL.
+Do the fuck you want to with this plugin,
+but please contribute to this plugin if you have made any improvements which could be useful for others.
+
+## Contribute
+
+If you find any issue, report it
+or fix it yourself and create a pull request.
diff --git a/images2pdf.plugin.zsh b/images2pdf.plugin.zsh
new file mode 100644
index 0000000..78d902d
--- /dev/null
+++ b/images2pdf.plugin.zsh
@@ -0,0 +1,10 @@
+#!/usr/bin/env zsh
+
+function images2pdf() {
+  if [ -z "$3" ]; then
+    echo "Usage: images2pdf <lang> <output-pdf> <input-file> …" >&2;
+    echo "  lang: languages separated by + characterized by 3 characters, example: deu+eng" >&2;
+    exit 2;
+  fi
+  convert "${@:3}" pdf:- | ocrmypdf -l "$1" - "$2";
+}