Fix tool-bar and menu-bar toggles in Show/Hide menu to reflect the state of the curre...
[emacs.git] / README.multi-tty
blob442c4c92fd2ae6d00464857109f7724ad04074d2
1                         -*- coding: utf-8; mode: text; -*-
2 GOAL
3 ----
5 This branch implements support for opening multiple, different tty
6 devices and simultaneous X and tty frames from a single Emacs session.
8 Some use cases:
9 Emacs is notoriously slow at startup, so most people use another
10 editor or emacsclient for quick editing jobs from the console.
11 Unfortunately, emacsclient was very awkward to use, because it did not
12 support opening a new Emacs frame on the current virtual tty.
13 Now, with multi-tty support, it can do that.  (Emacsclient starts up
14 faster than vi!)
16 Some Gnus users (including me) run Gnus in an X frame in its own Emacs
17 instance, which they typically leave running for weeks.  It would be
18 nice if they could connect to this instance from a remote ssh session
19 and check their messages without opening a remote X frame or resorting
20 to gnus-slave.
22 WHO IS DOING IT
23 ---------------
25 I'm Károly Lőrentey.  My address: lorentey@elte.hu.
27 Comments, bug reports, suggestions and patches are welcome; send them
28 to multi-tty@lists.fnord.hu.
30 The following is a (sadly incomplete) list of people who have
31 contributed to the project by testing, submitting patches, bug
32 reports, and suggestions.  Thanks!
34 Bernard Adrian <bernadrian@free.fr>
35 ARISAWA Akihiro <ari@mbf.ocn.ne.jp>
36 Vincent Bernat <bernat@luffy.cx>
37 Han Boetes <han@mijncomputer.nl>
38 Francisco Borges <borges@let.rug.nl>
39 Damien Cassou <damien.cassou@laposte.net>
40 Robert J. Chassell <bob@rattlesnake.com>
41 Romain Francoise <romain@orebokech.com>
42 Ami Fischman <ami@fischman.org>
43 Friedrich Delgado Friedrichs <friedel@nomaden.org>
44 IRIE Tetsuya <irie@t.email.ne.jp>
45 Yoshiaki Kasahara <kasahara@nc.kyushu-u.ac.jp>
46 Bas Kok <nekkobassu@yahoo.com>
47 Jurej Kubelka <Juraj.Kubelka@email.cz>
48 David Lichteblau <david@lichteblau.com>
49 Richard Lewis <rtf@jabble.com>
50 mace <mace@kirjakaapeli.lib.hel.fi>
51 Suresh Madhu <madhu@cs.unm.edu>
52 Xavier Mallard <zedek@gnu-rox.org>
53 Istvan Marko <mi-mtty@kismala.com>
54 Ted Morse <morse@ciholas.com>
55 Gergely Nagy <algernon@debian.org>
56 Dan Nicolaescu <dann@ics.uci.edu>
57 Kalle Olavi Niemitalo <kon@iki.fi>
58 Mark Plaksin <happy@mcplaksin.org>
59 Frank Ruell <stoerte@dreamwarrior.net>
60 Tom Schutzer-Weissmann <trmsw@yahoo.co.uk>
61 Joakim Verona <joakim@verona.se>
62 Dan Waber <dwaber@logolalia.com>
63 and many others.
65 Richard Stallman was kind enough to review an earlier version of my
66 patches.
69 MAILING LISTS
70 -------------
72 The multi-tty mailing list (discussion & bug reports):
74         Address:        multi-tty@lists.fnord.hu
75         Signup:         http://lists.fnord.hu/mailman/listinfo/multi-tty
76         Archive:        http://news.gmane.org/gmane.emacs.multi-tty/
78 Commit notifications (read-only):
80         Address:        multi-tty-commits@lists.fnord.hu
81         Signup:         http://lists.fnord.hu/mailman/listinfo/multi-tty-commits
84 STATUS
85 ------
87 The branch is now very stable and almost full-featured.  All of the
88 major problems have been fixed, only a few minor issues remain.  (It
89 still needs to be ported to Windows/Mac/DOS, though.)  Both multiple
90 tty device support and simultaneous X and tty frame support works
91 fine.  Emacsclient has been extended to support opening new tty and X
92 frames.  It has been changed to open new Emacs frames by default.
94 The multi-tty branch has been scheduled for inclusion in the next
95 major release of Emacs (version 23).  I expect the merge into the
96 development trunk to occur sometime during next year (2006), after the
97 merge of the Unicode branch.
99 Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD.  Please let me
100 know if you succeed or fail to use it on other platforms---I'll have a
101 few tricky test cases for you.
103 Known problems:
105         * GTK support.  If you compile your Emacs with the GTK
106           toolkit, some functionality of multi-tty will be lost.  In
107           particular, you will not be able to work on multiple X
108           displays at once.  Current releases of GTK have limitations
109           and bugs that prevent full-blown multi-display support in
110           Emacs.  (GTK crashes when Emacs tries to disconnect from an
111           X server.)  Use the Lucid toolkit if you want to see a
112           complete feature set.
114         * The single-kboard mode.
116           If your multi-tty Emacs session seems to be frozen, you
117           probably have a recursive editing session or a pending
118           minibuffer prompt (which is a kind of recursive editing) on
119           another display.  To unfreeze your session, switch to that
120           display and complete the recursive edit, for example by
121           pressing C-] (`abort-recursive-edit').
123           I am sorry to say that currently there is no way to break
124           out of this "single-kboard mode" from a frozen display.  If
125           you are unable to switch to the display that locks the
126           others (for example because it is on a remote computer),
127           then you can use emacsclient to break out of all recursive
128           editing sessions:
130                 emacsclient -e '(top-level)'
132           Note that this (perhaps) unintuitive behaviour is by design.
133           Single-kboard mode is required because of an intrinsic Emacs
134           limitation that is very hard to eliminate.  (This limitation
135           is related to the single-threaded nature of Emacs.)
137           I plan to implement better user notification and support for
138           breaking out of single-kboard mode from locked displays.
140         * Mac, Windows and DOS support is broken, doesn't even
141           compile.  Multiple display support will probably not provide
142           new Emacs features on these systems, but the multi-tty
143           branch changed a few low-level interfaces, and the
144           system-dependent source files need to be adapted
145           accordingly.  The changes are mostly trivial, so almost
146           anyone can help, if only by compiling the branch and
147           reporting the compiler errors.
150 HOW TO GET THE BRANCH
151 ---------------------
153 The branch uses Bazaar 1 (http://bazaar.canonical.com) for version control.
155 Retrieving the latest version of the branch:
157         baz register-archive -f http://aszt.inf.elte.hu/~lorentey/mirror/arch/2004
158         baz get lorentey@elte.hu--2004/emacs--multi-tty <directory>
160 This incantation uses an archive mirror that is hosted on a
161 high-bandwidth site.  Please note that on average there is a two-hour
162 delay for commits to arrive on this mirror.  My primary mirror is on the
163 low-bandwidth http://lorentey.hu/ site:
165         baz register-archive -f http://lorentey.hu/arch/2004/
166         baz get lorentey@elte.hu--2004/emacs--multi-tty <directory>
168 This is "instantly" updated, but very slow from outside Hungary.
169 (By "instantly" I mean as soon as I connect the notebook I work on to
170 a network.  It could take days.)
172 The Arch supermirror provides mirroring services for all public Arch
173 repositories.  We have a mirror there, too, if you prefer.
175         baz register-archive -f http://mirrors.sourcecontrol.net/lorentey%40elte.hu--2004
176         baz get lorentey@elte.hu--2004/emacs--multi-tty <directory>
178 My GPG key id is 0FB27A3F; it is available from
179 hkp://wwwkeys.eu.pgp.net/, or from my homepage at
180 http://lorentey.hu/rolam/gpg.html)
182 Don't worry if the above checkout takes a few minutes to complete;
183 once you have a source tree, updating it to the latest revision will
184 be _much_ faster.  Use the following command for the update:
186         baz replay
188 You can find more information about Bazaar on
189 http://bazaar.canonical.com/.  It's a distributed source control
190 system that is somewhat less broken than competing projects.
192 If you don't have Bazaar, the branch has a homepage from which you can
193 download conventional patches against Emacs CVS HEAD:
195         http://lorentey.hu/project/emacs.html
197 I suggest you use Bazaar whenever feasible.
200 DEBIAN PACKAGES
201 ---------------
203 If you run Debian, or a distribution based on Debian, you are welcome
204 to use our binary packages; put these lines in your /etc/apt/sources.list:
206         # Multi-tty Emacs
207         deb http://aszt.inf.elte.hu/~lorentey/mirror/apt unstable multi-tty
208         deb-src http://aszt.inf.elte.hu/~lorentey/mirror/apt unstable multi-tty
210 Note that these packages are intended solely to provide an easy way to
211 test the new multi-tty features.  They are not to be taken as Emacs
212 releases, and it's a mistake to expect robust operation or any kind of
213 timely support for them.  Do not install them, unless you'd like to
214 have your editor crash on you.
217 COMPILATION
218 -----------
220 The multi-tty branch is compiled the same way as Emacs itself:
222         make maintainer-clean  # (If you have compiled Emacs before)
224         ./configure --without-gtk <your favourite options>
225         make bootstrap
226         make install
228 If you have strange compilation errors, they may be caused by old
229 *.elc files that are left over from an earlier bootstrap.  The `make
230 maintainer-clean' target deletes them, so it is a good idea to run
231 that before reporting a bug.  (Emacs requires a clean recompilation
232 after certain kinds of source code changes.)
234 TESTING
235 -------
237 To test the multi-tty branch, start up the Emacs server with the
238 following commands:
240         emacs
241         M-x server-start
243 and then (from a shell prompt on another terminal) start emacsclient
244 with
245         emacsclient -t /optional/file/names...   (for a tty frame)
246         emacsclient /optional/file/names...      (for an X frame)
248 (Make sure both emacs and emacsclient are multi-tty versions.)
249 You'll hopefully have two fully working, independent frames on
250 separate terminals. The new frame is closed automatically when you
251 finish editing the specified files (C-x #), but delete-frame (C-x 5 0)
252 also works.  Of course, you can create frames on more than two tty
253 devices.
255 Creating new frames on the same tty with C-x 5 2 (make-frame-command)
256 works, and behaves the same way as in previous Emacs versions.  If you
257 exit emacs, all terminals should be restored to their previous states.
259 This is work in progress, and probably full of bugs.  It is a good
260 idea to run emacs from gdb, so that you'll have a live instance to
261 debug if something goes wrong.  Please send me your bug reports on our
262 mailing list: multi-tty@lists.fnord.hu
264 TIPS & TRICKS
265 -------------
267 I think the best way to use the new Emacs is to have it running inside
268 a disconnected GNU screen session, and always use emacsclient for
269 normal work.  One advantage of this is that not a single keystroke of
270 your work will be lost if the display device that you are using
271 crashes, or the network connection times out, or whatever.  (I had an
272 extremely unstable X server for some time while I was developing these
273 patches, and running Emacs this way has saved me a number of M-x
274 recover-session invocations.)
276 I use the following two bash scripts to handle my Emacs sessions:
278 -------------------------------------------------------connect-emacs--
279 #!/bin/bash
280 # Usage: connect-emacs <name> <args>...
282 # Connects to the Emacs instance called NAME.  Starts up the instance
283 # if it is not already running.  The rest of the arguments are passed
284 # to emacsclient.
286 name="$1"
287 shift
288     
289 if [ -z "$name" ]; then
290     echo "Usage: connect_emacs <name> <args>..." >&2
291     exit 1
293 preload-emacs "$name" wait
294 /usr/bin/emacsclient.emacs-multi-tty -s "$name" "$@"
295 ----------------------------------------------------------------------
297 -------------------------------------------------------preload-emacs--
298 #!/bin/bash
299 # Usage: preload-emacs <name> [<waitp>]
301 # Preloads the Emacs instance called NAME in a detached screen
302 # session.  Does nothing if the instance is already running.  If WAITP
303 # is non-empty, the function waits until the server starts up and
304 # creates its socket; otherwise it returns immediately.
306 name="$1"
307 waitp="$2"
308 screendir="/var/run/screen/S-$USER"
309 serverdir="/tmp/emacs$UID"
310 emacs=/usr/bin/emacs-multi-tty # Or wherever you installed your multi-tty Emacs
312 if [ -z "$name" ]; then 
313     echo "Usage: preload_emacs <name> [<waitp>]" >&2
314     exit 1
317 if [ ! -e "$screendir"/*."$name" ]; then
318     if [ -e "$serverdir/$name" ]; then
319         # Delete leftover socket (for the wait option)
320         rm "$serverdir/$name"
321     fi
322     screen -dmS "$name" "$emacs" -nw --eval "(setq server-name \"$name\")" -f server-start
324 if [ ! -z "$waitp" ]; then
325     while [ ! -e "$serverdir/$name" ]; do sleep 0.1; done
327 ----------------------------------------------------------------------
329 I have the following in my profile to have two instances automatically
330 preloaded for editing and email:
332         preload-emacs editor
333         preload-emacs gnus
335 It is useful to set up short aliases for connect-emacs.  I use the
336 following:
338         alias edit="connect-emacs editor"
339         alias e=edit
340         alias et="connect-emacs editor -t"
341         alias gnus="connect-emacs gnus"
344 CHANGELOG
345 ---------
347 See arch logs.
350 NEWS
351 ----
353 For the NEWS file:  (Needs much, much work)
355 ** Support for multiple terminal devices and simultaneous graphical
356    and tty frames has been added.  You can test for the presence of
357    this feature in your Lisp code by testing for the `multi-tty'
358    feature.
360 *** The `window-system' variable has been made frame-local. The new
361     `initial-window-system' variable contains the `window-system'
362     value for the first frame.
364 *** You can specify a terminal device (`tty' parameter) and a terminal
365     type (`tty-type' parameter) to `make-terminal-frame'.
367 *** The new function `make-frame-on-tty' allows you to create a new
368     frame on another tty device interactively.
370 *** The function `make-frame-on-display' now works during a tty
371     session, and `make-frame-on-tty' works during a graphical session.
373 *** Emacsclient has been extended to support opening a new terminal
374     frame. Its behaviour has been changed to open a new Emacs frame by
375     default.  Use the -c option to get the old behavior of opening
376     files in the currently selected Emacs frame.
378 *** C-z now invokes `suspend-frame', C-x C-c now invokes
379     `save-buffers-kill-terminal'.
381 *** New functions: frame-tty-name, frame-tty-type, delete-tty,
382     suspend-tty, resume-tty, terminal-id, terminal-parameters,
383     terminal-parameter, set-terminal-parameter,
384     modify-terminal-parameters, environment, let-environment
386 *** New variables: local-key-translation-map, local-function-key-map
388 *** The `keyboard-translate-table' variable and the terminal and
389     keyboard coding systems have been made terminal-local.
391 *** In addition to the global key-translation-map and
392     function-key-map, Emacs has terminal-local
393     local-key-translation-map and local-function-key-map variables,
394     and uses them instead of the global keymaps to set up translations
395     and function key sequences relevant to a specific terminal device.
397 *** talk.el has been extended for multiple tty support.
399 * * *
401 (The rest of this file consists of my development notes and as such it
402 is probably not very interesting for anyone else.)
404 THINGS TO DO
405 ------------
407 ** emacsclient -t on the console does not work after su:
409         # su lorentey
410         $ emacsclient -t
411         *ERROR*: Could not open file: /dev/tty1
413    The tty can be opened as /dev/tty by emacsclient, but not by Emacs.
414    This seems to be a serious problem.  Currently my only idea is to
415    bring back the ugly pty proxy hack from the initial versions of
416    multi-tty.  Suggestions would be appreciated.
418 ** Understand how `quit_throw_to_read_char' works, and fix any bugs
419    that come to light.
421 ** See if getcjmp can be eliminated somehow.  Why does Emacs allow
422    asynchronous input processing while it's reading input anyway?
424 ** `delete-frame' events are handled by `special-event-map'
425    immediately when read by `read_char'.  This is fine but it prevents
426    higher-level keymaps from binding that event to get notified of the
427    deleted frame.
429    Sometimes it would be useful for Lisp code to be notified of frame
430    deletions after they have happened, usually because they want to
431    clean up after the deleted frame.  Not all frame-local states can
432    be stored as a frame parameter.  For example,
433    `display-splash-screen' uses `recursive-edit' with a special keymap
434    override to create its buffer---and it leads to all kinds of
435    nastiness if Emacs stays in this recursive edit mode after the
436    frame containing the splash screen is deleted.  Basically, the
437    splash-screen implementation wants to throw out of the recursive
438    edit when the frame is deleted; however, it is not legal to throw
439    from `delete-frame-functions' because `delete-frame' must not fail.
440    (Introducing `delete-frame-after-functions' would not help either
441    because `delete-frame' may not fail at that time either.)
443    Currently `fancy-splash-screens' installs a
444    `delete-frame-functions' hook that sets up a timer to exit the
445    recursive edit.  This is an adequate solution, but it would perhaps
446    be better to have something like a `frame-deleted' event that could
447    be bound in the normal way.
449 ** Trouble: `setenv' doesn't actually set environment variables in the
450    Emacs process.  This defeats the purpose of the elaborate
451    `server-with-environment' magic around the `tgetent' call in
452    `init_tty'.  D'oh.
454 ** (Possibly) create hooks in struct device for creating frames on a
455    specific terminal, and eliminate the hackish terminal-related frame
456    parameters (display, tty, tty-type).
458         make_terminal_frame
459                 create_tty_output
461 ** Decide whether to keep the C implementation of terminal parameters,
462    or revert to the previous, purely Lisp code.  It turned out that
463    local environments do not need terminal parameters after all.
465 ** Move Fsend_string_to_terminal to term.c, and declare get_named_tty
466    as static, removing it from dispextern.h.
467    Move fatal to emacs.c and declare it somewhere.
469 ** Search for `suspend-emacs' references and replace them with
470    `suspend-frame', if necessary.  Ditto for `save-buffers-kill-emacs'
471    vs. `save-buffers-kill-display'.
473 ** Emacs crashes when a tty frame is resized so that there is no space
474    for all its windows.  (Tom Schutzer-Weissmann)
476 ** Report GTK multi-display problems to GTK maintainers.  For extra
477    credit, fix them.
479    Currently you can not connect to new X displays when you compile
480    Emacs with GTK support.  If you want to play around with GTK
481    multidisplay (and don't mind core dumps), you can edit src/config.h
482    and define HAVE_GTK_MULTIDISPLAY there by hand.
483    
484         http://bugzilla.gnome.org/show_bug.cgi?id=85715
486    Update: Han reports that GTK+ version 2.8.9 almost gets display
487    disconnects right.  GTK will probably be fully fixed by the time
488    multi-tty gets into the trunk.
490    Update: I am still having problems with GTK+ 2.8.10.  I have the
491    impression that the various multidisplay fixes will only get
492    released in GTK+ 2.10.
494 ** Audit `face-valid-attribute-values' usage in customize and
495    elsewhere.  Its return value depends on the current window system.
496    Replace static initializers using it with runtime functions.  For
497    example, custom's buttons are broken on non-initial device types.
499 ** Possibly turn off the double C-g feature when there is an X frame.
500    C.f. (emacs)Emergency Escape.
502 ** frames-on-display-list should also accept frames.
504 ** Consider the `tty-type' frame parameter and the `display-tty-type'
505    function.  They serve the exact same purpose.  I think it may be
506    a good idea to eliminate one of them, preferably `tty-type'.
508 ** The handling of lisp/term/*.el, and frame creation in general, is a
509    big, big mess.  How come the terminal-specific file is loaded by
510    tty-create-frame-with-faces?  I don't think it is necessary to load
511    these files for each frame; once per terminal should be enough.
512    Update: lisp/term/*.el is not loaded repeatedly anymore, but
513    faces.el still needs to be cleaned up.
515 ** Fix frame-set-background-mode in this branch.  It was recently
516    changed in CVS, and frame.el in multi-tty has not yet been adapted
517    for the changes.  (It needs to look at
518    default-frame-background-mode.)  (Update: maybe it is fixed now;
519    needs testing.) (Note that the byte compiler has this to say about
520    term/rxvt.el:)
522         term/rxvt.el:309:17:Warning: assignment to free variable
523             `default-frame-background-mode'
525 ** I think `(set-)terminal-local-value' and the terminal parameter
526    mechanism should be integrated into a single framework.
528    (Update: `(set-)terminal-local-value' is now eliminated, but the
529    terminal-local variables should still be accessible as terminal
530    parameters.  This also applies to `display-name' and similar
531    functions.)
533 ** Add the following hooks: after-delete-frame-hook (for server.el,
534    instead of delete-frame-functions),
535    after-delete-terminal-functions, after-create-terminal-functions.
537 ** BULK RENAME: The `display-' prefix of new Lisp-level functions
538    conflicts with stuff like `display-time-mode'.  Use `device-'
539    or `terminal-' instead.  I think I prefer `terminal-'.
541    It turns out that most of the offending Lisp functions were defined
542    in the trunk.  Therefore, compatibility aliases should be defined
543    for the following names:
545     display-color-cells                 terminal-color-cells
546     display-color-p                     terminal-color-p
547     display-graphic-p                   terminal-graphic-p
548     display-grayscale-p                 terminal-grayscale-p
549     display-images-p                    terminal-images-p
550     display-mm-height                   terminal-mm-height
551     display-mm-width                    terminal-mm-width
552     display-mouse-p                     terminal-mouse-p
553     display-multi-font-p                terminal-multi-font-p
554     display-multi-frame-p               terminal-multi-frame-p
555     display-pixel-height                terminal-pixel-height
556     display-pixel-width                 terminal-pixel-width
557     display-pixels-per-inch             terminal-pixels-per-inch
558     display-planes                      terminal-planes
559     display-popup-menus-p               terminal-popup-menus-p
560     display-save-under                  terminal-save-under
561     display-screens                     terminal-screens
562     display-supports-face-attributes-p  terminal-supports-face-attributes-p
563     display-visual-class                terminal-visual-class
564     framep-on-display                   framep-on-terminal
565     frames-on-display-list              frames-on-terminal-list
567    The following functions were introduced in the multi-tty branch, and
568    were renamed without aliases:
570     delete-display                      delete-terminal
571     display-controlling-tty-p           controlling-tty-p
572     display-list                        terminal-list
573     display-live-p                      terminal-live-p
574     display-name                        terminal-name
575     display-tty-type                    tty-type
576     frame-display                       frame-terminal
577     selected-display                    selected-terminal
579 ** The single-keyboard mode of MULTI_KBOARD is extremely confusing
580    sometimes; Emacs does not respond to stimuli from other keyboards.
581    At least a beep or a message would be important, if the single-mode
582    is still required to prevent interference.  (Reported by Dan
583    Nicolaescu.)  
585    Update: selecting a region with the mouse enables single_kboard
586    under X.  This is very confusing.
588    Update: After discussions with Richard Stallman, this will be
589    resolved by having locked displays warn the user to wait, and
590    introducing a complex protocol to remotely bail out of
591    single-kboard mode by pressing C-g.
593    Update: Warning the user is not trivial to implement, as Emacs has
594    only one echo area, shared by all frames.  Ideally the warning
595    should not be displayed on the display that is locking the others.
596    Perhaps the high probability of user confusion caused by
597    single_kboard mode deserves a special case in the display code.
598    Alternatively, it might be good enough to signal single_kboard mode
599    by changing the modelines or some other frame-local display element
600    on the locked out displays.
602    Update: In fact struct kboard does have an echo_string slot.
604 ** The session management module is prone to crashes when the X
605    connection is closed and then later I try to connect to a new X
606    session:
608         #0  0xb7ebc806 in SmcGetIceConnection () from /usr/X11R6/lib/libSM.so.6
609         #1  0x080e6641 in x_session_check_input (bufp=0xbf86c9c0) at xsmfns.c:144
610         #2  0x080d3bbc in XTread_socket (device=0xa722ff8, expected=1, hold_quit=0xbf86ca90) at xterm.c:7037
611         #3  0x080fa404 in read_avail_input (expected=1) at keyboard.c:6696
612         #4  0x080fa4ca in handle_async_input () at keyboard.c:6900
613         #5  0x080d51fa in x_term_init (display_name=162628899, xrm_option=0x0, resource_name=0x857068c "emacs") at xterm.c:10622
614         #6  0x080d920e in x_display_info_for_name (name=162628899) at xfns.c:3975
615         #7  0x080d92f9 in check_x_display_info (object=1) at xfns.c:274
616         #8  0x080d97b8 in Fx_create_frame (parms=151221485) at xfns.c:3016
617         #9  0x0815bf72 in Ffuncall (nargs=2, args=0xbf86ceec) at eval.c:2851
619    I installed a workaround to prevent this.  The X session manager is
620    only contacted when the very first display in the Emacs session is
621    an X display.  Also, x_delete_display() on this display aborts
622    session management, and XTread_socket only calls
623    x_session_check_input when it is called for the display that the
624    session was opened on.  While this does not really fix the bug, it
625    makes it much less frequent, because session manager support will
626    not normally be enabled when Emacs can survive the shutdown of the
627    X server.
629    See if xsmfns.c should be updated.
631 ** Hunt down display-related functions in frame.el and extend them all
632    to accept display ids.
634 ** rif->flush_display_optional (NULL) calls should be replaced by a
635    new global function.
637 ** The set-locale-environment hack (adding the DISPLAY option) should
638    be replaced with a clean design.
640 ** standard-display-table should be display-local.
641    standard-display-european should be display-local.
643 ** With iswitchb-default-method set to 'always-frame, only frames on
644    the current display should be considered.  This might involve
645    extending `get-buffer-window'.
647 ** Have a look at Vlocale_coding_system.  Seems like it would be a
648    tedious job to localize it, although most references use it for
649    interfacing with libc and are therefore OK with the global
650    definition.
652    Exceptions found so far: x-select-text and
653    x-cut-buffer-or-selection-value.
655 ** Have a look at fatal_error_hook.
657 ** Have a look at set_frame_matrix_frame.
659 ** Check if we got term-setup-hook right.
661 ** I think tip_frame should be display-local.
663 ** Check display reference count handling in x_create_tip_frame.
665 ** make-frame does not correctly handle extra parameters in its
666    argument:
668         (frame-parameter (make-frame (list (cons 'foobar 42))) 'foobar)
669                 => nil
671    (This is likely an error in the CVS trunk.)
673 ** Dan Nicolaescu suggests that -nw should be added as an alias for -t
674    in emacsclient.  Good idea.  (Alas, implementing this is not
675    trivial, getopt_long does not seem to support two-letter ``short''
676    options.  Patches are welcome.)
678 ** Mark Plaksin suggests that emacsclient should accept the same
679    X-related command-line arguments as Emacs.  Most of the X-related
680    argument-handling is done in Lisp, so this should be quite easy to
681    implement.
683 ** Gergely Nagy suggests that C-x # should only kill the current
684    frame, not any other emacsclient frame that may have the same file
685    opened for editing.  I think I agree with him.
687 ** Very strange bug: visible-bell does not work on secondary
688    terminals in xterm and konsole.  The screen does flicker a bit,
689    but it's so quick it isn't noticable.
691    (Update: This is probably some problem with padding or whatnot on
692    the secondary terminals.)
694 ** Move baud_rate to struct display.
696 ** Implement support for starting an interactive Emacs session without
697    an initial frame.  (The user would connect to it and open frames
698    later, with emacsclient.)
700 ** Fix Mac support (I can't do this entirely myself).  Note that the
701    current state of Mac-specific source files in the multi-tty tree
702    are not useful; before starting work on Mac support, revert to
703    pristine, pre-multi-tty versions.
705 ** Fix W32 support (I can't do this entirely myself).  Note that the
706    current state of W32-specific source files in the multi-tty tree
707    are not useful; before starting work on W32 support, revert to
708    pristine, pre-multi-tty versions.
710 ** Fix DOS support (I can't do this entirely myself).  Note that the
711    current state of DOS-specific source files in the multi-tty tree
712    are not useful; before starting work on DOS support, revert to
713    pristine, pre-multi-tty versions.
715 ** Do a grep on XXX and ?? for more issues.
717 ** flow-ctrl.el must be updated.
719 ** Fix stuff_char for multi-tty.  Doesn't seem to be of high priority.
721 DIARY OF CHANGES
722 ----------------
724 (ex-TODO items with explanations.)
726 -- Introduce a new struct for terminal devices.
728    (Done, see struct tty_output.  The list of members is not yet
729    complete.)
731 -- Change the bootstrap procedure to initialize tty_list.
733    (Done, but needs review.)
735 -- Change make-terminal-frame to support specifying another tty.
737    (Done, new frame parameters: `tty' and `tty-type'.)
739 -- Implement support for reading from multiple terminals.
741    (Done, read_avail_input tries to read from each terminal, until one
742    succeeds.  MULTI_KBOARD is not used.  Secondary terminals don't send
743    SIGIO!)
745    (Update: They do, now.)
747    (Update2: After enabling X, they don't.)
749 -- other-frame should cycle through the frames on the `current'
750    terminal only.
752    (Done, by trivially modifiying next_frame and prev_frame.)
754 -- Support different terminal sizes.
756    (Done, no problem.)
758 -- Make sure terminal resizes are handled gracefully.  (Could be
759    problematic.)
761    (Done.  We don't get automatic SIGWINCH for additional ttys,
762    though.)
764 -- Extend emacsclient to automatically open a new tty when it connects
765    to Emacs.
767    (Done.  It's an ugly hack, needs more work.)
769 -- Redisplay must refresh the topmost frame on *all* terminals, not
770    just the initial terminal.
772    (Done, but introduced an ugly redisplay problems.  Ugh.)
774 -- Fix redisplay problems.
776    (Done; it turned out that the entire Wcm structure must be moved
777    inside tty_output.  Why didn't I catch this earlier?)
779 -- Provide a way for emacsclient to tell Emacs that the tty has been
780    resized.
782    (Done, simply forward the SIGWINCH signal.)
784 -- Each keypress should automatically select the frame corresponding
785    to the terminal that it was coming from.  This means that Emacs
786    must know from which terminal the last keyboard event came from.
788    (Done, it was quite simple, the input event system already
789    supported multiple frames.)
791 -- Fix SIGIO issue with secondary terminals.
793    (Done, emacsclient signals Emacs after writing to the proxy pseudo
794    terminal.  Note that this means that multi-tty does not work with
795    raw ttys!)
797    (Update: This is bullshit.  There is a read_input_waiting function,
798    extend that somehow.)
800    (Update of update: The first update was not right either, extending
801    read_input_waiting was not necessary.  Secondary ttys do seem to
802    send signals on input.)
804    (Update^3: Not any more.)
806 -- Make make-terminal-frame look up the `tty' and `tty-type' frame
807    parameters from the currently selected terminal before the global
808    default.
810    (Done.)
812 -- Put all cached terminal escape sequences into struct tty_output.
813    Currently, they are still stored in global variables, so we don't
814    really support multiple terminal types.
816    (Done.  It was not fun.)
818 -- Implement sane error handling after initialization.  (Currently
819    emacs exits if you specify a bad terminal type.)  The helpful error
820    messages must still be provided when Emacs starts.
822    (Done.)
824 -- Implement terminal deletion, i.e., deleting local frames, closing
825    the tty device and restoring its previous state without exiting
826    Emacs.
828    (Done, but at the moment only called when an error happens during
829    initialization.  There is a memory corruption error around this
830    somewhere.)  (Update: now it is fully enabled.)
832 -- Implement automatic deletion of terminals when the last frame on
833    that terminal is closed.
835    (Done.)
837 -- Restore tty screen after closing the terminal.
839    (Done, we do the same as Emacs 21.2 for all terminals.)
841 -- 'TERM=dumb src/emacs' does not restore the terminal state.
843    (Done.)
845 -- C-g should work on secondary terminals.
847    (Done, but the binding is not configurable.)
849 -- Deal with SIGHUP in Emacs and in emacsclient.  (After this, the
850    server-frames may be removed from server.el.)
852    (Done, nothing to do.  It seems that Emacs does not receive SIGHUP
853    from secondary ttys, which is actually a good thing.)  (Update: I
854    think it would be a bad idea to remove server-frames.)
856 -- Change emacsclient/server.el to support the -t argument better,
857    i.e. automatically close the socket when the frame is closed.
859    (Seems to be working OK.)
861 -- Fix mysterious memory corruption error with tty deletion.  To
862    trigger it, try the following shell command:
864         while true; do TERM=no-such-terminal-definition emacsclient -h; done
866    Emacs usually dumps core after a few dozen iterations.  (The bug
867    seems to be related to the xfreeing or bzeroing of
868    tty_output.Wcm.  Maybe there are outside references to struct Wcm?
869    Why were these vars collected into a struct before multi-tty
870    support?)
872    (Done.  Whew.  It turned out that the problem had nothing to do
873    with hypothetical external references to Wcm, or any other
874    tty_output component; it was simply that delete_tty closed the
875    filehandles of secondary ttys twice, resulting in fclose doubly
876    freeing memory.  Utterly trivial matter.  I love the C's memory
877    management, it puts hair on your chest.)
879 -- Support raw secondary terminals.  (Note that SIGIO works only on
880    the controlling terminal.) Hint: extend read_input_waiting for
881    multiple ttys and hopefully this will be fixed.
883    (Done, it seems to have been working already for some time.  It
884    seems F_SETOWN does work, after all.  Not sure what made it fail
885    earlier, but it seems to be fixed (there were several changes
886    around request_sigio, maybe one of them did it).
887    read_input_waiting is only used in sys_select, don't change
888    it.)  (Update: After adding X support, it's broken again.)
889    (Update^2: No it isn't.) :-)
891 -- Find out why does Emacs abort when it wants to close its
892    controlling tty.  Hint: chan_process[] array.  Hey, maybe
893    noninterrupt-IO would work, too?  Update: no, there is no process
894    for stdin/out.
896    (Done.  Added add/delete_keyboard_wait_descriptor to
897    term_init/delete_tty.  The hint was right, in a way.)
899 -- Issue with SIGIO: it needs to be disabled during redisplay.  See if
900    fcntl kernel behaviour could be emulated by emacsclient.
902    (Done.  Simply disabled the SIGIO emulation hack in emacsclient.)
903    (Update: it was added back.)  (Update^2: and removed again.)
905 -- server.el: There are issues with saving files in buffers of closed
906    clients.  Try editing a file with emacsclient -f, and (without
907    saving it) do a delete-frame.  The frame is closed without
908    question, and a surprising confirmation prompt appears in another
909    frame.
911    (Done.  delete-frame now asks for confirmation if it still has
912    pending buffers, and modified buffers don't seem to be deleted.)
914 -- emacsclient.el, server.el: Handle eval or file open errors when
915    doing -t.
917    (Done.)
919 -- Make parts of struct tty_output accessible from Lisp.  The device
920    name and the type is sufficient.
922    (Done, see frame-tty-name and frame-tty-type.)
924 -- Export delete_tty to the Lisp environment, for emacsclient.
926    (Done, see delete-tty.)
928 -- Get rid of the accessor macros in termchar.h, or define macros for
929    all members.
931    (Done.)
933 -- Move device-specific parameters (like costs) commonly used by
934    device backends to a common, device-dependent structure.
936    (Done.  See struct display_method in termhooks.h.)
938 -- Fix X support.
940    (Done.  Well, it seems to be working.)
942 -- Allow simultaneous X and tty frames.  (Handling input could be
943    tricky.  Or maybe not.)
945    (Done.  Allowed, that is.  It is currently extremely unstable, to
946    the point of being unusable.  The rif variable causes constant
947    core dumps.  Handling input is indeed tricky.)
949 -- Rewrite multi-tty input in terms of MULTI_KBOARD.
951    (Done.  In fact, there was no need to rewrite anything, I just
952    added a kboard member to tty_display_info, and initialized the
953    frame's kboard from there.)
955 -- Fix rif issue with X-tty combo sessions.  IMHO the best thing to do
956    is to get rid of that global variable (and use the value value in
957    display_method, which is guaranteed to be correct).
959    (Done, did exactly that.  Core dumps during combo sessions became
960    much rarer.  In fact, I have not yet met a single one.)
962 -- Add multi-tty support to talk.el.
964    (Done.)
966 -- Clean up the source of emacsclient.  It is a mess.
968    (Done, eliminated stupid proxy-pty kludge.)
970 -- Fix faces on tty frames during X-tty combo sessions.  There is an
971    init_frame_faces call in init_sys_modes, see if there is a problem
972    with it.
974    (Done, there was a stupid mistake in
975    Ftty_supports_face_attributes_p. Colors are broken, though.)
977 -- C-x 5 2, C-x 5 o, C-x 5 0 on an emacsclient frame unexpectedly
978    exits emacsclient.  This is a result of trying to be clever with
979    delete-frame-functions.
981    (Fixed, added delete-tty-after-functions, and changed server.el to
982    use it.)
984 -- Something with (maybe) multi-keyboard support broke function keys
985    and arrows on ttys during X+tty combo sessions.  Debug this.
987    (I can't reproduce it, maybe the terminal type was wrong.)
989 -- Fix input from raw ttys (again).
991    (Now it seems to work all right.)
993 -- During an X-tty combo session, a (message "Hello") from a tty frame
994    goes to the X frame.  Fix this.
996    (Done.  There was a safeguard against writing to the initial
997    terminal frame during bootstrap which prevented echo_area_display
998    from working correctly on a tty frame during a combo session.)
1000 -- If there are no frames on its controlling terminal, Emacs should
1001    exit if the user presses C-c there.
1003    (Done, as far as possible.  See the SIGTERM comment in
1004    interrupt_signal on why this seems to be impossible to solve this
1005    in general.)
1007 -- During an X session, Emacs seems to read from stdin.  Also, Emacs
1008    fails to start without a controlling tty.
1010    (Fixed by replacing the troublesome termcap display with a dummy
1011    bootstrap display during bootstrap.
1013 -- Do tty output through struct display, like graphical display
1014    backends.
1016    (Done.)
1018 -- Define an output_initial value for output_method for the initial
1019    frame that is dumped with Emacs.  Checking for this frame (e.g. in
1020    cmd_error_internal) is ugly.
1022    (Done, breaking interactive temacs.)
1024 -- The command `emacsclient -t -e '(delete-frame)'' fails to exit.
1026    (Fixed.)
1028 -- frame-creation-function should always create a frame that is on the
1029    same display as the selected frame.  Maybe frame-creation-function
1030    should simply be removed and make-frame changed to do the right
1031    thing.
1033    (Done, with a nice hack.  frame-creation-function is now frame-local.)
1035 -- Fix C-g on raw ttys.
1037    (Done.  I disabled the interrupt/quit keys on all secondary
1038    terminals, so Emacs sees C-g as normal input.  This looks like an
1039    overkill, because emacsclient has extra code to pass SIGINT to
1040    Emacs, so C-g should remain the interrupt/quit key on emacsclient
1041    frames.  See the next entry why implementing this distinction would
1042    be a bad idea.)
1044 -- Make sure C-g goes to the right frame with ttys.  This is hard, as
1045    SIGINT doesn't have a tty parameter. :-(
1047    (Done, the previous change fixes this as a pleasant side effect.)
1049 -- I have seen a case when Emacs with multiple ttys fell into a loop
1050    eating 100% of CPU time.  Strace showed this loop:
1052         getpid()                                = 30284
1053         kill(30284, SIGIO)                      = 0
1054         --- SIGIO (I/O possible) @ 0 (0) ---
1055         ioctl(6, FIONREAD, [0])                 = -1 EIO (Input/output error)
1056         ioctl(5, FIONREAD, [0])                 = -1 EIO (Input/output error)
1057         ioctl(0, FIONREAD, [0])                 = 0
1058         sigreturn()                             = ? (mask now [])
1059         gettimeofday({1072842297, 747760}, NULL) = 0
1060         gettimeofday({1072842297, 747806}, NULL) = 0
1061         select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
1062         select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
1063         gettimeofday({1072842297, 748245}, NULL) = 0
1065    I have seen something similar with a single X frame, but have not
1066    been able to reproduce it for debugging.
1068    Update: This may have been caused by checking for nread != 0
1069    instead of nread > 0 after calling read_socket_hook in
1070    read_avail_input.
1072    (Fixed.  This was caused by unconditionally including stdin in
1073    input_wait_mask in init_process.  The select call in
1074    wait_reading_process_input always returned immediately, indicating
1075    that there is pending input from stdin, which nobody read.
1077    Note that the above strace output seems to be an unrelated but
1078    similar bug.  I think that is now fixed.)
1080 -- Exiting Emacs while there are emacsclient frames doesn't restore the
1081    ttys to their default states.
1083    (This seems to be fixed by some previous change.)
1085 -- Allow opening an X session after -nw.
1087    (Done.)
1089 -- Fix color handling during tty+X combo sessions.  (It seems that tty
1090    sessions automatically convert the face colors to terminal colors
1091    when the face is loaded.  This conversion must happen instead on
1092    the fly in write_glyphs, which might be problematic, as color
1093    approximation is currently done in lisp (term/tty-colors.el).)
1094    (Update: hm, colors seem to work fine if I start emacs with -nw and
1095    then create an X frame.  Maybe it's just a small buglet somewhere.)
1097    (Seems to be fixed.  The problem was in startup.el, it did not
1098    initialize tty colors when the initial window system was
1099    graphical.)
1101 -- emacs -nw --eval '(y-or-n-p "Foobar")' segfaults.  (Reported by
1102    Romain Francoise)
1104    (Fixed, there was a keyboard initialization problem.)
1106 -- Fix interactive use of temacs.  There are face-related SEGVs, most
1107    likely because of changes in realize_default_face, realize_face.
1109    (Fixed.)
1111 -- Don't exit Emacs when the last X connection fails during a
1112    multi-display session.
1114    (Fixed.)
1116 -- Dan Nicolaescu noticed that starting emacsclient on the same
1117    terminal device that is the controlling tty of the Emacs process
1118    gives unexpected results.
1120    (Fixed.)
1122 -- Istvan Marko reported that Emacs hang on ttys if it was started
1123    from a shell script.
1125    (Fixed.  There was a bug in the multi-tty version of
1126    narrow_foreground_group.  tcsetpgrp blocks if it is called from a
1127    process that is not in the same process group as the tty.)
1129 -- emacsclient -t from an Emacs term buffer does not work, complains
1130    about face problems.  This can even lock up Emacs (if the recursive
1131    frame sets single_kboard).  Update: the face problems are caused by
1132    bugs in term.el, not in multi-tty.  The lockup is caused by
1133    single_kboard mode, and is not easily resolvable.  The best thing to
1134    do is to simply refuse to create a tty frame of type `eterm'.
1136    (Fixed, changed emacsclient to check for TERM=eterm.  The face
1137    complaints seem to be caused by bugs in term.el; they are not
1138    related to multi-tty.)
1140 -- Find out the best way to support suspending Emacs with multiple
1141    ttys.  My guess: disable it on the controlling tty, but from other
1142    ttys pass it on to emacsclient somehow.  (It is (I hope) trivial to
1143    extend emacsclient to handle suspend/resume.  A `kill -STOP' almost
1144    works right now.)
1146    (Done.  I needed to play with signal handling and the server
1147    protocol a bit to make emacsclient behave as a normal UNIX program
1148    wrt foreground/background process groups.)
1150 -- There is a flicker during the startup of `emacs -nw'; it's as if
1151    the terminal is initialized, reset and then initialialized again.
1152    Debug this.  (Hint: narrow_foreground_group is called twice during
1153    startup.)
1155    (This is gone.)
1157 -- Robert Chassell has found serious copy-paste bugs with the
1158    multi-tty branch.  There seem to be redisplay bugs while copying
1159    from X to a terminal frame.  Copying accented characters do not
1160    work for me.
1162    (Patch-124 should fix this, by changing the interprogram-*-function
1163    variables to be frame-local, as suggested by Mark Plaksin
1164    (thanks!).  I think that the redisplay bugs are in fact not bugs,
1165    but delays caused by single_kboard --> perhaps MULTI_KBOARD should
1166    be removed.)
1168 -- frame-creation-function was removed, which might be a bad idea.
1169    Think up a compatible solution.
1171    (It was an internal interface that may be changed when necessary.)
1173 -- Change Lisp code not to (getenv "TERM"); use the `tty-type' frame
1174    parameter or the frame-tty-type function instead.  (M-x tags-search
1175    "TERM" helps with this.)  Update: Actually, all getenv invocations
1176    should be checked for multi-tty compatibility, and an interface
1177    must be implemented to get the remote client's environment.
1179    (Done.  Only getenv calls in lisp/term/*.el were changed; other
1180    calls should be mostly left as they are.)
1182 -- Add an elaborate mechanism for display-local variables.  (There are
1183    already a few of these; search for `terminal-local' in the Elisp
1184    manual.)
1186    (Not needed.  Display-local variables could be emulated by
1187    frame-local variables.)
1189 -- Emacs assumes that all terminal frames have the same locale
1190    settings as Emacs itself.  This may lead to bogus results in a
1191    multi-locale setup. (E.g., while logging in from a remote client
1192    with a different locale.)
1193    (Update after new bugreport by Friedrich Delgado Friedrichs: 
1194    (at least) the structs terminal_coding and keyboard_coding in
1195    coding.c must be moved to struct display, and the Lisp interface
1196    [set-]keyboard-coding-system must be adapted for the change.)
1198    (Fixed.  Emacs now uses the locale settings as seen by the
1199    emacsclient process for server tty frames.)
1200    (Update: Not really; Vlocale_coding_system is still global.)
1202 -- Make `struct display' accessible to Lisp programs.  Accessor functions:
1204         (displayp OBJECT):  Returns t if OBJECT is a display.
1205                 => Implemented as display-live-p.
1207         (display-list):  Returns list of currently active displays.
1208                 => Implemented.
1210         (selected-display):  Returns the display object of the selected frame.
1211                 => Not strictly necessary, but implemented anyway.
1213         (frame-display FRAME):  Returns the display object of FRAME.
1214                 => Implemented.
1216         (display-frames DISPLAY):  Returns a list of frames on DISPLAY.
1217                 => Already implemented, see frames-on-display-list.
1219         (display-type DISPLAY):  Returns the type of DISPLAY, as a
1220                 symbol.  (See `framep'.)
1221                 => Implemented as display-live-p.
1223         (display-device DISPLAY): Returns the name of the device that
1224                 DISPLAY uses, as a string.  (E.g: "/dev/pts/16", or
1225                 ":0.0")
1226                 => Implemented as display-name.
1228         etc.
1230    See next issue why this is necessary.
1232    (Update: The consensus on emacs-devel seems to be to do this via
1233    integer identifiers.  That's fine by me.)
1235    (Done.)
1237 -- The following needs to be supported:
1239         $ emacsclient -t
1240                 C-z
1241         $ emacsclient -t
1242                 (This fails now.)
1244    The cleanest way to solve this is to allow multiple displays on the
1245    same terminal device; each new emacsclient process should create
1246    its own display.  As displays are currently identified by their
1247    device names, this is not possible until struct display becomes
1248    accessible as a Lisp-level object.
1250    (Done.)
1252 -- Miles Bader suggests that C-x C-c on an emacsclient frame should
1253    only close the frame, not exit the entire Emacs session.  Update:
1254    see above for a function that does this.  Maybe this should be the
1255    new default?  
1257    (Done.  This is the new default.  No complaints so far.)
1259 -- Clean up the frame-local variable system.  I think it's ugly and
1260    error-prone.  But maybe I just haven't yet fully understood it.
1262    (Nothing to do.  It doesn't seem ugly any more.  It's rather clever.)
1264 -- Support multiple character locales.  A version of
1265    `set-locale-environment' needs to be written for setting up
1266    display-local settings on ttys.  I think calling
1267    set-display-table-and-terminal-coding-system and
1268    set-keyboard-coding-system would be enough.  The language
1269    environment itself should remain a global setting.
1271    (Done, by an ugly hack.)
1273 -- The terminal customization files in term/*.el tend to change global
1274    parameters, which may confuse Emacs with multiple displays.  Change
1275    them to tweak only frame-local settings, if possible.  (They tend
1276    to call define-key to set function key sequences a lot.)
1278    (Done, by making `function-key-map' terminal-local (i.e., part of
1279    struct kboard).  This has probably covered all the remaining problems.)
1281 -- Make `function-key-map' and `key-translation-map' terminal-local.
1283    (Done.)
1285 -- Implement `terminal-local-value' and `set-terminal-local-value' to
1286    allow deterministic access to terminal local bindings.  The
1287    encode-kb package can not set up `key-translation-map' without
1288    these.  The terminal-local bindings seem to be independent of what
1289    frame is selected.
1291    (Done.)
1293 -- xt-mouse.el needs to be adapted for multi-tty.  It currently
1294    signals an error on kill-emacs under X, which prevents the user
1295    from exiting Emacs. (Reported by Mnemonikk on freenode.)
1297    (Done, I hope.)
1298    
1300 -- Having {reset,init}_all_sys_modes in set-input-mode breaks arrow
1301    keys on non-selected terminals under screen, and sometimes on other
1302    terminal types as well.  The other function keys continue to work
1303    fine.  Sometimes faces on these screens become garbled.
1305    This only seems to affect displays that are of the same terminfo
1306    type as the selected one. Interestingly, in screen Emacs normally
1307    reports the up arrow key as `M-o A', but after the above SNAFU, it
1308    complains about `M-[ a'.  UNIX ttys are a complete mystery to me,
1309    but it seems the reset-reinitialize cycle somehow leaves the
1310    non-selected terminals in a different state than usual.  I have no
1311    idea how this could happen.
1313    Currently set-input-mode resets only the currently selected
1314    terminal, which seems to somehow work around the problem.
1316    Update:
1318         Dan Nicolaescu <dann@ics.uci.edu> writes:
1319         > Some terminals have 2 modes for cursor keys: Application Mode where
1320         > the cursor keys transmit the codes defined in the terminfo entry, and
1321         > Cursor mode. Applications have to send the smkx and rmkx terminfo
1322         > strings to switch between the 2 modes. So Emacs (and emacsclient) have
1323         > to send smkx when initializing and rmkx when quitting (or on
1324         > suspend). 
1326    (I think patch-370 fixed this.)
1328 -- This long-standing bug (first reported by Han Boetes) seems to come
1329    and go all the time.  It is time to track it down and fix it.
1331         emacs
1332                 M-x server-start
1333         
1334         # From another xterm:
1335         emacsclient -e '(y-or-n-p "Do you want me to crash? ")'
1336                 # Notice how the answer ends up in the *scratch* buffer
1337                 M-x garbage-collect
1338                 SIGSEGV
1340    (Fixed in patch-414 after detailed analysis by Kalle Olavi Niemitalo.)
1342 -- normal-erase-is-backspace-mode in simple.el needs to be updated for
1343    multi-tty (rep. by Dan Waber).  (The Delete key is broken on X
1344    because of this.)
1346    (Fixed in patch-427.)
1348 -- I think keyboard-translate-table should be made terminal-local.
1350    (Done in patch-431.)
1352 -- The semantics of terminal-local variables are confusing; it is not
1353    clear what binding is in effect in any given time.  See if
1354    current_kboard (or at least the terminal-local bindings exported to
1355    Lisp) might be changed to be tied to the selected frame instead.
1356    Currently, `function-key-map' and `key-translation-map' may be
1357    accessed reliably only using the hackish
1358    `(set-)terminal-local-value' functions.
1360    Perhaps there should be a difference between `last-command' &co.
1361    and these more conventional configuration variables.
1362    (E.g. `symbol-value' would use current_kboard to access
1363    `last-command', but SELECTED_FRAME()->display->kboard to get the
1364    value of `function-key-map'.
1366    (Fixed in patch-434.)
1368 -- If the first key pressed on a new tty terminal is a function key,
1369    it is not recognized correctly.  May be related to the bug below.
1371    (Seems to have been fixed as a side effect of patch-434.  "The bug
1372    below" was the set-input-mode madness.)  
1374    (Update: this bug was fixed for good in patch-449.  It was tracked
1375    down to a bug in `read_key_sequence': it failed to reinitialize its
1376    local function-key-map/key-translation-map references when it
1377    switched keyboards.  I don't understand why did this bug only
1378    appear on brand new frames, though!)
1380 -- Disable connecting to a new X display when we use the GTK toolkit.
1382    (Disabled in patch-450.)
1384 -- Implement automatic forwarding of client environment variables to
1385    forked processes, as discussed on the multi-tty list.  Terminal
1386    parameters are now accessible in C code, so the biggest obstacle is
1387    gone.  The `getenv_internal' and `child_setup' functions in
1388    callproc.c must be changed to support the following variable:
1390         terminal-local-environment-variables is a variable defined in ...
1392         Enable or disable terminal-local environment variables.
1394         If set to t, `getenv', `setenv' and subprocess creation
1395         functions use the environment variables of the emacsclient
1396         process that created the selected frame, ignoring
1397         `process-environment'.
1399         If set to nil, Emacs uses `process-environment' and ignores
1400         the client environment.
1402         Otherwise, `terminal-local-environment-variables' should be a
1403         list of variable names (represented by Lisp strings) to look
1404         up in the client environment.  The rest will come from
1405         `process-environment'.
1407    (Implemented in patch-461; `terminal-getenv', `terminal-setenv' and
1408    `with-terminal-environment' are now replaced by extensions to
1409    `getenv' and `setenv', and the new `local-environment-variables'
1410    facility.  Yay!)
1412    (Updated in patch-465 to fix the semantics of let-binding
1413    `process-environment'.  `process-environment' was changed to
1414    override all local/global environment variables, and a new variable
1415    `global-environment' was introduced to have `process-environment's
1416    old meaning.)
1418    (Updated in patch-466 to fix the case when two emacsclient sessions
1419    share the same terminal, but have different environment.  The local
1420    environment lists are now stored as frame parameters, so the
1421    C-level terminal parameters are not strictly necessary any more.)
1423 -- `Fdelete_frame' is called from various critical places where it is
1424    not acceptable for the frame deletion to fail, e.g. from
1425    x_connection_closed after an X error.  `Fdelete_frame' now protects
1426    against `delete-frame-functions' throwing an error and preventing a
1427    frame delete. (patch-475)
1429 -- Fix set-input-mode for multi-tty.  It's a truly horrible interface;
1430    what if we'd blow it up into several separate functions (with a
1431    compatibility definition)?
1433    (Done.  See `set-input-interrupt-mode', `set-output-flow-control',
1434    `set-input-meta-mode' and `set-quit-char'.) (patch-457)
1436 -- Let-binding `overriding-terminal-local-map' on a brand new frame
1437    does not seem to work correctly.  (See `fancy-splash-screens'.)
1438    The keymap seems to be set up right, but events go to another
1439    terminal.  Or is it `unread-command-events' that gets Emacs
1440    confused?  Investigate.
1442    (Emacs was confused because a process filter entered
1443    `recursive-edit' while Emacs was reading input.  I added support
1444    for this in the input system.) (patch-489)
1446 -- I smell something funny around pop_kboard's "deleted kboard" case.
1447    Determine what are the circumstances of this case, and fix any
1448    bug that comes to light.
1450    (It happens simply because single_kboard's terminal is sometimes
1451    deleted while executing a command on it, for example the one that
1452    kills the terminal.  There was no bug here, but I rewrote the whole
1453    single_kboard mess anyway.) (patch-489)
1455 -- Understand Emacs's low-level input system (it's black magic) :-)
1456    What exactly does interrupt_input do?  I tried to disable it for
1457    raw secondary tty support, but it does not seem to do anything
1458    useful.  (Update: Look again. X unconditionally enables this, maybe
1459    that's why raw terminal support is broken again.  I really do need
1460    to understand input.)
1461    (Update: I am starting to understand the read_key_sequence->read-char
1462    ->kbd_buffer_get_event->read_avail_input->read_socket_hook path.  Yay!)
1464    (Update: OK, it all seems so easy now (NOT).  Input could be done
1465    synchronously (with wait_reading_process_input), or asynchronously
1466    by SIGIO or polling (SIGALRM).  C-g either sets the Vquit_flag,
1467    signals a 'quit condition (when immediate_quit), or throws to
1468    `getcjmp' when Emacs was waiting for input when the C-g event
1469    arrived.)
1471 -- Replace wrong_kboard_jmpbuf with a special return value of
1472    read_char.  It is absurd that we use setjmp/longjmp just to return
1473    to the immediate caller.
1475    (Done in patch-500.)
1477 -- `tool-bar-mode', `scroll-bar-mode', `menu-bar-mode' and
1478    'fringe-mode' are modes global to the entire Emacs session, not
1479    just a single frame or a single terminal.  This means that their
1480    status sometimes differs from what's actually displayed on the
1481    screen.  As a consequence, the Options | Show/Hide menu sometimes
1482    shows incorrect status, and you have to select an option twice for
1483    it to have any visible effect on the current frame.
1485    Change Emacs so that the status of the items in the Options |
1486    Show/Hide menu correspond to the current frame.
1488    (Done in patch-537.)
1490 ;;; arch-tag: 8da1619e-2e79-41a8-9ac9-a0485daad17d