README.multi-tty 36.2 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
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
Karoly Lorentey's avatar
Karoly Lorentey committed
86
major release of Emacs (version 23).  I expect the merge into the
87 88 89
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:

Karoly Lorentey's avatar
Karoly Lorentey committed
96 97 98 99 100 101
        * GTK support.  If you compile your Emacs with the GTK
          toolkit, some functionality of multi-tty will be lost.
          Current releases of GTK have limitations and bugs that
          prevent full-blown multi-display support in Emacs.  Use the
          Lucid toolkit if you want to see a complete feature set.

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 132 133 134 135 136 137
        * 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.)

138 139 140 141 142

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

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

144
Retrieving the latest version of the branch:
145

146
	tla register-archive -f http://lorentey.hu/arch/2004/
147 148 149 150
	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
Karoly Lorentey's avatar
Karoly Lorentey committed
151 152 153 154 155 156 157 158 159 160 161
probably want to you use my secondary mirror: (Note that the -f option
will overwrite the archive location if you have previously registered
the Hungarian one.)

	tla register-archive -f http://aszt.inf.elte.hu/~lorentey/mirror/arch/2004
	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>

	http://aszt.inf.elte.hu/~lorentey/mirror/arch/2004

The Arch supermirror provides mirroring services for all public Arch
repositories.  We have a mirror there, too, if you prefer.
162

Karoly Lorentey's avatar
Karoly Lorentey committed
163
	tla register-archive -f http://mirrors.sourcecontrol.net/lorentey%40elte.hu--2004
164
	tla get lorentey@elte.hu--2004/emacs--multi-tty <directory>
165

166 167
My GPG key id is 0FB27A3F; it is available from
hkp://wwwkeys.eu.pgp.net/, or from my homepage at
168
http://lorentey.hu/rolam/gpg.html)
169

170 171 172
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:
173

174
	tla replay
175

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

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

182
	http://lorentey.hu/project/emacs.html
183

Karoly Lorentey's avatar
Karoly Lorentey committed
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
DEBIAN PACKAGES
---------------

If you run Debian, or a distribution based on Debian, you are welcome
to use our binary packages; put these lines in your /etc/apt/sources.list:

	# Multi-tty Emacs
	deb http://aszt.inf.elte.hu/~lorentey/mirror/apt ./
	deb-src http://aszt.inf.elte.hu/~lorentey/mirror/apt ./

Note that these packages are intended solely to provide an easy way to
test the new multi-tty features.  They are not to be taken as Emacs
releases, and it's a mistake to expect robust operation or any kind of
timely support for them.  Do not install them, unless you'd like to
have your editor crash on you.

200

Karoly Lorentey's avatar
Karoly Lorentey committed
201 202
COMPILATION
-----------
203

204
The multi-tty branch is compiled the same way as Emacs itself:
205

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

208
	./configure <your favourite options>
209
	make bootstrap
210 211
	make install

Karoly Lorentey's avatar
Karoly Lorentey committed
212 213 214 215 216
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.)
217

Karoly Lorentey's avatar
Karoly Lorentey committed
218 219 220 221
TESTING
-------

To test the multi-tty branch, start up the Emacs server with the
222 223 224
following commands:

	emacs
225
	M-x server-start
226

227 228
and then (from a shell prompt on another terminal) start emacsclient
with
229 230
	emacsclient -t /optional/file/names...   (for a tty frame)
	emacsclient /optional/file/names...      (for an X frame)
231

232
(Make sure both emacs and emacsclient are multi-tty versions.)
Karoly Lorentey's avatar
Karoly Lorentey committed
233
You'll hopefully have two fully working, independent frames on
234
separate terminals. The new frame is closed automatically when you
Karoly Lorentey's avatar
Karoly Lorentey committed
235 236 237
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.
238

239 240 241
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.
242

243 244 245 246
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
247

248 249 250
TIPS & TRICKS
-------------

