usr.sbin/bthcid/bthcid.conf.5

   1 .\" Copyright (c) 2001-2002 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 .\" $Id: hcsecd.conf.5,v 1.1 2003/05/26 22:49:23 max Exp $
  26 .\" $FreeBSD: src/usr.sbin/bluetooth/hcsecd/hcsecd.conf.5,v 1.2 2004/06/13 18:03:40 ru Exp $
  27 .\" $DragonFly: src/usr.sbin/bthcid/bthcid.conf.5,v 1.1 2008/01/30 14:10:19 hasso Exp $
  28 .\"
  29 .Dd May 26, 2003
  30 .Dt BTHCID.CONF 5
  31 .Os
  32 .Sh NAME
  33 .Nm bthcid.conf
  34 .Nd
  35 .Xr bthcid 8
  36 configuration file
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 file is the configuration file for the
  41 .Xr bthcid 8
  42 Bluetooth link keys/PIN codes management daemon.
  43 .Pp
  44 The
  45 .Nm
  46 file is a free-form
  47 .Tn ASCII
  48 text file.
  49 It is parsed by the recursive-descent parser built into
  50 .Xr bthcid 8 .
  51 The file may contain extra tabs and newlines for formatting purposes.
  52 Keywords in the file are case-sensitive.
  53 Comments may be placed anywhere within the file (except within quotes).
  54 Comments begin with the
  55 .Ql #
  56 character and end at the end of the line.
  57 .Sh FILE FORMAT
  58 The
  59 .Nm
  60 file consists of a list of
  61 .Cm device
  62 entries.
  63 Each
  64 .Cm device
  65 entry defines a link key or PIN code for a remote Bluetooth device.
  66 Each remote Bluetooth device is identified by its unique BD_ADDR.
  67 .Pp
  68 The
  69 .Cm device
  70 entry
  71 .Pp
  72 .Cm device
  73 {
  74 .Cm option Ar argument ;
  75 .Oo
  76 .Cm option Ar argument ;
  77 .Oc
  78 }
  79 .Pp
  80 The following section describes all supported options and arguments.
  81 .Bl -tag -width indent
  82 .It Cm bdaddr Ar BD_ADDR
  83 Specify remote device BD_ADDR for the entry.
  84 .It Cm name Ar device_name
  85 Specify user friendly name for the entry.
  86 Name is a string in straight double quotes.
  87 .It Cm key Ar link_key
  88 Specify link key for the entry.
  89 Link key is hexadecimal string up to 32 characters in length starting with
  90 .Ql 0x .
  91 .It Cm key nokey
  92 Specify no link key for the entry.
  93 .It Cm pin Ar PIN_code
  94 Specify PIN code for the entry.
  95 PIN code is a string up to 16 characters in length in straight double quotes.
  96 .It Cm pin nopin
  97 Specify no PIN code for the entry.
  98 .El
  99 .Sh EXAMPLES
 100 A sample
 101 .Nm
 102 file:
 103 .Bd -literal
 104 # Default entry is applied if no better match found
 105 # It MUST have 00:00:00:00:00:00 as bdaddr
 106 device {
 107         bdaddr  00:00:00:00:00:00;
 108         name    "Default entry";
 109         key     nokey;
 110         pin     nopin;
 111 }
 112
 113 # Ericsson T68 phone
 114 device {
 115         bdaddr  00:80:37:5e:4d:d4;
 116         name    "Ericsson T68 phone";
 117         key     nokey;
 118         pin     "0000"; # PIN code
 119 }
 120
 121 # Dummy device
 122 device {
 123         bdaddr  00:11:22:33:44:55;
 124         name    "Dummy";
 125         key     0x00112233445566778899aabbccddeeff; # 16 bytes key
 126         pin     nopin;
 127 }
 128 .Ed
 129 .Sh SEE ALSO
 130 .Xr bthcid 8
 131 .Sh AUTHORS
 132 .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com