]> code.delx.au - gnu-emacs-elpa/blobdiff - README.md
multishell - note that the tramp bug is on remote|sudo to homedir
[gnu-emacs-elpa] / README.md
index c1d9555b70f736048e3f549a3416517a1dc66574..4f3bcda0b5ea323ec2b71752c8bc5ab213e2b2fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,53 +1,65 @@
-EmacsUtils
-==========
-
-Handy Emacs utilities
-
-I've been using Emacs since it was publicly available (1985 or 1986), and have contributed some items which are included with Emacs, notably the [Allout outliner](http://myriadicity.net/software-and-systems/craft/emacs-allout), [icomplete mode](http://www.emacswiki.org/emacs/IcompleteMode), and python-mode's [pdbtrack functionality](http://myriadicity.net/software-and-systems/craft/crafty-hacks#section-1). Like many long-time Emacs users, I've got some personal custom code, some of which I wouldn't do without. Here's some that I particularly like, and think might be useful to others - I hope to include more, as time allows.
-
-* **pdbtrack.el**
-
-  Add sensitivity to comint shells so the source file lines are automatically
-  presented in a separate window when the Python PDB debugger steps to them.
-
-  This is derived from the pdb tracking code, which I originally wrote, and
-  which has been included in (various) official Emacs Python modes. I wanted
-  a version that I could more easily tweak and maintain, independently of
-  the python-mode code.
-
-  It would eventually be nice to generalize this code, to work for things
-  like the node.js debugger. We'll see if I (or anyone) ever gets around to
-  that.
-
-* **poptoshell.el**
-
-  I use the emacs shell a lot. This code enables me to streamline and
-  extend how I can a single one, or multiple ones in a project-oriented
-  fashion:
-
-  * It simplifies getting to the input prompt, by doing the right thing when
-    I hit the key I have bound to pop-to-shell (I use [M-space], ie
-    meta-space:
-  * If the cursor is in a buffer that has no subprocess, pop the window to
-    the primary shell buffer
-  * If there is no shell buffer, start one.
-  * If the cursor is in a buffer which has a process, move the cursor to
-    the process input point.
-  * With a universal argument, even if the current buffer has a subprocess,
-    solicit the name of the target shell buffer - defaulting to the currently
-    chosen primary one - and pop to that.
-    * This enables starting an alternate shell buffer, for instance, and/or
-      switching between the main and alternate ones.
-    * (The expected name is without the surrounding asterisks, and
-      completion is done against existing shell buffer names stripped of
-      their asterisks.)
-  * With a doubled universal arg, prompt for the target shell buffer and
-    use the provided name as the ensuing default. This is how the "primary"
-    is chosen.
-
-  The last few things enable a kind of project-focus mode.  I often have
-  various shell buffers, each one associated with a project. As I switch
-  which project is currently my primary focus, I use the double universal
-  argument to switch which shell buffer is the default. I can still use the
-  single universal argument to easily switch to any of the shells, but most
-  easily to my current primary.
+multishell.el
+=============
+
+Facilitate use of multiple local and remote Emacs shell buffers.
+
+I use the emacs shell a *lot*. On top of emacs' powerful shell and tramp
+facilities, use a `multishell` (customization-activated) key binding to:
+
+* Get to the input point from wherever you are in a shell buffer,
+* ... or to one of your shell buffers if you're not currently in one.
+* Use universal arguments to launch and choose among alternate shell buffers,
+* ... and select which is default.
+* 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: 
+
+  * `/ssh:example.net:/` for a shell buffer in / on
+    example.net; the buffer will be named "*example.net*".
+
+  * `#ex/ssh:example.net|sudo:root@example.net:/etc` for a root shell
+    starting in /etc on example.net named "*#ex*".
+
+(NOTE that there is a frequent problem with specifying a remote homedir
+using tramp syntax, eg `/ssh:example.net:` or `/ssh:example.net:~`. That
+sometimes fails on an obscure bug - particularly for remote+sudo with
+homedir syntax. Until fixed, you may need to start remote+sudo shells with
+an explicit path, then cd ~. With `multishell`s dir-tracking persistent history, you'll be able to use completion to start that shell in the right place, in your subsequent sessions.)
+
+Customize-group `multishell` to select and activate a keybinding and set
+various behaviors. Customize-group `savehist` to preserve buffer
+names/paths across emacs sessions.
+
+See the `multishell-pop-to-shell` docstring for details.
+
+Change Log
+----------
+* 2016-01-16 1.0.5 Ken Manheimer:
+  - History now includes paths, when designated
+  - Actively track current directory in history entries that have a path.
+    Custom control: multishell-history-entry-tracks-current-directory
+  - Offer to remove shell's history entry when buffer is killed
+    (For now, the only UI way to remove history entries.)
+  - Fix - prevent duplicate entries for same name but different paths
+  - Fix - recognize and respect tramp path syntax to start in home dir
+    - But tramp bug, remote+sudo hops to a home dir can fail, get wedged.
+  - Simplify history var name, migrate existing history if any from old name
+* 2016-01-04 Ken Manheimer - Released to ELPA
+* 2016-01-02 Ken Manheimer - working on this in public, but not yet released.
+
+ TODO
+----------
+* Isolate tramp sporadic failure to connect to remote+sudo+homedir syntax
+  (eg, /ssh:xyz.com|sudo:root@xyz.com: or /ssh:xyz.com|sudo:root@xyz.com:~)
+* Find suitable, internally consistent ways to sort tidy completions, eg:
+  - first list completions for active shells, then present but inactive,
+    then historical
+  - some way for user to toggle between presenting just buffer names vs
+    full buffer/path
+    - without cutting user off from easy editing of path
+* Find proper method for setting field boundary at beginning of tramp path
+  in the minibuffer, in order to see whether the field boundary magically
+  enables tramp completion of the path.
+* Assess whether option to delete history entry on kill-buffer is
+  sufficient.