11bd9ebea5c8947a58f9af78d49b53d69911196b
[dragonfly.git] / usr.bin / btpin / btpin.1
1 .\" $NetBSD: btpin.1,v 1.6 2007/09/24 19:29:01 plunky Exp $
2 .\" $DragonFly: src/usr.bin/btpin/btpin.1,v 1.2 2008/05/01 23:29:10 swildner Exp $
3 .\"
4 .\" Copyright (c) 2006 Itronix Inc.
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. The name of Itronix Inc. may not be used to endorse
16 .\"    or promote products derived from this software without specific
17 .\"    prior written permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
23 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26 .\" ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 .\" POSSIBILITY OF SUCH DAMAGE.
30 .\"
31 .Dd September 24, 2007
32 .Dt BTPIN 1
33 .Os
34 .Sh NAME
35 .Nm btpin
36 .Nd Bluetooth PIN utility
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl d Ar device
40 .Op Fl s Ar path
41 .Brq Fl p Ar pin | Fl r Op Fl l Ar len
42 .Fl a Ar address
43 .Sh DESCRIPTION
44 The
45 .Nm
46 utility is used to register a temporary PIN with the
47 .Xr bthcid 8
48 daemon for the purposes of pairing Bluetooth devices.
49 The PIN will be valid for 5 minutes or until used, whichever comes first.
50 .Pp
51 The options are as follows:
52 .Bl -tag -width indent
53 .It Fl a Ar address
54 Specify the remote device address.
55 The address can be specified as BD_ADDR or a name.
56 If a name was specified, the
57 .Nm
58 utility attempts to resolve the name via
59 .Xr bt_gethostbyname 3 .
60 .It Fl d Ar device
61 Specify the local device address.
62 The device can be specified by BD_ADDR or device name.
63 See
64 .Xr btconfig 8
65 for a list of devices available.
66 If no device is specified, the PIN will be valid for any local device.
67 .It Fl l Ar len
68 Specify length of PIN to generate, where 1 \*[Le]
69 .Ar len
70 \*[Le] 16.
71 .It Fl p Ar pin
72 The PIN to register.
73 The PIN may be up to 16 bytes in length.
74 .It Fl r
75 Generate a random PIN, the default length is 4 bytes.
76 .It Fl s Ar path
77 Specify path to the control socket.
78 The default path is
79 .Pa /var/run/bthcid .
80 .El
81 .Sh EXIT STATUS
82 .Ex -std
83 .Sh FILES
84 .Bl -tag -compact
85 .It Pa /var/run/bthcid
86 .El
87 .Sh SEE ALSO
88 .Xr btconfig 8 ,
89 .Xr bthcid 8
90 .Sh AUTHORS
91 .An Iain Hibbert
92 for Itronix, Inc