tools/hciconfig.1

   1 .TH HCICONFIG 1 "Nov 11 2002" BlueZ "Linux System Administration"
   2 .SH NAME
   3 hciconfig \- configure Bluetooth devices
   4 .SH SYNOPSIS
   5 .B hciconfig
   6 .B \-h
   7 .br
   8 .B hciconfig
   9 .RB [\| \-a \|]
  10 .br
  11 .B hciconfig
  12 .RB [\| \-a \|]
  13 .B hciX
  14 .RI [\| command
  15 .RI [\| "command parameters" \|]\|]
  16
  17 .SH DESCRIPTION
  18 .LP
  19 .B hciconfig
  20 is used to configure Bluetooth devices.
  21 .I hciX
  22 is the name of a Bluetooth device installed in the system. If
  23 .I hciX
  24 is not given,
  25 .B hciconfig
  26 prints name and basic information about all the Bluetooth devices installed in
  27 the system. If
  28 .I hciX
  29 is given but no command is given, it prints basic information on device
  30 .I hciX
  31 only. Basic information is
  32 interface type, BD address, ACL MTU, SCO MTU, flags (up, init, running, raw,
  33 page scan enabled, inquiry scan enabled, inquiry, authentication enabled,
  34 encryption enabled).
  35 .SH OPTIONS
  36 .TP
  37 .B \-h, \-\-help
  38 Gives a list of possible commands.
  39 .TP
  40 .B \-a, \-\-all
  41 Other than the basic info, print features, packet type, link policy, link mode,
  42 name, class, version.
  43 .SH COMMANDS
  44 .TP
  45 .B up
  46 Open and initialize HCI device.
  47 .TP
  48 .B down
  49 Close HCI device.
  50 .TP
  51 .B reset
  52 Reset HCI device.
  53 .TP
  54 .B rstat
  55 Reset statistic counters.
  56 .TP
  57 .B auth
  58 Enable authentication (sets device to security mode 3).
  59 .TP
  60 .B noauth
  61 Disable authentication.
  62 .TP
  63 .B encrypt
  64 Enable encryption (sets device to security mode 3).
  65 .TP
  66 .B noencrypt
  67 Disable encryption.
  68 .TP
  69 .B secmgr
  70 Enable security manager (current kernel support is limited).
  71 .TP
  72 .B nosecmgr
  73 Disable security manager.
  74 .TP
  75 .B piscan
  76 Enable page and inquiry scan.
  77 .TP
  78 .B noscan
  79 Disable page and inquiry scan.
  80 .TP
  81 .B iscan
  82 Enable inquiry scan, disable page scan.
  83 .TP
  84 .B pscan
  85 Enable page scan, disable inquiry scan.
  86 .TP
  87 \fBptype\fP [\fItype\fP]
  88 With no
  89 .I type
  90 , displays the current packet types. Otherwise, all the packet types specified
  91 by
  92 .I type
  93 are set.
  94 .I type
  95 is a comma-separated list of packet types, where the possible packet types are
  96 .BR DM1 ,
  97 .BR DM3 ,
  98 .BR DM5 ,
  99 .BR DH1 ,
 100 .BR DH3 ,
 101 .BR DH5 ,
 102 .BR HV1 ,
 103 .BR HV2 ,
 104 .BR HV3 .
 105 .TP
 106 .BI name " [name]"
 107 With no
 108 .IR name ,
 109 prints local name. Otherwise, sets local name to
 110 .IR name .
 111 .TP
 112 .BI class " [class]"
 113 With no
 114 .IR class ,
 115 prints class of device. Otherwise, sets class of device to
 116 .IR class .
 117 .I
 118 class
 119 is a 24-bit hex number describing the class of device, as specified in section
 120 1.2 of the Bluetooth Assigned Numers document.
 121 .TP
 122 .BI voice " [voice]"
 123 With no
 124 .IR voice ,
 125 prints voice setting. Otherwise, sets voice setting to
 126 .IR voice .
 127 .I voice
 128 is a 16-bit hex number describing the voice setting.
 129 .TP
 130 .BI iac " [iac]"
 131 With no
 132 .IR iac ,
 133 prints the current IAC setting. Otherwise, sets the IAC to
 134 .IR iac .
 135 .TP
 136 .BI inqtpl " [level]"
 137 With no
 138 .IR level ,
 139 prints out the current inquiry transmit power level. Otherwise, sets
 140 inquiry transmit power level to
 141 .IR level .
 142 .TP
 143 .BI inqmode " [mode]"
 144 With no
 145 .IR mode ,
 146 prints out the current inquiry mode. Otherwise, sets inquiry mode to
 147 .IR mode .
 148 .TP
 149 .BI inqdata " [data]"
 150 With no
 151 .IR name ,
 152 prints out the current inquiry data. Otherwise, sets inquiry data to
 153 .IR data .
 154 .TP
 155 .BI inqtype " [type]"
 156 With no
 157 .IR type ,
 158 prints out the current inquiry scan type. Otherwise, sets inquiry scan type to
 159 .IR type .
 160 .TP
 161 \fBinqparams\fP [\fIwin\fP:\fIint\fP]
 162 With no
 163 .IR win : int ,
 164 prints inquiry scan window and interval. Otherwise, sets inquiry scan window
 165 to
 166 .I win
 167 slots and inquiry scan interval to
 168 .I int
 169 slots.
 170 .TP
 171 \fBpageparms\fP [\fIwin\fP:\fIint\fP]
 172 With no
 173 .IR win : int ,
 174 prints page scan window and interval. Otherwise, sets page scan window to
 175 .I win
 176 slots and page scan interval to
 177 .I int
 178 slots.
 179 .TP
 180 .BI pageto " [to]"
 181 With no
 182 .IR to ,
 183 prints page timeout. Otherwise, sets page timeout
 184 to .I
 185 to
 186 slots.
 187 .TP
 188 .BI afhmode " [mode]"
 189 With no
 190 .IR mode ,
 191 prints out the current AFH mode. Otherwise, sets AFH mode to
 192 .IR mode .
 193 .TP
 194 .BI sspmode " [mode]"
 195 With no
 196 .IR mode ,
 197 prints out the current Simple Pairing mode. Otherwise, sets Simple Pairing mode to
 198 .IR mode .
 199 .TP
 200 \fBaclmtu\fP \fImtu\fP:\fIpkt\fP
 201 Sets ACL MTU to
 202 to
 203 .I mtu
 204 bytes and ACL buffer size to
 205 .I pkt
 206 packets.
 207 .TP
 208 \fBscomtu\fP \fImtu\fP:\fIpkt\fP
 209 Sets SCO MTU to
 210 .I mtu
 211 bytes and SCO buffer size to
 212 .I pkt
 213 packets.
 214 .TP
 215 .BI delkey " <bdaddr>"
 216 This command deletes the stored link key for
 217 .I bdaddr
 218 from the device.
 219 .TP
 220 .BI oobdata
 221 Get local OOB data (invalidates previously read data).
 222 .TP
 223 .BI commands
 224 Display supported commands.
 225 .TP
 226 .BI features
 227 Display device features.
 228 .TP
 229 .BI version
 230 Display version information.
 231 .TP
 232 .BI revision
 233 Display revision information.
 234 .TP
 235 .BI lm " [mode]"
 236 With no
 237 .I mode
 238 , prints link mode.
 239 .B MASTER
 240 or
 241 .B SLAVE
 242 mean, respectively, to ask to become master or to remain slave when a
 243 connection request comes in. The additional keyword
 244 .B ACCEPT
 245 means that baseband  connections will be accepted even if there are no
 246 listening
 247 .I AF_BLUETOOTH
 248 sockets.
 249 .I mode
 250 is
 251 .B NONE
 252 or a comma-separated list of keywords, where possible keywords are
 253 .B MASTER
 254 and
 255 .B "ACCEPT" .
 256 .B NONE
 257 sets link policy to the default behaviour of remaining slave and not accepting
 258 baseband connections when there are no listening
 259 .I AF_BLUETOOTH
 260 sockets. If
 261 .B MASTER
 262 is present, the device will ask to become master if a connection request comes
 263 in. If
 264 .B ACCEPT
 265 is present, the device will accept baseband connections even when there are no
 266 listening
 267 .I AF_BLUETOOTH
 268 sockets.
 269 .SH AUTHORS
 270 Written by Maxim Krasnyansky <maxk@qualcomm.com> and Marcel Holtmann <marcel@holtmann.org>
 271 .PP
 272 man page by Fabrizio Gennari <fabrizio.gennari@philips.com>