xref: /dragonfly/usr.sbin/btconfig/btconfig.8 (revision 9348a738)
1.\" $NetBSD: btconfig.8,v 1.7 2007/09/07 18:40:01 plunky Exp $
2.\" $DragonFly: src/usr.sbin/btconfig/btconfig.8,v 1.2 2008/01/09 09:03:34 swildner Exp $
3.\"
4.\" Copyright (c) 2006 Itronix Inc.
5.\" All rights reserved.
6.\"
7.\" Written by Iain Hibbert for Itronix Inc.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. The name of Itronix Inc. may not be used to endorse
18.\"    or promote products derived from this software without specific
19.\"    prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
25.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
28.\" ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31.\" POSSIBILITY OF SUCH DAMAGE.
32.\"
33.Dd September 7, 2007
34.Dt BTCONFIG 8
35.Os
36.Sh NAME
37.Nm btconfig
38.Nd configure bluetooth devices
39.Sh SYNOPSIS
40.Nm
41.Op Fl svz
42.Oo
43.Ar device
44.Op Ar parameters
45.Oc
46.Nm
47.Op Fl l
48.Sh DESCRIPTION
49.Nm
50is used to configure Bluetooth devices.
51If the
52.Ar device
53is given, but no parameters, then
54.Nm
55will print information about the device.
56If no
57.Ar device
58is given, a basic list of devices will be printed.
59.Pp
60When the
61.Fl l
62flag is used, just the device names will be printed.
63.Sh COMMANDS
64The following parameters may be specified with
65.Nm :
66.Bl -tag -width xxxxxxxxxxx
67.It Cm up
68Enable Bluetooth Device.
69.It Cm down
70Disable Bluetooth Device.
71.It Cm pscan
72Enable Page Scan.
73This enables incoming connections to the device.
74.It Cm -pscan
75Disable Page Scan.
76.It Cm iscan
77Enable Inquiry Scan.
78This puts the device in Discoverable mode.
79.It Cm -iscan
80Disable Inquiry Scan.
81.It Cm encrypt
82Enable encryption.
83This will cause the device to request encryption on all baseband
84connections, and will only work if authentication is also enabled.
85.It Cm -encrypt
86Disable encryption.
87.It Cm auth
88Enable authentication.
89This will cause the device to request authentication
90for all baseband connections.
91.It Cm -auth
92Disable authentication.
93.It Cm switch
94Enable Role Switching.
95.It Cm -switch
96Disable Role Switching.
97.It Cm hold
98Enable Hold Mode.
99.It Cm -hold
100Disable Hold Mode.
101.It Cm sniff
102Enable Sniff Mode.
103.It Cm -sniff
104Disable Sniff Mode.
105.It Cm park
106Enable Park Mode.
107.It Cm -park
108Disable Park Mode.
109.It Cm name Ar name
110Set human readable name of device.
111.It Cm ptype Ar type
112Set packet types.
113.Ar type
114is a 16 bit hex value specifying packet types that will be requested
115by outgoing ACL connections.
116By default, all packet types that the device supports are enabled,
117see bluetooth specifications for more information if you want to change this.
118.It Cm class Ar class
119Set class of device.
120.Ar class
121is a 3 byte hex value the value of which declares the device capabilities.
122See Bluetooth Assigned Numbers documents at
123.Pa https://www.bluetooth.org/
124for details
125of constructing a "Class of Device" value.
126As a starter, 0x020104 means Desktop Computer, with Networking
127available.
128.It Cm fixed
129Set fixed pin type.
130.It Cm variable
131Set variable pin type.
132.It Cm inquiry
133Perform device Discovery from the specified device and print details.
134.It Cm rssi
135Enable Remote Signal Strength Indicator (RSSI) in inquiry results.
136This will only work if the device features indicate
137.Aq RSSI with inquiry result .
138.It Cm -rssi
139Disable Remote Signal Strength Indicator (RSSI) in inquiry results.
140.It Cm reset
141Perform a hard reset on the device and re-initialise system state.
142.It Cm voice
143Set Voice Setting.
144[This should be 0x0060 for now]
145.It Cm pto
146Set Page Timeout value.
147This is a decimal value in milliseconds.
148.It Cm scomtu
149Change SCO mtu value.
150This is a decimal value, see
151.Xr ubt 4
152for reasons why you may need to do this.
153.El
154.Pp
155All parameters are parsed before any device operations take place.
156Each time the
157.Fl v
158flag is given, verbosity levels will be increased.
159.Pp
160Super-user privileges are required to change device configurations.
161.Sh DIAGNOSTICS
162Messages indicating the specified device does not exist, the
163requested address is unknown, or the user is not privileged and
164tried to alter an device's configuration.
165.Sh SEE ALSO
166.Xr bluetooth 4 ,
167.Xr ubt 4
168.Sh HISTORY
169The
170.Nm
171command was written for
172.Nx 4.0
173by
174.An Iain Hibbert
175under the sponsorship of Itronix, Inc and was imported into
176.Dx 1.11 .
177.Sh BUGS
178The output is very messy.
179