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 .\" $DragonFly: src/usr.sbin/pcvt/kcon/Attic/kcon.1,v 1.2 2003/06/17 04:29:59 dillon Exp $
  29 .\"
  30 .Dd March 27, 2000
  31 .Dt KCON 1
  32 .Os
  33 .Sh NAME
  34 .Nm kcon
  35 .Nd pcvt keyboard control and remapping
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl d Ar delay
  39 .Op Fl l
  40 .Op Fl m Ar map
  41 .Op Fl o
  42 .Op Fl p
  43 .Op Fl R
  44 .Op Fl r Ar rate
  45 .Op Fl s
  46 .Op Fl t Ns Ar +/-
  47 .Op Fl x
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility
  52 is used for controlling all aspects of keyboard configuration for the 'pcvt'
  53 video driver.
  54 .Pp
  55 The available options are:
  56 .Bl -tag -width flag
  57 .It Fl d Ar delay
  58 Specifies the delay after which the last key entered will be repeated by the
  59 Keyboard.
  60 Valid values are 0..3 corresponding to delays of 250, 500, 750 and
  61 1000 milliseconds.
  62 .It Fl l
  63 Displays the current keyboard map in use by the driver.
  64 .It Fl m Ar map
  65 Specifies the map entry to be searched in the keyboard capabilities database
  66 .Nm keycap .
  67 The database is searched for the entry and if found, the mapping
  68 is loaded and is used in the driver from then on.
  69 .It Fl o
  70 Switches display of control codes to octal in the listing of the current map.
  71 To be used in conjunction with the
  72 .Fl l
  73 option.
  74 .It Fl p
  75 Uses 'pure' output when listing - the Escape character is displayed in either
  76 octal or hexadecimal and not as 'ESC'. To be used in conjunction with the
  77 .Fl l
  78 option.
  79 .It Fl r Ar rate
  80 Specifies the character repetition rate.
  81 Valid argument values are 0...31
  82 corresponding to rates of 30 characters/second ... 2 characters/second.
  83 .It Fl R
  84 Reset the Keyboard.
  85 .It Fl s
  86 Displays the current settings of the rate and delay values.
  87 .It Fl t Ar +/-
  88 Specify this option to enable
  89 .Pq Ar +
  90 or disable
  91 .Pq Ar -
  92 the repetition of keys.
  93 .It Fl x
  94 Switches display of control codes to hexadecimal in the listing of the current map.
  95 To be used in conjunction with the
  96 .Fl l
  97 option.
  98 This is the default behaviour.
  99 .El
 100 .Sh FILES
 101 .Bl -tag -width /usr/share/misc/keycap.pcvt -compact
 102 .It Pa /usr/share/misc/keycap.pcvt
 103 Keyboard capabilities data base file if nothing else was chosen during installation.
 104 .It Pa /dev/console
 105 Keyboard raw device.
 106 .El
 107 .Sh SEE ALSO
 108 .Xr keycap 3 ,
 109 .Xr keycap 5
 110 .Sh BUGS
 111 The
 112 .Nm
 113 utility detects several inconsistencies in the keycap database.
 114 In case of errors
 115 .Nm
 116 exits with an error message.
 117 If this happens, the keyboard may remain in
 118 an undefined state.
 119 To recover from such situation, execute
 120 .Dq Li kcon -m default .
 121 .Sh EXAMPLES
 122 The command
 123 .Dq Li kcon -m gb
 124 loads the entry 'gb' from the keycap file into the keyboard to switch to
 125 a british keyboard behaviour.
 126 .Pp
 127 The command
 128 .Dq Li kcon -r 0 -d 0
 129 switches the keyboard to emit characters at a rate of 30 characters per second
 130 after a key has been held down for 250 milliseconds.