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