usr.sbin/pcvt/mcon/mcon.1

   1 .\" Copyright (c) 1994 Joerg Wunsch
   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 .\" 3. All advertising materials mentioning features or use of this software
  14 .\"    must display the following acknowledgement:
  15 .\"     This product includes software developed by Joerg Wunsch
  16 .\" 4. The name authors may not be used to endorse or promote products
  17 .\"    derived from this software without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
  20 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22 .\" IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  23 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .\" @(#)mcon.1, 3.00, Last Edit-Date: [Mon Jan 10 21:28:22 1994]
  31 .\" $FreeBSD: src/usr.sbin/pcvt/mcon/mcon.1,v 1.8.2.1 2000/12/27 13:50:37 ru Exp $
  32 .\" $DragonFly: src/usr.sbin/pcvt/mcon/Attic/mcon.1,v 1.2 2003/06/17 04:29:59 dillon Exp $
  33 .\"
  34 .Dd January 3, 1994
  35 .Dt MCON 1
  36 .Os
  37 .Sh NAME
  38 .Nm mcon
  39 .Nd controls pcvt mouse emulator
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl l Ar left-button-key
  43 .Op Fl m Ar mid-button-key
  44 .Op Fl r Ar right-button-key
  45 .Op Fl a Ar accel-time
  46 .Op Fl s Ar 0 | false | \&no
  47 .Op Fl s Ar 1 | true | yes
  48 .Ar device
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility controls the configurable parameters for the mouse emulator of
  53 .Xr pcvt 4 .
  54 .Pp
  55 .Em NB :
  56 The mouse emulator is not configured in by default; the system's config
  57 file needs to specify an option line
  58 .Pp
  59 .Cd options PCVT_EMU_MOUSE
  60 .Pp
  61 in order to get its functionality.
  62 .Pp
  63 Either way, the
  64 .Nm
  65 program must be called with an argument
  66 .Ar device
  67 that specifies the device node used for the mouse emulation.
  68 This is
  69 usually the first device node of the
  70 .Xr pcvt 4
  71 driver not being used as a virtual terminal device.
  72 E.\ g., if you
  73 have configured eight virtual terminals
  74 .Pq the default value ,
  75 named
  76 .Pa /dev/ttyv0
  77 through
  78 .Pa /dev/ttyv7 ,
  79 the mouse emulator would allocate
  80 .Pa /dev/ttyv8 .
  81 .Pp
  82 If
  83 .Nm
  84 is called without any option, it will print the actual values of the
  85 configurable parameters.
  86 .Pp
  87 If called with an option, the program attempts to set up the new value.
  88 .Pp
  89 The options are as follows:
  90 .Bl -tag -width Ds
  91 .It Fl l Ar left-button-key
  92 .It Fl m Ar mid-button-key
  93 .It Fl r Ar right-button-key
  94 Maps the named
  95 .Ar button key
  96 to emulate either the left, middle, or right mouse button.
  97 .Ar Button key
  98 is the usual name for that key.
  99 Normal ASCII keys are denoted by the
 100 character they're labeled with, function keys are named
 101 .Em f1
 102 through
 103 .Em f10 .
 104 Note that the AT function keys
 105 .Em f11
 106 and
 107 .Em f12
 108 are
 109 .Em extended
 110 keys that cannot be mapped to be used with the mouse emulator since
 111 it only allows basic PC-scancode keys to be used.
 112 .It Fl a Ar accel-time
 113 Set the time limit for the internal accelerator to
 114 .Ar accel-time
 115 milliseconds.
 116 Key events occurring after a longer time than this limit
 117 will move the mouse cursor in single steps.
 118 Key events arriving more
 119 frequently will move the cursor accelerated by a factor of 6. Note that
 120 despite of
 121 .Em milliseconds
 122 being the unit of choice here, the time resolution is restricted by the
 123 timer tick distance of the underlying operating system, usually to a
 124 granularity of 10 milliseconds.
 125 .It Fl s Ar 0 | false | \&no
 126 .It Fl s Ar 1 | true | yes
 127 The first form disables, the second form enables the
 128 .Em sticky
 129 behaviour of the mouse buttons.
 130 Sticky mouse keys behave much like
 131 toggle-buttons: on first press, they become active, on second press,
 132 they're deactivated.
 133 Pressing another button will deactivate any
 134 other sticky button anyway.
 135 .Pp
 136 Sticky buttons might be more convenient since you don't need 20 fingers
 137 at all; on the other hand, they make it virtually impossible to initiate
 138 double or triple mouse clicks.
 139 .El
 140 .Sh EXAMPLES
 141 The following example would install the default behaviour of the
 142 mouse emulator:
 143 .Pp
 144 .Nm
 145 .Fl l Ar f1
 146 .Fl m Ar f2
 147 .Fl r Ar f3
 148 .Fl a Ar 250
 149 .Fl s Ar \&no
 150 .Pa /dev/ttyv8
 151 .Sh BUGS
 152 The key names used to map the button-emulating keys to scan codes
 153 .Pq and vica verse
 154 are based on the American keyboard layout.
 155 This would usually not
 156 cause any trouble since the
 157 .Dq button-of-choice
 158 is certainly some function key that should be equal for any national
 159 keyboard layout.
 160 .Pp
 161 The mouse emulator is a rude hack at all; its only purpose is to provide
 162 a device to move the pointer within an X-windowing environment.
 163 .Sh SEE ALSO
 164 .Xr X 1 ,
 165 .Xr pcvt 4
 166 .Sh HISTORY
 167 The
 168 .Nm
 169 utility appeared in
 170 .Xr pcvt 4 ,
 171 release 3.00.
 172 .Sh AUTHORS
 173 The mouse emulator has been contributed by
 174 .An "J\(:org Wunsch" .