File: README.md

package info (click to toggle)
esh-help-el 1.0.1-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 92 kB
  • sloc: lisp: 166; makefile: 2
file content (17 lines) | stat: -rw-r--r-- 566 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# esh-help.el

This library adds the following help functions and support for Eshell:
* run-help function inspired by Zsh
* eldoc support

You can install it by using `package-install` via [MELPA](http://melpa.milkbox.net/).

To use this package, add these lines to your `.emacs` file:
```elisp
    (require 'esh-help)
    (setup-esh-help-eldoc)  ;; To use eldoc in Eshell
```
And by using `M-x eldoc-mode` in Eshell, you can see help strings
for the pointed command in minibuffer.
And by using `M-x esh-help-run-help`, you can see full help string
for the command.