]> code.delx.au - gnu-emacs-elpa/blobdiff - README.md
multishell - Remove notes about tramp remote+sudo+homedir+sudo prob
[gnu-emacs-elpa] / README.md
index 48b80bf78d2ffc29609a5d12914674b2daba3573..4f3bcda0b5ea323ec2b71752c8bc5ab213e2b2fc 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,63 +1,65 @@
-EmacsUtils
-==========
-
-Handy Emacs utilities
-
-I've been using Gnu Emacs since it was publicly available (1985?), and have contributed some packages 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 use some custom code, some of which I wouldn't do without. Here's a few items that I particularly like, and think might be useful to others - I hope to include more, as time allows.
-
-* **[poptoshell.el](./poptoshell.el)**
-
-  I use the emacs shell a lot. I bind this to Meta-space to make it easy to:
-
-    * Return to the current primary shell, in an alternate window
-    * When within a shell buffer, get to the input prompt
-    * Start alternate shells, and easily choose between any that are going:
-      * With one universal argument, prompt for the name of the shell
-      * with completion on existing names,
-      * and new names to start a new shells.
-    * Prefix names of new shells with paths, to specify starting directory
-    * For a remote shell, use tramp-style remote path!
-      * Without an explicit name following the last slash, the host name is
-        used as the shell name. But the trailing name makes it easy to
-        distinguish, eg, root shells: `/ssh:myserver.net|sudo:root@myserver.net:/#myserver`
-      * Since the shell's current directory is used by default:
-        * If the remote shell has been disconnected, it's reconnected by default, in the same directory where you left off
-          * (So I exit remote shells I'm done with, but keep the buffers around - I just resume by Meta-space <shell-name>.)
-        * Visiting files from a remote shell buffer visits relative to the remote host!
-    * Change which shell is the session default by using a doubled
-      universal argument.
-      * Handy for a kind of current-project modality, easily changing
-        which shell is the default as you change project focus.
-
-* **[xsel.el](./xsel.el)**
-
-  X copy and paste emacs region from emacs tty sessions, using a shell command.
-
-  If xsel or linux or cygwin equivalent is installed, and DISPLAY is
-  working, use `klm:xsel-copy` to copy the region to the X clipboard and
-  `klm:xsel-paste` to paste the contents of the clipboard at point.
-
-  One benefit is that `klm:xsel-paste` pastes are single units, rather than
-  a sequence of individual keystrokes that constitute regular X pastes to a
-  terminal. This avoids layers of parsing, indenting, auto-paren insertion,
-  and so forth. (You can always do a regular X paste on occasions when you
-  want that processing.)
-
-* **[pdbtrack.el](./pdbtrack.el)**
-
-  [I've moved my standalone version of pdbtrack aside. I hadn't realized 
-  that the version that I derived this code from lacks my source-buffer 
-  fallback provisions. It looks like I'm going to have to do some
-  unraveling to reconstruct the best basis.]
-
-  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 be nice to eventually generalize this code, to work for things
-  like the node.js debugger. We'll see if I (or anyone) ever gets around to
-  that.
+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.