251 252
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
253 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
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
283
| 	    # Delete leftover socket (for the wait option)
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
| 	    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
`----

324 325 326 327

NEWS
----

328
For the NEWS file:  (Needs work)
329

330
** Support for multiple terminal devices has been added.
331

332 333
*** You can specify a terminal device (`tty' parameter) and a terminal
    type (`tty-type' parameter) to `make-terminal-frame'.
334

335 336
*** You can test for the presence of multiple terminal support by
    testing for the `multi-tty' feature.
337

338
*** Emacsclient has been extended to support opening a new terminal
Karoly Lorentey's avatar
Karoly Lorentey committed
339 340 341
    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.
342

343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
*** 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.
363

364 365 366 367 368
CHANGELOG
---------

See arch logs.

Karoly Lorentey's avatar
Karoly Lorentey committed
369 370 371 372 373
* * *

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

374 375
THINGS TO DO
------------
376

377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
** 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).
401

402 403 404
** Hunt down display-related functions in frame.el and extend them all
   to accept display ids.

405 406 407
** rif->flush_display_optional (NULL) calls should be replaced by a
   new global function.

Karoly Lorentey's avatar
Karoly Lorentey committed
408 409
** Have a look at fatal_error_hook.

Karoly Lorentey's avatar
Karoly Lorentey committed
410 411
** Have a look at set_frame_matrix_frame.

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

414 415 416 417
** I think tip_frame should be display-local.

** Check display reference count handling in x_create_tip_frame.

418 419 420 421 422 423 424 425
** 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
426 427 428 429
** 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)?

430 431 432 433
** 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
434 435 436
** 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
437
   options.  Patches are welcome.) :-)
Karoly Lorentey's avatar
Karoly Lorentey committed
438 439 440 441 442

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

Karoly Lorentey's avatar
Karoly Lorentey committed
444 445 446 447
** 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.

448 449 450 451 452 453 454
** 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.

455
** Move baud_rate to struct display.
456 457 458

** 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
459
   later, with emacsclient.)
460

461 462 463 464
** 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.
465

466 467 468 469
** 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.
470

471 472 473 474
** 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.
475 476 477

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

Karoly Lorentey's avatar
Karoly Lorentey committed
478 479 480 481 482 483
** 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.)
484

485 486
** Maybe standard-display-table should be display-local.

487 488 489 490
DIARY OF CHANGES
----------------

(ex-TODO items with explanations.)
491

492
-- Introduce a new struct for terminal devices.
493

494
   (Done, see struct tty_output.  The list of members is not yet
495 496 497 498 499 500 501 502 503 504
   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'.)

505 506 507
-- Implement support for reading from multiple terminals.

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

511 512
   (Update: They do, now.)

513 514
   (Update2: After enabling X, they don't.)

515
-- other-frame should cycle through the frames on the `current'
516
   terminal only.
517

518
   (Done, by trivially modifiying next_frame and prev_frame.)
519 520

-- Support different terminal sizes.
521

522 523 524 525 526
   (Done, no problem.)

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

527 528
   (Done.  We don't get automatic SIGWINCH for additional ttys,
   though.)
529 530 531

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

533 534
   (Done.  It's an ugly hack, needs more work.)

535 536
-- Redisplay must refresh the topmost frame on *all* terminals, not
   just the initial terminal.
537

538
   (Done, but introduced an ugly redisplay problems.  Ugh.)
539

540 541
-- Fix redisplay problems.

542 543
   (Done; it turned out that the entire Wcm structure must be moved
   inside tty_output.  Why didn't I catch this earlier?)
544 545 546 547 548 549 550 551 552 553

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

554 555
   (Done, it was quite simple, the input event system already
   supported multiple frames.)
556 557 558 559

-- Fix SIGIO issue with secondary terminals.

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

Karoly Lorentey's avatar
Karoly Lorentey committed
563 564 565
   (Update: This is bullshit.  There is a read_input_waiting function,
   extend that somehow.)

566 567 568 569
   (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.)

570 571
   (Update^3: Not any more.)

572 573 574 575 576 577 578 579 580 581
-- 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.

582
   (Done.  It was not fun.)
583 584

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

588 589 590 591 592
   (Done.)

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

594 595
   (Done, but at the moment only called when an error happens during
   initialization.  There is a memory corruption error around this
596
   somewhere.)  (Update: now it is fully enabled.)
597

598 599 600 601 602
-- Implement automatic deletion of terminals when the last frame on
   that terminal is closed.

   (Done.)

Karoly Lorentey's avatar
Karoly Lorentey committed
603 604 605 606 607
-- 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.
608

Karoly Lorentey's avatar
Karoly Lorentey committed
609
   (Done.)
610

611 612 613 614 615 616 617 618
-- 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
619
   from secondary ttys, which is actually a good thing.)  (Update: I
620
   think it would be a bad idea to remove server-frames.)
621

622
-- Change emacsclient/server.el to support the -t argument better,
623 624 625 626
   i.e. automatically close the socket when the frame is closed.

   (Seems to be working OK.)

627
-- Fix mysterious memory corruption error with tty deletion.  To
628 629 630 631 632
   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
633
   seems to be related to the xfreeing or bzeroing of
634 635 636
   tty_output.Wcm.  Maybe there are outside references to struct Wcm?
   Why were these vars collected into a struct before multi-tty
   support?)
637

638 639 640 641
   (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
642
   freeing memory.  Utterly trivial matter.  I love the C's memory
643 644
   management, it puts hair on your chest.)

645
-- Support raw secondary terminals.  (Note that SIGIO works only on
646
   the controlling terminal.) Hint: extend read_input_waiting for
647
   multiple ttys and hopefully this will be fixed.
648

649 650 651 652
   (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).
653
   read_input_waiting is only used in sys_select, don't change
654
   it.)  (Update: After adding X support, it's broken again.)
Karoly Lorentey's avatar
Karoly Lorentey committed
655
   (Update^2: No it isn't.) :-)
656

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

662 663
   (Done.  Added add/delete_keyboard_wait_descriptor to
   term_init/delete_tty.  The hint was right, in a way.)
664

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

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

671
-- server.el: There are issues with saving files in buffers of closed
672 673 674 675 676
   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.

677 678 679 680
   (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
681
   doing -t.
682

683
   (Done.)
684

685 686
-- Make parts of struct tty_output accessible from Lisp.  The device
   name and the type is sufficient.
687

688 689 690
   (Done, see frame-tty-name and frame-tty-type.)

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

692 693
   (Done, see delete-tty.)

694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
-- 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.)
714

715
-- Rewrite multi-tty input in terms of MULTI_KBOARD.
716

717 718 719
   (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.)
720

721 722 723 724 725 726 727
-- 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.)

728 729 730 731
-- Add multi-tty support to talk.el.

   (Done.)

732 733 734 735 736 737 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 764 765
-- 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.)

