Luj/eat-emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update documentation in commentary section

Browse source 
* README.org (Usage): List keybindings in semi-char mode to
switch to other keybinding modes.
* eat.el (Commentary): Put the documentation of semi-char mode
first as it is the default.  List keybindings in semi-char mode
to switch to other keybinding modes.  Update stale keybindings
listed in emacs mode documentation.
This commit is contained in:
Akib Azmain Turja 2023-04-17 17:47:15 +06:00
parent 092bdd9b95
commit 5a01e09cbb
No known key found for this signature in database
GPG key ID: 5535FCF54D88616B
2 changed files with 20 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.org
View file

@ -32,16 +32,18 @@ To start Eat, run =M-x eat=. Eat has three keybinding modes:
- =C-y=: Like `yank', but send the text to the terminal.
- =M-y=: Like `yank-pop', but send the text to the terminal.
- =C-c C-k=: Kill process.
- =C-c C-e=: Switch to "emacs" keybinding mode.
- =C-c M-d=: Switch to "char" keybinding mode.
- "emacs" mode: No special keybinding, except the following:
- =C-c C-j=: Switch to semi-char mode.
- =C-c M-d=: Switch to char mode.
- =C-c C-j=: Switch to "semi-char" keybinding mode.
- =C-c M-d=: Switch to "char" keybinding mode.
- =C-c C-k=: Kill process.
- "char" mode: All supported keys are bound to send the key to the
terminal, except =C-M-m= or =M-RET=, which is bound to switch to
semi-char mode.
"semi-char" keybinding mode.
If you like Eshell, then there is a good news for you. Eat integrates
with Eshell. Eat has two global minor modes for Eshell:

28
eat.el
View file

@ -43,27 +43,29 @@
;; To start Eat, run M-x eat. Eat has three keybinding modes:
;; * "emacs" mode: No special keybinding, except the following:
;; * `C-c' `C-s': Switch to semi-char mode.
;; * `C-c' `C-j': Switch to char mode.
;; * `C-c' `C-k': Kill process.
;; * "semi-char" mode: Most keys are bound to send the key to the
;; terminal, except the following keys: `C-\', `C-c', `C-x',
;; `C-g', `C-h', `C-M-c', `C-u', `M-x', `M-:', `M-!', `M-&' and
;; some other keys (see the user option
;; `eat-semi-char-non-bound-keys' for the complete list). The
;; following special keybinding are available:
;; * "semi-char" mode: This is the default keybinding mode. Most
;; keys are bound to send the key to the terminal, except the
;; following keys: `C-\', `C-c', `C-x', `C-g', `C-h', `C-M-c',
;; `C-u', `M-x', `M-:', `M-!', `M-&' and some other keys (see the
;; user option `eat-semi-char-non-bound-keys' for the complete
;; list). The following special keybinding are available:
;; * `C-q': Send next key to the terminal.
;; * `C-y': Like `yank', but send the text to the terminal.
;; * `M-y': Like `yank-pop', but send the text to the terminal.
;; * `C-c' `C-k': Kill process.
;; * `C-c' `C-e': Switch to "emacs" keybinding mode.
;; * `C-c' `M-d': Switch to "char" keybinding mode.
;; * "emacs" mode: No special keybinding, except the following:
;; * `C-c' `C-j': Switch to "semi-char" keybinding mode.
;; * `C-c' `M-d': Switch to "char" keybinding mode.
;; * `C-c' `C-k': Kill process.
;; * "char" mode: All supported keys are bound to send the key to
;; the terminal, except `C-M-m' or `M-RET', which is bound to
;; switch to semi-char mode.
;; switch to "semi-char" keybinding mode.
;; If you like Eshell, then there is a good news for you. Eat
;; integrates with Eshell. Eat has two global minor modes for Eshell: