README.multi-tty 35 KB
Newer Older
1
			-*- coding: utf-8; mode: text; -*-
2 3 4
GOAL
----

5 6
This branch implements support for opening multiple, different tty
devices and simultaneous X and tty frames from a single Emacs session.
7

8 9 10 11 12 13 14 15 16 17 18 19 20 21
Some use cases:
Emacs is notoriously slow at startup, so most people use another
editor or emacsclient for quick editing jobs from the console.
Unfortunately, emacsclient was very awkward to use, because it did not
support opening a new Emacs frame on the current virtual console.
Now, with multi-tty support, it can do that.  (Emacsclient starts up
faster than vi!)

Some Gnus users (including me) run Gnus in an X frame in its own Emacs
instance, which they typically leave running for weeks.  It would be
nice if they could connect to this instance from a remote ssh session
and check their messages without opening a remote X frame or resorting
to gnus-slave.

22 23 24 25 26
WHO IS DOING IT
---------------

I'm Károly Lőrentey.  My address: lorentey@elte.hu.

27 28 29
Comments, bug reports, suggestions and patches are welcome; send them
to multi-tty@lists.fnord.hu.

30 31 32 33 34
The following is a (sadly incomplete) list of people who have
contributed to the project by testing, submitting patches, bug
reports, and suggestions.  Thanks!

ARISAWA Akihiro <ari at mbf dot ocn dot ne dot jp>
35
Vincent Bernat <bernat at luffy dot cx>
36 37 38 39 40 41 42 43 44
Han Boetes <han at mijncomputer dot nl>
Robert J. Chassell <bob at rattlesnake dot com>
Romain Francoise <romain at orebokech dot com>
Ami Fischman <ami at fischman dot org>
Friedrich Delgado Friedrichs <friedel at nomaden dot org>
IRIE Tetsuya <irie at t dot email dot ne dot jp>
Yoshiaki Kasahara <kasahara at nc dot kyushu-u dot ac dot jp>
Jurej Kubelka <Juraj dot Kubelka at email dot cz>
David Lichteblau <david at lichteblau dot com>
45
Xavier Mallard <zedek at gnu-rox dot org>
46 47 48 49 50 51 52 53 54 55 56 57 58 59
Istvan Marko <mi-mtty at kismala dot com>
Ted Morse <morse at ciholas dot com>
Dan Nicolaescu <dann at ics dot uci dot edu>
Gergely Nagy <algernon at debian dot org>
Mark Plaksin <happy at mcplaksin dot org>
Francisco Borges <borges at let dot rug dot nl>
Frank Ruell <stoerte at dreamwarrior dot net>
Dan Waber <dwaber at logolalia dot com>
and many others.

Richard Stallman was kind enough to review an earlier version of my
patches.


60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
MAILING LISTS
-------------

The multi-tty mailing list (discussion & bug reports):

    	Address:	multi-tty@lists.fnord.hu
	Signup:		http://lists.fnord.hu/mailman/listinfo/multi-tty
	Archive:	http://news.gmane.org/gmane.emacs.multi-tty/

Commit notifications (read-only):

        Address:	multi-tty-commits@lists.fnord.hu
	Signup:		http://lists.fnord.hu/mailman/listinfo/multi-tty-commits


STATUS
------

The branch is now very stable and almost full-featured.  All of the
major problems have been fixed, only a few minor issues remain.  (It
still needs to be ported to Windows/Mac/DOS, though.)  Both multiple
tty device support and simultaneous X and tty frame support works
fine.  Emacsclient has been extended to support opening new tty and X
frames.  It has been changed open new Emacs frames by default.

The multi-tty branch has been scheduled for inclusion in the next
major release of Emacs (version 22).  I expect the merge into the
development trunk to occur sometime during next year (2005), after the
merge of the Unicode branch.

Karoly Lorentey's avatar
Karoly Lorentey committed
90 91 92
Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD.  Please let me
know if you succeed or fail to use it on other platforms---I'll have a
few tricky test cases for you.
93 94 95

Known problems:

