usr.sbin/tpctl/tpctl.8

   1 .\"     $NetBSD: tpctl.8,v 1.3 2003/02/25 10:36:21 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25 .\" POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .Dd August 25, 2002
  28 .Dt TPCTL 8
  29 .Os
  30 .Sh NAME
  31 .Nm tpctl
  32 .Nd touch panel calibration utility
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Bk -words
  36 .Op Fl D Ar dispdevname
  37 .Ek
  38 .Bk -words
  39 .Op Fl d Ar devname
  40 .Ek
  41 .Bk -words
  42 .Op Fl f Ar filename
  43 .Ek
  44 .Op Fl hnuv
  45 .Sh DESCRIPTION
  46 .Nm
  47 is a touch panel calibration utility.
  48 .Nm
  49 calibrates a touch panel and saves and restores the calibration parameters
  50 into/from a parameter database file.
  51 .Pp
  52 Available command-line flags are:
  53 .Bl -tag -width dispdevnameXXXX -compact
  54 .It Fl D Ar dispdevname
  55 Specify display device name.
  56 .It Fl d Ar devname
  57 Specify touch panel device name.
  58 .It Fl f Ar filename
  59 Specify alternate parameter database file name.
  60 .It Fl h
  61 Print brief description.
  62 .It Fl n
  63 Do not change the parameter database file.
  64 .It Fl u
  65 Force calibration.
  66 Without this flag,
  67 .Nm
  68 won't do calibration if the database file already contains parameters
  69 for the touch panel.
  70 .It Fl v
  71 Verbose mode.
  72 .El
  73 .Pp
  74 You calibrate the touch panel the first time you run
  75 .Nm .
  76 If you see a cross cursor on the screen, you should tap the center of
  77 the cursor to calibrate the touch panel, or you can abort the
  78 calibration with the
  79 .Sq ESC
  80 key.
  81 Five cursors will appear on the screen in turn.
  82 Once calibration is done,
  83 .Nm
  84 saves the calibration parameters into the database file and uses the saved
  85 parameters to calibrate the touch panel.
  86 .Pp
  87 You can run
  88 .Nm
  89 automatically with
  90 .Pa /etc/rc.d/tpctl .
  91 .Sh FILES
  92 .Bl -tag -width /etc/tpctl.dat -compact
  93 .It Pa /etc/tpctl.dat
  94 The default calibration parameter database file.
  95 The
  96 .Fl f
  97 flag may be used to specify an alternate database file name.
  98 .Nm
  99 will create an empty database file if it doesn't exist.
 100 .It Pa /dev/ttyE0
 101 The default display device, which is used to display the cursor during
 102 calibration.
 103 The
 104 .Fl D
 105 flag may be used to specify an alternate display device name.
 106 The display device must provide the
 107 .Sq hpcfb
 108 interface as defined in
 109 .Pa /usr/include/dev/hpc/hpcfbio.h .
 110 .It Pa /dev/wsmux0
 111 The default touch panel device.
 112 The
 113 .Fl d
 114 flag may be used to specify an alternate touch panel device name.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr rc.conf 5
 118 .Sh BUGS
 119 .Nm
 120 isn't available on all ports because it requires a display device which
 121 provides the
 122 .Sq hpcfb
 123 interface.