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