usr.sbin/pcvt/kcon/kcon.1

   1 .\" Copyright (c) 1992, 2000 Hellmuth Michaelis
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  15 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  16 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  17 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  18 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  19 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  20 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  21 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  23 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" Last Edit-Date: [Mon Mar 27 17:04:14 2000]
  26 .\"
  27 .\" $FreeBSD: src/usr.sbin/pcvt/kcon/kcon.1,v 1.7.2.6 2002/06/21 16:41:08 charnier Exp $
  28 .\"
  29 .Dd March 27, 2000
  30 .Dt KCON 1
  31 .Os
  32 .Sh NAME
  33 .Nm kcon
  34 .Nd pcvt keyboard control and remapping
  35 .Sh SYNOPSIS
  36 .Nm
  37 .Op Fl d Ar delay
  38 .Op Fl l
  39 .Op Fl m Ar map
  40 .Op Fl o
  41 .Op Fl p
  42 .Op Fl R
  43 .Op Fl r Ar rate
  44 .Op Fl s
  45 .Op Fl t Ns Ar +/-
  46 .Op Fl x
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility
  51 is used for controlling all aspects of keyboard configuration for the 'pcvt'
  52 video driver.
  53 .Pp
  54 The available options are:
  55 .Bl -tag -width flag
  56 .It Fl d Ar delay
  57 Specifies the delay after which the last key entered will be repeated by the
  58 Keyboard.
  59 Valid values are 0..3 corresponding to delays of 250, 500, 750 and
  60 1000 milliseconds.
  61 .It Fl l
  62 Displays the current keyboard map in use by the driver.
  63 .It Fl m Ar map
  64 Specifies the map entry to be searched in the keyboard capabilities database
  65 .Nm keycap .
  66 The database is searched for the entry and if found, the mapping
  67 is loaded and is used in the driver from then on.
  68 .It Fl o
  69 Switches display of control codes to octal in the listing of the current map.
  70 To be used in conjunction with the
  71 .Fl l
  72 option.
  73 .It Fl p
  74 Uses 'pure' output when listing - the Escape character is displayed in either
  75 octal or hexadecimal and not as 'ESC'. To be used in conjunction with the
  76 .Fl l
  77 option.
  78 .It Fl r Ar rate
  79 Specifies the character repetition rate.
  80 Valid argument values are 0...31
  81 corresponding to rates of 30 characters/second ... 2 characters/second.
  82 .It Fl R
  83 Reset the Keyboard.
  84 .It Fl s
  85 Displays the current settings of the rate and delay values.
  86 .It Fl t Ar +/-
  87 Specify this option to enable
  88 .Pq Ar +
  89 or disable
  90 .Pq Ar -
  91 the repetition of keys.
  92 .It Fl x
  93 Switches display of control codes to hexadecimal in the listing of the current map.
  94 To be used in conjunction with the
  95 .Fl l
  96 option.
  97 This is the default behaviour.
  98 .El
  99 .Sh FILES
 100 .Bl -tag -width /usr/share/misc/keycap.pcvt -compact
 101 .It Pa /usr/share/misc/keycap.pcvt
 102 Keyboard capabilities data base file if nothing else was chosen during installation.
 103 .It Pa /dev/console
 104 Keyboard raw device.
 105 .El
 106 .Sh SEE ALSO
 107 .Xr keycap 3 ,
 108 .Xr keycap 5
 109 .Sh BUGS
 110 The
 111 .Nm
 112 utility detects several inconsistencies in the keycap database.
 113 In case of errors
 114 .Nm
 115 exits with an error message.
 116 If this happens, the keyboard may remain in
 117 an undefined state.
 118 To recover from such situation, execute
 119 .Dq Li kcon -m default .
 120 .Sh EXAMPLES
 121 The command
 122 .Dq Li kcon -m gb
 123 loads the entry 'gb' from the keycap file into the keyboard to switch to
 124 a british keyboard behaviour.
 125 .Pp
 126 The command
 127 .Dq Li kcon -r 0 -d 0
 128 switches the keyboard to emit characters at a rate of 30 characters per second
 129 after a key has been held down for 250 milliseconds.