xref: /freebsd/usr.sbin/bluetooth/bthidcontrol/bthidcontrol.8 (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1.\" Copyright (c) 2004 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: bthidcontrol.8,v 1.1 2004/02/13 21:44:41 max Exp $
26.\"
27.Dd October 30, 2006
28.Dt BTHIDCONTROL 8
29.Os
30.Sh NAME
31.Nm bthidcontrol
32.Nd Bluetooth HID control utility
33.Sh SYNOPSIS
34.Nm
35.Fl h
36.Nm
37.Op Fl a Ar BD_ADDR
38.Op Fl c Ar file
39.Op Fl H Ar file
40.Op Fl v
41.Ar command
42.Sh DESCRIPTION
43The
44.Nm
45utility can be used to query remote Bluetooth HID devices, dump HID descriptors
46in human readable form and perform simple manipulations on the Bluetooth HID
47daemon configuration files.
48.Pp
49The
50.Nm
51utility will print results to the standard output and error messages to the
52standard error.
53.Pp
54The options are as follows:
55.Bl -tag -width indent
56.It Fl a Ar BD_ADDR
57Specify BD_ADDR for the HID device.
58Example:
59.Fl a Li 00:01:02:03:04:05 .
60.It Fl c Ar file
61Specify path to the Bluetooth HID daemon configuration file.
62The default path is
63.Pa /etc/bluetooth/bthidd.conf .
64.It Fl H Ar file
65Specify path to the Bluetooth HID daemon known HIDs file.
66The default path is
67.Pa /var/db/bthidd.hids .
68.It Fl h
69Display usage message and exit.
70.It Fl v
71Be verbose and show items that are being used for padding.
72.It Ar command
73One of the supported commands (see below).
74Special command
75.Cm help
76can be used to obtain the list of all supported commands.
77To get more information about specific command use
78.Cm help Ar command .
79.El
80.Sh COMMANDS
81The currently supported node commands in
82.Nm
83are:
84.Pp
85.Bl -tag -width "Forget" -offset indent -compact
86.It Cm Query
87.It Cm Dump
88.It Cm Known
89.It Cm Forget
90.El
91.Sh FILES
92.Bl -tag -width ".Pa /etc/bluetooth/bthidd.conf" -compact
93.It Pa /etc/bluetooth/bthidd.conf
94.It Pa /var/db/bthidd.hids
95.El
96.Sh EXIT STATUS
97.Ex -std
98.Sh SEE ALSO
99.Xr bthidd 8
100.Sh AUTHORS
101.An Maksim Yevmenkin Aq Mt m_evmenkin@yahoo.com
102