96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
        * The single-kboard mode.

	  If your multi-tty Emacs session seems to be frozen, you
	  probably have a recursive editing session or a pending
	  minibuffer prompt (which is a kind of recursive editing) on
	  another display.  To unfreeze your session, switch to that
	  display and complete the recursive edit, for example by
	  pressing C-] (`abort-recursive-edit').

	  I am sorry to say that currently there is no way to break
	  out of this "single-kboard mode" from a frozen display.  If
	  you are unable to switch to the display that locks the
	  others (for example because it is on a remote computer),
	  then you can use emacsclient to break out of all recursive
	  editing sessions:

		emacsclient -e '(top-level)'

	  Note that this (perhaps) unintuitive behaviour is by design.
	  Single-kboard mode is required because of an intrinsic Emacs
	  limitation that is very hard to eliminate.  (This limitation
	  is related to the single-threaded nature of Emacs.)

	  I plan to implement better user notification and support for
	  breaking out of single-kboard mode from locked displays.

	* Mac, Windows and DOS support is broken, doesn't even
  	  compile.  Multiple display support will probably not provide
  	  new Emacs features on these systems, but the multi-tty
  	  branch changed a few low-level interfaces, and the
  	  system-dependent source files need to be adapted
  	  accordingly.  The changes are mostly trivial, so almost
  	  anyone can help, if only by compiling the branch and
  	  reporting the compiler errors.  (It is not worth to do this
  	  yet, though.)

132 133 134 135 136

HOW TO GET THE BRANCH
---------------------

The branch uses GNU Arch (http://www.gnuarch.org) for version control.
137

138
Retrieving the latest version of the branch:
139

140
	tla register-archive -f http://lorentey.hu/arch/2004/
141 142 143 144
	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>

This incantation uses my private archive mirror that is hosted on a
relatively low-bandwidth site; if you are outside Hungary, you will
145 146 147
probably want to you use the Arch supermirror instead: (Note that the
-f option will overwrite the archive location if you have previously
registered the Hungarian one.)
148

149
	tla register-archive -f http://mirrors.gnuarch.org/lorentey@elte.hu--2004/
150
	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>
151

152 153
My GPG key id is 0FB27A3F; it is available from
hkp://wwwkeys.eu.pgp.net/, or from my homepage at
154
http://lorentey.hu/rolam/gpg.html)
155

156 157 158
Don't worry if the above checkout takes a few minutes to complete;
once you have a source tree, updating it to the latest revision will
be _much_ faster.  Use the following command for the update:
159

160
	tla replay
161

162 163
You can find more information about Arch on http://wiki.gnuarch.org/.
It's a wonderful source control system, I highly recommend it.
164

165
If you don't have tla, the branch has a homepage from which you can
166
download conventional patches against Emacs CVS HEAD:
167

168
	http://lorentey.hu/project/emacs.html
169 170


Karoly Lorentey's avatar
Karoly Lorentey committed
171 172
COMPILATION
-----------
173

174
The multi-tty branch is compiled the same way as Emacs itself:
175

Karoly Lorentey's avatar
Karoly Lorentey committed
176 177
	make maintainer-clean  # (If you have compiled Emacs before)

178
	./configure <your favourite options>
179
	make bootstrap
180 181
	make install

Karoly Lorentey's avatar
Karoly Lorentey committed
182 183 184 185 186
If you have strange compilation errors, they may be caused by old
*.elc files that are left over from an earlier bootstrap.  The `make
maintainer-clean' target deletes them, so it is a good idea to run
that before reporting a bug.  (Emacs requires a clean recompilation
after certain kinds of source code changes.)
187

Karoly Lorentey's avatar
Karoly Lorentey committed
188 189 190 191
TESTING
-------

To test the multi-tty branch, start up the Emacs server with the
192 193 194
following commands:

	emacs
195
	M-x server-start
196

197 198
and then (from a shell prompt on another terminal) start emacsclient
with
199 200
	emacsclient -t /optional/file/names...   (for a tty frame)
	emacsclient /optional/file/names...      (for an X frame)
201

202
(Make sure both emacs and emacsclient are multi-tty versions.)
Karoly Lorentey's avatar
Karoly Lorentey committed
203
You'll hopefully have two fully working, independent frames on
204
separate terminals. The new frame is closed automatically when you
Karoly Lorentey's avatar
Karoly Lorentey committed
205 206 207
finish editing the specified files (C-x #), but delete-frame (C-x 5 0)
also works.  Of course, you can create frames on more than two tty
devices.
208

209 210 211
Creating new frames on the same tty with C-x 5 2 works, and they
behave the same way as in previous Emacs versions.  If you exit emacs,
all terminals should be restored to their previous states.
212

213 214 215 216
This is work in progress, and probably full of bugs.  It is a good
idea to run emacs from gdb, so that you'll have a live instance to
debug if something goes wrong.  Please send me your bug reports on our
mailing list: multi-tty@lists.fnord.hu
Karoly Lorentey's avatar
Karoly Lorentey committed
217

218 219 220
TIPS & TRICKS
-------------

221 222
I think the best way to use the new Emacs is to have it running inside
a disconnected GNU screen session, and always use emacsclient for
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
normal work.  One advantage of this is that not a single keystroke of
your work will be lost if the display device that you are using
crashes, or the network connection times out, or whatever.  (I had an
extremely unstable X server for some time while I was developing these
patches, and running Emacs this way has saved me a number of M-x
recover-session invocations.)

I use the following two bash functions to handle my Emacs sessions:

,----[ ~/.bash_profile
| # Usage: preload-emacs <name> [<waitp>]
| #
| # Preloads the Emacs instance called NAME in a detached screen
| # session.  Does nothing if the instance is already running.  If WAITP
| # is non-empty, the function waits until the server starts up and
| # creates its socket; otherwise it returns immediately.
| function preload-emacs {
|     local name="$1"
|     local waitp="$2"
|     local screendir="/var/run/screen/S-$USER"
|     local serverdir="/tmp/emacs$UID"
|     local emacs=emacs # Or wherever you installed your multi-tty Emacs
| 
|     if [ -z "$name" ]; then 
| 	echo "Usage: preload-emacs <name> [<waitp>]" >&2
| 	return 1
|     fi
| 
|     if [ ! -e "$screendir"/*."$name" ]; then
| 	if [ -e "$serverdir/$name" ]; then
Karoly Lorentey's avatar
Karoly Lorentey committed
253
| 	    # Delete leftover socket (for the wait option)
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
| 	    rm "$serverdir/$name"
| 	fi
| 	screen -dmS "$name" "$emacs" -nw --eval "(setq server-name \"$name\")" -f server-start
|     fi
|     if [ ! -z "$waitp" ]; then
| 	while [ ! -e "$serverdir/$name" ]; do sleep 0.1; done
|     fi
|     return 0
| }
| 
| # Usage: connect-emacs <name> <args>...
| #
| # Connects to the Emacs instance called NAME.  Starts up the instance
| # if it is not already running.  The rest of the arguments are passed
| # to emacsclient.
| function connect-emacs {
|     local name="$1"
|     shift
|     
|     if [ -z "$name" ]; then
| 	echo "Usage: connect-emacs <name> <args>..." >&2
|     fi
|     preload-emacs "$name" wait
|     emacsclient -s "$name" "$@"
| }
| 
| export -f preload-emacs connect-emacs
|
| # Preload editor and gnus sessions for speedy initial connects.
| preload-emacs editor
| preload-emacs gnus
`----

,----[ ~/.bashrc
| alias gnus="connect-emacs gnus"
| alias edit="connect-emacs editor"
| alias et="connect-emacs editor -t"
| alias e=edit
`----

294 295 296 297

NEWS
----

298
For the NEWS file:  (Needs work)
299

300
** Support for multiple terminal devices has been added.
301

302 303
*** You can specify a terminal device (`tty' parameter) and a terminal
    type (`tty-type' parameter) to `make-terminal-frame'.
304

305 306
*** You can test for the presence of multiple terminal support by
    testing for the `multi-tty' feature.
307

308
*** Emacsclient has been extended to support opening a new terminal
Karoly Lorentey's avatar
Karoly Lorentey committed
309 310 311
    frame. Its behaviour has been changed to open a new Emacs frame by
    default.  Use the -c option to get the old behavior of opening
    files in the currently selected Emacs frame.
312

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
*** A make-frame-on-tty function has been added to make it easier to
    create frames on new terminals.

*** New functions: frame-tty-name, frame-tty-type for accessing
    terminal parameters, and delete-tty for closing the terminal
    device.

*** talk.el has been extended for multiple tty support.


** Support for simultaneous graphical and terminal frames has been
   added.

*** The function `make-frame-on-display' now works during a terminal
    session, and `make-frame-on-tty' works during a graphical session.

*** The `window-system' variable has been made frame-local.

*** The new `initial-window-system' variable contains the
    `window-system' value for the first frame.
333

334 335 336 337 338
CHANGELOG
---------

See arch logs.

Karoly Lorentey's avatar
Karoly Lorentey committed
339 340 341 342 343
* * *

(The rest of this file consists of my development notes and as such it
is probably not very interesting for anyone else.)

344 345
THINGS TO DO
------------
346

347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
** The single-keyboard mode of MULTI_KBOARD is extremely confusing
   sometimes; Emacs does not respond to stimuli from other keyboards.
   At least a beep or a message would be important, if the single-mode
   is still required to prevent interference.  (Reported by Dan
   Nicolaescu.)  

   Update: selecting a region with the mouse enables single_kboard
   under X.  This is very confusing.

   Update: After discussions with Richard, this will be resolved by
   having locked displays warn the user to wait, and introducing a
   complex protocol to remotely bail out of single-kboard mode by
   pressing C-g.

   Update: Warning the user is not trivial to implement, as Emacs has
   only one echo area.  Ideally the warning should not be displayed on
   the display that is locking the others.  Perhaps the high
   probability of user confusion caused by single_kboard mode deserves
   a special case in the display code.  Alternatively, it might be
   good enough to signal single_kboard mode by changing the modelines
   or some other frame-local display element on the locked out displays.

** normal-erase-is-backspace-mode in simple.el needs to be updated for
   multi-tty (rep. by Dan Waber).
371

372 373 374
** Hunt down display-related functions in frame.el and extend them all
   to accept display ids.

375 376 377
** rif->flush_display_optional (NULL) calls should be replaced by a
   new global function.

Karoly Lorentey's avatar
Karoly Lorentey committed
378 379
** Have a look at fatal_error_hook.

Karoly Lorentey's avatar
Karoly Lorentey committed
380 381
** Have a look at set_frame_matrix_frame.

Karoly Lorentey's avatar
Karoly Lorentey committed
382 383
** Check if we got term-setup-hook right.

384 385 386 387
** I think tip_frame should be display-local.

** Check display reference count handling in x_create_tip_frame.

388 389 390 391 392 393 394 395
** make-frame does not correctly handle extra parameters in its
   argument:

	(frame-parameter (make-frame (list (cons 'foobar 42))) 'foobar)
		=> nil

   (This is likely an error in the CVS trunk.)

Karoly Lorentey's avatar
Karoly Lorentey committed
396 397 398 399
** Fix set-input-mode for multi-tty.  It's a truly horrible interface;
   what if we'd blow it up into several separate functions (with a
   compatibility definition)?

400 401 402 403
** The terminal customization files in term/*.el tend to change global
   parameters, which may confuse Emacs with multiple displays.  Change
   them to tweak only frame-local settings, if possible.

Karoly Lorentey's avatar
Karoly Lorentey committed
404 405 406
** Dan Nicolaescu suggests that -nw should be added as an alias for -t
   in emacsclient.  Good idea.  (Alas, implementing this is not
   trivial, getopt_long does not seem to support two-letter ``short''
Karoly Lorentey's avatar
Karoly Lorentey committed
407
   options.  Patches are welcome.) :-)
Karoly Lorentey's avatar
Karoly Lorentey committed
408 409 410 411 412

** Mark Plaksin suggests that emacsclient should accept the same
   X-related command-line arguments as Emacs.  Most of the X-related
   argument-handling is done in Lisp, so this should be quite easy to
   implement.
413

Karoly Lorentey's avatar
Karoly Lorentey committed
414 415 416 417
** Gergely Nagy suggests that C-x # should only kill the current
   frame, not any other emacsclient frame that may have the same file
   opened for editing.  I think I agree with him.

418 419 420 421 422 423 424
** Very strange bug: visible-bell does not work on secondary
   terminals in xterm and konsole.  The screen does flicker a bit,
   but it's so quick it isn't noticable.

** Clean up the frame-local variable system.  I think it's ugly and
   error-prone.  But maybe I just haven't yet fully understood it.

425
** Move baud_rate to struct display.
426 427 428

** Implement support for starting an interactive Emacs session without
   an initial frame.  (The user would connect to it and open frames
Karoly Lorentey's avatar
Karoly Lorentey committed
429
   later, with emacsclient.)
430

431 432 433 434
** Fix Mac support (I can't do this entirely myself).  Note that the
   current state of Mac-specific source files in the multi-tty tree
   are not useful; before starting work on Mac support, revert to
   pristine, pre-multi-tty versions.
435

436 437 438 439
** Fix W32 support (I can't do this entirely myself).  Note that the
   current state of W32-specific source files in the multi-tty tree
   are not useful; before starting work on W32 support, revert to
   pristine, pre-multi-tty versions.
440

441 442 443 444
** Fix DOS support (I can't do this entirely myself).  Note that the
   current state of DOS-specific source files in the multi-tty tree
   are not useful; before starting work on DOS support, revert to
   pristine, pre-multi-tty versions.
445 446 447

** Do a grep on XXX and ?? for more issues.

Karoly Lorentey's avatar
Karoly Lorentey committed
448 449 450 451 452 453
** Understand Emacs's low-level input system (it's black magic) :-)
   What exactly does interrupt_input do?  I tried to disable it for
   raw secondary tty support, but it does not seem to do anything
   useful.  (Update: Look again. X unconditionally enables this, maybe
   that's why raw terminal support is broken again.  I really do need
   to understand input.)
454

455 456
** Maybe standard-display-table should be display-local.

457 458 459 460
DIARY OF CHANGES
----------------

(ex-TODO items with explanations.)
461

462
-- Introduce a new struct for terminal devices.
463

464
   (Done, see struct tty_output.  The list of members is not yet
465 466 467 468 469 470 471 472 473 474
   complete.)

-- Change the bootstrap procedure to initialize tty_list.

   (Done, but needs review.)

-- Change make-terminal-frame to support specifying another tty.

   (Done, new frame parameters: `tty' and `tty-type'.)

475 476 477
-- Implement support for reading from multiple terminals.

   (Done, read_avail_input tries to read from each terminal, until one
478
   succeeds.  MULTI_KBOARD is not used.  Secondary terminals don't send
479
   SIGIO!)
480

481 482
   (Update: They do, now.)

483 484
   (Update2: After enabling X, they don't.)

485
-- other-frame should cycle through the frames on the `current'
486
   terminal only.
487

488
   (Done, by trivially modifiying next_frame and prev_frame.)
489 490

-- Support different terminal sizes.
491

492 493 494 495 496
   (Done, no problem.)

-- Make sure terminal resizes are handled gracefully.  (Could be
   problematic.)

497 498
   (Done.  We don't get automatic SIGWINCH for additional ttys,
   though.)
499 500 501

-- Extend emacsclient to automatically open a new tty when it connects
   to Emacs.
502

503 504
   (Done.  It's an ugly hack, needs more work.)

505 506
-- Redisplay must refresh the topmost frame on *all* terminals, not
   just the initial terminal.
507

508
   (Done, but introduced an ugly redisplay problems.  Ugh.)
509

510 511
-- Fix redisplay problems.

512 513
   (Done; it turned out that the entire Wcm structure must be moved
   inside tty_output.  Why didn't I catch this earlier?)
514 515 516 517 518 519 520 521 522 523

-- Provide a way for emacsclient to tell Emacs that the tty has been
   resized.

   (Done, simply forward the SIGWINCH signal.)

-- Each keypress should automatically select the frame corresponding
   to the terminal that it was coming from.  This means that Emacs
   must know from which terminal the last keyboard event came from.

524 525
   (Done, it was quite simple, the input event system already
   supported multiple frames.)
526 527 528 529

-- Fix SIGIO issue with secondary terminals.

   (Done, emacsclient signals Emacs after writing to the proxy pseudo
530 531
   terminal.  Note that this means that multi-tty does not work with
   raw ttys!)
532

Karoly Lorentey's avatar
Karoly Lorentey committed
533 534 535
   (Update: This is bullshit.  There is a read_input_waiting function,
   extend that somehow.)

536 537 538 539
   (Update of update: The first update was not right either, extending
   read_input_waiting was not necessary.  Secondary ttys do seem to
   send signals on input.)

540 541
   (Update^3: Not any more.)

542 543 544 545 546 547 548 549 550 551
-- Make make-terminal-frame look up the `tty' and `tty-type' frame
   parameters from the currently selected terminal before the global
   default.

   (Done.)

-- Put all cached terminal escape sequences into struct tty_output.
   Currently, they are still stored in global variables, so we don't
   really support multiple terminal types.

552
   (Done.  It was not fun.)
553 554

-- Implement sane error handling after initialization.  (Currently
555 556 557
   emacs exits if you specify a bad terminal type.)  The helpful error
   messages must still be provided when Emacs starts.

558 559 560 561 562
   (Done.)

-- Implement terminal deletion, i.e., deleting local frames, closing
   the tty device and restoring its previous state without exiting
   Emacs.
563

564 565
   (Done, but at the moment only called when an error happens during
   initialization.  There is a memory corruption error around this
566
   somewhere.)  (Update: now it is fully enabled.)
567

568 569 570 571 572
-- Implement automatic deletion of terminals when the last frame on
   that terminal is closed.

   (Done.)

Karoly Lorentey's avatar
Karoly Lorentey committed
573 574 575 576 577
-- Restore tty screen after closing the terminal.

   (Done, we do the same as Emacs 21.2 for all terminals.)

-- 'TERM=dumb src/emacs' does not restore the terminal state.
578

Karoly Lorentey's avatar
Karoly Lorentey committed
579
   (Done.)
580

581 582 583 584 585 586 587 588
-- C-g should work on secondary terminals.

   (Done, but the binding is not configurable.)

-- Deal with SIGHUP in Emacs and in emacsclient.  (After this, the
   server-frames may be removed from server.el.)

   (Done, nothing to do.  It seems that Emacs does not receive SIGHUP
589
   from secondary ttys, which is actually a good thing.)  (Update: I
590
   think it would be a bad idea to remove server-frames.)
591

592
-- Change emacsclient/server.el to support the -t argument better,
593 594 595 596
   i.e. automatically close the socket when the frame is closed.

   (Seems to be working OK.)

597
-- Fix mysterious memory corruption error with tty deletion.  To
598 599 600 601 602
   trigger it, try the following shell command:

	while true; do TERM=no-such-terminal-definition emacsclient -h; done

   Emacs usually dumps core after a few dozen iterations.  (The bug
603
   seems to be related to the xfreeing or bzeroing of
604 605 606
   tty_output.Wcm.  Maybe there are outside references to struct Wcm?
   Why were these vars collected into a struct before multi-tty
   support?)
607

608 609 610 611
   (Done.  Whew.  It turned out that the problem had nothing to do
   with hypothetical external references to Wcm, or any other
   tty_output component; it was simply that delete_tty closed the
   filehandles of secondary ttys twice, resulting in fclose doubly
612
   freeing memory.  Utterly trivial matter.  I love the C's memory
613 614
   management, it puts hair on your chest.)

615
-- Support raw secondary terminals.  (Note that SIGIO works only on
616
   the controlling terminal.) Hint: extend read_input_waiting for
617
   multiple ttys and hopefully this will be fixed.
618

619 620 621 622
   (Done, it seems to have been working already for some time.  It
   seems F_SETOWN does work, after all.  Not sure what made it fail
   earlier, but it seems to be fixed (there were several changes
   around request_sigio, maybe one of them did it).
623
   read_input_waiting is only used in sys_select, don't change
624
   it.)  (Update: After adding X support, it's broken again.)
Karoly Lorentey's avatar
Karoly Lorentey committed
625
   (Update^2: No it isn't.) :-)
626

627
-- Find out why does Emacs abort when it wants to close its
Karoly Lorentey's avatar
Karoly Lorentey committed
628
   controlling tty.  Hint: chan_process[] array.  Hey, maybe
629 630
   noninterrupt-IO would work, too?  Update: no, there is no process
   for stdin/out.
Karoly Lorentey's avatar
Karoly Lorentey committed
631

632 633
   (Done.  Added add/delete_keyboard_wait_descriptor to
   term_init/delete_tty.  The hint was right, in a way.)
634

635
-- Issue with SIGIO: it needs to be disabled during redisplay.  See if
636
   fcntl kernel behaviour could be emulated by emacsclient.
Karoly Lorentey's avatar
Karoly Lorentey committed
637

638
   (Done.  Simply disabled the SIGIO emulation hack in emacsclient.)
Karoly Lorentey's avatar
Karoly Lorentey committed
639
   (Update: it was added back.)  (Update^2: and removed again.)
640

641
-- server.el: There are issues with saving files in buffers of closed
642 643 644 645 646
   clients.  Try editing a file with emacsclient -f, and (without
   saving it) do a delete-frame.  The frame is closed without
   question, and a surprising confirmation prompt appears in another
   frame.

647 648 649 650
   (Done.  delete-frame now asks for confirmation if it still has
   pending buffers, and modified buffers don't seem to be deleted.)

-- emacsclient.el, server.el: Handle eval or file open errors when
651
   doing -t.
652

653
   (Done.)
654

655 656
-- Make parts of struct tty_output accessible from Lisp.  The device
   name and the type is sufficient.
657

658 659 660
   (Done, see frame-tty-name and frame-tty-type.)

-- Export delete_tty to the Lisp environment, for emacsclient.
661

662 663
   (Done, see delete-tty.)

664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683
-- Get rid of the accessor macros in termchar.h, or define macros for
   all members.

   (Done.)

-- Move device-specific parameters (like costs) commonly used by
   device backends to a common, device-dependent structure.

   (Done.  See struct display_method in termhooks.h.)

-- Fix X support.

   (Done.  Well, it seems to be working.)

-- Allow simultaneous X and tty frames.  (Handling input could be
   tricky.  Or maybe not.)

   (Done.  Allowed, that is.  It is currently extremely unstable, to
   the point of being unusable.  The rif variable causes constant
   core dumps.  Handling input is indeed tricky.)
684

685
-- Rewrite multi-tty input in terms of MULTI_KBOARD.
686

687 688 689
   (Done.  In fact, there was no need to rewrite anything, I just
   added a kboard member to tty_display_info, and initialized the
   frame's kboard from there.)
690

691 692 693 694 695 696 697
-- Fix rif issue with X-tty combo sessions.  IMHO the best thing to do
   is to get rid of that global variable (and use the value value in
   display_method, which is guaranteed to be correct).

   (Done, did exactly that.  Core dumps during combo sessions became
   much rarer.  In fact, I have not yet met a single one.)

698 699 700 701
-- Add multi-tty support to talk.el.

   (Done.)

702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
-- Clean up the source of emacsclient.  It is a mess.

   (Done, eliminated stupid proxy-pty kludge.)

-- Fix faces on tty frames during X-tty combo sessions.  There is an
   init_frame_faces call in init_sys_modes, see if there is a problem
   with it.

   (Done, there was a stupid mistake in
   Ftty_supports_face_attributes_p. Colors are broken, though.)

-- C-x 5 2, C-x 5 o, C-x 5 0 on an emacsclient frame unexpectedly
   exits emacsclient.  This is a result of trying to be clever with
   delete-frame-functions.

   (Fixed, added delete-tty-after-functions, and changed server.el to
   use it.)

-- Something with (maybe) multi-keyboard support broke function keys
   and arrows on ttys during X+tty combo sessions.  Debug this.

   (I can't reproduce it, maybe the terminal type was wrong.)

-- Fix input from raw ttys (again).

   (Now it seems to work all right.)

-- During an X-tty combo session, a (message "Hello") from a tty frame
   goes to the X frame.  Fix this.

   (Done.  There was a safeguard against writing to the initial
   terminal frame during bootstrap which prevented echo_area_display
   from working correctly on a tty frame during a combo session.)

736
-- If there are no frames on its controlling terminal, Emacs should
Karoly Lorentey's avatar
Karoly Lorentey committed
737
   exit if the user presses C-c there.
738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

   (Done, as far as possible.  See the SIGTERM comment in
   interrupt_signal on why this seems to be impossible to solve this
   in general.)

-- During an X session, Emacs seems to read from stdin.  Also, Emacs
   fails to start without a controlling tty.

   (Fixed by replacing the troublesome termcap display with a dummy
   bootstrap display during bootstrap.

-- Do tty output through struct display, like graphical display
   backends.

   (Done.)

-- Define an output_initial value for output_method for the initial
   frame that is dumped with Emacs.  Checking for this frame (e.g. in
   cmd_error_internal) is ugly.

   (Done, broking interactive temacs.)

-- The command `emacsclient -t -e '(delete-frame)'' fails to exit.

   (Fixed.)

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784
-- frame-creation-function should always create a frame that is on the
   same display as the selected frame.  Maybe frame-creation-function
   should simply be removed and make-frame changed to do the right
   thing.

   (Done, with a nice hack.  frame-creation-function is now frame-local.)

-- Fix C-g on raw ttys.

   (Done.  I disabled the interrupt/quit keys on all secondary
   terminals, so Emacs sees C-g as normal input.  This looks like an
   overkill, because emacsclient has extra code to pass SIGINT to
   Emacs, so C-g should remain the interrupt/quit key on emacsclient
   frames.  See the next entry why implementing this distinction would
   be a bad idea.)

-- Make sure C-g goes to the right frame with ttys.  This is hard, as
   SIGINT doesn't have a tty parameter. :-(

   (Done, the previous change fixes this as a pleasant side effect.)

785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
-- I have seen a case when Emacs with multiple ttys fell into a loop
   eating 100% of CPU time.  Strace showed this loop:

	getpid()                                = 30284
	kill(30284, SIGIO)                      = 0
	--- SIGIO (I/O possible) @ 0 (0) ---
	ioctl(6, FIONREAD, [0])                 = -1 EIO (Input/output error)
	ioctl(5, FIONREAD, [0])                 = -1 EIO (Input/output error)
	ioctl(0, FIONREAD, [0])                 = 0
	sigreturn()                             = ? (mask now [])
	gettimeofday({1072842297, 747760}, NULL) = 0
	gettimeofday({1072842297, 747806}, NULL) = 0
	select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
	select(9, [0 3 5 6], NULL, NULL, {0, 0}) = 2 (in [5 6], left {0, 0})
	gettimeofday({1072842297, 748245}, NULL) = 0

   I have seen something similar with a single X frame, but have not
   been able to reproduce it for debugging.

   Update: This may have been caused by checking for nread != 0
   instead of nread > 0 after calling read_socket_hook in
   read_avail_input.

   (Fixed.  This was caused by unconditionally including stdin in
   input_wait_mask in init_process.  The select call in
   wait_reading_process_input always returned immediately, indicating
   that there is pending input from stdin, which nobody read.

   Note that the above strace output seems to be an unrelated but
   similar bug.  I think that is now fixed.)
815

816 817 818 819 820 821 822 823 824
-- Exiting Emacs while there are emacsclient frames doesn't restore the
   ttys to their default states.

   (This seems to be fixed by some previous change.)

-- Allow opening an X session after -nw.

   (Done.)

825 826 827 828 829 830 831 832 833 834 835
-- Fix color handling during tty+X combo sessions.  (It seems that tty
   sessions automatically convert the face colors to terminal colors
   when the face is loaded.  This conversion must happen instead on
   the fly in write_glyphs, which might be problematic, as color
   approximation is currently done in lisp (term/tty-colors.el).)
   (Update: hm, colors seem to work fine if I start emacs with -nw and
   then create an X frame.  Maybe it's just a small buglet somewhere.)

   (Seems to be fixed.  The problem was in startup.el, it did not
   initialize tty colors when the initial window system was
   graphical.)
836

837 838 839 840 841
-- emacs -nw --eval '(y-or-n-p "Foobar")' segfaults.  (Reported by
   Romain Francoise)

   (Fixed, there was a keyboard initialization problem.)

Karoly Lorentey's avatar
Karoly Lorentey committed
842 843 844 845 846
-- Fix interactive use of temacs.  There are face-related SEGVs, most
   likely because of changes in realize_default_face, realize_face.

   (Fixed.)

847 848 849 850 851
-- Don't exit Emacs when the last X connection fails during a
   multi-display session.

   (Fixed.)

852 853 854 855 856 857
-- Dan Nicolaescu noticed that starting emacsclient on the same
   terminal device that is the controlling tty of the Emacs process
   gives unexpected results.

   (Fixed.)

858 859 860 861 862 863 864
-- Istvan Marko reported that Emacs hang on ttys if it was started
   from a shell script.

   (Fixed.  There was a bug in the multi-tty version of
   narrow_foreground_group.  tcsetpgrp blocks if it is called from a
   process that is not in the same process group as the tty.)

865 866 867 868
-- emacsclient -t from an Emacs term buffer does not work, complains
   about face problems.  This can even lock up Emacs (if the recursive
   frame sets single_kboard).  Update: the face problems are caused by
   bugs in term.el, not in multi-tty.  The lockup is caused by
Karoly Lorentey's avatar
Karoly Lorentey committed
869
   single_kboard mode, and is not easily resolvable.  The best thing to
870 871 872 873 874 875
   do is to simply refuse to create a tty frame of type `eterm'.

   (Fixed, changed emacsclient to check for TERM=eterm.  The face
   complaints seem to be caused by bugs in term.el; they are not
   related to multi-tty.)

876 877 878 879 880 881 882 883 884 885
-- Find out the best way to support suspending Emacs with multiple
   ttys.  My guess: disable it on the controlling tty, but from other
   ttys pass it on to emacsclient somehow.  (It is (I hope) trivial to
   extend emacsclient to handle suspend/resume.  A `kill -STOP' almost
   works right now.)

   (Done.  I needed to play with signal handling and the server
   protocol a bit to make emacsclient behave as a normal UNIX program
   wrt foreground/background process groups.)

Karoly Lorentey's avatar
Karoly Lorentey committed
886 887 888 889 890 891 892
-- There is a flicker during the startup of `emacs -nw'; it's as if
   the terminal is initialized, reset and then initialialized again.
   Debug this.  (Hint: narrow_foreground_group is called twice during
   startup.)

   (This is gone.)

893 894 895 896 897 898 899 900 901 902 903
-- Robert Chassell has found serious copy-paste bugs with the
   multi-tty branch.  There seem to be redisplay bugs while copying
   from X to a terminal frame.  Copying accented characters do not
   work for me.

   (Patch-124 should fix this, by changing the interprogram-*-function
   variables to be frame-local, as suggested by Mark Plaksin
   (thanks!).  I think that the redisplay bugs are in fact not bugs,
   but delays caused by single_kboard --> perhaps MULTI_KBOARD should
   be removed.)

904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
-- frame-creation-function was removed, which might be a bad idea.
   Think up a compatible solution.

   (It was an internal interface that may be changed when necessary.)

-- Change Lisp code not to (getenv "TERM"); use the `tty-type' frame
   parameter or the frame-tty-type function instead.  (M-x tags-search
   "TERM" helps with this.)  Update: Actually, all getenv invocations
   should be checked for multi-tty compatibility, and an interface
   must be implemented to get the remote client's environment.

   (Done.  Only getenv calls in lisp/term/*.el were changed; other
   calls should be mostly left as they are.)

-- Add an elaborate mechanism for display-local variables.  (There are
   already a few of these; search for `terminal-local' in the Elisp
   manual.)

   (Not needed.  Display-local variables could be emulated by
   frame-local variables.)
924

Karoly Lorentey's avatar
Karoly Lorentey committed
925 926 927 928 929 930 931 932 933 934 935
-- Emacs assumes that all terminal frames have the same locale
   settings as Emacs itself.  This may lead to bogus results in a
   multi-locale setup. (E.g., while logging in from a remote client
   with a different locale.)
   (Update after new bugreport by Friedrich Delgado Friedrichs: 
   (at least) the structs terminal_coding and keyboard_coding in
   coding.c must be moved to struct display, and the Lisp interface
   [set-]keyboard-coding-system must be adapted for the change.)

   (Fixed.  Emacs now uses the locale settings as seen by the
   emacsclient process for server tty frames.)
936

937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987

-- Make `struct display' accessible to Lisp programs.  Accessor functions:

	(displayp OBJECT):  Returns t if OBJECT is a display.
		=> Implemented as display-live-p.

	(display-list):  Returns list of currently active displays.
		=> Implemented.

	(selected-display):  Returns the display object of the selected frame.
		=> Not strictly necessary, but implemented anyway.

	(frame-display FRAME):  Returns the display object of FRAME.
	        => Implemented.

	(display-frames DISPLAY):  Returns a list of frames on DISPLAY.
		=> Already implemented, see frames-on-display-list.

	(display-type DISPLAY):  Returns the type of DISPLAY, as a
		symbol.  (See `framep'.)
		=> Implemented as display-live-p.

	(display-device DISPLAY): Returns the name of the device that
		DISPLAY uses, as a string.  (E.g: "/dev/pts/16", or
		":0.0")
		=> Implemented as display-name.

	etc.

   See next issue why this is necessary.

   (Update: The consensus on emacs-devel seems to be to do this via
   integer identifiers.  That's fine by me.)

   (Done.)

-- The following needs to be supported:

	$ emacsclient -t
		C-z
	$ emacsclient -t
		(This fails now.)

   The cleanest way to solve this is to allow multiple displays on the
   same terminal device; each new emacsclient process should create
   its own display.  As displays are currently identified by their
   device names, this is not possible until struct display becomes
   accessible as a Lisp-level object.

   (Done.)

988 989 990 991 992 993 994 995
-- Miles Bader suggests that C-x C-c on an emacsclient frame should
   only close the frame, not exit the entire Emacs session.  Update:
   see above for a function that does this.  Maybe this should be the
   new default?  

   (Done.  This is the new default.  No complaints so far.)


996
;;; arch-tag: 8da1619e-2e79-41a8-9ac9-a0485daad17d