xref: /netbsd-src/usr.sbin/btdevctl/btdevctl.8 (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1.\" $NetBSD: btdevctl.8,v 1.3 2006/09/10 15:45:56 plunky Exp $
2.\"
3.\" Copyright (c) 2006 Itronix 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. The name of Itronix Inc. may not be used to endorse
15.\"    or promote products derived from this software without specific
16.\"    prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
22.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25.\" ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.\" Copyright (c) 2004 Maksim Yevmenkin <m_evmenkin@yahoo.com>
31.\" All rights reserved.
32.\"
33.\" Redistribution and use in source and binary forms, with or without
34.\" modification, are permitted provided that the following conditions
35.\" are met:
36.\" 1. Redistributions of source code must retain the above copyright
37.\"    notice, this list of conditions and the following disclaimer.
38.\" 2. Redistributions in binary form must reproduce the above copyright
39.\"    notice, this list of conditions and the following disclaimer in the
40.\"    documentation and/or other materials provided with the distribution.
41.\"
42.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
43.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
46.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
48.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
49.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
50.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
51.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52.\" SUCH DAMAGE.
53.\"
54.\" $Id: btdevctl.8,v 1.3 2006/09/10 15:45:56 plunky Exp $
55.\" $FreeBSD: src/usr.sbin/bluetooth/bthidcontrol/bthidcontrol.8,v 1.3 2005/01/18 20:02:30 ru Exp $
56.\"
57.Dd September 9, 2006
58.Dt BTDEVCTL 8
59.Os
60.Sh NAME
61.Nm btdevctl
62.Nd Bluetooth remote device control utility
63.Sh SYNOPSIS
64.Nm
65.Op Fl A | Fl D
66.Op Fl qv
67.Fl a Ar address
68.Fl d Ar device
69.Fl s Ar service
70.Sh DESCRIPTION
71The
72.Nm
73utility is used to configure bluetooth devices in the system.
74Normally,
75.Nm
76will perform  an SDP query to the remote device as needed, and
77cache the results in the
78.Pa /var/db/btdevctl.plist
79file for later use.
80If neither Attach nor Detach is specified,
81.Nm
82will display the configuration.
83.Pp
84The options are:
85.Bl -tag
86.It Fl A
87Attach device
88.It Fl a Ar address
89Remote device address.
90The
91.Ar address
92may be given as BDADDR or a name.
93If a name was specified,
94.Nm
95attempts to resolve the name via
96.Xr bt_gethostbyname 3 .
97.It Fl D
98Detach device
99.It Fl d Ar device
100Local device address.
101May be given as BDADDR or device name.
102.It Fl q
103Ignore any cached data and perform a SDP query for the given
104.Ar service .
105.It Fl s Ar service
106Service to configure.
107Known services are:
108.Pp
109.Bl -tag -width HSETXX -compact
110.It Dv HID
111Human Interface Device.
112.It Dv HF
113Handsfree.
114.It Dv HSET
115Headset.
116.El
117.It Fl v
118Be verbose.
119.El
120.Pp
121For device configurations to persist across boots, add entries to the
122.Pa /etc/bluetooth/btdevctl.conf
123file and
124set the
125.Xr rc.conf 5
126variable
127.Sy btdevctl
128to YES.
129.Pp
130.Sh EXIT STATUS
131.Ex -std
132.Sh FILES
133.Bl -tag -compact
134.It Pa /etc/bluetooth/btdevctl.conf
135.It Pa /dev/bthub
136.It Pa /var/db/btdevctl.plist
137.El
138.Sh SEE ALSO
139.Xr bthidev 4 ,
140.Xr bthub 4 ,
141.Xr btsco 4 ,
142.Xr rc.conf 5
143.Sh HISTORY
144Parts of the
145.Nm
146program originated in the
147.Fx
148.Nm bthidcontrol
149program.
150.Sh AUTHORS
151.An Iain Hibbert
152for Itronix, Inc.
153.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
154