aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLiam Hupfer <liam@hpfr.net>2022-04-28 16:05:13 +0200
committerVasilij Schneidermann <mail@vasilij.de>2022-04-28 16:07:00 +0200
commitfce7b0b0506231626887f131ca38e968e4c7f9e8 (patch)
tree995ac9e47e3d0bda1d7d75d1b8d152dbd7f6ff54 /README.md
parent12faf16fbbaf09aadec26dfbda5809d886248c02 (diff)
Add support for arbitrary decompression tools
This allows users to use non-unzip decompression tools such as libarchive's `bsdtar`.
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index 52f7eea..f643795 100644
--- a/README.md
+++ b/README.md
@@ -29,11 +29,17 @@ and install with `M-x package-install RET nov RET`.
## Setup
-Make sure you have an `unzip` executable on `PATH`, otherwise the
-extraction of EPUB files will fail. If you for some reason have
-`unzip` in a non-standard location, customize `nov-unzip-program` to
-its path. You'll also need an Emacs compiled with `libxml2` support,
-otherwise rendering will fail.
+By default, `nov.el` uses `unzip` on `PATH` to extract EPUB files. You
+can customize `nov-unzip-program` if it is located elsewhere. You can
+also customize `nov-unzip-args` if you use a different decompression
+tool like `bsdtar`. It must accept a target `directory` where nov
+unzips the EPUB `filename`.
+
+ (setq nov-unzip-program (executable-find "bsdtar")
+ nov-unzip-args '("-xC" directory "-f" filename))
+
+You'll also need an Emacs compiled with `libxml2` support, otherwise
+rendering will fail.
Put the following in your init file: