diff --git a/README.org b/README.org index 7cc3344..6e5031b 100644 --- a/README.org +++ b/README.org @@ -1,6 +1,6 @@ #+title: Eat: Emulate A Terminal -Eat's name self-explainary, it stands for "Emulate A Terminal". Eat +Eat's name self-explainatory, it stands for "Emulate A Terminal". Eat is a terminal emulator. It can run most (if not all) full-screen terminal programs, including Emacs. @@ -24,8 +24,9 @@ To start Eat, run =M-x eat=. Eat has three keybinding modes: - "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: + =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. @@ -71,8 +72,15 @@ 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]]. +For Zsh, put the following in your ~.zshrc~: + +#+begin_src sh +[ -n "$EAT_SHELL_INTEGRATION_DIR" ] && \ + source "$EAT_SHELL_INTEGRATION_DIR/zsh" +#+end_src sh + +There's a Info manual available with much 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 diff --git a/eat.texi b/eat.texi index b146d64..9a809ec 100644 --- a/eat.texi +++ b/eat.texi @@ -2,7 +2,7 @@ @comment %**start of header @setfilename eat.info -@set UPDATED 31 March 2023 +@set UPDATED 02 April 2023 @set VERSION 0.6.1 @documentencoding UTF-8 @codequotebacktick on @@ -252,7 +252,8 @@ applications. ``Semi-char mode'' is the default input mode of Eat. This works for most inputs. It forwards all keys, except @kbd{C-\}, @kbd{C-c}, @kbd{C-x}, @kbd{C-g}, @kbd{C-h}, @kbd{C-M-c}, @kbd{C-u}, @kbd{M-x}, -@kbd{C-q}, @kbd{M-:}, @kbd{M-!} and @kbd{M-&}, Emacs handle them. +@kbd{C-q}, @kbd{M-:}, @kbd{M-!}, @kbd{M-&} and some other keys, Emacs +handles them. @cindex inputting exceptional characters @kindex C-q @r{(``semi-char mode'')} @@ -295,7 +296,8 @@ Both user options contain a list of keys of form @code{[@var{key}]}, where @var{key} is a key not to bind. @var{key} mustn't contain meta modifier. To not bind a key with meta modifier, use a vector of form @code{[?\e @var{key}]}, where @var{key} is the key without meta -modifier. +modifier. These user options contain all the ``semi-char'' mode +exceptions listed above, plus some more exceptions. @findex eat-update-semi-char-mode-map @findex eat-eshell-update-semi-char-mode-map