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

5 6 7
The goal of this branch is to implement support for opening multiple,
different tty devices and simultaneous X and tty frames from a single
Emacs session.
8

9 10 11 12 13 14 15 16 17 18 19 20 21 22
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.

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

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

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67
Comments, bug reports, suggestions and patches are welcome; send them
to multi-tty@lists.fnord.hu.

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.

Please let me know if you find any bugs in this branch.

Known problems:

	* Mac, Windows and DOS support is broken, probably doesn't
	  even compile -- this will be solved later.

Karoly Lorentey's avatar
Karoly Lorentey committed
68
	* Tested on GNU/Linux, Solaris 8, FreeBSD and OpenBSD.
69 70 71 72 73 74


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

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

76
Retrieving the latest version of the branch:
77

78 79 80 81 82 83 84 85
	tla register-archive lorentey@elte.hu--2004 http://lorentey.hu/arch/2004/
	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
probably want to you use the Arch supermirror instead:

	tla register-archive lorentey@elte.hu--2004 http://mirrors.gnuarch.org/lorentey@elte.hu--2004/
86
	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>
87

88 89 90 91
(I use a recent tla development snapshot, but any of the released
versions of arch will do fine, I think.)  My GPG key id is 0FB27A3F;
it is available from hkp://wwwkeys.eu.pgp.net/, or my homepage at
http://lorentey.hu/rolam/gpg.html)
92

93 94 95 96 97
To update your source tree to the latest revision after the first
checkout, simply use the following command:

	tla replay lorentey@elte.hu--2004/emacs--multi-tty--0

98 99 100
If you are interested, you can find more information about Arch on
http://wiki.gnuarch.org/.  It's a wonderful source control system, I
highly recommend it.
101

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

105
	http://lorentey.hu/project/emacs.html
106 107


108 109
HOW TO COMPILE
--------------
110

111
The multi-tty branch is compiled the same way as Emacs itself:
112

113
	./configure <your favourite options>
114
	make bootstrap
115 116 117 118 119 120 121 122 123
	make install

HOW TO TEST IT
--------------

To try out the multi-tty branch start up the Emacs server with the
following commands:

	emacs
124
	M-x server-start
125

126 127
and then (from a shell prompt on another terminal) start emacsclient
with
128 129
	emacsclient -t /optional/file/names...   (for a tty frame)
	emacsclient /optional/file/names...      (for an X frame)
130

131
(Make sure both emacs and emacsclient are multi-tty versions.)
Karoly Lorentey's avatar
Karoly Lorentey committed
132
You'll hopefully have two fully working, independent frames on
133
separate terminals. The new frame is closed automatically when you
Karoly Lorentey's avatar
Karoly Lorentey committed
134 135 136
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.
137

138 139 140
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.
141

142 143
This is work in progress, and probably full of bugs.  You should
always run emacs from gdb, so that you'll have a live instance to
144
debug if something goes wrong.  Please send me your bug reports.
Karoly Lorentey's avatar
Karoly Lorentey committed
145

146 147 148
TIPS & TRICKS
-------------

