share/man/man5/bluetooth.device.conf.5

   1 .\" Copyright (c) 2005 Maksim Yevmenkin <m_evmenkin@yahoo.com>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 1, 2005
  28 .Dt BLUETOOTH.DEVICE.CONF 5
  29 .Os
  30 .Sh NAME
  31 .Nm bluetooth.device.conf
  32 .Nd Bluetooth device configuration file
  33 .Sh DESCRIPTION
  34 Bluetooth device configuration framework provides ability to adjust certain
  35 Bluetooth device parameters on per-device basis.
  36 .Pp
  37 Bluetooth device configuration files are plain text files that should conform
  38 to basic
  39 .Xr sh 1
  40 syntax.
  41 Even though Bluetooth device are not exactly shell scripts,
  42 they are parsed and passed through shell
  43 .Ic eval
  44 command.
  45 This makes it possible to use various shell tricks in the Bluetooth device
  46 configuration files.
  47 .Pp
  48 The
  49 .Pa /etc/rc.d/bluetooth
  50 script is used to start and stop Bluetooth devices.
  51 This script is not executed by default when system boots.
  52 It is called by
  53 .Xr devd 8
  54 in response to Bluetooth device arrival and departure events.
  55 It is possible to execute this script by hand if required.
  56 The script accepts Bluetooth device driver name as an extra parameter.
  57 .Pp
  58 The system wide Bluetooth device configuration file is called
  59 .Pa /etc/defaults/bluetooth.device.conf .
  60 Configuration parameters set in the system wide Bluetooth device configuration
  61 file apply to every Bluetooth device connected to the system.
  62 .Pp
  63 Configuration parameters overrides for the specific Bluetooth device
  64 should be placed in the
  65 .Pa /etc/bluetooth/ Ns Ar DEVICE_DRIVER_NAME Ns Pa .conf
  66 file.
  67 Where
  68 .Ar DEVICE_DRIVER_NAME
  69 is the device driver name of the Bluetooth device.
  70 .Pp
  71 The following list provides a name and short description for each
  72 variable that can be set in a Bluetooth device configuration file.
  73 .Bl -tag -width indent-two
  74 .It Va authentication_enable
  75 .Pq Vt bool
  76 The
  77 .Va authentication_enable
  78 parameter controls if the device requires to authenticate the remote device
  79 at connection setup.
  80 If set to
  81 .Dq Li YES ,
  82 the device will try to authenticate the other device at connection setup.
  83 Bluetooth authentication requests are handled by
  84 .Xr hcsecd 8
  85 daemon.
  86 .It Va class
  87 .Pq Vt str
  88 The
  89 .Va class
  90 parameter is used to indicate the capabilities of the device to
  91 other devices.
  92 For more details see
  93 .Pa https://www.bluetooth.org/foundry/assignnumb/document/baseband .
  94 .It Va connectable
  95 .Pq Vt bool
  96 The
  97 .Va connectable
  98 parameter controls whether or not the device should periodically scan for
  99 page attempts from other devices.
 100 If set to
 101 .Dq Li YES ,
 102 the device will periodically scan for page attempts from other devices.
 103 .It Va discoverable
 104 .Pq Vt bool
 105 The
 106 .Va discoverable
 107 parameter controls whether or not the device should periodically scan for
 108 inquiry requests from other devices.
 109 If set to
 110 .Dq Li YES ,
 111 the device will periodically scan for inquiry requests from other devices.
 112 .It Va encryption_mode
 113 .Pq Vt str
 114 The
 115 .Va encryption_mode
 116 parameter controls if the device requires encryption to the remote device
 117 at connection setup.
 118 At connection setup, only the devices with the
 119 .Va authentication_enable
 120 parameter enabled and
 121 .Va encryption_mode
 122 parameter enabled will try to encrypt the connection to the other device.
 123 Possible values are
 124 .Dq Li NONE
 125 encryption disabled,
 126 .Dq Li P2P
 127 encryption for only point-to-point packets,
 128 or
 129 .Dq Li ALL
 130 encryption for both point-to-point and broadcast packets.
 131 .It Va hci_debug_level
 132 .Pq Vt int
 133 HCI node debug level.
 134 Higher values mean more verbose output.
 135 .It Va l2cap_debug_level
 136 .Pq Vt int
 137 L2CAP node debug level.
 138 Higher values mean more verbose output.
 139 .It Va local_name
 140 .Pq Vt str
 141 The
 142 .Va local_name
 143 parameter provides the ability to modify the user friendly name for the device.
 144 .It Va role_switch
 145 .Pq Vt bool
 146 The
 147 .Va role_switch
 148 parameter controls whether the local device should perform role switch.
 149 By default, if role switch is supported, the local device will try to perform
 150 role switch and become Master on incoming connection.
 151 Some devices do not support role switch and thus incoming connections from
 152 such devices will fail.
 153 If
 154 .Va role switch
 155 is disabled then accepting device will remain Slave.
 156 .El
 157 .Sh FILES
 158 .Bl -tag -width ".Pa /etc/defaults/bluetooth.device.conf" -compact
 159 .It Pa /etc/defaults/bluetooth.device.conf
 160 .It Pa /etc/rc.d/bluetooth
 161 .El
 162 .Sh EXAMPLES
 163 The
 164 .Pa /etc/bluetooth/ubt0.conf
 165 file should be used to specify configuration parameters overrides for the
 166 first USB Bluetooth device
 167 (device driver name is
 168 .Li ubt0 ) .
 169 .Pp
 170 The
 171 .Pa /etc/bluetooth/ubt1.conf
 172 file should be used to specify configuration parameters overrides for the
 173 second USB Bluetooth device.
 174 .Sh SEE ALSO
 175 .Xr ng_bt3c 4 ,
 176 .Xr ng_h4 4 ,
 177 .Xr ng_hci 4 ,
 178 .Xr ng_l2cap 4 ,
 179 .Xr ng_ubt 4 ,
 180 .Xr devd 8 ,
 181 .Xr hccontrol 8 ,
 182 .Xr hcsecd 8 ,
 183 .Xr l2control 8
 184 .Sh AUTHORS
 185 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com