https://github.com/tom-tan/esh-help

This library adds some help features for Eshell
https://github.com/tom-tan/esh-help

emacs-lisp eshell zsh

Last synced: about 1 year ago
JSON representation

This library adds some help features for Eshell

• Host: GitHub
• URL: https://github.com/tom-tan/esh-help
• Owner: tom-tan
• Created: 2013-06-24T10:51:21.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2020-11-30T13:10:44.000Z (over 5 years ago)
• Last Synced: 2025-02-06T17:23:25.129Z (about 1 year ago)
• Topics: emacs-lisp, eshell, zsh
• Language: Emacs Lisp
• Homepage:
• Size: 10.7 KB
• Stars: 22
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# esh-help.el

[![MELPA](http://melpa-stable.milkbox.net/packages/esh-help-badge.svg)](http://melpa-stable.milkbox.net/#/esh-help)

[![MELPA](http://melpa.milkbox.net/packages/esh-help-badge.svg)](http://melpa.milkbox.net/#/esh-help)

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.