149 150
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
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
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
181
| 	    # Delete leftover socket (for the wait option)
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
| 	    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
`----

222 223 224 225

NEWS
----

226
For the NEWS file:  (Needs work)
227

228
** Support for multiple terminal devices has been added.
229

230 231
*** You can specify a terminal device (`tty' parameter) and a terminal
    type (`tty-type' parameter) to `make-terminal-frame'.
232

233 234
*** You can test for the presence of multiple terminal support by
    testing for the `multi-tty' feature.
235

236
*** Emacsclient has been extended to support opening a new terminal
Karoly Lorentey's avatar
Karoly Lorentey committed
237 238 239
    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.
240

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
*** 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.
261

262 263 264 265
THANKS
------

The following is an (incomplete) list of people who have contributed
266 267
to the project by testing, submitting patches, bug reports, and
suggestions.  Thanks!
268

269
ARISAWA Akihiro <ari at mbf dot ocn dot ne dot jp>
Karoly Lorentey's avatar
Karoly Lorentey committed
270
Han Boetes <han at mijncomputer dot nl>
271
Robert J. Chassell <bob at rattlesnake dot com>
272
Romain Francoise <romain at orebokech dot com>
273
Ami Fischman <ami at fischman dot org>
274
Friedrich Delgado Friedrichs <friedel at nomaden dot org>
275
IRIE Tetsuya <irie at t dot email dot ne dot jp>
276
Yoshiaki Kasahara <kasahara at nc dot kyushu-u dot ac dot jp>
277
Jurej Kubelka <Juraj dot Kubelka at email dot cz>
278 279
David Lichteblau <david at lichteblau dot com>
Istvan Marko <mi-mtty at kismala dot com>
280
Ted Morse <morse at ciholas dot com>
281
Dan Nicolaescu <dann at ics dot uci dot edu>
Karoly Lorentey's avatar
Karoly Lorentey committed
282
Gergely Nagy <algernon at debian dot org>
Karoly Lorentey's avatar
Karoly Lorentey committed
283
Mark Plaksin <happy at mcplaksin dot org>
284
Francisco Borges <borges at let dot rug dot nl>
Karoly Lorentey's avatar
Karoly Lorentey committed
285
Frank Ruell <stoerte at dreamwarrior dot net>
Karoly Lorentey's avatar
Karoly Lorentey committed
286
Dan Waber <dwaber at logolalia dot com>
Karoly Lorentey's avatar
Karoly Lorentey committed
287
and many others.
288

Karoly Lorentey's avatar
Karoly Lorentey committed
289 290
Richard Stallman was kind enough to review an earlier version of my
patches.
291

292 293 294 295 296
CHANGELOG
---------

See arch logs.

297 298
THINGS TO DO
------------
299

300 301 302
** Hunt down display-related functions in frame.el and extend them all
   to accept display ids.

Karoly Lorentey's avatar
Karoly Lorentey committed
303 304
** Have a look at fatal_error_hook.

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

307 308 309 310 311 312 313 314
** 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
315 316 317 318
** 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)?

Karoly Lorentey's avatar
Karoly Lorentey committed
319 320 321 322 323
** Lisp-level stuff that needs to be updated for multi-tty:

	- normal-erase-is-backspace-mode (simple.el)  (rep. by Dan Waber)


Karoly Lorentey's avatar
Karoly Lorentey committed
324 325 326 327
** 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
328
   Nicolaescu.)  (Update: selecting a region with the mouse enables
329 330 331 332
   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.
Karoly Lorentey's avatar
Karoly Lorentey committed
333

334 335 336 337
** 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
338 339 340
** 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
341
   options.  Patches are welcome.) :-)
Karoly Lorentey's avatar
Karoly Lorentey committed
342 343 344 345 346

** 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.
347

Karoly Lorentey's avatar
Karoly Lorentey committed
348 349 350 351
** 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.

Karoly Lorentey's avatar
Karoly Lorentey committed
352
** Miles Bader suggests that C-x C-c on an emacsclient frame should
353 354 355
   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?
Karoly Lorentey's avatar
Karoly Lorentey committed
356

357 358 359 360 361 362 363
** 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.

364
** Move baud_rate to struct display.
365 366 367

** 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
368
   later, with emacsclient.)
369

370 371 372 373
** 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.
374

375 376 377 378
** 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.
379

380 381 382 383
** 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.
384 385 386

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

Karoly Lorentey's avatar
Karoly Lorentey committed
387 388 389 390 391 392
** 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.)
393

394 395
** Maybe standard-display-table should be display-local.

396 397 398 399
DIARY OF CHANGES
----------------

(ex-TODO items with explanations.)
400

401
-- Introduce a new struct for terminal devices.
402

403
   (Done, see struct tty_output.  The list of members is not yet
404 405 406 407 408 409 410 411 412 413
   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'.)

414 415 416
-- Implement support for reading from multiple terminals.

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

420 421
   (Update: They do, now.)

422 423
   (Update2: After enabling X, they don't.)

424
-- other-frame should cycle through the frames on the `current'
425
   terminal only.
426

427
   (Done, by trivially modifiying next_frame and prev_frame.)
428 429

-- Support different terminal sizes.
430

431 432 433 434 435
   (Done, no problem.)

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

436 437
   (Done.  We don't get automatic SIGWINCH for additional ttys,
   though.)
438 439 440

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

442 443
   (Done.  It's an ugly hack, needs more work.)

444 445
-- Redisplay must refresh the topmost frame on *all* terminals, not
   just the initial terminal.
446

447
   (Done, but introduced an ugly redisplay problems.  Ugh.)
448

449 450
-- Fix redisplay problems.

451 452
   (Done; it turned out that the entire Wcm structure must be moved
   inside tty_output.  Why didn't I catch this earlier?)
453 454 455 456 457 458 459 460 461 462

-- 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.

463 464
   (Done, it was quite simple, the input event system already
   supported multiple frames.)
465 466 467 468

-- Fix SIGIO issue with secondary terminals.

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

Karoly Lorentey's avatar
Karoly Lorentey committed
472 473 474
   (Update: This is bullshit.  There is a read_input_waiting function,
   extend that somehow.)

475 476 477 478
   (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.)

479 480
   (Update^3: Not any more.)

481 482 483 484 485 486 487 488 489 490
-- 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.

491
   (Done.  It was not fun.)
492 493

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

497 498 499 500 501
   (Done.)

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

503 504
   (Done, but at the moment only called when an error happens during
   initialization.  There is a memory corruption error around this
505
   somewhere.)  (Update: now it is fully enabled.)
506

507 508 509 510 511
-- Implement automatic deletion of terminals when the last frame on
   that terminal is closed.

   (Done.)

Karoly Lorentey's avatar
Karoly Lorentey committed
512 513 514 515 516
-- 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.
517

Karoly Lorentey's avatar
Karoly Lorentey committed
518
   (Done.)
519

520 521 522 523 524 525 526 527
-- 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
528
   from secondary ttys, which is actually a good thing.)  (Update: I
529
   think it would be a bad idea to remove server-frames.)
530

531
-- Change emacsclient/server.el to support the -t argument better,
532 533 534 535
   i.e. automatically close the socket when the frame is closed.

   (Seems to be working OK.)

536
-- Fix mysterious memory corruption error with tty deletion.  To
537 538 539 540 541
   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
542
   seems to be related to the xfreeing or bzeroing of
543 544 545
   tty_output.Wcm.  Maybe there are outside references to struct Wcm?
   Why were these vars collected into a struct before multi-tty
   support?)
546

547 548 549 550
   (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
551
   freeing memory.  Utterly trivial matter.  I love the C's memory
552 553
   management, it puts hair on your chest.)

554
-- Support raw secondary terminals.  (Note that SIGIO works only on
555
   the controlling terminal.) Hint: extend read_input_waiting for
556
   multiple ttys and hopefully this will be fixed.
557

558 559 560 561
   (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).
562
   read_input_waiting is only used in sys_select, don't change
563
   it.)  (Update: After adding X support, it's broken again.)
Karoly Lorentey's avatar
Karoly Lorentey committed
564
   (Update^2: No it isn't.) :-)
565

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

571 572
   (Done.  Added add/delete_keyboard_wait_descriptor to
   term_init/delete_tty.  The hint was right, in a way.)
573

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

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

580
-- server.el: There are issues with saving files in buffers of closed
581 582 583 584 585
   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.

586 587 588 589
   (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
590
   doing -t.
591

592
   (Done.)
593

594 595
-- Make parts of struct tty_output accessible from Lisp.  The device
   name and the type is sufficient.
596

597 598 599
   (Done, see frame-tty-name and frame-tty-type.)

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

601 602
   (Done, see delete-tty.)

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
-- 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.)
623

624
-- Rewrite multi-tty input in terms of MULTI_KBOARD.
625

626 627 628
   (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.)
629

630 631 632 633 634 635 636
-- 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.)

637 638 639 640
-- Add multi-tty support to talk.el.

   (Done.)

641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
-- 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.)

