Copyright (C) 1993, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.See the end of the file for license conditions. This directory contains files of elisp that customize Emacs for certainterminal types. When Emacs opens a new terminal, it checks the TERM environment variable tosee what type of terminal the user is running on, searches for an elisp filenamed "term/${TERM}.el", and if one exists, loads it. If Emacs finds nosuitable file, then it strips the last hyphen and what follows it from TERM,and tries again. If that still doesn't yield a file, then the previous hyphenis stripped, and so on until all hyphens are gone. For example, if theterminal type is `aaa-48-foo', Emacs will try first `term/aaa-48-foo.el', then`term/aaa-48.el' and finally `term/aaa.el'. Emacs stops searching at thefirst file found, and will not load more than one file for any terminal. Notethat it is not an error if Emacs is unable to find a terminal initializationfile; in that case, it will simply proceed with the next step without loadingany files. Once the file has been loaded (or the search failed), Emacs tries to call afunction named `terminal-init-TERMINALNAME' (eg `terminal-init-aaa-48' for the`aaa-48' terminal) in order to initialize the terminal. Once again, if thefunction is not found, Emacs strips the last component of the name and triesagain using the shorter name. This search is independent of the previous filesearch, so that you can have terminal initialization functions for a family ofterminals collected in a single file named after the family name, and usersmay put terminal initialization functions directly in their .emacs files. Note that an individual terminal file is loaded only once in an Emacssession; if the same terminal type is opened again, Emacs will simply call theinitialization function without reloading the file. Therefore, all the actualinitialization actions should be collected in terminal-init-* functions; thefile should not contain any top-level form that is not a function or variabledeclaration. Simply loading the file should not have any side effect. Similarly, the terminal initialization function is called only once on anygiven terminal, when the first frame is created on it. The function is notcalled for subsequent frames on the same terminal. Therefore, terminal-init-*functions should only modify terminal-local variables (such as`local-function-key-map') and terminal parameters. For example, it is notcorrect to modify frame parameters, since the modifications will only beapplied for the first frame opened on the terminal. When writing terminal packages, there are some things it is good to keep inmind. First, about keycap names. Your terminal package can create any keycapcookies it likes, but there are good reasons to stick to the set recognized bythe X-windows code whenever possible. The key symbols recognized by Emacsare listed in src/term.c; look for the string `keys' in that file. For one thing, it means that you'll have the same Emacs key bindings on interminal mode as on an X console. If there are differences, you can betthey'll frustrate you after you've forgotten about them. For another, the X keysms provide a standard set of names that Emacs knowsabout. It tries to bind many of them to useful things at startup, before your.emacs is read (so you can override them). In some ways, the X keysym standardis a admittedly poor one; it's incomplete, and not well matched to the set of`virtual keys' that UNIX terminfo(3) provides. But, trust us, the alternativeswere worse. This doesn't mean that if your terminal has a "Cokebottle" key you shouldn'tdefine a [cokebottle] keycap. But if you must define cookies that aren't inthat set, try to pattern them on the standard terminfo variable names forclarity; also, for a fighting chance that your binding may be useful to someoneelse someday. For example, if your terminal has a `find' key, observe that terminfosupports a key_find capability and call your cookie [find].Here is a complete list, with corresponding X keysyms.-----------------------------------------------------------------------------Variable name cap X Keysym Description-------------- --- ------------ -------------------------------------key_down kd down Sent by terminal down arrow keykey_up ku up Sent by terminal up arrow keykey_left kl left Sent by terminal left arrow keykey_right kr right Sent by terminal right arrow keykey_home kh home Sent by home key.key_backspace kb Sent by backspace keykey_dl kd deleteline Sent by delete line key.key_il kA insertline Sent by insert line.key_dc kD Sent by delete character key.key_ic kI insertchar (1) Sent by ins char/enter ins mode key.key_eic KM Sent by rmir or smir in insert mode.key_clear kC Sent by clear screen or erase key.key_eos kS Sent by clear-to-end-of-screen key.key_eol kE Sent by clear-to-end-of-line key.key_sf kF Sent by scroll-forward/down keykey_sr kR Sent by scroll-backward/up keykey_npage kN next (2) Sent by next-page keykey_ppage kP prior (2) Sent by previous-page keykey_stab kT Sent by set-tab keykey_ctab kt Sent by clear-tab keykey_catab ka Sent by clear-all-tabs key.key_enter @8 kp-enter Enter/send (unreliable)key_print %9 print print or copykey_ll kH Sent by home-down keykey_a1 K1 kp-1 Upper left of keypadkey_a3 K3 kp-3 Upper right of keypadkey_b2 K2 kp-5 Center of keypadkey_c1 K4 kp-7 Lower left of keypadkey_c3 K5 kp-9 Lower right of keypadkey_btab kB backtab Back tab keykey_beg @1 begin beg(inning) keykey_cancel @2 cancel cancel keykey_close @3 close keykey_command @4 execute (3) cmd (command) keykey_copy @5 copy keykey_create @6 create keykey_end @7 end end keykey_exit @9 exit keykey_find @0 find keykey_help %1 help keykey_mark %2 mark keykey_message %3 message keykey_move %4 move keykey_next %5 next (2) next object keykey_open %6 open keykey_options %7 menu (3) options keykey_previous %8 previous (2) previous object keykey_redo %0 redo redo keykey_reference &1 ref(erence) keykey_refresh &2 refresh keykey_replace &3 replace keykey_restart &4 reset (3) restart keykey_resume &5 resume keykey_save &6 save keykey_sbeg &9 shifted beginning keykey_select *6 select select keykey_suspend &7 suspend keykey_undo &8 undo undo keykey_scancel &0 shifted cancel keykey_scommand *1 shifted command keykey_scopy *2 shifted copy keykey_screate *3 shifted create keykey_sdc *4 shifted delete char keykey_sdl *5 shifted delete line keykey_send *7 shifted end keykey_seol *8 shifted clear line keykey_sexit *9 shifted exit keykey_sf kF shifted find keykey_shelp #1 shifted help keykey_shome #2 shifted home keykey_sic #3 shifted input keykey_sleft #4 shifted left arrow keykey_smessage %a shifted message keykey_smove %b shifted move keykey_snext %c shifted next keykey_soptions %d shifted options keykey_sprevious %e shifted prev keykey_sprint %f shifted print keykey_sredo %g shifted redo keykey_sreplace %h shifted replace keykey_sright %i shifted right arrowkey_sresume %j shifted resume keykey_ssave !1 shifted save keykey_suspend !2 shifted suspend keykey_sundo !3 shifted undo keykey_f0 k0 f0 (4) function key 0key_f1 k1 f1 function key 1key_f2 k2 f2 function key 2key_f3 k3 f3 function key 3key_f4 k4 f4 function key 4key_f5 k5 f5 function key 5key_f6 k6 f6 function key 6key_f7 k7 f7 function key 7key_f8 k8 f8 function key 8key_f9 k9 f9 function key 9key_f10 k; f10 (4) function key 10key_f11 F1 f11 function key 11 : : : :key_f35 FP f35 function key 35key_f36 FQ function key 36 : : : :key_f64 k1 function key 64(1) The terminfo documentation says this may be the 'insert character' or `enter insert mode' key. Accordingly, key_ic is mapped to the `insertchar' keysym if there is also a key_dc key; otherwise it's mapped to `insert'. The presumption is that keyboards with `insert character' keys usually have `delete character' keys paired with them.(2) If there is no key_next key but there is a key_npage key, key_npage will be bound to the `next' keysym. If there is no key_previous key but there is a key_ppage key, key_ppage will be bound to the `previous' keysym.(3) Sorry, these are not exact but they're the best we can do.(4) The uses of the "k0" capability are inconsistent; sometimes it describes F10, whereas othertimes it describes F0 and "k;" describes F10. Emacs attempts to politely accommodate both systems by testing for "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.----------------------------------------------------------------------------- The following X keysyms do *not* have terminfo equivalents. These arethe cookies your terminal package will have to set up itself, if you want them: break system user kp-backtab kp-space kp-tab kp-f1 kp-f2 kp-f3 kp-f4 kp-multiply kp-add kp-separator kp-subtract kp-decimal kp-divide kp-0 kp-2 kp-4 kp-6 kp-8 kp-equal In general, you should not bind any of the standard keysym names tofunctions in a terminal package. There's code in loaddefs.el that does that;the less people make exceptions to that, the more consistent an interface Emacswill have across different keyboards. Those exceptions should go in your.emacs file. Finally, if you're using a USL UNIX or a Sun box or anything else with theUSL version of curses(3) on it, bear in mind that the original curses(3) had(and still has) a very much smaller set of keycaps. In fact, the reliableones were just the arrow keys and the first ten function keys. If you careabout making your package portable to older Berkeley machines, don't count onthe setup code to bind anything else. If your terminal's arrow key sequences are so funky that they conflict withnormal Emacs key bindings, the package should set up a function called(enable-foo-arrow-keys), where `foo' becomes the terminal name, and leaveit up to the user's .emacs file whether to call it. Before writing a terminal-support package, it's a good idea to read theexisting ones and learn the common conventions.This file is part of GNU Emacs.GNU Emacs is free software: you can redistribute it and/or modifyit under the terms of the GNU General Public License as published bythe Free Software Foundation, either version 3 of the License, or(at your option) any later version.GNU Emacs is distributed in the hope that it will be useful,but WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See theGNU General Public License for more details.You should have received a copy of the GNU General Public Licensealong with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
