From 2f2a4907dee9ee0f3a87f089bbf9a7bfdc1c98cb Mon Sep 17 00:00:00 2001 From: Radek Szymczyszyn Date: Sat, 4 Nov 2017 18:51:11 +0100 Subject: Describe install-docsh command in the README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 8cdcc54..6f45f3c 100644 --- a/README.md +++ b/README.md @@ -614,6 +614,29 @@ other tools to extract to path information. $ kerl path 19.2.3 /aux/erlangs/19.2.3 +### install-docsh + + kerl install-docsh + +Install `erl` shell documentation access +extension - [docsh](https://github.com/erszcz/docsh). +This extends the shell with new helpers, which enable access to full +function help (via `h/{1,2,3}`), function specs (`s/{1,2,3}`) and type +information (`t/{1,2,3}`). + +Activating a docsh-enabled Erlang installation will try to create +a `$HOME/.erlang` symlink. +If this file exists (i.e. you have created it manually), +please consider removing it - otherwise, docsh won't work. +Deactivating the kerl Erlang installation will remove the symlink. + +Alternatively, if the file exists and you have to keep it you can extend +it with the content of [a docsh-specific `.erlang`][docsh-dot-erlang] - this +task is left as an exercise for the reader - and export +`KERL_DOCSH_DOT_ERLANG=exists` to silence unwanted warnings. + +[docsh-dot-erlang]: https://github.com/erszcz/docsh/blob/2d9843bce794e726f591bbca49c88aedbb435f8c/templates/dot.erlang + Compiling crypto on Macs ------------------------ Apple stopped shipping OpenSSL in OS X 10.11 (El Capitan) in favor of Apple's -- cgit v1.2.3