changeset 83191:bc4b91420ff4

README updates, including a new Tips & Tricks section git-archimport-id: [e-mail]--2004/emacs--multi-tty--0--patch-231

--- a/README.multi-tty	Wed Aug 11 17:33:32 2004 +0000
+++ b/README.multi-tty	Fri Aug 13 14:48:29 2004 +0000
@@ -25,49 +25,23 @@
 
 I'm Károly Lőrentey.  My address: [e-mail].
 
-Comments, bug reports, suggestions and patches are welcome!
-
-Retrieving the latest version of the branch:
-
-	tla register-archive [e-mail]--2004 http://lorentey.hu/arch/2004/
-	tla get [e-mail]--2004/emacs--multi-tty <directory>
-
-This incantation uses my private archive mirror that is hosted on a
-relatively low-bandwidth site; if you are outside Hungary, you will
-probably want to you use the Arch supermirror instead:
+Comments, bug reports, suggestions and patches are welcome; send them
+to [e-mail].
 
-	tla register-archive [e-mail]--2004 http://mirrors.gnuarch.org/[e-mail]--2004/
-	tla get [e-mail]--2004/emacs--multi-tty <directory>
+MAILING LISTS
+-------------
 
-(I use a recent arch development snapshot, but any of the released
-versions of arch will do fine, I think.)
-
-To update your source tree to the latest revision after the first
-checkout, simply use the following command:
-
-	tla replay [e-mail]--2004/emacs--multi-tty--0
+The multi-tty mailing list (discussion & bug reports):
 
-If you are interested, you can find more detailed information about
-Arch on http://wiki.gnuarch.org/.  It's a wonderful source control
-system, I highly recommend it.
-
-If you don't have arch, the branch has a homepage from which you can
-download conventional patches against Emacs CVS HEAD:
-
-	http://lorentey.hu/project/emacs.html
+    	Address:	[e-mail]
+	Signup:		http://lists.fnord.hu/mailman/listinfo/multi-tty
+	Archive:	http://news.gmane.org/gmane.emacs.multi-tty/
 
-If you want to be notified of new revisions, sign up to the
[e-mail] mailing list by visiting the
-below homepage and following its instructions.
-
-	https://listbox.elte.hu/mailman/listinfo/multi-tty
+Commit notifications (read-only):
 
-Please note that the multi-tty mailing list is read-only, and is
-reserved for automatic commit messages.  Discussion about the branch
-and bug reports should be sent directly to me ([e-mail]), or
-to the [e-mail] mailing list.  (I hope to merge my branch
-into CVS HEAD reasonably soon, so I don't want to set up an elaborate
-development infrastructure for the multi-tty branch.)
+        Address:	[e-mail]
+	Signup:		http://lists.fnord.hu/mailman/listinfo/multi-tty-commits
+
 
 STATUS
 ------
@@ -86,6 +60,51 @@
 
 Please let me know if you find any bugs in this branch.
 
