From f4f36e356fdfc73d52409efa5b9bd35a5218041b Mon Sep 17 00:00:00 2001 From: Marc Joliet Date: Thu, 26 Sep 2013 20:00:01 +0200 Subject: Document the optional dependency to backports.lzma. --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'README.md') 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 or join us on our IRC channel [#fish at irc.oftc.net](https://webchat.oftc.net/?channels=fish). -- cgit v1.2.3