* server.el (server-process-filter): Likewise.
[bpt/emacs.git] / README.multi-tty
CommitLineData
3224dac1 1 -*- coding: utf-8; mode: text; -*-
28d440ab
KL
2GOAL
3----
4
856dd475
KL
5This branch implements support for opening multiple, different tty
6devices and simultaneous X and tty frames from a single Emacs session.
28d440ab 7
7b00d185 8Some use cases:
7b00d185
KL
9Emacs is notoriously slow at startup, so most people use another
10editor or emacsclient for quick editing jobs from the console.
11Unfortunately, emacsclient was very awkward to use, because it did not
6ed8eeff 12support opening a new Emacs frame on the current virtual tty.
7b00d185
KL
13Now, with multi-tty support, it can do that. (Emacsclient starts up
14faster than vi!)
15
16Some Gnus users (including me) run Gnus in an X frame in its own Emacs
17instance, which they typically leave running for weeks. It would be
18nice if they could connect to this instance from a remote ssh session
19and check their messages without opening a remote X frame or resorting
20to gnus-slave.
21
36ab8612
MB
22THANKS
23------
422f68e0 24
856dd475
KL
25The following is a (sadly incomplete) list of people who have
26contributed to the project by testing, submitting patches, bug
27reports, and suggestions. Thanks!
28
d6805803 29Bernard Adrian <bernadrian@free.fr>
256c9c3a
KL
30ARISAWA Akihiro <ari@mbf.ocn.ne.jp>
31Vincent Bernat <bernat@luffy.cx>
32Han Boetes <han@mijncomputer.nl>
bedeffcf 33Francisco Borges <borges@let.rug.nl>
d6805803 34Damien Cassou <damien.cassou@laposte.net>
256c9c3a
KL
35Robert J. Chassell <bob@rattlesnake.com>
36Romain Francoise <romain@orebokech.com>
37Ami Fischman <ami@fischman.org>
a13f8f50 38Noah Friedman <friedman@splode.com>
256c9c3a 39Friedrich Delgado Friedrichs <friedel@nomaden.org>
6bccb6c5
KL
40Samium Gromoff <_deepfire@mail.ru>
41Mikhail Gusarov <dottedmag@dottedmag.net>
d7a0175d 42Eric Hanchrow <offby1@blarg.net>
256c9c3a
KL
43IRIE Tetsuya <irie@t.email.ne.jp>
44Yoshiaki Kasahara <kasahara@nc.kyushu-u.ac.jp>
45Bas Kok <nekkobassu@yahoo.com>
46Jurej Kubelka <Juraj.Kubelka@email.cz>
47David Lichteblau <david@lichteblau.com>
095fe281 48Richard Lewis <rtf@jabble.com>
911650d2 49mace <mace@kirjakaapeli.lib.hel.fi>
db9d7d9a 50Suresh Madhu <madhu@cs.unm.edu>
256c9c3a
KL
51Xavier Mallard <zedek@gnu-rox.org>
52Istvan Marko <mi-mtty@kismala.com>
53Ted Morse <morse@ciholas.com>
54Gergely Nagy <algernon@debian.org>
55Dan Nicolaescu <dann@ics.uci.edu>
56Kalle Olavi Niemitalo <kon@iki.fi>
57Mark Plaksin <happy@mcplaksin.org>
256c9c3a 58Frank Ruell <stoerte@dreamwarrior.net>
bedeffcf 59Tom Schutzer-Weissmann <trmsw@yahoo.co.uk>
a712a8c3 60Joakim Verona <joakim@verona.se>
256c9c3a 61Dan Waber <dwaber@logolalia.com>
856dd475
KL
62and many others.
63
64Richard Stallman was kind enough to review an earlier version of my
65patches.
66
67
422f68e0
KL
68STATUS
69------
70
71The branch is now very stable and almost full-featured. All of the
72major problems have been fixed, only a few minor issues remain. (It
73still needs to be ported to Windows/Mac/DOS, though.) Both multiple
74tty device support and simultaneous X and tty frame support works
75fine. Emacsclient has been extended to support opening new tty and X
6ed8eeff 76frames. It has been changed to open new Emacs frames by default.
422f68e0
KL
77
78The multi-tty branch has been scheduled for inclusion in the next
779d7de9 79major release of Emacs (version 23). I expect the merge into the
f35ca2fe 80development trunk to occur sometime during next year (2006), after the
422f68e0
KL
81merge of the Unicode branch.
82
90e06c2e
KL
83Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD. Please let me
84know if you succeed or fail to use it on other platforms---I'll have a
85few tricky test cases for you.
422f68e0
KL
86
87Known problems:
88
779d7de9 89 * GTK support. If you compile your Emacs with the GTK
36ab8612
MB
90 toolkit, some functionality of multi-tty may be lost. In
91 particular, you may get crashes while working on multiple X
92 displays at once. Previous releases of GTK had limitations
93 and bugs that prevented full-blown multi-display support in
94 Emacs. (GTK crashed when Emacs tries to disconnect from an
95 X server.) Things are much improved in the current GTK
96 version, but if you do experience crashes in libgtk, try
97 compiling Emacs with the Lucid toolkit instead.
779d7de9 98
856dd475
KL
99 * The single-kboard mode.
100
101 If your multi-tty Emacs session seems to be frozen, you
102 probably have a recursive editing session or a pending
103 minibuffer prompt (which is a kind of recursive editing) on
104 another display. To unfreeze your session, switch to that
105 display and complete the recursive edit, for example by
106 pressing C-] (`abort-recursive-edit').
107
108 I am sorry to say that currently there is no way to break
109 out of this "single-kboard mode" from a frozen display. If
110 you are unable to switch to the display that locks the
111 others (for example because it is on a remote computer),
112 then you can use emacsclient to break out of all recursive
113 editing sessions:
114
115 emacsclient -e '(top-level)'
116
117 Note that this (perhaps) unintuitive behaviour is by design.
118 Single-kboard mode is required because of an intrinsic Emacs
119 limitation that is very hard to eliminate. (This limitation
120 is related to the single-threaded nature of Emacs.)
121
122 I plan to implement better user notification and support for
123 breaking out of single-kboard mode from locked displays.
124
471f1044 125 * Mac and DOS support is broken, doesn't even
856dd475
KL
126 compile. Multiple display support will probably not provide
127 new Emacs features on these systems, but the multi-tty
128 branch changed a few low-level interfaces, and the
129 system-dependent source files need to be adapted
130 accordingly. The changes are mostly trivial, so almost
131 anyone can help, if only by compiling the branch and
f35ca2fe 132 reporting the compiler errors.
856dd475 133
422f68e0 134
422f68e0
KL
135HOW TO GET THE BRANCH
136---------------------
137
36ab8612 138To get the branch, check out the "multi-tty" CVS branch from Emacs CVS.
779d7de9 139
36ab8612 140Alternatively, you can use Bazaar version 1 (not 2) or tla:
779d7de9 141
36ab8612
MB
142 baz register-archive http://arch.sv.gnu.org/archives/emacs
143 baz get emacs@sv.gnu.org/emacs--multi-tty--0 <directory>
779d7de9 144
28d440ab 145
90e06c2e
KL
146COMPILATION
147-----------
0c72d684 148
d03a8fe4 149The multi-tty branch is compiled the same way as Emacs itself:
bc279d67 150
90e06c2e
KL
151 make maintainer-clean # (If you have compiled Emacs before)
152
36ab8612 153 ./configure <your favourite options>
bc279d67 154 make bootstrap
d03a8fe4
KL
155 make install
156
90e06c2e
KL
157If you have strange compilation errors, they may be caused by old
158*.elc files that are left over from an earlier bootstrap. The `make
159maintainer-clean' target deletes them, so it is a good idea to run
160that before reporting a bug. (Emacs requires a clean recompilation
161after certain kinds of source code changes.)
d03a8fe4 162
90e06c2e
KL
163TESTING
164-------
165
166To test the multi-tty branch, start up the Emacs server with the
d03a8fe4
KL
167following commands:
168
169 emacs
7b00d185 170 M-x server-start
bc279d67 171
7b00d185
KL
172and then (from a shell prompt on another terminal) start emacsclient
173with
d03a8fe4
KL
174 emacsclient -t /optional/file/names... (for a tty frame)
175 emacsclient /optional/file/names... (for an X frame)
28d440ab 176
d03a8fe4 177(Make sure both emacs and emacsclient are multi-tty versions.)
04c3243c 178You'll hopefully have two fully working, independent frames on
7b00d185 179separate terminals. The new frame is closed automatically when you
2a0c7b06
KL
180finish editing the specified files (C-x #), but delete-frame (C-x 5 0)
181also works. Of course, you can create frames on more than two tty
182devices.
52c2ee2a 183
f35ca2fe 184Creating new frames on the same tty with C-x 5 2 (make-frame-command)
6ed8eeff
KL
185works, and behaves the same way as in previous Emacs versions. If you
186exit emacs, all terminals should be restored to their previous states.
daf01701 187
856dd475
KL
188This is work in progress, and probably full of bugs. It is a good
189idea to run emacs from gdb, so that you'll have a live instance to
36ab8612
MB
190debug if something goes wrong. Please send your bug reports to
191emacs-devel@gnu.org. Please don't forget to mention that you are
192using the multi-tty branch.
04c3243c 193
422f68e0
KL
194TIPS & TRICKS
195-------------
196
bacb6689
KL
197I think the best way to use the new Emacs is to have it running inside
198a disconnected GNU screen session, and always use emacsclient for
422f68e0
KL
199normal work. One advantage of this is that not a single keystroke of
200your work will be lost if the display device that you are using
201crashes, or the network connection times out, or whatever. (I had an
202extremely unstable X server for some time while I was developing these
203patches, and running Emacs this way has saved me a number of M-x
204recover-session invocations.)
205
97c57fb2
KL
206I use the following two bash scripts to handle my Emacs sessions:
207
208-------------------------------------------------------connect-emacs--
209#!/bin/bash
210# Usage: connect-emacs <name> <args>...
211#
212# Connects to the Emacs instance called NAME. Starts up the instance
213# if it is not already running. The rest of the arguments are passed
214# to emacsclient.
215
216name="$1"
217shift
218
219if [ -z "$name" ]; then
220 echo "Usage: connect_emacs <name> <args>..." >&2
221 exit 1
222fi
223preload-emacs "$name" wait
224/usr/bin/emacsclient.emacs-multi-tty -s "$name" "$@"
225----------------------------------------------------------------------
226
227-------------------------------------------------------preload-emacs--
228#!/bin/bash
229# Usage: preload-emacs <name> [<waitp>]
230#
231# Preloads the Emacs instance called NAME in a detached screen
232# session. Does nothing if the instance is already running. If WAITP
233# is non-empty, the function waits until the server starts up and
234# creates its socket; otherwise it returns immediately.
235
236name="$1"
237waitp="$2"
238screendir="/var/run/screen/S-$USER"
239serverdir="/tmp/emacs$UID"
240emacs=/usr/bin/emacs-multi-tty # Or wherever you installed your multi-tty Emacs
241
242if [ -z "$name" ]; then
243 echo "Usage: preload_emacs <name> [<waitp>]" >&2
244 exit 1
245fi
246
247if [ ! -e "$screendir"/*."$name" ]; then
248 if [ -e "$serverdir/$name" ]; then
249 # Delete leftover socket (for the wait option)
250 rm "$serverdir/$name"
251 fi
252 screen -dmS "$name" "$emacs" -nw --eval "(setq server-name \"$name\")" -f server-start
253fi
254if [ ! -z "$waitp" ]; then
255 while [ ! -e "$serverdir/$name" ]; do sleep 0.1; done
256fi
257----------------------------------------------------------------------
258
259I have the following in my profile to have two instances automatically
260preloaded for editing and email:
261
262 preload-emacs editor
263 preload-emacs gnus
264
265It is useful to set up short aliases for connect-emacs. I use the
266following:
267
268 alias edit="connect-emacs editor"
269 alias e=edit
270 alias et="connect-emacs editor -t"
271 alias gnus="connect-emacs gnus"
422f68e0 272
28d440ab 273
2a42d440
KL
274CHANGELOG
275---------
276
36ab8612 277See the ChangeLog.multi-tty files in the source tree.
2a42d440 278
28d440ab
KL
279NEWS
280----
281
2a42d440 282For the NEWS file: (Needs much, much work)
28d440ab 283
6ed8eeff
KL
284** Support for multiple terminal devices and simultaneous graphical
285 and tty frames has been added. You can test for the presence of
286 this feature in your Lisp code by testing for the `multi-tty'
287 feature.
288
289*** The `window-system' variable has been made frame-local. The new
290 `initial-window-system' variable contains the `window-system'
291 value for the first frame.
6548cf00 292
2246281f
KL
293*** You can specify a terminal device (`tty' parameter) and a terminal
294 type (`tty-type' parameter) to `make-terminal-frame'.
6548cf00 295
6ed8eeff
KL
296*** The new function `make-frame-on-tty' allows you to create a new
297 frame on another tty device interactively.
298
299*** The function `make-frame-on-display' now works during a tty
300 session, and `make-frame-on-tty' works during a graphical session.
28d440ab 301
2246281f 302*** Emacsclient has been extended to support opening a new terminal
aaaf7fe1
KL
303 frame. Its behaviour has been changed to open a new Emacs frame by
304 default. Use the -c option to get the old behavior of opening
305 files in the currently selected Emacs frame.
e5299d8d 306
6ed8eeff
KL
307*** C-z now invokes `suspend-frame', C-x C-c now invokes
308 `save-buffers-kill-terminal'.
2246281f 309
2a42d440 310*** New functions: frame-tty-name, frame-tty-type, delete-tty,
6ed8eeff
KL
311 suspend-tty, resume-tty, terminal-id, terminal-parameters,
312 terminal-parameter, set-terminal-parameter,
313 modify-terminal-parameters, environment, let-environment
2246281f 314
6ed8eeff 315*** New variables: local-key-translation-map, local-function-key-map
4400e764 316
6ed8eeff
KL
317*** The `keyboard-translate-table' variable and the terminal and
318 keyboard coding systems have been made terminal-local.
2246281f 319
6ed8eeff
KL
320*** In addition to the global key-translation-map and
321 function-key-map, Emacs has terminal-local
322 local-key-translation-map and local-function-key-map variables,
323 and uses them instead of the global keymaps to set up translations
324 and function key sequences relevant to a specific terminal device.
819b8f00 325
2a42d440 326*** talk.el has been extended for multiple tty support.
28d440ab 327
90e06c2e
KL
328* * *
329
330(The rest of this file consists of my development notes and as such it
331is probably not very interesting for anyone else.)
332
7b00d185
KL
333THINGS TO DO
334------------
4edd8a5c 335
8cbd7bed 336** See if `tty-defined-color-alist' needs to be terminal-local.
6bccb6c5
KL
337 Update: Dan says it should be, so convert it.
338
339** Mikhail Gusarov suggest to add a hook akin to
340 `after-make-frame-functions' that is called whenever Emacs connects
341 to a new terminal. Good idea!
8cbd7bed 342
ce593f6e
KL
343** emacsclient -t on the console does not work after su. You have to
344 use non-root accounts or start as root to see this.
89121f95 345
ce593f6e
KL
346 Login: root
347 Password:
6213d5b3 348 # su lorentey
89121f95
KL
349 $ emacsclient -t
350 *ERROR*: Could not open file: /dev/tty1
351
352 The tty can be opened as /dev/tty by emacsclient, but not by Emacs.
353 This seems to be a serious problem. Currently my only idea is to
354 bring back the ugly pty proxy hack from the initial versions of
355 multi-tty. Suggestions would be appreciated.
356
ce593f6e
KL
357 Update: we could change emacsclient to pass its open file
358 descriptor to the Emacs process. Unfortunately, this requires a
359 new Lisp-level Emacs API, and as file descriptors are not otherwise
360 exported to Lisp, this approach seems at least as ugly as the pty
361 proxy idea.
362
3fde2acf
KL
363** lisp/vc.el depends on the terminal type during load time.
364 `vc-annotate-color-map' is one example that needs to be fixed.
365
6bbba5a6
KL
366** Understand how `quit_throw_to_read_char' works, and fix any bugs
367 that come to light.
368
6bbba5a6
KL
369** See if getcjmp can be eliminated somehow. Why does Emacs allow
370 asynchronous input processing while it's reading input anyway?
371
526039df
KL
372** `delete-frame' events are handled by `special-event-map'
373 immediately when read by `read_char'. This is fine but it prevents
374 higher-level keymaps from binding that event to get notified of the
375 deleted frame.
376
377 Sometimes it would be useful for Lisp code to be notified of frame
378 deletions after they have happened, usually because they want to
379 clean up after the deleted frame. Not all frame-local states can
380 be stored as a frame parameter. For example,
381 `display-splash-screen' uses `recursive-edit' with a special keymap
382 override to create its buffer---and it leads to all kinds of
383 nastiness if Emacs stays in this recursive edit mode after the
384 frame containing the splash screen is deleted. Basically, the
385 splash-screen implementation wants to throw out of the recursive
386 edit when the frame is deleted; however, it is not legal to throw
387 from `delete-frame-functions' because `delete-frame' must not fail.
388 (Introducing `delete-frame-after-functions' would not help either
389 because `delete-frame' may not fail at that time either.)
390
391 Currently `fancy-splash-screens' installs a
392 `delete-frame-functions' hook that sets up a timer to exit the
393 recursive edit. This is an adequate solution, but it would perhaps
394 be better to have something like a `frame-deleted' event that could
395 be bound in the normal way.
396
f105f403
KL
397** Trouble: `setenv' doesn't actually set environment variables in the
398 Emacs process. This defeats the purpose of the elaborate
399 `server-with-environment' magic around the `tgetent' call in
400 `init_tty'. D'oh.
ed8dad6b
KL
401
402** (Possibly) create hooks in struct device for creating frames on a
403 specific terminal, and eliminate the hackish terminal-related frame
404 parameters (display, tty, tty-type).
405
406 make_terminal_frame
407 create_tty_output
da8e8fc1
KL
408
409** Decide whether to keep the C implementation of terminal parameters,
410 or revert to the previous, purely Lisp code. It turned out that
411 local environments do not need terminal parameters after all.
ed8dad6b
KL
412
413** Move Fsend_string_to_terminal to term.c, and declare get_named_tty
414 as static, removing it from dispextern.h.
415 Move fatal to emacs.c and declare it somewhere.
416
f35ca2fe
KL
417** Search for `suspend-emacs' references and replace them with
418 `suspend-frame', if necessary. Ditto for `save-buffers-kill-emacs'
419 vs. `save-buffers-kill-display'.
420
bedeffcf
KL
421** Emacs crashes when a tty frame is resized so that there is no space
422 for all its windows. (Tom Schutzer-Weissmann)
423
256c9c3a
KL
424** Report GTK multi-display problems to GTK maintainers. For extra
425 credit, fix them.
6bac1616 426
5f6a587f
KL
427 Currently you can not connect to new X displays when you compile
428 Emacs with GTK support. If you want to play around with GTK
429 multidisplay (and don't mind core dumps), you can edit src/config.h
430 and define HAVE_GTK_MULTIDISPLAY there by hand.
b3e6f69c 431
5f3c1a63
KL
432 http://bugzilla.gnome.org/show_bug.cgi?id=85715
433
b3e6f69c
KL
434 Update: Han reports that GTK+ version 2.8.9 almost gets display
435 disconnects right. GTK will probably be fully fixed by the time
436 multi-tty gets into the trunk.
d6805803 437
5f3c1a63
KL
438 Update: I am still having problems with GTK+ 2.8.10. I have the
439 impression that the various multidisplay fixes will only get
440 released in GTK+ 2.10.
441
f369f10b
KL
442** Audit `face-valid-attribute-values' usage in customize and
443 elsewhere. Its return value depends on the current window system.
444 Replace static initializers using it with runtime functions. For
445 example, custom's buttons are broken on non-initial device types.
446
30a2fded
KL
447** Possibly turn off the double C-g feature when there is an X frame.
448 C.f. (emacs)Emergency Escape.
449
6bac1616 450** frames-on-display-list should also accept frames.
f0caabd9 451
5b65d888
KL
452** Consider the `tty-type' frame parameter and the `display-tty-type'
453 function. They serve the exact same purpose. I think it may be
454 a good idea to eliminate one of them, preferably `tty-type'.
455
4400e764
KL
456** The handling of lisp/term/*.el, and frame creation in general, is a
457 big, big mess. How come the terminal-specific file is loaded by
458 tty-create-frame-with-faces? I don't think it is necessary to load
459 these files for each frame; once per terminal should be enough.
6bac1616
KL
460 Update: lisp/term/*.el is not loaded repeatedly anymore, but
461 faces.el still needs to be cleaned up.
4400e764
KL
462
463** Fix frame-set-background-mode in this branch. It was recently
464 changed in CVS, and frame.el in multi-tty has not yet been adapted
465 for the changes. (It needs to look at
6bac1616 466 default-frame-background-mode.) (Update: maybe it is fixed now;
30663b47
KL
467 needs testing.) (Note that the byte compiler has this to say about
468 term/rxvt.el:)
469
470 term/rxvt.el:309:17:Warning: assignment to free variable
471 `default-frame-background-mode'
4400e764
KL
472
473** I think `(set-)terminal-local-value' and the terminal parameter
474 mechanism should be integrated into a single framework.
475
ed8dad6b
KL
476 (Update: `(set-)terminal-local-value' is now eliminated, but the
477 terminal-local variables should still be accessible as terminal
478 parameters. This also applies to `display-name' and similar
479 functions.)
480
4400e764
KL
481** Add the following hooks: after-delete-frame-hook (for server.el,
482 instead of delete-frame-functions),
483 after-delete-terminal-functions, after-create-terminal-functions.
484
1fb8c4ad
KL
485** BULK RENAME: The `display-' prefix of new Lisp-level functions
486 conflicts with stuff like `display-time-mode'. Use `device-'
7d6d7d1a
KL
487 or `terminal-' instead. I think I prefer `terminal-'.
488
3e6f836c
KL
489 It turns out that most of the offending Lisp functions were defined
490 in the trunk. Therefore, compatibility aliases should be defined
491 for the following names:
492
493 display-color-cells terminal-color-cells
494 display-color-p terminal-color-p
495 display-graphic-p terminal-graphic-p
496 display-grayscale-p terminal-grayscale-p
497 display-images-p terminal-images-p
498 display-mm-height terminal-mm-height
499 display-mm-width terminal-mm-width
500 display-mouse-p terminal-mouse-p
501 display-multi-font-p terminal-multi-font-p
502 display-multi-frame-p terminal-multi-frame-p
503 display-pixel-height terminal-pixel-height
504 display-pixel-width terminal-pixel-width
505 display-pixels-per-inch terminal-pixels-per-inch
506 display-planes terminal-planes
507 display-popup-menus-p terminal-popup-menus-p
508 display-save-under terminal-save-under
509 display-screens terminal-screens
510 display-supports-face-attributes-p terminal-supports-face-attributes-p
511 display-visual-class terminal-visual-class
512 framep-on-display framep-on-terminal
513 frames-on-display-list frames-on-terminal-list
514
515 The following functions were introduced in the multi-tty branch, and
6ed8eeff 516 were renamed without aliases:
3e6f836c 517
6ed8eeff
KL
518 delete-display delete-terminal
519 display-controlling-tty-p controlling-tty-p
3e6f836c
KL
520 display-list terminal-list
521 display-live-p terminal-live-p
522 display-name terminal-name
6ed8eeff
KL
523 display-tty-type tty-type
524 frame-display frame-terminal
525 selected-display selected-terminal
3e6f836c 526
856dd475
KL
527** The single-keyboard mode of MULTI_KBOARD is extremely confusing
528 sometimes; Emacs does not respond to stimuli from other keyboards.
529 At least a beep or a message would be important, if the single-mode
530 is still required to prevent interference. (Reported by Dan
531 Nicolaescu.)
532
533 Update: selecting a region with the mouse enables single_kboard
534 under X. This is very confusing.
535
68bba4e4
KL
536 Update: After discussions with Richard Stallman, this will be
537 resolved by having locked displays warn the user to wait, and
538 introducing a complex protocol to remotely bail out of
539 single-kboard mode by pressing C-g.
856dd475
KL
540
541 Update: Warning the user is not trivial to implement, as Emacs has
68bba4e4
KL
542 only one echo area, shared by all frames. Ideally the warning
543 should not be displayed on the display that is locking the others.
544 Perhaps the high probability of user confusion caused by
545 single_kboard mode deserves a special case in the display code.
546 Alternatively, it might be good enough to signal single_kboard mode
547 by changing the modelines or some other frame-local display element
548 on the locked out displays.
856dd475 549
b3e6f69c
KL
550 Update: In fact struct kboard does have an echo_string slot.
551
d51abf22
KL
552** The session management module is prone to crashes when the X
553 connection is closed and then later I try to connect to a new X
554 session:
555
556 #0 0xb7ebc806 in SmcGetIceConnection () from /usr/X11R6/lib/libSM.so.6
557 #1 0x080e6641 in x_session_check_input (bufp=0xbf86c9c0) at xsmfns.c:144
558 #2 0x080d3bbc in XTread_socket (device=0xa722ff8, expected=1, hold_quit=0xbf86ca90) at xterm.c:7037
559 #3 0x080fa404 in read_avail_input (expected=1) at keyboard.c:6696
560 #4 0x080fa4ca in handle_async_input () at keyboard.c:6900
561 #5 0x080d51fa in x_term_init (display_name=162628899, xrm_option=0x0, resource_name=0x857068c "emacs") at xterm.c:10622
562 #6 0x080d920e in x_display_info_for_name (name=162628899) at xfns.c:3975
563 #7 0x080d92f9 in check_x_display_info (object=1) at xfns.c:274
564 #8 0x080d97b8 in Fx_create_frame (parms=151221485) at xfns.c:3016
565 #9 0x0815bf72 in Ffuncall (nargs=2, args=0xbf86ceec) at eval.c:2851
566
567 I installed a workaround to prevent this. The X session manager is
568 only contacted when the very first display in the Emacs session is
569 an X display. Also, x_delete_display() on this display aborts
570 session management, and XTread_socket only calls
571 x_session_check_input when it is called for the display that the
572 session was opened on. While this does not really fix the bug, it
573 makes it much less frequent, because session manager support will
574 not normally be enabled when Emacs can survive the shutdown of the
575 X server.
576
577 See if xsmfns.c should be updated.
578
b6660415
KL
579** Hunt down display-related functions in frame.el and extend them all
580 to accept display ids.
581
856dd475
KL
582** rif->flush_display_optional (NULL) calls should be replaced by a
583 new global function.
584
97c57fb2
KL
585** The set-locale-environment hack (adding the DISPLAY option) should
586 be replaced with a clean design.
68bba4e4 587
97c57fb2
KL
588** standard-display-table should be display-local.
589 standard-display-european should be display-local.
68bba4e4 590
7d6d7d1a
KL
591** With iswitchb-default-method set to 'always-frame, only frames on
592 the current display should be considered. This might involve
593 extending `get-buffer-window'.
594
97c57fb2
KL
595** Have a look at Vlocale_coding_system. Seems like it would be a
596 tedious job to localize it, although most references use it for
597 interfacing with libc and are therefore OK with the global
598 definition.
599
600 Exceptions found so far: x-select-text and
601 x-cut-buffer-or-selection-value.
68bba4e4 602
6ea444cf
KL
603** Have a look at fatal_error_hook.
604
97b977db
KL
605** Have a look at set_frame_matrix_frame.
606
7d1a6b33
KL
607** Check if we got term-setup-hook right.
608
9d3d44ba
KL
609** I think tip_frame should be display-local.
610
611** Check display reference count handling in x_create_tip_frame.
612
54021676
KL
613** make-frame does not correctly handle extra parameters in its
614 argument:
615
616 (frame-parameter (make-frame (list (cons 'foobar 42))) 'foobar)
617 => nil
618
619 (This is likely an error in the CVS trunk.)
620
01d81f75
KL
621** Dan Nicolaescu suggests that -nw should be added as an alias for -t
622 in emacsclient. Good idea. (Alas, implementing this is not
623 trivial, getopt_long does not seem to support two-letter ``short''
d6805803 624 options. Patches are welcome.)
01d81f75
KL
625
626** Mark Plaksin suggests that emacsclient should accept the same
627 X-related command-line arguments as Emacs. Most of the X-related
628 argument-handling is done in Lisp, so this should be quite easy to
6bccb6c5
KL
629 implement. (For example, Samium Gromoff wants emacsclient to
630 support --geometry; implementing this would add that support.)
d448e982 631
cd5355f9
KL
632** Gergely Nagy suggests that C-x # should only kill the current
633 frame, not any other emacsclient frame that may have the same file
634 opened for editing. I think I agree with him.
635
0b0d3e0b
KL
636** Very strange bug: visible-bell does not work on secondary
637 terminals in xterm and konsole. The screen does flicker a bit,
638 but it's so quick it isn't noticable.
639
b3e6f69c
KL
640 (Update: This is probably some problem with padding or whatnot on
641 the secondary terminals.)
642
428a555e 643** Move baud_rate to struct display.
7b00d185 644
7b00d185
KL
645** Implement support for starting an interactive Emacs session without
646 an initial frame. (The user would connect to it and open frames
f70dd009 647 later, with emacsclient.)
7b00d185 648
2cd1371d
KL
649** Fix Mac support (I can't do this entirely myself). Note that the
650 current state of Mac-specific source files in the multi-tty tree
651 are not useful; before starting work on Mac support, revert to
652 pristine, pre-multi-tty versions.
7b00d185 653
2cd1371d
KL
654** Fix DOS support (I can't do this entirely myself). Note that the
655 current state of DOS-specific source files in the multi-tty tree
656 are not useful; before starting work on DOS support, revert to
657 pristine, pre-multi-tty versions.
7b00d185 658
471f1044
JR
659** Fix Windows support. Currently bootstraping works on w32, but Emacs
660 crashes on startup and none of the multi-tty features are
661 implemented. Many XXX comments mark things that probably need
662 updating, ChangeLogs will help in spotting changes to X specific
663 files that may need porting.
664
7b00d185
KL
665** Do a grep on XXX and ?? for more issues.
666
2e478293
KL
667** flow-ctrl.el must be updated.
668
7d6d7d1a
KL
669** Fix stuff_char for multi-tty. Doesn't seem to be of high priority.
670
6548cf00
KL
671DIARY OF CHANGES
672----------------
673
674(ex-TODO items with explanations.)
28d440ab 675
114a8b8c 676-- Introduce a new struct for terminal devices.
28d440ab 677
daf01701 678 (Done, see struct tty_output. The list of members is not yet
28d440ab
KL
679 complete.)
680
28d440ab
KL
681-- Change the bootstrap procedure to initialize tty_list.
682
683 (Done, but needs review.)
684
28d440ab
KL
685-- Change make-terminal-frame to support specifying another tty.
686
687 (Done, new frame parameters: `tty' and `tty-type'.)
688
9628b887
KL
689-- Implement support for reading from multiple terminals.
690
691 (Done, read_avail_input tries to read from each terminal, until one
28d7d09f 692 succeeds. MULTI_KBOARD is not used. Secondary terminals don't send
6548cf00 693 SIGIO!)
9628b887 694
819b8f00
KL
695 (Update: They do, now.)
696
daf01701
KL
697 (Update2: After enabling X, they don't.)
698
9628b887 699-- other-frame should cycle through the frames on the `current'
114a8b8c 700 terminal only.
9628b887 701
6548cf00 702 (Done, by trivially modifiying next_frame and prev_frame.)
9628b887
KL
703
704-- Support different terminal sizes.
114a8b8c 705
9628b887
KL
706 (Done, no problem.)
707
708-- Make sure terminal resizes are handled gracefully. (Could be
709 problematic.)
710
6548cf00
KL
711 (Done. We don't get automatic SIGWINCH for additional ttys,
712 though.)
9628b887
KL
713
714-- Extend emacsclient to automatically open a new tty when it connects
715 to Emacs.
114a8b8c 716
9628b887
KL
717 (Done. It's an ugly hack, needs more work.)
718
52c2ee2a
KL
719-- Redisplay must refresh the topmost frame on *all* terminals, not
720 just the initial terminal.
114a8b8c 721
52c2ee2a 722 (Done, but introduced an ugly redisplay problems. Ugh.)
9628b887 723
6548cf00
KL
724-- Fix redisplay problems.
725
52c2ee2a
KL
726 (Done; it turned out that the entire Wcm structure must be moved
727 inside tty_output. Why didn't I catch this earlier?)
6548cf00
KL
728
729-- Provide a way for emacsclient to tell Emacs that the tty has been
730 resized.
731
732 (Done, simply forward the SIGWINCH signal.)
733
734-- Each keypress should automatically select the frame corresponding
735 to the terminal that it was coming from. This means that Emacs
736 must know from which terminal the last keyboard event came from.
6548cf00 737
52c2ee2a
KL
738 (Done, it was quite simple, the input event system already
739 supported multiple frames.)
6548cf00
KL
740
741-- Fix SIGIO issue with secondary terminals.
742
743 (Done, emacsclient signals Emacs after writing to the proxy pseudo
52c2ee2a
KL
744 terminal. Note that this means that multi-tty does not work with
745 raw ttys!)
28d440ab 746
0a125897
KL
747 (Update: This is bullshit. There is a read_input_waiting function,
748 extend that somehow.)
749
819b8f00
KL
750 (Update of update: The first update was not right either, extending
751 read_input_waiting was not necessary. Secondary ttys do seem to
752 send signals on input.)
753
daf01701
KL
754 (Update^3: Not any more.)
755
fca177d4
KL
756-- Make make-terminal-frame look up the `tty' and `tty-type' frame
757 parameters from the currently selected terminal before the global
758 default.
759
760 (Done.)
761
762-- Put all cached terminal escape sequences into struct tty_output.
763 Currently, they are still stored in global variables, so we don't
764 really support multiple terminal types.
765
52c2ee2a 766 (Done. It was not fun.)
fca177d4
KL
767
768-- Implement sane error handling after initialization. (Currently
6548cf00
KL
769 emacs exits if you specify a bad terminal type.) The helpful error
770 messages must still be provided when Emacs starts.
771
fca177d4
KL
772 (Done.)
773
774-- Implement terminal deletion, i.e., deleting local frames, closing
775 the tty device and restoring its previous state without exiting
776 Emacs.
9628b887 777
fca177d4
KL
778 (Done, but at the moment only called when an error happens during
779 initialization. There is a memory corruption error around this
daf01701 780 somewhere.) (Update: now it is fully enabled.)
fca177d4 781
8303ba32
KL
782-- Implement automatic deletion of terminals when the last frame on
783 that terminal is closed.
784
785 (Done.)
786
0a125897
KL
787-- Restore tty screen after closing the terminal.
788
789 (Done, we do the same as Emacs 21.2 for all terminals.)
790
791-- 'TERM=dumb src/emacs' does not restore the terminal state.
114a8b8c 792
0a125897 793 (Done.)
fca177d4 794
b2af72d2
KL
795-- C-g should work on secondary terminals.
796
797 (Done, but the binding is not configurable.)
798
799-- Deal with SIGHUP in Emacs and in emacsclient. (After this, the
800 server-frames may be removed from server.el.)
801
802 (Done, nothing to do. It seems that Emacs does not receive SIGHUP
daf01701 803 from secondary ttys, which is actually a good thing.) (Update: I
7b00d185 804 think it would be a bad idea to remove server-frames.)
b2af72d2 805
daf01701 806-- Change emacsclient/server.el to support the -t argument better,
b2af72d2
KL
807 i.e. automatically close the socket when the frame is closed.
808
809 (Seems to be working OK.)
810
16c290d8 811-- Fix mysterious memory corruption error with tty deletion. To
fca177d4
KL
812 trigger it, try the following shell command:
813
814 while true; do TERM=no-such-terminal-definition emacsclient -h; done
815
816 Emacs usually dumps core after a few dozen iterations. (The bug
3224dac1 817 seems to be related to the xfreeing or bzeroing of
9d9f1812
KL
818 tty_output.Wcm. Maybe there are outside references to struct Wcm?
819 Why were these vars collected into a struct before multi-tty
820 support?)
fca177d4 821
16c290d8
KL
822 (Done. Whew. It turned out that the problem had nothing to do
823 with hypothetical external references to Wcm, or any other
824 tty_output component; it was simply that delete_tty closed the
825 filehandles of secondary ttys twice, resulting in fclose doubly
3224dac1 826 freeing memory. Utterly trivial matter. I love the C's memory
16c290d8
KL
827 management, it puts hair on your chest.)
828
819b8f00 829-- Support raw secondary terminals. (Note that SIGIO works only on
3224dac1 830 the controlling terminal.) Hint: extend read_input_waiting for
819b8f00 831 multiple ttys and hopefully this will be fixed.
fca177d4 832
819b8f00
KL
833 (Done, it seems to have been working already for some time. It
834 seems F_SETOWN does work, after all. Not sure what made it fail
835 earlier, but it seems to be fixed (there were several changes
836 around request_sigio, maybe one of them did it).
3224dac1 837 read_input_waiting is only used in sys_select, don't change
daf01701 838 it.) (Update: After adding X support, it's broken again.)
d3c554a0 839 (Update^2: No it isn't.) :-)
c1c63edb 840
819b8f00 841-- Find out why does Emacs abort when it wants to close its
0a125897 842 controlling tty. Hint: chan_process[] array. Hey, maybe
16c290d8
KL
843 noninterrupt-IO would work, too? Update: no, there is no process
844 for stdin/out.
c33d2d42 845
819b8f00
KL
846 (Done. Added add/delete_keyboard_wait_descriptor to
847 term_init/delete_tty. The hint was right, in a way.)
6548cf00 848
819b8f00 849-- Issue with SIGIO: it needs to be disabled during redisplay. See if
3224dac1 850 fcntl kernel behaviour could be emulated by emacsclient.
0a125897 851
819b8f00 852 (Done. Simply disabled the SIGIO emulation hack in emacsclient.)
d3c554a0 853 (Update: it was added back.) (Update^2: and removed again.)
22de1e79 854
819b8f00 855-- server.el: There are issues with saving files in buffers of closed
16c290d8
KL
856 clients. Try editing a file with emacsclient -f, and (without
857 saving it) do a delete-frame. The frame is closed without
858 question, and a surprising confirmation prompt appears in another
859 frame.
860
819b8f00
KL
861 (Done. delete-frame now asks for confirmation if it still has
862 pending buffers, and modified buffers don't seem to be deleted.)
863
864-- emacsclient.el, server.el: Handle eval or file open errors when
daf01701 865 doing -t.
16c290d8 866
819b8f00 867 (Done.)
22de1e79 868
819b8f00
KL
869-- Make parts of struct tty_output accessible from Lisp. The device
870 name and the type is sufficient.
22de1e79 871
819b8f00
KL
872 (Done, see frame-tty-name and frame-tty-type.)
873
874-- Export delete_tty to the Lisp environment, for emacsclient.
22de1e79 875
819b8f00
KL
876 (Done, see delete-tty.)
877
daf01701
KL
878-- Get rid of the accessor macros in termchar.h, or define macros for
879 all members.
880
881 (Done.)
882
883-- Move device-specific parameters (like costs) commonly used by
884 device backends to a common, device-dependent structure.
885
886 (Done. See struct display_method in termhooks.h.)
887
888-- Fix X support.
889
890 (Done. Well, it seems to be working.)
891
892-- Allow simultaneous X and tty frames. (Handling input could be
893 tricky. Or maybe not.)
894
895 (Done. Allowed, that is. It is currently extremely unstable, to
896 the point of being unusable. The rif variable causes constant
897 core dumps. Handling input is indeed tricky.)
819b8f00 898
7b00d185 899-- Rewrite multi-tty input in terms of MULTI_KBOARD.
28d440ab 900
7b00d185
KL
901 (Done. In fact, there was no need to rewrite anything, I just
902 added a kboard member to tty_display_info, and initialized the
903 frame's kboard from there.)
819b8f00 904
fa971ac3
KL
905-- Fix rif issue with X-tty combo sessions. IMHO the best thing to do
906 is to get rid of that global variable (and use the value value in
907 display_method, which is guaranteed to be correct).
908
909 (Done, did exactly that. Core dumps during combo sessions became
910 much rarer. In fact, I have not yet met a single one.)
911
17086732
KL
912-- Add multi-tty support to talk.el.
913
914 (Done.)
915
428a555e
KL
916-- Clean up the source of emacsclient. It is a mess.
917
918 (Done, eliminated stupid proxy-pty kludge.)
919
920-- Fix faces on tty frames during X-tty combo sessions. There is an
921 init_frame_faces call in init_sys_modes, see if there is a problem
922 with it.
923
924 (Done, there was a stupid mistake in
925 Ftty_supports_face_attributes_p. Colors are broken, though.)
926
927-- C-x 5 2, C-x 5 o, C-x 5 0 on an emacsclient frame unexpectedly
928 exits emacsclient. This is a result of trying to be clever with
929 delete-frame-functions.
930
931 (Fixed, added delete-tty-after-functions, and changed server.el to
932 use it.)
933
934-- Something with (maybe) multi-keyboard support broke function keys
935 and arrows on ttys during X+tty combo sessions. Debug this.
936
937 (I can't reproduce it, maybe the terminal type was wrong.)
938
939-- Fix input from raw ttys (again).
940
941 (Now it seems to work all right.)
942
943-- During an X-tty combo session, a (message "Hello") from a tty frame
944 goes to the X frame. Fix this.
945
946 (Done. There was a safeguard against writing to the initial
947 terminal frame during bootstrap which prevented echo_area_display
948 from working correctly on a tty frame during a combo session.)
949
114a8b8c 950-- If there are no frames on its controlling terminal, Emacs should
d3c554a0 951 exit if the user presses C-c there.
114a8b8c
KL
952
953 (Done, as far as possible. See the SIGTERM comment in
954 interrupt_signal on why this seems to be impossible to solve this
955 in general.)
956
957-- During an X session, Emacs seems to read from stdin. Also, Emacs
958 fails to start without a controlling tty.
959
960 (Fixed by replacing the troublesome termcap display with a dummy
961 bootstrap display during bootstrap.
962
963-- Do tty output through struct display, like graphical display
964 backends.
965
966 (Done.)
967
968-- Define an output_initial value for output_method for the initial
969 frame that is dumped with Emacs. Checking for this frame (e.g. in
970 cmd_error_internal) is ugly.
971
d6805803 972 (Done, breaking interactive temacs.)
114a8b8c
KL
973
974-- The command `emacsclient -t -e '(delete-frame)'' fails to exit.
975
976 (Fixed.)
977
4ca927b4
KL
978-- frame-creation-function should always create a frame that is on the
979 same display as the selected frame. Maybe frame-creation-function
980 should simply be removed and make-frame changed to do the right
981 thing.
982
983 (Done, with a nice hack. frame-creation-function is now frame-local.)
984
985-- Fix C-g on raw ttys.
986
987 (Done. I disabled the interrupt/quit keys on all secondary
988 terminals, so Emacs sees C-g as normal input. This looks like an
989 overkill, because emacsclient has extra code to pass SIGINT to
990 Emacs, so C-g should remain the interrupt/quit key on emacsclient
991 frames. See the next entry why implementing this distinction would
992 be a bad idea.)
993
994-- Make sure C-g goes to the right frame with ttys. This is hard, as
995 SIGINT doesn't have a tty parameter. :-(
996
997 (Done, the previous change fixes this as a pleasant side effect.)
998
c0707982
KL
999-- I have seen a case when Emacs with multiple ttys fell into a loop
1000 eating 100% of CPU time. Strace showed this loop:
1001
1002 getpid() = 30284
1003 kill(30284, SIGIO) = 0
1004 --- SIGIO (I/O possible) @ 0 (0) ---
1005 ioctl(6, FIONREAD, [0]) = -1 EIO (Input/output error)
1006 ioctl(5, FIONREAD, [0]) = -1 EIO (Input/output error)
1007 ioctl(0, FIONREAD, [0]) = 0
1008 sigreturn() = ? (mask now [])
1009 gettimeofday({1072842297, 747760}, NULL) = 0
1010 gettimeofday({1072842297, 747806}, NULL) = 0
1011 select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
1012 select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
1013 gettimeofday({1072842297, 748245}, NULL) = 0
1014
1015 I have seen something similar with a single X frame, but have not
1016 been able to reproduce it for debugging.
1017
1018 Update: This may have been caused by checking for nread != 0
1019 instead of nread > 0 after calling read_socket_hook in
1020 read_avail_input.
1021
1022 (Fixed. This was caused by unconditionally including stdin in
1023 input_wait_mask in init_process. The select call in
1024 wait_reading_process_input always returned immediately, indicating
1025 that there is pending input from stdin, which nobody read.
1026
1027 Note that the above strace output seems to be an unrelated but
1028 similar bug. I think that is now fixed.)
4ca927b4 1029
2246281f
KL
1030-- Exiting Emacs while there are emacsclient frames doesn't restore the
1031 ttys to their default states.
1032
1033 (This seems to be fixed by some previous change.)
1034
1035-- Allow opening an X session after -nw.
1036
1037 (Done.)
1038
d448e982
KL
1039-- Fix color handling during tty+X combo sessions. (It seems that tty
1040 sessions automatically convert the face colors to terminal colors
1041 when the face is loaded. This conversion must happen instead on
1042 the fly in write_glyphs, which might be problematic, as color
1043 approximation is currently done in lisp (term/tty-colors.el).)
1044 (Update: hm, colors seem to work fine if I start emacs with -nw and
1045 then create an X frame. Maybe it's just a small buglet somewhere.)
1046
1047 (Seems to be fixed. The problem was in startup.el, it did not
1048 initialize tty colors when the initial window system was
1049 graphical.)
2246281f 1050
2441679b
KL
1051-- emacs -nw --eval '(y-or-n-p "Foobar")' segfaults. (Reported by
1052 Romain Francoise)
1053
1054 (Fixed, there was a keyboard initialization problem.)
1055
3bbdbec9
KL
1056-- Fix interactive use of temacs. There are face-related SEGVs, most
1057 likely because of changes in realize_default_face, realize_face.
1058
1059 (Fixed.)
1060
bacb6689
KL
1061-- Don't exit Emacs when the last X connection fails during a
1062 multi-display session.
1063
1064 (Fixed.)
1065
0c72d684
KL
1066-- Dan Nicolaescu noticed that starting emacsclient on the same
1067 terminal device that is the controlling tty of the Emacs process
1068 gives unexpected results.
1069
1070 (Fixed.)
1071
4edd8a5c
KL
1072-- Istvan Marko reported that Emacs hang on ttys if it was started
1073 from a shell script.
1074
1075 (Fixed. There was a bug in the multi-tty version of
1076 narrow_foreground_group. tcsetpgrp blocks if it is called from a
1077 process that is not in the same process group as the tty.)
1078
2fc0cf2a
KL
1079-- emacsclient -t from an Emacs term buffer does not work, complains
1080 about face problems. This can even lock up Emacs (if the recursive
1081 frame sets single_kboard). Update: the face problems are caused by
1082 bugs in term.el, not in multi-tty. The lockup is caused by
d3c554a0 1083 single_kboard mode, and is not easily resolvable. The best thing to
2fc0cf2a
KL
1084 do is to simply refuse to create a tty frame of type `eterm'.
1085
1086 (Fixed, changed emacsclient to check for TERM=eterm. The face
1087 complaints seem to be caused by bugs in term.el; they are not
1088 related to multi-tty.)
1089
0b0d3e0b
KL
1090-- Find out the best way to support suspending Emacs with multiple
1091 ttys. My guess: disable it on the controlling tty, but from other
1092 ttys pass it on to emacsclient somehow. (It is (I hope) trivial to
1093 extend emacsclient to handle suspend/resume. A `kill -STOP' almost
1094 works right now.)
1095
1096 (Done. I needed to play with signal handling and the server
1097 protocol a bit to make emacsclient behave as a normal UNIX program
1098 wrt foreground/background process groups.)
1099
eb1f46c9
KL
1100-- There is a flicker during the startup of `emacs -nw'; it's as if
1101 the terminal is initialized, reset and then initialialized again.
1102 Debug this. (Hint: narrow_foreground_group is called twice during
1103 startup.)
1104
1105 (This is gone.)
1106
026ad6ba
KL
1107-- Robert Chassell has found serious copy-paste bugs with the
1108 multi-tty branch. There seem to be redisplay bugs while copying
1109 from X to a terminal frame. Copying accented characters do not
1110 work for me.
1111
1112 (Patch-124 should fix this, by changing the interprogram-*-function
1113 variables to be frame-local, as suggested by Mark Plaksin
1114 (thanks!). I think that the redisplay bugs are in fact not bugs,
1115 but delays caused by single_kboard --> perhaps MULTI_KBOARD should
1116 be removed.)
1117
2cd1371d
KL
1118-- frame-creation-function was removed, which might be a bad idea.
1119 Think up a compatible solution.
1120
1121 (It was an internal interface that may be changed when necessary.)
1122
1123-- Change Lisp code not to (getenv "TERM"); use the `tty-type' frame
1124 parameter or the frame-tty-type function instead. (M-x tags-search
1125 "TERM" helps with this.) Update: Actually, all getenv invocations
1126 should be checked for multi-tty compatibility, and an interface
1127 must be implemented to get the remote client's environment.
1128
1129 (Done. Only getenv calls in lisp/term/*.el were changed; other
1130 calls should be mostly left as they are.)
1131
1132-- Add an elaborate mechanism for display-local variables. (There are
1133 already a few of these; search for `terminal-local' in the Elisp
1134 manual.)
1135
1136 (Not needed. Display-local variables could be emulated by
1137 frame-local variables.)
026ad6ba 1138
d4d89d37
KL
1139-- Emacs assumes that all terminal frames have the same locale
1140 settings as Emacs itself. This may lead to bogus results in a
1141 multi-locale setup. (E.g., while logging in from a remote client
1142 with a different locale.)
1143 (Update after new bugreport by Friedrich Delgado Friedrichs:
1144 (at least) the structs terminal_coding and keyboard_coding in
1145 coding.c must be moved to struct display, and the Lisp interface
1146 [set-]keyboard-coding-system must be adapted for the change.)
1147
1148 (Fixed. Emacs now uses the locale settings as seen by the
1149 emacsclient process for server tty frames.)
68bba4e4 1150 (Update: Not really; Vlocale_coding_system is still global.)
b6660415
KL
1151
1152-- Make `struct display' accessible to Lisp programs. Accessor functions:
1153
1154 (displayp OBJECT): Returns t if OBJECT is a display.
1155 => Implemented as display-live-p.
1156
1157 (display-list): Returns list of currently active displays.
1158 => Implemented.
1159
1160 (selected-display): Returns the display object of the selected frame.
1161 => Not strictly necessary, but implemented anyway.
1162
1163 (frame-display FRAME): Returns the display object of FRAME.
1164 => Implemented.
1165
1166 (display-frames DISPLAY): Returns a list of frames on DISPLAY.
1167 => Already implemented, see frames-on-display-list.
1168
1169 (display-type DISPLAY): Returns the type of DISPLAY, as a
1170 symbol. (See `framep'.)
1171 => Implemented as display-live-p.
1172
1173 (display-device DISPLAY): Returns the name of the device that
1174 DISPLAY uses, as a string. (E.g: "/dev/pts/16", or
1175 ":0.0")
1176 => Implemented as display-name.
1177
1178 etc.
1179
1180 See next issue why this is necessary.
1181
1182 (Update: The consensus on emacs-devel seems to be to do this via
1183 integer identifiers. That's fine by me.)
1184
1185 (Done.)
1186
1187-- The following needs to be supported:
1188
1189 $ emacsclient -t
1190 C-z
1191 $ emacsclient -t
1192 (This fails now.)
1193
1194 The cleanest way to solve this is to allow multiple displays on the
1195 same terminal device; each new emacsclient process should create
1196 its own display. As displays are currently identified by their
1197 device names, this is not possible until struct display becomes
1198 accessible as a Lisp-level object.
1199
1200 (Done.)
1201
856dd475
KL
1202-- Miles Bader suggests that C-x C-c on an emacsclient frame should
1203 only close the frame, not exit the entire Emacs session. Update:
1204 see above for a function that does this. Maybe this should be the
1205 new default?
1206
1207 (Done. This is the new default. No complaints so far.)
1208
68bba4e4
KL
1209-- Clean up the frame-local variable system. I think it's ugly and
1210 error-prone. But maybe I just haven't yet fully understood it.
1211
1212 (Nothing to do. It doesn't seem ugly any more. It's rather clever.)
856dd475 1213
97c57fb2
KL
1214-- Support multiple character locales. A version of
1215 `set-locale-environment' needs to be written for setting up
1216 display-local settings on ttys. I think calling
1217 set-display-table-and-terminal-coding-system and
1218 set-keyboard-coding-system would be enough. The language
1219 environment itself should remain a global setting.
1220
1221 (Done, by an ugly hack.)
1222
1fb8c4ad
KL
1223-- The terminal customization files in term/*.el tend to change global
1224 parameters, which may confuse Emacs with multiple displays. Change
1225 them to tweak only frame-local settings, if possible. (They tend
1226 to call define-key to set function key sequences a lot.)
1227
1228 (Done, by making `function-key-map' terminal-local (i.e., part of
1229 struct kboard). This has probably covered all the remaining problems.)
1230
2a42d440
KL
1231-- Make `function-key-map' and `key-translation-map' terminal-local.
1232
1233 (Done.)
1234
1235-- Implement `terminal-local-value' and `set-terminal-local-value' to
1236 allow deterministic access to terminal local bindings. The
1237 encode-kb package can not set up `key-translation-map' without
1238 these. The terminal-local bindings seem to be independent of what
1239 frame is selected.
1240
1241 (Done.)
6bac1616
KL
1242
1243-- xt-mouse.el needs to be adapted for multi-tty. It currently
1244 signals an error on kill-emacs under X, which prevents the user
1245 from exiting Emacs. (Reported by Mnemonikk on freenode.)
1246
1247 (Done, I hope.)
5b65d888 1248
2a42d440 1249
ee0bcfbc
KL
1250-- Having {reset,init}_all_sys_modes in set-input-mode breaks arrow
1251 keys on non-selected terminals under screen, and sometimes on other
1252 terminal types as well. The other function keys continue to work
1253 fine. Sometimes faces on these screens become garbled.
1254
1255 This only seems to affect displays that are of the same terminfo
1256 type as the selected one. Interestingly, in screen Emacs normally
1257 reports the up arrow key as `M-o A', but after the above SNAFU, it
1258 complains about `M-[ a'. UNIX ttys are a complete mystery to me,
1259 but it seems the reset-reinitialize cycle somehow leaves the
1260 non-selected terminals in a different state than usual. I have no
1261 idea how this could happen.
1262
1263 Currently set-input-mode resets only the currently selected
1264 terminal, which seems to somehow work around the problem.
1265
1266 Update:
1267
1268 Dan Nicolaescu <dann@ics.uci.edu> writes:
1269 > Some terminals have 2 modes for cursor keys: Application Mode where
1270 > the cursor keys transmit the codes defined in the terminfo entry, and
1271 > Cursor mode. Applications have to send the smkx and rmkx terminfo
1272 > strings to switch between the 2 modes. So Emacs (and emacsclient) have
1273 > to send smkx when initializing and rmkx when quitting (or on
1274 > suspend).
1275
1276 (I think patch-370 fixed this.)
1277
256c9c3a
KL
1278-- This long-standing bug (first reported by Han Boetes) seems to come
1279 and go all the time. It is time to track it down and fix it.
1280
1281 emacs
1282 M-x server-start
1283
1284 # From another xterm:
1285 emacsclient -e '(y-or-n-p "Do you want me to crash? ")'
1286 # Notice how the answer ends up in the *scratch* buffer
1287 M-x garbage-collect
1288 SIGSEGV
1289
1290 (Fixed in patch-414 after detailed analysis by Kalle Olavi Niemitalo.)
1291
30a2fded
KL
1292-- normal-erase-is-backspace-mode in simple.el needs to be updated for
1293 multi-tty (rep. by Dan Waber). (The Delete key is broken on X
1294 because of this.)
1295
1296 (Fixed in patch-427.)
1297
2e478293
KL
1298-- I think keyboard-translate-table should be made terminal-local.
1299
1300 (Done in patch-431.)
1301
9684e4c9
KL
1302-- The semantics of terminal-local variables are confusing; it is not
1303 clear what binding is in effect in any given time. See if
1304 current_kboard (or at least the terminal-local bindings exported to
1305 Lisp) might be changed to be tied to the selected frame instead.
1306 Currently, `function-key-map' and `key-translation-map' may be
1307 accessed reliably only using the hackish
1308 `(set-)terminal-local-value' functions.
1309
1310 Perhaps there should be a difference between `last-command' &co.
1311 and these more conventional configuration variables.
1312 (E.g. `symbol-value' would use current_kboard to access
1313 `last-command', but SELECTED_FRAME()->display->kboard to get the
1314 value of `function-key-map'.
1315
1316 (Fixed in patch-434.)
1317
1318-- If the first key pressed on a new tty terminal is a function key,
1319 it is not recognized correctly. May be related to the bug below.
1320
1321 (Seems to have been fixed as a side effect of patch-434. "The bug
d6805803
KL
1322 below" was the set-input-mode madness.)
1323
1324 (Update: this bug was fixed for good in patch-449. It was tracked
1325 down to a bug in `read_key_sequence': it failed to reinitialize its
1326 local function-key-map/key-translation-map references when it
1327 switched keyboards. I don't understand why did this bug only
1328 appear on brand new frames, though!)
9684e4c9 1329
5f6a587f
KL
1330-- Disable connecting to a new X display when we use the GTK toolkit.
1331
1332 (Disabled in patch-450.)
1333
f105f403
KL
1334-- Implement automatic forwarding of client environment variables to
1335 forked processes, as discussed on the multi-tty list. Terminal
1336 parameters are now accessible in C code, so the biggest obstacle is
1337 gone. The `getenv_internal' and `child_setup' functions in
1338 callproc.c must be changed to support the following variable:
1339
1340 terminal-local-environment-variables is a variable defined in ...
1341
1342 Enable or disable terminal-local environment variables.
1343
1344 If set to t, `getenv', `setenv' and subprocess creation
1345 functions use the environment variables of the emacsclient
1346 process that created the selected frame, ignoring
1347 `process-environment'.
1348
1349 If set to nil, Emacs uses `process-environment' and ignores
1350 the client environment.
1351
1352 Otherwise, `terminal-local-environment-variables' should be a
1353 list of variable names (represented by Lisp strings) to look
1354 up in the client environment. The rest will come from
1355 `process-environment'.
1356
1357 (Implemented in patch-461; `terminal-getenv', `terminal-setenv' and
1358 `with-terminal-environment' are now replaced by extensions to
1359 `getenv' and `setenv', and the new `local-environment-variables'
1360 facility. Yay!)
1361
da8e8fc1
KL
1362 (Updated in patch-465 to fix the semantics of let-binding
1363 `process-environment'. `process-environment' was changed to
1364 override all local/global environment variables, and a new variable
1365 `global-environment' was introduced to have `process-environment's
1366 old meaning.)
1367
1368 (Updated in patch-466 to fix the case when two emacsclient sessions
1369 share the same terminal, but have different environment. The local
1370 environment lists are now stored as frame parameters, so the
1371 C-level terminal parameters are not strictly necessary any more.)
1372
526039df
KL
1373-- `Fdelete_frame' is called from various critical places where it is
1374 not acceptable for the frame deletion to fail, e.g. from
1375 x_connection_closed after an X error. `Fdelete_frame' now protects
1376 against `delete-frame-functions' throwing an error and preventing a
1377 frame delete. (patch-475)
1378
b3e6f69c
KL
1379-- Fix set-input-mode for multi-tty. It's a truly horrible interface;
1380 what if we'd blow it up into several separate functions (with a
1381 compatibility definition)?
1382
1383 (Done. See `set-input-interrupt-mode', `set-output-flow-control',
1384 `set-input-meta-mode' and `set-quit-char'.) (patch-457)
1385
1386-- Let-binding `overriding-terminal-local-map' on a brand new frame
1387 does not seem to work correctly. (See `fancy-splash-screens'.)
1388 The keymap seems to be set up right, but events go to another
1389 terminal. Or is it `unread-command-events' that gets Emacs
1390 confused? Investigate.
1391
1392 (Emacs was confused because a process filter entered
1393 `recursive-edit' while Emacs was reading input. I added support
1394 for this in the input system.) (patch-489)
1395
1396-- I smell something funny around pop_kboard's "deleted kboard" case.
1397 Determine what are the circumstances of this case, and fix any
1398 bug that comes to light.
1399
1400 (It happens simply because single_kboard's terminal is sometimes
1401 deleted while executing a command on it, for example the one that
1402 kills the terminal. There was no bug here, but I rewrote the whole
1403 single_kboard mess anyway.) (patch-489)
1404
6bbba5a6
KL
1405-- Understand Emacs's low-level input system (it's black magic) :-)
1406 What exactly does interrupt_input do? I tried to disable it for
1407 raw secondary tty support, but it does not seem to do anything
1408 useful. (Update: Look again. X unconditionally enables this, maybe
1409 that's why raw terminal support is broken again. I really do need
1410 to understand input.)
1411 (Update: I am starting to understand the read_key_sequence->read-char
1412 ->kbd_buffer_get_event->read_avail_input->read_socket_hook path. Yay!)
1413
1414 (Update: OK, it all seems so easy now (NOT). Input could be done
1415 synchronously (with wait_reading_process_input), or asynchronously
1416 by SIGIO or polling (SIGALRM). C-g either sets the Vquit_flag,
1417 signals a 'quit condition (when immediate_quit), or throws to
1418 `getcjmp' when Emacs was waiting for input when the C-g event
1419 arrived.)
1420
9688ff53
KL
1421-- Replace wrong_kboard_jmpbuf with a special return value of
1422 read_char. It is absurd that we use setjmp/longjmp just to return
1423 to the immediate caller.
1424
1425 (Done in patch-500.)
526039df 1426
6a5af08f
KL
1427-- `tool-bar-mode', `scroll-bar-mode', `menu-bar-mode' and
1428 'fringe-mode' are modes global to the entire Emacs session, not
1429 just a single frame or a single terminal. This means that their
1430 status sometimes differs from what's actually displayed on the
1431 screen. As a consequence, the Options | Show/Hide menu sometimes
1432 shows incorrect status, and you have to select an option twice for
1433 it to have any visible effect on the current frame.
1434
1435 Change Emacs so that the status of the items in the Options |
1436 Show/Hide menu correspond to the current frame.
1437
1438 (Done in patch-537.)
1439
2828d5f9
KL
1440-- The `default-directory' variable should somehow be set to the
1441 cwd of the emacsclient process when the user runs emacsclient
1442 without file arguments. Perhaps it is OK to just override the
1443 directory of the *scratch* buffer.
1444
1445 (Done in patch-539.)
1446
ce593f6e
KL
1447-- The borders on tooltip frames on X are messed up. More
1448 specifically, the frame's internal border (internal-border-width
1449 frame parameter) is not filled with the correct background color.
1450
1451 It seems the border contents are drawn onto by the
1452 update_single_window call in `x-show-tip'. After some debugging, I
1453 think the window's background color is not set up
1454 correctly---calling `x_clear_area' fills the specified area with
1455 black, not light yellow.
1456
1457 (Done in patch-544. A background_pixel field was defined both in
1458 struct frame and struct x_output, and Emacs got confused between
1459 them.)
1460
28d440ab 1461;;; arch-tag: 8da1619e-2e79-41a8-9ac9-a0485daad17d
2a42d440 1462