2 @setfilename ../../info/edt
3 @settitle EDT Emulation for Emacs
6 This file documents the EDT emulation package for Emacs.
8 Copyright @copyright{} 1986, 1992, 1994--1995, 1999--2013
9 Free Software Foundation, Inc.
12 Permission is granted to copy, distribute and/or modify this document
13 under the terms of the GNU Free Documentation License, Version 1.3 or
14 any later version published by the Free Software Foundation; with no
15 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
16 and with the Back-Cover Texts as in (a) below. A copy of the license
17 is included in the section entitled ``GNU Free Documentation License''.
19 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
20 modify this GNU manual.''
24 @dircategory Emacs misc features
26 * EDT: (edt). An Emacs emulation of the EDT editor.
30 @title EDT Emulation User's Manual
31 @author Kevin Gallagher
32 @author @email{Kevin.Gallagher@@boeing.com}
34 @vskip 0pt plus 1filll
42 @top Emacs EDT emulation
43 This manual describes the Emacs EDT package, which provides emulation
50 * Overview:: Overview of the EDT package.
51 * Supported terminals:: Terminals/keyboards that are supported.
52 * Starting emulation:: How to get started.
53 * Platform-specific notes:: Notes specific to certain platforms.
54 * Differences:: How does this EDT emulation differ from real EDT?
55 * Highlights:: Some highlights, and comparisons to the
56 original Emacs EDT emulation.
57 * Customizing:: Customizing emulation.
58 * GNU Free Documentation License:: The license for this manual.
62 @chapter Overview of the EDT Package
64 This manual describes version 4.0 of the EDT Emulation for Emacs.
65 It comes with special functions which replicate nearly all of
66 EDT's keypad mode behavior. It sets up default keypad and function key
67 bindings which closely match those found in EDT@. Support is provided so
68 that users may reconfigure most keypad and function key bindings to
71 Version 4.0 contains several enhancements (@pxref{Changes}).
74 * Quick start:: How to begin using EDT.
75 * Changes:: What's new in version 4.0.
76 * Goals:: The aims of this package.
80 @section How to Begin Using EDT
82 To start the EDT Emulation, first start Emacs and then enter @kbd{M-x
83 edt-emulation-on} to begin the emulation. After initialization is
84 complete, the following message will appear below the status line
85 informing you that the emulation has been enabled: ``Default EDT keymap
88 You can have the EDT Emulation start up automatically, each time you
89 initiate an Emacs session, by adding the following line to your
93 (add-hook term-setup-hook 'edt-emulation-on)
96 @noindent @strong{Important:} Be sure to read the rest of this manual.
97 It contains very useful information on how the EDT Emulation behaves and
98 how to customize it to your liking.
100 @noindent The EDT emulation consists of the following files:
105 @file{edt.texi}---This manual.
108 @file{edt-user.el}---An example customization file.
111 @file{edt.el}---EDT emulation functions and default configuration.
114 @file{edt-lk201.el}---Built-in support for DEC LK-201 keyboards.
117 @file{edt-vt100.el}---Built-in support for DEC VT-100 (and above) terminals.
120 @file{edt-pc.el}---Built-in support for PC 101 Keyboards under MS-DOS.
123 @file{edt-mapper.el}---Create an EDT LK-201 map file for keyboards
124 without built-in support.
129 @section What's New in Version 4.0
131 Version 4.0 contains the following enhancements:
136 Scroll margins at the top and bottom of the window are now supported.
137 (The design was copied from @file{tpu-extras.el}.) By default, this
138 feature is enabled with the top margin set to 10% of the window and the
139 bottom margin set to 15% of the window. To change these settings, you
140 can invoke the function @code{edt-set-scroll-margins} in your
141 @file{.emacs} file. For example, the following line
144 (edt-set-scroll-margins "20%" "25%")
147 @noindent sets the top margin to 20% of the window and the bottom margin
148 to 25% of the window. To disable this feature, set each margin to 0%.
149 You can also invoke @code{edt-set-scroll-margins} interactively while
150 EDT Emulation is active to change the settings for that session.
152 @strong{Please note:} Another way to set the scroll margins is to use
153 the Emacs customization feature to set the following two variables
154 directly: @code{edt-top-scroll-margin} and @code{edt-bottom-scroll-margin}.
156 Enter the Emacs @code{customize} command. First select the
157 @samp{Editing} group and then select the @samp{Emulations} group.
158 Finally, select the @samp{Edt} group and follow the directions.
161 The @samp{SUBS} command is now supported and bound to @kbd{GOLD-Enter}
162 by default. (This design was copied from @file{tpu-edt.el}.) Note, in
163 earlier versions of EDT Emulation, @kbd{GOLD-Enter} was assigned to the
164 Emacs function @code{query-replace}. The binding of
165 @code{query-replace} has been moved to @kbd{GOLD-/}. If you prefer to
166 restore @code{query-replace} to @kbd{GOLD-Enter}, then use an EDT user
167 customization file, @file{edt-user.el}, to do this
168 (@pxref{Customizing}).
171 EDT Emulation now also works in XEmacs, including the highlighting of
175 If you access a workstation using an X Server, observe that the
176 initialization file generated by @file{edt-mapper.el} will now contain
177 the name of the X Server vendor. This is a convenience for those who
178 have access to their Unix account from more than one type of X Server.
179 Since different X Servers typically require different EDT emulation
180 initialization files, @file{edt-mapper.el} will now generate these
181 different initialization files and save them with different names.
182 Then, the correct initialization file for the particular X server in use
183 is loaded correctly automatically.
186 Also, @file{edt-mapper.el} is now capable of binding an @acronym{ASCII}
187 key sequence, providing the @acronym{ASCII} key sequence prefix is
188 already known by Emacs to be a prefix. As a result of providing this
189 support, some terminal/keyboard/window system configurations, which
190 don't have a complete set of sensible function key bindings built into
191 Emacs in @code{function-key-map}, can still be configured for use with
192 EDT Emulation. (Note: In a few rare circumstances this does not work
193 properly. In particular, it does not work if a subset of the leading
194 @acronym{ASCII} characters in a key sequence are recognized by Emacs as
195 having an existing binding. For example, if the keypad 7 (@key{KP7})
196 key generates the sequence @samp{<ESC>Ow} and @samp{<ESC>O} is already
197 bound to a function, pressing @key{KP7} when told to do so by
198 @file{edt-mapper.el} will result in @file{edt-mapper.el} incorrectly
199 mapping @samp{<ESC>O} to @key{KP7} and @samp{w} to @key{KP8}. If
200 something like this happens to you, it is probably a bug in the support
201 for your keyboard within Emacs @strong{or} a bug in the Unix
202 termcap/terminfo support for your terminal @strong{or} a bug in the
203 terminal emulation software you are using.)
206 The @code{edt-quit} function (bound to @kbd{GOLD-q} by default) has been
207 modified to warn the user when file-related buffer modifications exist.
208 It now cautions the user that those modifications will be lost if the
209 user quits without saving those buffers.
214 @section The Aims of this Package
219 Emulate EDT Keypad Mode commands closely so that current EDT users will
220 find that it easy and comfortable to use Emacs with a small learning
224 Make it easy for a user to customize EDT emulation key bindings without
225 knowing much about Emacs Lisp.
228 Make it easy to switch between the original EDT default bindings and the
229 user's customized EDT bindings, without having to exit Emacs.
232 Provide support for some TPU/EVE functions not supported in EDT.
235 Provide an easy way to restore @strong{all} original Emacs key bindings,
236 just as they existed before the EDT emulation was first invoked.
239 Support Emacs and XEmacs 19 and higher.
242 Supports highlighting of marked text within the EDT emulation on all
243 platforms on which Emacs supports highlighting of marked text.
246 Handle terminal configuration interactively for most terminal
247 configurations, when the emulation is invoked for the first time.
250 Support a PC AT keyboard under MS-DOS.
254 @node Supported terminals
255 @chapter Terminals/Keyboards that are Supported
257 Keyboards used under a Window System are supported via the
258 @code{edt-mapper} function. The first time you invoke the emulation
259 under a window system, the @code{edt-mapper} function is run
260 automatically and the user is prompted to identify which keys the
261 emulation is to use for the standard keypad and function keys EDT
262 expects (e.g., @key{PF1}, @key{PF2}, @key{KP0}, @key{KP1}, @key{F1},
263 @key{F2}, etc.). This configuration is saved to disk read each time the
264 emulation is invoked.
266 In character oriented connections not running a window manager, built-in
267 support for the following terminals/keyboards is provided:
272 DEC VT-100 series and higher. This includes well behaved VT clones and
273 emulators. If you are using a VT series terminal, be sure that the
274 @env{TERM} environment variable is set properly before invoking emacs.
277 PC AT keyboard under MS-DOS.
281 Be sure to read @ref{Platform-specific notes} to see if those notes
284 @node Starting emulation
285 @chapter How to Get Started
287 Start up Emacs and enter @kbd{M-x edt-emulation-on} to begin the
288 emulation. After initialization is complete, the following message will
289 appear below the status line informing you that the emulation has been
290 enabled: ``Default EDT keymap active''.
292 You can have the EDT Emulation start up automatically, each time you
293 initiate an Emacs session, by adding the following line to your
297 (add-hook term-setup-hook 'edt-emulation-on)
300 A reference sheet is included (later on) listing the default EDT
301 Emulation key bindings. This sheet is also accessible on line from
302 within Emacs by pressing @key{PF2}, @kbd{GOLD-H}, or @samp{HELP} (when
303 in the EDT Default Mode).
305 It is easy to customize key bindings in the EDT Emulation
306 (@pxref{Customizing}). Customizations are placed in a file called
307 @file{edt-user.el}. The Emacs @file{etc/} directory contains an
308 example. If @file{edt-user.el} is found in your Emacs load path
309 during EDT Emulation initialization, then the following message will
310 appear below the status line indicating that the emulation has been
311 enabled, enhanced by your own customizations: ``User EDT custom keymap
314 Once enabled, it is easy to switch back and forth between your
315 customized EDT Emulation key bindings and the default EDT Emulation key
316 bindings. (Look at the binding to @kbd{GOLD-Z} in the sample
317 @file{edt-user.el} file.) It is also easy to turn off the emulation
318 (via the command @code{edt-emulation-off}). Doing so completely
319 restores the original key bindings in effect just prior to invoking the
322 Emacs binds keys to @acronym{ASCII} control characters and so does the
323 real EDT@. Where EDT key bindings and Emacs key bindings conflict,
324 the default Emacs key bindings are retained by the EDT emulation by
325 default. If you are a diehard EDT user you may not like this. The
326 @ref{Control keys} section explains how to change this so that the EDT
327 bindings to @acronym{ASCII} control characters override the default
330 @node Platform-specific notes
331 @chapter Notes Specific to Certain Platforms
334 * Sun workstations:: Sun workstations running X.
335 * MS-DOS:: PC users running MS-DOS.
336 * GNU/Linux:: PC users running GNU/Linux.
337 * Unix:: Using @key{NumLock} for the @key{PF1} key on Unix systems.
340 @node Sun workstations
341 @section Sun Workstations Running X
343 Some earlier Sun keyboards do not have arrow keys separate from the
344 keypad keys. It is difficult to emulate the full EDT keypad and still
345 retain use of the arrow keys on such keyboards.
347 The Sun Type 5 and other more recent Sun keyboards, however, do have
348 separate arrow keys. This makes them candidates for setting up a
349 reasonable EDT keypad emulation.
351 Depending upon the configuration of the version of X installed on your
352 system, you may find the default X keynames for the keypad keys don't
353 permit Emacs to interpret some or all the keypad keys as something other
354 than arrow keys, numeric keys, @key{Home}, @key{PageUp}, etc. Both Sun
355 and HP have been particularly guilty of making bizarre keysym
356 assignments to the keypad keys.
358 In most cases, the X Windows command, @code{xmodmap}, can be used to
359 correct the problem. Here's a sample @file{.xmodmaprc} file which
360 corrects this problem on one Sun workstation configuration using an
361 older SunOS release configured with a Sun Type 5 keyboard:
366 ! Set up Sun Type 5 keypad for use with the Emacs EDT Emulation
368 keycode 53 = KP_Divide
369 keycode 54 = KP_Multiply
370 keycode 57 = KP_Decimal
374 keycode 78 = KP_Subtract
375 keycode 97 = KP_Enter
387 If @file{edt-mapper.el} does not recognize your keypad keys as unique
388 keys, use the command @samp{xmodmap -pke} to get a listing of the actual
389 key codes and the keysyms mapped to them and then generate you own
390 custom @file{.xmodmaprc} similar to the one above.
392 Next, feed @file{.xmodmaprc} to the @code{xmodmap} command and all the
393 Sun Type 5 keypad keys will now be configurable for the emulation of an
394 LK-201 keypad (less the @key{,} key). In this example, the line
400 @noindent changes the X Windows name of the keypad @key{NumLock} key to
401 be known internally as the @key{F24} key. Doing so permits it to be
402 configured to behave as the @key{PF1} (@key{GOLD}) key.
404 The side effect of this change is that you will no longer have a
405 @key{NumLock} key. If you are using other software under X which
406 requires a @key{NumLock} key, then examine your keyboard and look for
407 one you don't use and redefine it to be the @key{NumLock} key.
408 Basically, you need to clear the @key{NumLock} key from being assigned
409 as a modifier, assign it to the key of your choice, and then add it back
410 as a modifier. (@ref{Unix} for further help on how to do this.)
413 @section PC Users Running MS-DOS
415 By default, F1 is configured to emulate the @key{PF1} (@key{GOLD}) key.
416 But @key{NumLock} can be used instead if you load a freeware TSR
417 distributed with MS-Kermit, call @samp{gold.com}. This was once
418 distributed in a file called @file{gold22.zip} and came with the source
419 code as well as a loadable binary image. (See @file{edt-pc.el} in the
420 Emacs @file{lisp/emulation} directory for more information.)
423 @section PC Users Running GNU/Linux
425 The default X server configuration varies from distribution to
426 distribution and release to release of GNU/Linux. If your system fails
427 to recognize the keypad keys as distinct keys, change the NumLock state,
428 turning it on or off, as the case may be, then try again. If this
429 doesn't solve your problem, you may have to modify the X keysym mappings
432 On one distribution on an Intel PC, the following @file{.xmodmaprc} set
438 ! Set up PC keypad under GNU/Linux for the Emacs EDT Emulation
442 keycode 96 = Num_Lock Pointer_EnableKeys
446 In this example, after feeding the file to the @code{xmodmap} command,
447 the PC @key{NumLock} keypad key will be configurable for the emulation
448 of the @key{PF1} key. The PC keypad can now emulate an LK-201 keypad
449 (less the comma key), the standard keyboard supplied with DEC terminals
450 VT-200 and above. This @file{.xmodmaprc} file switches the role of the
451 @key{F12} and @key{NumLock} keys. It has been tested on RedHat
452 GNU/Linux 5.2. Other versions of GNU/Linux may require different
453 keycodes. (@ref{Unix} for further help on how to do this.)
455 @strong{Please note:} Remember, it may be necessary to have @key{NumLock} in
456 one position (ON) or the other (OFF) for the PC keypad to emulate the
457 LK-201 keypad properly.
460 @section General Notes on Using @key{NumLock} for the @key{PF1} Key on Unix Systems
462 Making the physical @key{NumLock} key available for use in the EDT Emulation
463 requires some modification to the default X Window settings. Since the
464 keycode assignments vary from system to system, some investigation is
465 needed to see how to do this on a particular system.
467 You will need to look at the output generated by @code{xmodmap} invoked
468 with the "-pm" switch. For example, on RedHat GNU/Linux 5.2 on a PC, we
469 get the following output when running @samp{xmodmap -pm}:
472 xmodmap: up to 2 keys per modifier, (keycodes in parentheses):
474 shift Shift_L (0x32), Shift_R (0x3e)
475 lock Caps_Lock (0x42)
476 control Control_L (0x25), Control_R (0x6d)
477 mod1 Alt_L (0x40), Alt_R (0x71)
481 mod5 Scroll_Lock (0x4e)
484 @noindent Note that Num_Lock is assigned to the modifier @samp{mod2}. This is
485 what hides Num_Lock from being seen by Emacs.
487 Now, @samp{xmodmap -pke} yields:
493 keycode 77 = Num_Lock Pointer_EnableKeys
503 @noindent So, in RedHat GNU/Linux 5.2 on a PC, Num_Lock generates keycode 77.
504 The following steps are taken:
508 clear the assignment of Num_Lock to mod2;
510 swap the keycodes assigned to F12 and Num_Lock;
512 assign Num_Lock back to mod2.
515 @noindent The @file{.xmodmaprc} file looks like this:
520 ! Set up PC keypad under GNU/Linux for the Emacs EDT Emulation
524 keycode 96 = Num_Lock Pointer_EnableKeys
528 So, after executing @samp{xmodmap .xmodmaprc}, a press of the physical
529 @key{F12} key looks like a Num_Lock keypress to X@. Also, a press of the
530 physical @key{NumLock} key looks like a press of the @key{F12} key to X.
532 Now, @file{edt-mapper.el} will see @samp{f12} when the physical
533 @key{NumLock} key is pressed, allowing the @key{NumLock} key to be used
534 as the EDT @key{PF1} (@key{GOLD}) key.
537 @chapter How Does this EDT Emulation Differ from Real EDT?
539 In general, you will find that this emulation of EDT replicates most,
540 but not all, of EDT's most used Keypad Mode editing functions and
541 behavior. It is not perfect, but most EDT users who have tried the
542 emulation agree that it is quite good enough to make it easy for
543 die-hard EDT users to move over to using Emacs.
545 Here's a list of the most important differences between EDT and this GNU
546 Emacs EDT Emulation. The list is short but you must be aware of these
547 differences if you are to use the EDT Emulation effectively.
552 Entering repeat counts works a little differently than in EDT.
554 EDT allows users to enter a repeat count before entering a command that
555 accepts repeat counts. For example, when using the real EDT, pressing
556 these three keys in sequence, @kbd{GOLD 5 KP1}, will move the cursor in
557 the current direction 5 words. This does @strong{not} work in Emacs!
559 Emacs provides two ways to enter repeat counts and neither involves
560 using the @key{GOLD} key. First, repeat counts can be entered in Emacs
561 by using the @key{ESC} key. For example, pressing these keys in
562 sequence, @kbd{ESC 1 0 KP1}, will move the cursor in the current
563 direction 10 words. Second, Emacs provides another command called
564 @code{universal-argument} that can be used to do the same thing.
565 Normally, in Emacs has this bound to @kbd{C-u}.
568 EDT's line mode commands and nokeypad mode commands are @strong{not}
569 supported (with one important exception; see item 8 in
570 @ref{Highlights}). Although, at first, this may seem like a big
571 omission, the set of built-in Emacs commands provides a much richer set
572 of capabilities which more than make up for this omission.
574 To enter Emacs commands not bound to keys, you can press @kbd{GOLD KP7}
575 or the @key{DO} key. Emacs will display its own command prompt "M-x".
576 This stands for the keypress @kbd{Meta-x}, where @key{Meta} is a special
577 shift key. The @key{Alt} key is often mapped to behave as a @key{Meta}
578 key. So, you can also invoke this prompt by pressing @kbd{Meta-x}.
579 Typing the sequence @kbd{ESC x} will also invoke the prompt.
582 Selected text is highlighted @strong{only} on systems where Emacs
583 supports the highlighting of text.
586 Just like in TPU/EVE, the @key{ENTER} key is @strong{not} used to
587 terminate input when the editor prompts you for input. The @key{RETURN}
588 key is used, instead. (@key{KP4} and @key{KP5} (the direction keys) do
589 terminate input for the @samp{FIND} command, just like in EDT, however.)
594 @chapter Some Highlights, and Comparisons to the Original Emacs EDT Emulation
599 The EDT define key command is supported (@code{edt-define-key}) and is
600 bound to @kbd{C-k} in the default EDT mode when EDT control sequence
601 bindings are enabled, or when the sample @file{edt-user.el}
602 customization file is used. The TPU/EVE learn command is supported but
603 not bound to a key in the default EDT mode but is bound in the sample
604 @file{edt-user.el} file.
606 Unlike the TPU/EVE learn command, which uses one key to begin the learn
607 sequence, @kbd{C-l}, and another command to remember the sequence,
608 @kbd{C-r}, this version of the learn command (@code{edt-learn}) serves
609 as a toggle to both begin and to remember the learn sequence.
611 Many users who change the meaning of a key with the define key and the
612 learn commands, would like to be able to restore the original key
613 binding without having to quit and restart emacs. So a restore key
614 command is provided to do just that. When invoked, it prompts you to
615 press the key to which you wish the last replaced key definition
616 restored. It is bound to @kbd{GOLD C-k} in the default EDT mode when
617 EDT control sequence bindings are enabled or the sample
618 @file{edt-user.el} customization file is used.
621 Direction support is fully supported.
624 All original Emacs bindings are fully restored when EDT emulation is
625 turned off. So, if a fellow worker comes over to your terminal to help
626 you with a software problem, for example, and is completely confused by
627 your EDT emulation bindings, just enter the command,
628 @code{edt-emulation-off}, at the @samp{M-x} prompt and the original
629 Emacs bindings will be restored. To resume the EDT emulation, just
630 enter @code{edt-emulation-on}.
633 User custom EDT bindings are kept separate from the default EDT
634 bindings. One can toggle back and forth between the custom EDT bindings
635 and default EDT bindings.
638 The Emacs functions in @file{edt.el} attempt to emulate, where
639 practical, the exact behavior of the corresponding EDT keypad mode
640 commands. In a few cases, the emulation is not exact, but we hope you
641 will agree it is close enough. In a very few cases, we chose to use the
642 Emacs way of handling things. As mentioned earlier, we do not emulate
643 the EDT @samp{SUBS} command. Instead, we chose to use the Emacs
644 @code{query-replace} function, which we find to be easier to use.
647 Emacs uses the regexp assigned to @code{page-delimiter} to determine
648 what marks a page break. This is normally @samp{^\f}, which causes the
649 @code{edt-page} command to ignore form feeds not located at the
650 beginning of a line. To emulate the EDT @samp{PAGE} command exactly,
651 page-delimiter is set to @samp{\f} when EDT emulation is turned on, and
652 restored to @samp{^\f} when EDT emulation is turned off. But, since
653 some users prefer the Emacs definition of a page break, or may wish to
654 preserve a customized definition of page break, one can override the EDT
655 definition by placing
658 (setq edt-keep-current-page-delimiter t)
661 @noindent in your @file{.emacs} file. Or, you can used the Emacs customize
662 command to change its setting.
665 The EDT definition of a section of a terminal window is hardwired to be
666 16 lines of its one-and-only 24-line window (the EDT @samp{SECT} command
667 bound to @key{KP8}). That's two-thirds of the window at a time. Since
668 Emacs, like TPU/EVE, can handle multiple windows of sizes of other than
669 24 lines, the definition of section used here has been modified to
670 two-thirds of the current window. (There is also an
671 @code{edt-scroll-window} function which you may prefer over the
672 @samp{SECT} emulation.)
675 Cursor movement and deletion involving word entities is identical to
676 EDT@. This, above all else, gives the die-hard EDT user a sense of being
677 at home. Also, an emulation of EDT's @samp{SET ENTITY WORD} command is
678 provided, for those users who like to customize movement by a word at a
679 time to their own liking.
682 EDT's @samp{FIND} and @samp{FNDNXT} are supported.
685 EDT's @samp{APPEND}, @samp{REPLACE}, and @samp{SUBS} commands are supported.
688 @samp{CHNGCASE} is supported. It works on individual characters or
689 selected text, if @samp{SELECT} is active. In addition, two new
690 commands are provided: @code{edt-lowercase} and @code{edt-uppercase}.
691 They work on individual @strong{words} or selected text, if
692 @samp{SELECT} is active.
695 Form feed and tab insert commands are supported.
698 A new command, @code{edt-duplicate-word}, is provided. If you
699 experiment with it, you might find it to be surprisingly useful and may
700 wonder how you ever got along without it! It is assigned to @kbd{C-j}
701 in the sample @file{edt-user.el} customization file.
704 TPU/EVE's Rectangular Cut and Paste functions (originally from the
705 EVE-Plus package) are supported. But unlike the TPU/EVE versions, these
706 here support both insert and overwrite modes. The seven rectangular
707 functions are bound to @key{F7}, @key{F8}, @kbd{GOLD-F8}, @key{F9},
708 @kbd{GOLD-F9}, @key{F10}, and @kbd{GOLD-F10} in the default EDT mode.
711 The original EDT emulation package set up many default regular and GOLD
712 bindings. We tried to preserve most (but not all!) of these, so users
713 of the original emulation package will feel more at home.
715 Nevertheless, there are still many GOLD key sequences which are not
716 bound to any functions. These are prime candidates to use for your own
719 Also, there are several commands in @file{edt.el} not bound to any key.
720 So, you will find it worthwhile to look through @file{edt.el} for
721 functions you may wish to add to your personal customized bindings.
724 The VT200/VT300 series terminals steal the function keys @key{F1} to
725 @key{F5} for their own use. These do not generate signals which are
726 sent to the host. So, @file{edt.el} does not assign any default
727 bindings to @key{F1} through @key{F5}.
729 In addition, our VT220 terminals generate an interrupt when the @key{F6}
730 key is pressed (@samp{^C} or @samp{^Y}, can't remember which) and not
731 the character sequence documented in the manual. So, binding Emacs
732 commands to @key{F6} will not work if your terminal behaves the same
736 The VT220 terminal has no @key{ESC}, @key{BS}, nor @key{LF} keys, as
737 does a VT100. So the default EDT bindings adopt the standard DEC
738 convention of having the @key{F11}, @key{F12}, and @key{F13} keys, on a
739 VT200 series (and above) terminal, assigned to the same EDT functions
740 that are bound to @key{ESC}, @key{BS}, and @key{LF} on a VT100 terminal.
743 Each user, through the use of a private @file{edt-user.el} file, can
744 customize, very easily, personal EDT emulation bindings.
747 The EDT @samp{SELECT} and @samp{RESET} functions are supported.
748 However, unlike EDT, pressing @samp{RESET} to cancel text selection does
749 @strong{not} reset the existing setting of the current direction.
751 We also provide a TPU/EVE like version of the single @samp{SELECT/RESET}
752 function, called @code{edt-toggle-select}, which makes the EDT
753 @samp{SELECT} function into a toggle on/off switch. That is, if
754 selection is on, pressing @samp{SELECT} again turns selection off
755 (cancels selection). This function is used in the sample
756 @file{edt-user.el} customization file.
759 EDT scroll margins are supported, but are disabled by default.
760 (@ref{Scroll margins} for instructions on how to enable them.)
765 @chapter Customizing Emulation
767 Most EDT users, at one time or another, make some custom key bindings,
768 or use someone else's custom key bindings, which they come to depend
769 upon just as if they were built-in bindings. This EDT Emulation for GNU
770 Emacs is designed to make it easy to customize bindings.
772 If you wish to customize the EDT Emulation to use some of your own key
773 bindings, you need to make a private version of @file{edt-user.el} in
774 your own private lisp directory. The Emacs @file{etc/} directory
775 contains an example for you to use as a template and for ideas.
776 @c This seems to be untrue.
778 There are two sample files @file{edt-user.el1} and @file{edt-user.el2}
779 for you to use as templates and for ideas. Look at @file{edt-user.el1}
780 first. Unless you will be using two or more very different types of
781 terminals on the same system, you need not look at @file{edt-user.el2}.
784 First, you need to have your own private lisp directory, say
785 @file{~/lisp}, and you should add it to the Emacs load path.
787 @strong{Please note:} A few sites have different load-path requirements,
788 so the above directions may need some modification if your site has such
792 * Init file:: Creating your own @file{edt-user.el} file.
793 * Words:: Specifying word entities.
794 * Control keys:: Enabling EDT control key sequence bindings.
795 * Scroll margins:: Setting scroll margins.
799 @section Creating your own @file{edt-user.el} File
801 A sample @file{edt-user.el} file is provided in the Emacs @file{etc/}
802 directory. You should use it as a guide to learn how you can customize
803 EDT emulation bindings to your own liking. Names used to identify the
804 set of LK-201 keypad and function keys are:
822 F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 F11 F12 F13 F14
823 HELP DO F17 F18 F19 F20
829 Note: Many VT-200 terminals, and above, steal function keys @key{F1}
830 through @key{F5} for terminal setup control and don't send anything to
831 the host if pressed. So customizing bindings to these keys may not work
834 There are three basic functions that do the EDT emulation custom
835 bindings: @code{edt-bind-key}, @code{edt-bind-gold-key}, and
836 @code{edt-bind-function-key}.
838 The first two are for binding functions to keys which are standard
839 across most keyboards. This makes them keyboard independent, making it
840 possible to define these key bindings for all terminals in the file
843 The first, @code{edt-bind-key}, is used typically to bind emacs commands
844 to control keys, although some people use it to bind commands to other
845 keys, as well. (For example, some people use it to bind the VT200
846 seldom used back-tick key (@samp{`}) to the function @samp{ESC-prefix}
847 so it will behave like an @key{ESC} key.) The second function,
848 @code{edt-bind-gold-key}, is used to bind emacs commands to gold key
849 sequences involving alpha-numeric keys, special character keys, and
852 The third function, @code{edt-bind-function-key}, is terminal dependent
853 and is defined in a terminal specific file (see @file{edt-vt100.el} for
854 example). It is used to bind emacs commands to LK-201 function keys, to
855 keypad keys, and to gold sequences of those keys.
858 @section Specifying Word Entities
860 The variable @code{edt-word-entities} is used to emulate EDT's @samp{SET
861 ENTITY WORD} command. It contains a list of characters to be treated as
862 words in themselves. If the user does not define
863 @code{edt-word-entities} in his/her @file{.emacs} file, then it is set
864 up with the EDT default containing only @key{TAB}.
866 The characters are stored in the list by their numerical values, not as
867 strings. Emacs supports several ways to specify the numerical value of
868 a character. One method is to use the question mark: @samp{?A} means
869 the numerical value for @samp{A}, @samp{?/} means the numerical value
870 for @samp{/}, and so on. Several unprintable characters have special
874 ?\b specifies BS, C-h
875 ?\t specifies TAB, C-i
876 ?\n specifies LFD, C-j
877 ?\v specifies VTAB, C-k
878 ?\f specifies FF, C-l
879 ?\r specifies CR, C-m
880 ?\e specifies ESC, C-[
884 Here are some examples:
887 (setq edt-word-entities '(?\t ?- ?/)) ; specifies TAB, - , and /
888 (setq edt-word-entities '(?\t) ; specifies TAB, the default
891 @noindent You can also specify characters by their decimal ascii values:
894 (setq edt-word-entities '(9 45 47)) ; specifies TAB, - , and /
898 @section Enabling EDT Control Key Sequence Bindings
900 Where EDT key bindings and Emacs key bindings conflict, the default
901 Emacs key bindings are retained by default. Some diehard EDT users
902 may not like this. So, if the variable
903 @code{edt-use-EDT-control-key-bindings} is set to true in a user's
904 @file{.emacs} file, then the default EDT Emulation mode will enable most
905 of the original EDT control key sequence bindings. If you wish to do
906 this, add the following line to your @file{.emacs} file:
909 (setq edt-use-EDT-control-key-bindings t)
913 @section Setting Scroll Margins
915 Scroll margins at the top and bottom of the window are now supported.
916 (The design was copied from @file{tpu-extras.el}.) By default, this
917 feature is enabled with the top margin set to 10% of the window and the
918 bottom margin set to 15% of the window. To change these settings, you
919 can invoke the function @code{edt-set-scroll-margins} in your
920 @file{.emacs} file. For example, the following line
923 (edt-set-scroll-margins "20%" "25%")
926 @noindent sets the top margin to 20% of the window and the bottom margin
927 to 25% of the window. To disable this feature, set each margin to 0%.
928 You can also invoke @code{edt-set-scroll-margins} interactively while
929 EDT Emulation is active to change the settings for that session.
931 @strong{Please note:} Another way to set the scroll margins is to use
932 the Emacs customization feature to set the following two variables
933 directly: @code{edt-top-scroll-margin} and @code{edt-bottom-scroll-margin}.
935 Enter the Emacs @code{customize} command. First select the
936 @samp{Editing} group and then select the @samp{Emulations} group.
937 Finally, select the @samp{Edt} group and follow the directions.
939 @node GNU Free Documentation License
940 @appendix GNU Free Documentation License
941 @include doclicense.texi