summaryrefslogtreecommitdiff
path: root/multishell.el
diff options
context:
space:
mode:
authorKen Manheimer <ken.manheimer@gmail.com>2022-06-05 11:47:25 -0400
committerKen Manheimer <ken.manheimer@gmail.com>2022-06-05 11:47:25 -0400
commit86e07ba8db36743ea2082bb1839a568b9cee254b (patch)
treeb894fa7cc2b75308d12f018527f48546492e1fe4 /multishell.el
parent82b2ac67352d483a0c5eb226a506ff409f55e7d9 (diff)
Refine multishell features description.
In README.md and multishell.el commentary.
Diffstat (limited to 'multishell.el')
-rw-r--r--multishell.el47
1 files changed, 26 insertions, 21 deletions
diff --git a/multishell.el b/multishell.el
index 87afa27..49c4fbe 100644
--- a/multishell.el
+++ b/multishell.el
@@ -15,38 +15,43 @@
;; Fundamentally, multishell is the function `multishell-pop-to-shell' -
;; a la `pop-to-buffer' - plus a keybinding. Together, they enable you to:
;;
-;; * Get to the input point from wherever you are in a shell buffer,
-;; ... or to any of your shell buffers, from anywhere inside emacs.
+;; * Easily get to the input point from wherever you are in a shell buffer,
+;; or to any of your shell buffers, from anywhere inside emacs.
;;
-;; * Use universal arguments to launch and choose among alternate shell buffers,
-;; ... and change which is the current default.
+;; * Use universal arguments and name completion to launch a new or choose
+;; among existing shell buffers, and change which is the current default.
;;
-;; * Easily restart disconnected shells, or shells from prior sessions
-;; ... the latter from Emacs builtin savehist minibuf history persistence
+;; * Easily restart exited shells, or shells from emacs prior sessions.
;;
-;; * Append a path to a new shell name to launch a shell in that directory,
-;; ... and use a path with Emacs tramp syntax to launch a remote shell -
-;; for example:
+;; * Specify an initial path for the shell. By using Emacs tramp syntax you
+;; can launch a sudo and/or remote shell.
;;
-;; * `#root/sudo:root@localhost:/etc` for a buffer named "*#root*" with a
-;; root shell starting in /etc.
+;; For example, specifying the following at the multishell buffer name
+;; prompt will:
;;
-;; * `/ssh:example.net:` for a shell buffer in your homedir on example.net.
-;; The buffer will be named "*example.net*".
+;; * `#root/sudo:root@localhost:/etc` launch a shell in a buffer named
+;; "*#root*" with a root shell starting in /etc.
;;
-;; * `#ex/ssh:example.net|sudo:root@example.net:/var/log` for a root shell
-;; starting in /var/log on example.net named "*#ex*".
+;; * `/ssh:example.net:` launch a shell buffer in your homedir on
+;; example.net. The buffer will be named "*example.net*".
;;
-;; * 'interior/ssh:gateway.corp.com|ssh:interior.corp.com:' to go via
-;; gateway.corp.com to your homedir on interior.corp.com. The buffer
-;; will be named "*interior*". You could append a sudo hop, and so on.
+;; * `#ex/ssh:example.net|sudo:root@example.net:/etc` launch a root
+;; shell starting in /etc on example.net named "*#ex*".
;;
-;; * Thanks to tramp, file visits from the shell will seamlessly be in
-;; the auspices of the target account, and relative to the current
-;; directory, on the host where the shell is running.
+;; * `interior/ssh:gateway.corp.com|ssh:interior.corp.com:` via
+;; gateway.corp.com launch a shell in your homedir on interior.corp.com.
+;; The buffer will be named "*interior*". You could append a sudo hop,
+;; and so on.
+;;
+;; * Thanks to tramp, file visits initiated in remote shell buffers will
+;; seamlessly be on the hosts where the shells are running, in the auspices
+;; of the account being used.
;;
;; * Manage your list of shells, current and past, as a collection.
;;
+;; * Of course, emacs completion makes it easy to switch to an already
+;; existing shell buffer, or one in your history roster, by name.
+;;
;; See the `multishell-pop-to-shell' docstring for details.
;;
;; Customize-group `multishell' to select and activate a keybinding and set