tizen 2.3.1 release
[framework/connectivity/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 -i " <hciX> | <bdaddr>"
52 The command is applied to device hciX, which must be the name or the address of
53 an installed Bluetooth device. If not specified, the command will be use the
54 first available Bluetooth device.
55 .TP
56 .BI -A
57 Enable authentification
58 .TP
59 .BI -E
60 Enable encryption
61 .TP
62 .BI -S
63 Secure connection
64 .TP
65 .BI -M
66 Become the master of a piconet
67 .TP
68 .BI -L " <seconds>"
69 Set linger timeout
70 .SH COMMANDS
71 .TP
72 .BI show " <dev>"
73 Display the information about the specified device.
74 .TP
75 .BI connect " <dev> [bdaddr] [channel]"
76 Connect the RFCOMM device to the remote Bluetooth device on the
77 specified channel. If no channel is specified, it will use the
78 channel number 1. This command can be terminated with the key
79 sequence CTRL-C.
80 .TP
81 .BI listen " <dev> [channel] [cmd]"
82 Listen on a specified RFCOMM channel for incoming connections.
83 If no channel is specified, it will use the channel number 1, but
84 a channel must be specified before cmd. If cmd is given, it will be
85 executed as soon as a client connects. When the child process
86 terminates or the client disconnect, the command will terminate.
87 Occurrences of {} in cmd will be replaced by the name of the device
88 used by the connection. This command can be terminated with the key
89 sequence CTRL-C.
90 .TP
91 .BI watch " <dev> [channel] [cmd]"
92 Watch is identical to
93 .B listen
94 except that when the child process terminates or the client
95 disconnect, the command will restart listening with the same
96 parameters.
97 .TP
98 .BI bind " <dev> [bdaddr] [channel]"
99 This binds the RFCOMM device to a remote Bluetooth device. The
100 command does not establish a connection to the remote device, it
101 only creates the binding. The connection will be established right
102 after an application tries to open the RFCOMM device. If no channel
103 number is specified, it uses the channel number 1.
104 .TP
105 .BI release " <dev>"
106 This command releases a defined RFCOMM binding.
107
108 If
109 .B all
110 is specified for the RFCOMM device, then all bindings will be removed.
111 .SH AUTHOR
112 Written by Marcel Holtmann <marcel@holtmann.org>.
113 .br