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