Update manual to correctly describe command 'eat'

* eat.texi (Hello Terminal): Update to match with the current
behavior of command 'eat'.
This commit is contained in:
Akib Azmain Turja 2023-03-29 23:09:30 +06:00
parent 8ee08d2b22
commit 26d83d04c1
No known key found for this signature in database
GPG key ID: 5535FCF54D88616B
2 changed files with 17 additions and 15 deletions

8
eat.el
View file

@ -5551,7 +5551,7 @@ Return the buffer selected (or created).
With a non-numeric prefix ARG, create a new session. With a non-numeric prefix ARG, create a new session.
With a numeric prefix ARG (like \\[universal-argument] 42 \\[eshell]), With a numeric prefix ARG (like \\[universal-argument] 42 \\[eat]),
switch to the session with that number, or create it if it doesn't switch to the session with that number, or create it if it doesn't
already exist. already exist.
@ -6223,9 +6223,9 @@ Return the buffer selected (or created).
With a non-numeric prefix ARG, create a new session. With a non-numeric prefix ARG, create a new session.
With a numeric prefix ARG (like \\[universal-argument] 42 \\[eshell]), With a numeric prefix ARG (like
switch to the session with that number, or create it if it doesn't \\[universal-argument] 42 \\[eat-project]), switch to the session with
already exist." that number, or create it if it doesn't already exist."
(interactive "P") (interactive "P")
(require 'project) (require 'project)
(let* ((default-directory (project-root (project-current t))) (let* ((default-directory (project-root (project-current t)))

View file

@ -2,7 +2,7 @@
@comment %**start of header @comment %**start of header
@setfilename eat.info @setfilename eat.info
@set UPDATED 28 March 2023 @set UPDATED 29 March 2023
@set VERSION 0.6.1 @set VERSION 0.6.1
@documentencoding UTF-8 @documentencoding UTF-8
@codequotebacktick on @codequotebacktick on
@ -116,13 +116,10 @@ to run full screen programs like Emacs within the terminal.
@chapter Hello Terminal @chapter Hello Terminal
@findex eat @findex eat
The terminal can be started with @kbd{M-x eat}. It would prompt you The terminal can be started with @kbd{M-x eat}. It'll create a
for the program to run in the terminal, with a reasonable default terminal and run the default shell
value already filled in. You can specify a program path, or a shell (@pxref{Interactive Shell,,, emacs, GNU Emacs Manual}) in it. You
command. After you hit @kbd{@key{RET}}, you will see a terminal, and should get a shell prompt and be able to write shell commands and
the program you chose will be run within the terminal in the current
directory. You can interact with it. If you started a shell, you
should get a shell prompt and you should be able to write commands and
execute them. Full screen programs like @samp{htop}, @samp{lynx} and execute them. Full screen programs like @samp{htop}, @samp{lynx} and
Emacs will work inside it, just like other any other terminal. Emacs will work inside it, just like other any other terminal.
@ -130,9 +127,14 @@ If an Eat terminal already exists, @kbd{M-x eat} will switch to it.
To create a new terminal, call it with a prefix argument like this, To create a new terminal, call it with a prefix argument like this,
@kbd{C-u M-x eat}. @kbd{C-u M-x eat}.
If you give it a numeric argument N, for example @kbd{C-u 42 M-x eat}, If you give it a numeric prefix argument N, for example
it'll switch to a terminal in @file{*eat*<N>}, @file{*eat*<42>} for @kbd{C-u 42 M-x eat}, it'll switch to a terminal in the buffer
example, and it'll create a new terminal if that doesn't exist. @file{*eat*<N>}, @file{*eat*<42>} for example, or it'll create a new
terminal if that buffer doesn't exist.
If you give it double prefix argument, for example
@kbd{C-u C-u M-x eat}, you'll be prompted for the program or shell
command to run, and it'll be run in a newly created terminal.
@node Project-local Terminal @node Project-local Terminal
@cindex project-local terminal @cindex project-local terminal