Remove * in defcustom docstrings.
[emacs.git] / lisp / emulation / edt-pc.el
blob6f3931972815ac2422db6693f895d324323fa895
1 ;;; edt-pc.el --- enhanced EDT keypad mode emulation for PC 101 keyboards
3 ;; Copyright (C) 1986, 1994, 1995, 2002, 2003, 2004,
4 ;; 2005, 2006 Free Software Foundation, Inc.
6 ;; Author: Kevin Gallagher <kevingal@onramp.net>
7 ;; Maintainer: Kevin Gallagher <kevingal@onramp.net>
8 ;; Keywords: emulations
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
24 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
25 ;; Boston, MA 02110-1301, USA.
27 ;;; Commentary:
29 ;; See edt-user.doc in the Emacs etc directory.
31 ;; ====================================================================
33 ;;;;
34 ;;;; KEY TRANSLATIONS
35 ;;;;
37 ;; Associate EDT keynames with Emacs terminal function vector names.
39 ;; To emulate the DEC LK-201 keypad keys on the PC 101 keyboard,
40 ;; NumLock must be ON.
42 ;; The PC keypad keys are mapped to the corresponding DEC LK-201
43 ;; keypad keys according to the corresponding physical position on
44 ;; the keyboard. Thus, the physical position of the PC keypad key
45 ;; determines its function, not the PC keycap name.
47 ;; There are two LK-201 keypad keys needing special handling: PF1 and
48 ;; the keypad comma key.
50 ;; PF1:
51 ;; Most PC software does not see a press of the NumLock key. A TSR
52 ;; program distributed with MS-Kermit to support its VT-100 emulation
53 ;; solves this problem. The TSR, called GOLD, causes a press of the
54 ;; keypad NumLock key to look as if the PC F1 key were pressed. So
55 ;; the PC F1 key is mapped here to behave as the PF1 (GOLD) key.
56 ;; Then with GOLD loaded, the NumLock key will behave as the GOLD key.
58 ;; By the way, with GOLD loaded, you can still toggle numlock on/off.
59 ;; GOLD binds this to Shift-NumLock.
61 ;; Keypad Comma:
62 ;; There is no physical PC keypad key to correspond to the LK-201
63 ;; keypad comma key. So, the EDT Emulation is configured below to
64 ;; ignore attempts to bind functions to the keypad comma key.
66 ;; Finally, F2 through F12 are also available for making key bindings
67 ;; in the EDT Emulation on the PC. F1 is reserved for the GOLD key,
68 ;; so don't attempt to bind anything to it. Also, F13, F14, HELP, DO,
69 ;; and F17 through F20 do not exist on the PC, so the EDT emulation is
70 ;; configured below to ignore attempts to bind functions to those keys.
73 ;;; Code:
75 (defconst *EDT-keys*
76 '(("KP0" . [kp-0]) ("KP1" . [kp-1]) ("KP2" . [kp-2]) ("KP3" . [kp-3])
77 ("KP4" . [kp-4]) ("KP5" . [kp-5]) ("KP6" . [kp-6]) ("KP7" . [kp-7])
78 ("KP8" . [kp-8]) ("KP9" . [kp-9]) ("KP," . "" )
79 ("KP-" . [kp-add]) ("KPP" . [kp-decimal]) ("KPE" . [kp-enter])
80 ("PF1" . [f1]) ("PF2" . [kp-divide]) ("PF3" . [kp-multiply])
81 ("PF4" . [kp-subtract])
82 ("UP" . [up]) ("DOWN" . [down]) ("RIGHT" . [right]) ("LEFT" . [left])
83 ("FIND" . [insert]) ("INSERT" . [home]) ("REMOVE" . [prior])
84 ("SELECT" . [delete]) ("PREVIOUS" . [end]) ("NEXT" . [next])
85 ("F1" . "" ) ("F2" . [f2]) ("F3" . [f3]) ("F4" . [f4]) ("F5" . [f5])
86 ("F6" . [f6]) ("F7" . [f7]) ("F8" . [f8]) ("F9" . [f9]) ("F10" . [f10])
87 ("F11" . [f11]) ("F12" . [f12]) ("F13" . "" ) ("F14" . "" )
88 ("HELP" . "" ) ("DO" . "" ) ("F17" . "" ) ("F18" . "" )
89 ("F19" . "" ) ("F20" . "" )))
91 ;;; arch-tag: 4593d053-183a-4062-97de-57b8877595ce
92 ;;; edt-pc.el ends here