usr.sbin/btconfig/btconfig.8

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