85cf7a794b
This contains fixes suggested by Henrik as feedback from the initial PR, including updating and correcting the Eshell module README, and few tweaks to the module configuration, and properly pinning eshell-did-you-mean.
54 lines
2 KiB
Org Mode
54 lines
2 KiB
Org Mode
#+TITLE: term/eshell
|
|
#+DATE: May 18, 2020
|
|
#+SINCE: v2.0
|
|
#+STARTUP: inlineimages nofold
|
|
|
|
* Table of Contents :TOC_3:noexport:
|
|
- [[#description][Description]]
|
|
- [[#maintainers][Maintainers]]
|
|
- [[#module-flags][Module Flags]]
|
|
- [[#plugins][Plugins]]
|
|
- [[#prerequisites][Prerequisites]]
|
|
- [[#features][Features]]
|
|
- [[#configuration][Configuration]]
|
|
- [[#troubleshooting][Troubleshooting]]
|
|
|
|
* Description
|
|
This module provides additional features for the built-in [[https://www.gnu.org/software/emacs/manual/html_mono/eshell.html][Emacs Shell]]
|
|
|
|
The Emacs Shell or =eshell= is a shell-like command interpreter implemented in
|
|
Emacs Lisp. It is an alternative to traditional shells such as =bash=, =zsh=,
|
|
=fish=, etc. that is built into Emacs and entirely cross-platform.
|
|
|
|
** Maintainers
|
|
This module has no dedicated maintainers.
|
|
|
|
** Module Flags
|
|
This module provides no flags, but does gain auto-completion if =:completion
|
|
company= is enabled.
|
|
|
|
** Plugins
|
|
+ [[https://github.com/peterwvj/eshell-up][eshell-up]]
|
|
+ [[https://github.com/xuchunyang/eshell-z][eshell-z]]
|
|
+ [[https://github.com/tom-tan/esh-help][esh-help]]
|
|
+ [[https://gitlab.com/bennya/shrink-path.el][shrink-path]]
|
|
+ [[https://github.com/xuchunyang/eshell-did-you-mean][eshell-did-you-mean]]
|
|
+ =:completion company=
|
|
+ [[https://gitlab.com/ambrevar/emacs-fish-completion][fish-completion]]
|
|
+ [[https://github.com/szermatt/emacs-bash-completion][bash-completion]]
|
|
|
|
* Prerequisites
|
|
[[https://fishshell.com/][=fish= shell]] for completions, falling back to [[https://www.gnu.org/software/bash/][=bash= shell]] if =fish= is not
|
|
found. If neither shell is found, completions may not be available.
|
|
|
|
* Features
|
|
+ Command completion with Company
|
|
+ =fish=-style prompt with Git integration
|
|
+ [[https://github.com/rupa/z][=z=]]-like directory jumping
|
|
+ Command-not-found recommendations
|
|
|
|
* TODO Configuration
|
|
# How to configure this module, including common problems and how to address them.
|
|
|
|
* TODO Troubleshooting
|
|
# Common issues and their solution, or places to look for help.
|