]> www.wagner.pp.ru Git - oss/btcli.git/blob - btpasskey/btpasskey.1
Initial import
[oss/btcli.git] / btpasskey / btpasskey.1
1 .TH BTPASSKEY "1" "November 2007" "btpasskey 1.0" "User Commands"
2 .SH NAME
3 btpasskey\- waits for D-Bus signal and request passkey from stdin
4 .SH SYNOPSIS
5 .B btpasskey
6 [\fB--path\fR \fIagent-path\fI]
7 .SH DESCRIPTION
8 .PP
9 .B btpasskey
10 is a command line utility to enter passkeys during bluetooth pairing
11 process. When started it just sits and waits for D-BUS message from
12 bluez bluetooth stack. 
13 .PP
14 When message recieved, it prints out name and bluetooth address of the
15 device requesting connection and expects numeric passkey to be entered
16 from stdin. Passkey entry should be finished by hitting Return key.
17 .PP
18 Entering empty passkey (just hitting enter) causes 
19 .B btpasskey
20 to refuse answer to recieved message, which typically means cancelling
21 bluetooth connection, unless another passkey agent is listening on
22 system message bus.
23 .PP
24 .B btpasskey
25 is intended to run from some more sophisticated user interface, so it
26 uses unbuffered input/output. If another application starts it
27 redirecting stdin and stdout to pipes, application may expect complete 
28 message to be read before 
29 .B btpasswd
30 blocks waiting for input.
31 .SH OPTIONS
32 .TP
33 .BI "--path, -p " agent-path
34 Specify D-BUS path for agent, other than default.
35 .TP
36 .B --discoverable, -d
37 Turn default adapter into discoverable mode while program is running and waiting for pairing request
38 .TP
39 .BI "--pair, -P " address
40 Initiate pairing with device with specified address.
41 .TP 
42 .BI "--remove, -r " address
43 Instead of waiting for pairing request and ask user for passkey, just remove bonding with specified device and exit. This operation may be needed if device was prevoisly paired with this computer, then was paired with another computer and forgot link key. In this case we need to remove link key from our computer before pairing once again.
44 .TP 
45 .B --help, -h
46 Displays brief usage message.
47 .TP
48 .B --version, -V
49 Displays program version.
50 .SH SIGNALS
51 .TP
52 .B SIGINT
53 Closes D-BUS connection and terminates
54 .TP
55 .B SIGTERM
56 Closes D-BUS connection and terminates
57 .TP
58 .B SIGPIPE
59 Closes D-BUS connection and terminates
60 .SH BUGS
61 Doesn't properly handle org.bluez.PasskeyAgent.Cancel method, when is blocked on reading from stdin.
62 .PP
63 All mode changes and pairing operations (-d,-P,-r) work only with default Bluetooth adapter. There is no way to specify other adapter to operate with.
64 .SH AUTHOR
65 Victor B. Wagner <vitus@wagner.pp.ru>
66
67