merge: rewrite-docs
I've omitted docs/*.org from this merge, as there is still work left to do there, but I am pushing the module docs early so folks can benefit from the new docs sooner.
This commit is contained in:
Henrik Lissner
commit
1f8bf7accb
179 changed files with 13125 additions and 8630 deletions
|
|
@ -1,65 +1,76 @@
|
|||
#+TITLE: term/eshell
|
||||
#+DATE: May 18, 2020
|
||||
#+SINCE: v2.0
|
||||
#+STARTUP: inlineimages nofold
|
||||
# -*- mode: doom-docs-org -*-
|
||||
#+title: :term eshell
|
||||
#+subtitle: The elisp shell that works everywhere
|
||||
#+created: February 20, 2017
|
||||
#+since: 2.0.0
|
||||
|
||||
* Table of Contents :TOC_3:noexport:
|
||||
- [[#description][Description]]
|
||||
- [[#maintainers][Maintainers]]
|
||||
- [[#module-flags][Module Flags]]
|
||||
- [[#plugins][Plugins]]
|
||||
- [[#hacks][Hacks]]
|
||||
- [[#prerequisites][Prerequisites]]
|
||||
- [[#features][Features]]
|
||||
- [[#configuration][Configuration]]
|
||||
- [[#term-name][TERM name]]
|
||||
- [[#troubleshooting][Troubleshooting]]
|
||||
|
||||
* Description
|
||||
* Description :unfold:
|
||||
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
|
||||
The Emacs Shell or [[doom-package:][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.
|
||||
- [[doom-user:][@hlissner]]
|
||||
|
||||
** Module Flags
|
||||
This module provides no flags, but does gain auto-completion if =:completion
|
||||
company= is enabled.
|
||||
[[doom-contrib-maintainer:][Become a maintainer?]]
|
||||
|
||||
** 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]]
|
||||
** Module flags
|
||||
/This module has no flags./
|
||||
|
||||
** Packages
|
||||
- [[doom-package:][eshell-did-you-mean]]
|
||||
- [[doom-package:][eshell-up]]
|
||||
- [[doom-package:][eshell-z]]
|
||||
- [[doom-package:][esh-help]]
|
||||
- [[doom-package:][shrink-path]]
|
||||
- if [[doom-module:][:completion company]]
|
||||
- [[doom-package:][fish-completion]]
|
||||
- [[doom-package:][bash-completion]]
|
||||
|
||||
** Hacks
|
||||
+ Even with =fish-completion-fallback-on-bash-p= non-nil, fish must be installed
|
||||
for bash completion to work. Workaround in =config.el=.
|
||||
+ =eshell-did-you-mean= does not work on first invocation, so we manually invoke
|
||||
- Even with ~fish-completion-fallback-on-bash-p~ non-nil, fish must be installed
|
||||
for bash completion to work. This has been circumvented.
|
||||
- [[doom-package:][eshell-did-you-mean]] does not work on first invocation, so we manually invoke
|
||||
it once.
|
||||
|
||||
* 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.
|
||||
** TODO Changelog
|
||||
# This section will be machine generated. Don't edit it by hand.
|
||||
/This module does not have a changelog yet./
|
||||
|
||||
* Features
|
||||
+ Command completion with Company
|
||||
+ =fish=-style prompt with Git integration
|
||||
+ [[https://github.com/rupa/z][=z=]]-like directory jumping
|
||||
+ Command-not-found recommendations
|
||||
* Installation
|
||||
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]
|
||||
|
||||
This module requires either [[https://fishshell.com/][Fish shell]] or [[https://www.gnu.org/software/bash/][Bash]] for code completion.
|
||||
|
||||
* TODO Usage
|
||||
#+begin_quote
|
||||
🔨 /This module's usage documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
- 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
|
||||
#+begin_quote
|
||||
🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
|
||||
#+end_quote
|
||||
|
||||
* Configuration
|
||||
** TERM name
|
||||
By default, =eshell= sets the =$TERM= variable to ="xterm-256color"=, which helps with
|
||||
rendering various colours. As eshell is /not/ a terminal emulator, these will not
|
||||
always work 100%. Modifying =eshell-term-name= to your liking may help.
|
||||
By default, [[doom-package:][eshell]] sets the =$TERM= variable to ~"xterm-256color"~, which helps
|
||||
with rendering various colours. As eshell is /not/ a terminal emulator, these
|
||||
will not always work 100%. Modifying ~eshell-term-name~ to your liking may help.
|
||||
|
||||
* TODO Troubleshooting
|
||||
# Common issues and their solution, or places to look for help.
|
||||
* Troubleshooting
|
||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||
|
||||
* Frequently asked questions
|
||||
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]
|
||||
|
||||
* TODO Appendix
|
||||
#+begin_quote
|
||||
🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
|
||||
#+end_quote
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue