Tizen 2.0 Release
[profile/ivi/bluez.git] / tools / rfcomm.1
1 .\"
2 .\"     This program is free software; you can redistribute it and/or modify
3 .\"     it under the terms of the GNU General Public License as published by
4 .\"     the Free Software Foundation; either version 2 of the License, or
5 .\"     (at your option) any later version.
6 .\"
7 .\"     This program is distributed in the hope that it will be useful,
8 .\"     but WITHOUT ANY WARRANTY; without even the implied warranty of
9 .\"     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10 .\"     GNU General Public License for more details.
11 .\"
12 .\"     You should have received a copy of the GNU General Public License
13 .\"     along with this program; if not, write to the Free Software
14 .\"     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
15 .\"
16 .\"
17 .TH RFCOMM 1 "APRIL 28, 2002" "" ""
18
19 .SH NAME
20 rfcomm \- RFCOMM configuration utility
21 .SH SYNOPSIS
22 .BR "rfcomm
23 [
24 .I options
25 ] <
26 .I command
27 > <
28 .I dev
29 >
30 .SH DESCRIPTION
31 .B rfcomm
32 is used to set up, maintain, and inspect the RFCOMM configuration
33 of the Bluetooth subsystem in the Linux kernel. If no
34 .B command
35 is given, or if the option
36 .B -a
37 is used,
38 .B rfcomm
39 prints information about the configured RFCOMM devices.
40 .SH OPTIONS
41 .TP
42 .BI -h
43 Gives a list of possible commands.
44 .TP
45 .BI -a
46 Prints information about all configured RFCOMM devices.
47 .TP
48 .BI -r
49 Switch TTY into raw mode (doesn't work with "bind").
50 .TP
51 .BI -f " <file>"
52 Specify alternate config file.
53 .TP
54 .BI -i " <hciX> | <bdaddr>"
55 The command is applied to device
56 .BI -A
57 Enable authentication.
58 .BI -E
59 Enable encryption.
60 .BI -S
61 Secure connection.
62 .BI -M
63 Become the master of a piconet.
64 .I
65 hciX
66 , which must be the name or the address of an installed Bluetooth
67 device. If not specified, the command will be use the first
68 available Bluetooth device.
69 .TP
70 .BI -A
71 Enable authentification
72 .TP
73 .BI -E
74 Enable encryption
75 .TP
76 .BI -S
77 Secure connection
78 .TP
79 .BI -M
80 Become the master of a piconet
81 .TP
82 .BI -L " <seconds>"
83 Set linger timeout
84 .SH COMMANDS
85 .TP
86 .BI show " <dev>"
87 Display the information about the specified device.
88 .TP
89 .BI connect " <dev> [bdaddr] [channel]"
90 Connect the RFCOMM device to the remote Bluetooth device on the
91 specified channel. If no channel is specified, it will use the
92 channel number 1. If also the Bluetooth address is left out, it
93 tries to read the data from the config file. This command can
94 be terminated with the key sequence CTRL-C.
95 .TP
96 .BI listen " <dev> [channel] [cmd]"
97 Listen on a specified RFCOMM channel for incoming connections.
98 If no channel is specified, it will use the channel number 1, but
99 a channel must be specified before cmd. If cmd is given, it will be
100 executed as soon as a client connects. When the child process
101 terminates or the client disconnect, the command will terminate.
102 Occurrences of {} in cmd will be replaced by the name of the device
103 used by the connection. This command can be terminated with the key
104 sequence CTRL-C.
105 .TP
106 .BI watch " <dev> [channel] [cmd]"
107 Watch is identical to
108 .B listen
109 except that when the child process terminates or the client
110 disconnect, the command will restart listening with the same
111 parameters.
112 .TP
113 .BI bind " <dev> [bdaddr] [channel]"
114 This binds the RFCOMM device to a remote Bluetooth device. The
115 command did not establish a connection to the remote device, it
116 only creates the binding. The connection will be established right
117 after an application tries to open the RFCOMM device. If no channel
118 number is specified, it uses the channel number 1. If the Bluetooth
119 address is also left out, it tries to read the data from the config
120 file.
121
122 If
123 .B all
124 is specified for the RFCOMM device, then all devices that have
125 .B "bind yes"
126 set in the config will be bound.
127 .TP
128 .BI release " <dev>"
129 This command releases a defined RFCOMM binding.
130
131 If
132 .B all
133 is specified for the RFCOMM device, then all bindings will be removed.
134 This command didn't care about the settings in the config file.
135 .SH AUTHOR
136 Written by Marcel Holtmann <marcel@holtmann.org>.
137 .br