aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Marc Joliet <marcec@gmx.de>2013-09-26 20:00:01 +0200
committerGravatar Marc Joliet <marcec@gmx.de>2013-10-17 12:12:13 +0200
commitf4f36e356fdfc73d52409efa5b9bd35a5218041b (patch)
tree6eeda824cbcba51814f451c7a5a3215b1985eeb8 /README.md
parent6de9a9258207ca38d320cc0bc3c3653deef12d7d (diff)
Document the optional dependency to backports.lzma.
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.md b/README.md
index c7462465..522b0d91 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,12 @@ To switch your default shell back, you can run:
Substitute /bin/bash with /bin/tcsh or /bin/zsh as appropriate.
+## Optional Dependencies
+
+In order to generate completions from man pages compressed with either lzma or xz, you may need to install an extra Python package.
+
+Python versions prior to 2.6 are not supported. For Python versions 2.6 to 3.2 you need to install the module `backports.lzma`. How to install it depends on your system and how you installed Python. Most Linux distributions should include it as a package named `backports-lzma` (or similar). From version 3.3 onwards, Python already includes the required module.
+
## Contact Us
Questions, comments, rants and raves can be posted to the official fish mailing list at <https://lists.sourceforge.net/lists/listinfo/fish-users> or join us on our IRC channel [#fish at irc.oftc.net](https://webchat.oftc.net/?channels=fish).