scm: update documentation

Describe the new --listen flag, and give some example of its usage, including
some snippet for using it with Emacs/Geiser.
This commit is contained in:
Dirk-Jan C. Binnema
2025-08-17 12:01:27 +03:00
parent e56c848952
commit b52920bfcf
2 changed files with 106 additions and 3 deletions

View File

@ -25,6 +25,19 @@ Using *mu scm*, you can script *mu*.
* SCM OPTIONS
** --listen
With the ~--listen~ parameter, *mu scm* starts listening on a UNIX domain socket.
This can be used for communicating with the REPL using some external tool, such
as Emacs with the "Geiser" package. For details, refer to the *mu-scm* Info
manual.
It blocks after printing the name of the socket (which is a randomized name),
prefixed by *UNIX_CONNECT:* and ending with a newline. For instance:
#+begin_example
UNIX-CONNECT:/run/user/1000/mu-scm-socket-4eb5db40
#+end_example
#+include: "muhome.inc" :minlevel 2
#+include: "common-options.inc" :minlevel 1
@ -45,4 +58,6 @@ should give you access to the complete manual.
http://www.schemers.org provides a general introduction to the Scheme language.
{{{man-link(emacs,1)}}}
#+include: "prefooter.inc" :minlevel 1