usr.sbin/pcvt/Misc/Doc/Keyboard.VT

   1 ================================================================================
   2 #                                                                              #
   3 #       Function key mapping for the "more VT220" - like layout                #
   4 #                                                                              #
   5 ================================================================================
   6
   7
   8 I.      Special Keys Used To Change The General Runtime Functionality
   9 =====================================================================
  10
  11
  12         CTRL-F9 Function key labels ON / OFF
  13         ------------------------------------
  14
  15                 this key is only operational, when in HP/VT mode, see CTRL-F11
  16
  17                 CTRL-F9 toggles between function key labels displayed or not.
  18
  19                 ON:  screen has either 25-3 = 22, 28-3 = 25 or 50-3 = 47 lines
  20                         2 lines fkey labels displayed
  21                         row/col display enabled
  22                         1 line status/load avg line
  23
  24                 OFF: screen has either 25-3 = 22, 28-3 = 25 or 50-3 = 47 lines
  25                         no function key labels displayed
  26                         no row/col display
  27                         no status/load avg line
  28
  29                 applicable escape sequences:
  30
  31                         switch OFF:
  32                         ESC & j @       remove labels from screen
  33
  34                         switch ON:
  35                         ESC & j A       display system fkey labels
  36                         ESC & j B       display user fkey labels
  37                         ESC & j C       display current fkey labels
  38
  39
  40         CTRL-F10        User / System Function key labels
  41         -------------------------------------------------
  42
  43                 this key is only operational, when in HP/VT mode, see CTRL-F11
  44
  45                 CTRL-F10 toggles between the display of user or system
  46                 function key labels
  47
  48                 this key is only active if labels are toggled on via
  49                 the CTRL-F9 function key
  50
  51                 screen has either 25-3 = 22, 28-3 = 25 or 50-3 = 47 lines
  52                         2 lines fkey labels displayed
  53                         row/col display enabled
  54                         1 line status/load avg line
  55
  56
  57                 applicable escape sequences: (see above)
  58
  59                         ESC & j A       display system fkey labels
  60                         ESC & j B       display user fkey labels
  61                         ESC & j C       display current fkey labels
  62
  63
  64         CTRL-F11        Toggle between pure VT and HP-VT Emulation
  65         ----------------------------------------------------------
  66
  67                 This key switches between pure vt100/vt220 mode and
  68                 vt100/vt220 with hp-fkey-labels mode of operation.
  69                 this is not dependent of any screen resolution the
  70                 virtual consoles are in.
  71
  72                 initially, after power on, all virtual screens are in
  73                 the pure vt-mode:
  74
  75                 - the emulator does not execute any hp escape sequences
  76                 - the function key label lines are switched off
  77                 - no load average or status line is displayed
  78                 - no row / column counter is displayed
  79                 - the full screen 25x80, 28x80 or 50x80 is usable
  80                 - CTRL-F9 and CTRL-F10 have no function
  81
  82                 when toggled to the vt/hp mix of operation, the following
  83                 changes take place:
  84
  85                 - the emulator executes the supported hp-esc sequences
  86                 - the function key labels are displayable depending
  87                   on the state of CTRL-F9/CTRL-F10
  88                 - the load average is displayed
  89                 - the row / column counters are displayed
  90                 - in any screen resolution, the last 3 lines are lost,
  91                   so one has a 22x80, 25x80 and 47x80 resolution
  92                 - CTRL-F9 and CTRL-F10 are operational.
  93
  94                 when switching modes by means of CTRL-F11, the following
  95                 changes to the current environment, the emulator may
  96                 be in, apply:
  97
  98                 - the screen is cleared
  99                 - the cursor moves to the home position
 100                 - the scrolling region is reset to default
 101
 102                 (this functionality is available via an ioctl)
 103
 104         F5      Cycle current page
 105         --------------------------
 106
 107                 This key cycles through the display of the video
 108                 pages. on startup, page 0 is displayed; with every
 109                 keypress of F5, the next page is displayed, wrapping
 110                 from the maximum page number back to page 0.
 111
 112                 F1      switches to page 0
 113                 F2      switches to page 1
 114                 F3      switches to page 2
 115                 F4      switches to page 3
 116
 117                 Shift-F1 -- select screen 4
 118                 Shift-F2 -- select screen 5
 119                 Shift-F3 -- select screen 6
 120                 Shift-F4 -- select screen 7
 121                 Shift-F5 -- select (current screen - 1)
 122
 123                 (this functionality is available via an ioctl)
 124
 125
 126 II.     Special Keys used to change the Runtime Functionality of a Page
 127 =======================================================================
 128
 129         when in mixed HP/VT mode, one has two types of function key labels
 130         on screen, user function keys and system function keys.  they are
 131         accessed by using the CTRL key while pressing a function key.
 132
 133         the function key labels are NOT available in pure VT220 mode--although
 134         the function keys are still active
 135
 136         the user function keys and their labels can be reprogrammed by use of
 137         escape sequences.
 138
 139         in system function key mode, several pre-programmed functions inside
 140         the emulator can be toggled, currently implemented are:
 141
 142         - CTRL-F1, toggle 80/132 columns
 143         - CTRL-F2, soft reset emulator
 144         - CTRL-F3, toggle force 24 lines mode
 145         - CTRL-F4, toggle keyboard debugging (if compiled in)
 146         - CTRL-F5, toggle the audible beep generation
 147         - CTRL-F6, toggle 7/8 bit char width
 148         - CTRL-F7, toggle display functions. this means that control codes
 149                    in the range 0x00 to 0x1f are not EXECUTED by the emulator
 150                    any longer, but displayed on the screen
 151         - CTRL-F8, toggle automatic cursor wraparound at end of line
 152
 153         these functions operate just for the selected page
 154
 155
 156 III.    Keyboard VT220 compatibility
 157 ====================================
 158
 159         The following keys behave different as probably expected.
 160
 161         They were mapped to provide more VT220 compatibility.
 162
 163
 164         PC Keyboard     VT220 Keyboard
 165         -------------   --------------------------------------------------
 166         F6 - F12        emit the sequences for VT220 F6 - F12 keys
 167                         (ESC [ 17 ~ .... ESC [ 24 ~)
 168
 169         ALT F1 - F10    emit the sequences for VT220 F11 - F14, HELP, DO,
 170                         F17 - F20 keys
 171                         (ESC [ 23 ~ .... ESC [ 34 ~)
 172
 173         SHIFT F6 - F12  emit the User Definable Key sequences for VT220
 174                         F6 - F12 keys or
 175                         (ESC [ 17 ~ .... ESC [ 24 ~) for cleared sequences
 176
 177         ALTSHIFT F1-F10 emit the User Definable Key sequences for VT220
 178                         F11 - F14, HELP, DO, F17 - F20 keys or
 179                         (ESC [ 23 ~ .... ESC [ 34 ~) for cleared sequences
 180
 181         Insert          Insert Here (ESC [ 2 ~)
 182
 183         Delete          Remove (ESC [ 3 ~)
 184
 185         Home            Find (ESC [ 1 ~)
 186
 187         End             Select (ESC [ 4 ~)
 188
 189         PgUp            Prev Screen (ESC [ 5 ~)
 190
 191         PgDn            Next Screen (ESC [ 6 ~)
 192
 193         PrtSc           (ignored)
 194
 195         Pause           (ignored)
 196
 197         Break           (ignored)
 198
 199         Cursor Keys     dependent upon state of cursor key mode either
 200                         ESC [ A ... ESC [ D or ESC O A ... ESC O D
 201
 202         NumLock         toggles Numeric Keypad for Keypad Numeric Mode
 203                         and Keypad Application Mode
 204
 205         ALT-Keypad-0    can be used to generate any keycode in the
 206         ALT-Keypad-1    rage 0-255.
 207         ALT-Keypad-2    this was modeled with the behaviour of a
 208         ALT-Keypad-3    popular boot loader in mind
 209         ALT-Keypad-4
 210         ALT-Keypad-5
 211         ALT-Keypad-6
 212         ALT-Keypad-7
 213         ALT-Keypad-8
 214         ALT-Keypad-9
 215
 216         Numeric Keypad  dependent upon state of keypad numeric/application
 217                         mode either 0 ... 9 or ESC O p ... ESC O y
 218
 219         ALT-NumLock     emits PF1 sequence (ESC O P)
 220
 221         ALT-Keypad-/    emits PF2 sequence (ESC O Q)
 222
 223         ALT-Keypad-*    emits PF3 sequence (ESC O R)
 224
 225         ALT-Keypad--    emits PF4 sequence (ESC O S)
 226
 227         ALT-F11         emits PF1 sequence (ESC O P)
 228
 229         ALT-F12         emits PF2 sequence (ESC O Q)
 230
 231 /* EOF */