+Known problems:
+
+	* Mac, Windows and DOS support is broken, probably doesn't
+	  even compile -- this will be solved later.
+
+	* Only tested on my GNU/Linux box, Solaris 8 and FreeBSD.
+
+
+HOW TO GET THE BRANCH
+---------------------
+
+The branch uses GNU Arch (http://www.gnuarch.org) for version control.
+
+Retrieving the latest version of the branch:
+
+	tla register-archive [e-mail]--2004 http://lorentey.hu/arch/2004/
+	tla get [e-mail]--2004/emacs--multi-tty <directory>
+
+This incantation uses my private archive mirror that is hosted on a
+relatively low-bandwidth site; if you are outside Hungary, you will
+probably want to you use the Arch supermirror instead:
+
+	tla register-archive [e-mail]--2004 http://mirrors.gnuarch.org/[e-mail]--2004/
+	tla get [e-mail]--2004/emacs--multi-tty <directory>
+
+(I use a recent tla development snapshot, but any of the released
+versions of arch will do fine, I think.)  My GPG key id is 0FB27A3F;
+it is available from hkp://wwwkeys.eu.pgp.net/, or my homepage at
+http://lorentey.hu/rolam/gpg.html)
+
+To update your source tree to the latest revision after the first
+checkout, simply use the following command:
+
+	tla replay [e-mail]--2004/emacs--multi-tty--0
+
+If you are interested, you can find more information about Arch on
+http://wiki.gnuarch.org/.  It's a wonderful source control system, I
+highly recommend it.
+
+If you don't have tla, the branch has a homepage from which you can
+download conventional patches against Emacs CVS HEAD:
+
+	http://lorentey.hu/project/emacs.html
+
+
 HOW TO COMPILE
 --------------
 
@@ -124,26 +143,101 @@
 always run emacs from gdb, so that you'll have a live instance to
 debug if something goes wrong.  Please send me your bug reports.
 
+TIPS & TRICKS
+-------------
+
 I think the best way to use the new Emacs is to have it running inside
 a disconnected GNU screen session, and always use emacsclient for
-normal work.  This way not a single keystroke of your work will be
-lost if the display device that you are using crashes, or the network
-connection times out, or whatever.  As long as the server that runs
-your Emacs remains up, all your buffers remain exactly as they were
-before the crash, and you can continue working as if nothing had
-happened.  (I had an extremely unstable X server for some time while I
-was developing these patches, and running Emacs this way has saved me
-a number of M-x recover-session invocations.)
+normal work.  One advantage of this is that not a single keystroke of
+your work will be lost if the display device that you are using
+crashes, or the network connection times out, or whatever.  (I had an
+extremely unstable X server for some time while I was developing these
+patches, and running Emacs this way has saved me a number of M-x
+recover-session invocations.)
+
+I use the following two bash functions to handle my Emacs sessions:
 
-(I am thinking about introducing a --daemon option to get rid of the
-above screen dependency.)
-
-Problems:
+,----[ ~/.bash_profile
+| # Usage: preload-emacs <name> [<waitp>]
+| #
+| # Preloads the Emacs instance called NAME in a detached screen
+| # session.  Does nothing if the instance is already running.  If WAITP
+| # is non-empty, the function waits until the server starts up and
+| # creates its socket; otherwise it returns immediately.
+| function preload-emacs {
+|     local name="$1"
+|     local waitp="$2"
+|     local screendir="/var/run/screen/S-$USER"
+|     local serverdir="/tmp/emacs$UID"
+|     local emacs=emacs # Or wherever you installed your multi-tty Emacs
+| 
+|     if [ -z "$name" ]; then 
+| 	echo "Usage: preload-emacs <name> [<waitp>]" >&2
+| 	return 1
+|     fi
+| 
+|     if [ ! -e "$screendir"/*."$name" ]; then
+| 	if [ -e "$serverdir/$name" ]; then
+| 	    # Delete leftover socket (for preload-emacs-wait)
+| 	    rm "$serverdir/$name"
+| 	fi
+| 	screen -dmS "$name" "$emacs" -nw --eval "(setq server-name \"$name\")" -f server-start
+|     fi
+|     if [ ! -z "$waitp" ]; then
+| 	while [ ! -e "$serverdir/$name" ]; do sleep 0.1; done
+|     fi
+|     return 0
+| }
+| 
+| # Usage: connect-emacs <name> <args>...
+| #
+| # Connects to the Emacs instance called NAME.  Starts up the instance
+| # if it is not already running.  The rest of the arguments are passed
+| # to emacsclient.
+| function connect-emacs {
+|     local name="$1"
+|     shift
+|     
+|     if [ -z "$name" ]; then
+| 	echo "Usage: connect-emacs <name> <args>..." >&2
+|     fi
+|     preload-emacs "$name" wait
+|     emacsclient -s "$name" "$@"
+| }
+| 
+| export -f preload-emacs connect-emacs
+|
+| # Preload editor and gnus sessions for speedy initial connects.
+| preload-emacs editor
+| preload-emacs gnus
+`----
 
-	* Mac, Windows and DOS support is broken, probably doesn't
-	  even compile -- this will be solved later.
+,----[ ~/.bashrc
+| alias gnus="connect-emacs gnus"
+| alias edit="connect-emacs editor"
+| alias et="connect-emacs editor -t"
+| alias e=edit
+`----
+
+The following settings prevent me from accidentally killing the Emacs
+session.  (Maybe this should be the default binding of C-x C-c.)
 
-	* Only tested on my GNU/Linux box, Solaris 8 and FreeBSD.
+,----[ ~/.emacs
+| (defun lk-exit-emacs-or-delete-frame (&optional arg)
+|   "If the current frame has a client, kill it; otherwise kill Emacs itself.
+| Offer to save each buffer before the murder.  With prefix arg,
+| ignore client status and kill Emacs."
+|   (interactive "P")
+|   (let ((proc (frame-parameter (selected-frame) 'client)))
+|     (if (and (not arg) proc)
+| 	(progn
+| 	  (save-some-buffers nil t)
+| 	  (server-delete-client proc))
+|       (save-buffers-kill-emacs))))
+| 
+| (global-set-key (kbd "C-x C-c") 'lk-exit-emacs-or-delete-frame)
+`----
+
 
 NEWS
 ----
@@ -188,7 +282,8 @@
 ------
 
 The following is an (incomplete) list of people who have contributed
-to the project by testing, bug reports, and suggestions.  Thanks!
+to the project by testing, submitting patches, bug reports, and
+suggestions.  Thanks!
 
 ARISAWA Akihiro <ari at mbf dot ocn dot ne dot jp>
 Robert J. Chassell <bob at rattlesnake dot com>
@@ -247,7 +342,10 @@
    At least a beep or a message would be important, if the single-mode
    is still required to prevent interference.  (Reported by Dan
    Nicolaescu.)  (Update: selecting a region with the mouse enables
-   single_kboard under X.  This is very confusing.)
+   single_kboard under X.  This is very confusing.)  Update:
+   After discussions with Richard, this will be resolved by having
+   locked displays warn the user to wait, and introducing a complex
+   protocol to remotely bail out of single-kboard mode by pressing C-g.
 
 ** The terminal customization files in term/*.el tend to change global
    parameters, which may confuse Emacs with multiple displays.  Change
@@ -268,7 +366,9 @@
    opened for editing.  I think I agree with him.
 
 ** Miles Bader suggests that C-x C-c on an emacsclient frame should
-   only close the frame, not exit the entire Emacs session.
+   only close the frame, not exit the entire Emacs session.  Update:
+   see above for a function that does this.  Maybe this should be the
+   new default?
 
 ** Very strange bug: visible-bell does not work on secondary
    terminals in xterm and konsole.  The screen does flicker a bit,