diff options
| author | Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> | 2025-08-17 12:01:27 +0300 |
|---|---|---|
| committer | Dirk-Jan C. Binnema <djcb@djcbsoftware.nl> | 2025-08-17 12:02:34 +0300 |
| commit | b52920bfcfc804cefa68fa3615c921e89f462b37 (patch) | |
| tree | 012a01bb79a0938a00b74e3ff7d4a14173e9bf4d /man | |
| parent | e56c8489522e1aebb1309a03d460314138cb35dc (diff) | |
scm: update documentation
Describe the new --listen flag, and give some example of its usage, including
some snippet for using it with Emacs/Geiser.
Diffstat (limited to 'man')
| -rw-r--r-- | man/mu-scm.1.org | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/man/mu-scm.1.org b/man/mu-scm.1.org index 42e7652..90fe4df 100644 --- a/man/mu-scm.1.org +++ b/man/mu-scm.1.org @@ -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 |
