; * README.org (Usage): Improve and link to manual

This commit is contained in:
Akib Azmain Turja 2023-01-15 22:15:44 +06:00
parent 9a432eef11
commit 135a562a20
No known key found for this signature in database
GPG key ID: 5535FCF54D88616B

View file

@ -21,22 +21,23 @@ To get the most out of Eat, you should also setup shell integration.
To start Eat, run =M-x eat=. Eat has three keybinding modes:
- "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-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=, =C-q=, =M-x=, =M-:=, =M-!=, =M-&=. 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=, =C-q=,
=M-x=, =M-:=, =M-!=, =M-&=. 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.
- "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-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.
@ -70,6 +71,9 @@ of your ~.bashrc~:
source "$EAT_SHELL_INTEGRATION_DIR/bash"
#+end_src sh
There's a Info manual available with more information, which can be
accessed with =C-h i m Eat=, also available [[https://elpa.nongnu.org/nongnu-devel/doc/eat.html][here on the internet]].
* Installation
Eat requires at least Emacs 28.1 or above.