675
-- If there are no frames on its controlling terminal, Emacs should
Karoly Lorentey's avatar
Karoly Lorentey committed
676
   exit if the user presses C-c there.
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702

   (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.)

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
-- 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.)

724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
-- 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.)
754

755 756 757 758 759 760 761 762 763
-- 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.)

764 765 766 767 768 769 770 771 772 773 774
-- 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.)
775

776 777 778 779 780
-- 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
781 782 783 784 785
-- Fix interactive use of temacs.  There are face-related SEGVs, most
   likely because of changes in realize_default_face, realize_face.

   (Fixed.)

786 787 788 789 790
-- Don't exit Emacs when the last X connection fails during a
   multi-display session.

   (Fixed.)

791 792 793 794 795 796
-- Dan Nicolaescu noticed that starting emacsclient on the same
   terminal device that is the controlling tty of the Emacs process
   gives unexpected results.

   (Fixed.)

797 798 799 800 801 802 803
-- 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.)

804 805 806 807
-- 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
808
   single_kboard mode, and is not easily resolvable.  The best thing to
809 810 811 812 813 814
   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.)

815 816 817 818 819 820 821 822 823 824
-- 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
825 826 827 828 829 830 831
-- 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.)

832 833 834 835 836 837 838 839 840 841 842
-- 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.)

843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
-- 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.)
863

Karoly Lorentey's avatar
Karoly Lorentey committed
864 865 866 867 868 869 870 871 872 873 874
-- 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.)
875

876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926

-- 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.)

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