readme.md in text_tunnel-0.1.1 vs readme.md in text_tunnel-0.2.0

- old
+ new

@@ -26,32 +26,50 @@ text_tunneld -e /usr/local/bin/subl Connect to the remote host with SSH and specify a reverse port forward (the default port for Text Tunnel is 1777). - ssh -R 1777:localhost:1777 remote-host + ssh -R 1777:localhost:1777 remote-host On the remote machine use text_tunnel as your editor. - text_tunnel /path/to/file + text_tunnel /path/to/file The file should open on your local machine. Do your edits and save your file. It will automatically be transferred to the remote host. When you are done hit Crtl+C on the remote host to terminate Text Tunnel. ## Shortcuts The reverse port forward can be configured in ~/.ssh/config to avoid having to retype the reverse port forward on the command line every time. + RemoteForward 127.0.0.1:1777 127.0.0.1:1777 + Consider setting text_tunnel as your EDITOR environment variable on your remote hosts. This will let you use a local text editor for git commit -messages, crontabs, etc. +messages, crontabs, etc. If the text_tunneld server is unavailable it will +seamlessly fall back to vi. You can use the --fallback-editor option to +configure the fallback console editor. -text_tunneld supports a background daemon mode. Run text_tunneld -h for full options. + export EDITOR='/usr/local/bin/text_tunnel --fallback-editor=nano' +text_tunneld supports a background daemon mode. Run text_tunneld -h for full +options. You may want to configure it to run automatically when you log in to +your desktop environment. Sadly, the exact means of doing this vary across +platforms. On Ubuntu 12.04 with the Gnome Classic desktop environment you can +configure a program to autostart in Applications -> System Tools -> +Preferences -> Startup Applications. The following command would start +text_tunneld in background mode with the "subl" editor. + + text_tunneld --editor subl --daemon + ## Version History +* **0.2.0** + * Unblock INT signal for bin/text_tunnel. This allows usage with crontab -e. + * Fall back to local editor if text_tunneld server is unreachable. + * Added information to readme about autostarting on desktop login. * **0.1.1** * Add compatibility with older patch versions of Ruby 1.9.2. * **0.1.0** * Initial release