766
-- If there are no frames on its controlling terminal, Emacs should
Karoly Lorentey's avatar
Karoly Lorentey committed
767
   exit if the user presses C-c there.
768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793

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

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
-- 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.)

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
-- 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.)
845

846 847 848 849 850 851 852 853 854
-- 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.)

855 856 857 858 859 860 861 862 863 864 865
-- 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.)
866

867 868 869 870 871
-- 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
872 873 874 875 876
-- Fix interactive use of temacs.  There are face-related SEGVs, most
   likely because of changes in realize_default_face, realize_face.

   (Fixed.)

877 878 879 880 881
-- Don't exit Emacs when the last X connection fails during a
   multi-display session.

   (Fixed.)

882 883 884 885 886 887
-- Dan Nicolaescu noticed that starting emacsclient on the same
   terminal device that is the controlling tty of the Emacs process
   gives unexpected results.

   (Fixed.)

888 889 890 891 892 893 894
-- 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.)

895 896 897 898
-- 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
899
   single_kboard mode, and is not easily resolvable.  The best thing to
900 901 902 903 904 905
   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.)

906 907 908 909 910 911 912 913 914 915
-- 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
916 917 918 919 920 921 922
-- 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.)

923 924 925 926 927 928 929 930 931 932 933
-- 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.)

934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
-- 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.)
954

Karoly Lorentey's avatar
Karoly Lorentey committed
955 956 957 958 959 960 961 962 963 964 965
-- 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.)
966

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

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

1018 1019 1020 1021 1022 1023 1024 1025
-- 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.)


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