[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/eat 135a562a20 1/2: ; * README.org (Usage): Improve and li
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/eat 135a562a20 1/2: ; * README.org (Usage): Improve and link to manual |
Date: |
Sun, 15 Jan 2023 23:58:54 -0500 (EST) |
branch: elpa/eat
commit 135a562a2056bc1043f243304c539e2b08624463
Author: Akib Azmain Turja <akib@disroot.org>
Commit: Akib Azmain Turja <akib@disroot.org>
; * README.org (Usage): Improve and link to manual
---
README.org | 24 ++++++++++++++----------
1 file changed, 14 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index 509343db92..30c70f6e5f 100644
--- a/README.org
+++ b/README.org
@@ -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.