summaryrefslogtreecommitdiff
path: root/README.md
blob: 55d2991b39df6bbd78b3c2fc9f19d768270fe91a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
multishell.el
=============

Organize multiple local and remote Emacs shell buffers.

Multishell is available via Emacs package manager, [in ELPA](https://elpa.gnu.org/packages/multishell.html). Install "multishell" from the `M-x package-list-packages` listing.

I use almost as many emacs shell buffers as I do tabs in my browser
sessions. Multishell makes it easy to organize my use of them with distinct
names for each, tramp syntax for remote and / or sudo shells, a roster of
them all that can be saved between emacs sessions (preserving remote and
sudo specifications), and more. With a customizable master keybinding,
multishell makes it easy 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.

* 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 exited shells, or shells from prior emacs sessions.

* Specify an initial path for the shell. By using Emacs tramp syntax you
  can launch a sudo and/or remote shell.

  For example, specifying the following at the multishell buffer name
  prompt will:

  * `#root/sudo:root@localhost:/etc` launch a shell in a buffer named
    "*#root*" with a root shell starting in /etc.

  * `/ssh:example.net:` launch a shell buffer in your homedir on
    example.net.  The buffer will be named "*example.net*".

  * `#ex/ssh:example.net|sudo:root@example.net:/etc` launch a root
    shell starting in /etc on example.net named "*#ex*".

  * `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 (in
[multishell.el](multishell.el)) for details, and
[getting-to-a-shell.md](getting-to-a-shell.md) for the nitty-gritty
decision tree that determines where the keybinding goes according to the
various conditions.

Customize-group `multishell' to select and activate a keybinding and set
various behaviors. Customize-group `savehist' to preserve buffer
names/paths across emacs restarts.

Please use
[the multishell repository](https://github.com/kenmanheimer/EmacsMultishell)
issue tracker to report problems, suggestions, etc.

See the [multishell.el](multishell.el) file commentary for a change log and
Todo list.