xref: /freebsd/usr.sbin/bluetooth/bthidd/bthidd.8 (revision 6574b8ed19b093f0af09501d2c9676c28993cb97)
1.\" Copyright (c) 2006 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: bthidd.8,v 1.1 2006/09/07 21:36:55 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd September 7, 2006
29.Dt BTHIDD 8
30.Os
31.Sh NAME
32.Nm bthidd
33.Nd Bluetooth HID daemon
34.Sh SYNOPSIS
35.Nm
36.Fl h
37.Nm
38.Op Fl a Ar BD_ADDR
39.Op Fl c Ar file
40.Op Fl H Ar file
41.Op Fl p Ar file
42.Op Fl t Ar val
43.Sh DESCRIPTION
44The
45.Nm
46daemon handles remote Bluetooth HID devices.
47.Pp
48The options are as follows:
49.Bl -tag -width indent
50.It Fl a Ar BD_ADDR
51Specify the local address to listen on.
52By default, the server will listen on
53.Dv ANY
54address.
55The address can be specified as BD_ADDR or name.
56If a name was specified, the
57.Nm
58daemon will attempt to resolve the name via
59.Xr bt_gethostbyname 3 .
60.It Fl c Ar file
61Specify path to the configuration file.
62The default path is
63.Pa /etc/bluetooth/bthidd.conf .
64.It Fl d
65Do not detach from the controlling terminal, i.e., run in foreground.
66.It Fl H Ar file
67Specify path to the known HIDs file.
68The default path is
69.Pa /var/db/bthidd.hids .
70.It Fl h
71Display usage message and exit.
72.It Fl p Ar file
73Specify path to the PID file.
74The default path is
75.Pa /var/run/bthidd.pid .
76.It Fl t Ar val
77Specify client rescan interval in seconds.
78The
79.Nm
80daemon will periodically scan for newly configured Bluetooth HID devices or
81disconnected
82.Dq passive
83Bluetooth HID devices and will attempt to establish an outgoing connection.
84The default rescan interval is 10 seconds.
85.El
86.Sh KNOWN LIMITATIONS
87The
88.Nm
89daemon currently does not handle key auto repeat and double click mouse events.
90Those events work under
91.Xr X 7
92just fine,
93but not in text console.
94.Pp
95This manual page needs more work.
96A manual page documenting the format of the
97.Pa /etc/bluetooth/bthidd.conf
98configuration file is needed as well.
99.Sh FILES
100.Bl -tag -width ".Pa /etc/bluetooth/bthidd.conf" -compact
101.It Pa /etc/bluetooth/bthidd.conf
102.It Pa /var/db/bthidd.hids
103.It Pa /var/run/bthidd.pid
104.El
105.Sh SEE ALSO
106.Xr kbdmux 4 ,
107.Xr vkbd 4 ,
108.Xr bthidcontrol 8
109.Sh AUTHORS
110.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
111.Sh CAVEATS
112Any Bluetooth HID device that has
113.Dv HUP_KEYBOARD
114or
115.Dv HUP_CONSUMER
116entries in its descriptor is considered as
117.Dq keyboard .
118For each
119.Dq keyboard
120Bluetooth HID device,
121the
122.Nm
123daemon will use a separate instance of the virtual keyboard interface
124.Xr vkbd 4 .
125Therefore the
126.Xr kbdmux 4
127driver must be used to properly multiplex input from multiple keyboards.
128