usr.sbin/btconfig/btconfig.8

   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
  50 is used to configure Bluetooth devices.
  51 If the
  52 .Ar device
  53 is given, but no parameters, then
  54 .Nm
  55 will print information about the device.
  56 If no
  57 .Ar device
  58 is given, a basic list of devices will be printed.
  59 .Pp
  60 When the
  61 .Fl l
  62 flag is used, just the device names will be printed.
  63 .Sh COMMANDS
  64 The following parameters may be specified with
  65 .Nm :
  66 .Bl -tag -width xxxxxxxxxxx
  67 .It Cm up
  68 Enable Bluetooth Device.
  69 .It Cm down
  70 Disable Bluetooth Device.
  71 .It Cm pscan
  72 Enable Page Scan.
  73 This enables incoming connections to the device.
  74 .It Cm -pscan
  75 Disable Page Scan.
  76 .It Cm iscan
  77 Enable Inquiry Scan.
  78 This puts the device in Discoverable mode.
  79 .It Cm -iscan
  80 Disable Inquiry Scan.
  81 .It Cm encrypt
  82 Enable encryption.
  83 This will cause the device to request encryption on all baseband
  84 connections, and will only work if authentication is also enabled.
  85 .It Cm -encrypt
  86 Disable encryption.
  87 .It Cm auth
  88 Enable authentication.
  89 This will cause the device to request authentication
  90 for all baseband connections.
  91 .It Cm -auth
  92 Disable authentication.
  93 .It Cm switch
  94 Enable Role Switching.
  95 .It Cm -switch
  96 Disable Role Switching.
  97 .It Cm hold
  98 Enable Hold Mode.
  99 .It Cm -hold
 100 Disable Hold Mode.
 101 .It Cm sniff
 102 Enable Sniff Mode.
 103 .It Cm -sniff
 104 Disable Sniff Mode.
 105 .It Cm park
 106 Enable Park Mode.
 107 .It Cm -park
 108 Disable Park Mode.
 109 .It Cm name Ar name
 110 Set human readable name of device.
 111 .It Cm ptype Ar type
 112 Set packet types.
 113 .Ar type
 114 is a 16 bit hex value specifying packet types that will be requested
 115 by outgoing ACL connections.
 116 By default, all packet types that the device supports are enabled,
 117 see bluetooth specifications for more information if you want to change this.
 118 .It Cm class Ar class
 119 Set class of device.
 120 .Ar class
 121 is a 3 byte hex value the value of which declares the device capabilities.
 122 See Bluetooth Assigned Numbers documents at
 123 .Pa https://www.bluetooth.org/
 124 for details
 125 of constructing a "Class of Device" value.
 126 As a starter, 0x020104 means Desktop Computer, with Networking
 127 available.
 128 .It Cm fixed
 129 Set fixed pin type.
 130 .It Cm variable
 131 Set variable pin type.
 132 .It Cm inquiry
 133 Perform device Discovery from the specified device and print details.
 134 .It Cm rssi
 135 Enable Remote Signal Strength Indicator (RSSI) in inquiry results.
 136 This will only work if the device features indicate
 137 .Aq RSSI with inquiry result .
 138 .It Cm -rssi
 139 Disable Remote Signal Strength Indicator (RSSI) in inquiry results.
 140 .It Cm reset
 141 Perform a hard reset on the device and re-initialise system state.
 142 .It Cm voice
 143 Set Voice Setting.
 144 [This should be 0x0060 for now]
 145 .It Cm pto
 146 Set Page Timeout value.
 147 This is a decimal value in milliseconds.
 148 .It Cm scomtu
 149 Change SCO mtu value.
 150 This is a decimal value, see
 151 .Xr ubt 4
 152 for reasons why you may need to do this.
 153 .El
 154 .Pp
 155 All parameters are parsed before any device operations take place.
 156 Each time the
 157 .Fl v
 158 flag is given, verbosity levels will be increased.
 159 .Pp
 160 Super-user privileges are required to change device configurations.
 161 .Sh DIAGNOSTICS
 162 Messages indicating the specified device does not exist, the
 163 requested address is unknown, or the user is not privileged and
 164 tried to alter an device's configuration.
 165 .Sh SEE ALSO
 166 .Xr bluetooth 4 ,
 167 .Xr ubt 4
 168 .Sh HISTORY
 169 The
 170 .Nm
 171 command was written for
 172 .Nx 4.0
 173 by
 174 .An Iain Hibbert
 175 under the sponsorship of Itronix, Inc and was imported into
 176 .Dx 1.11 .
 177 .Sh BUGS
 178 The output is very messy.