xref: /freebsd/usr.bin/bluetooth/rfcomm_sppd/rfcomm_sppd.1 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
1.\" Copyright (c) 2001-2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $Id: rfcomm_sppd.1,v 1.3 2003/09/07 18:15:55 max Exp $
26.\" $FreeBSD$
27.\"
28.Dd April 26, 2003
29.Dt RFCOMM_SPPD 1
30.Os
31.Sh NAME
32.Nm rfcomm_sppd
33.Nd RFCOMM Serial Port Profile daemon
34.Sh SYNOPSIS
35.Nm
36.Op Fl bh
37.Fl a Ar address
38.Fl c Ar channel
39.Op Fl t Ar tty
40.Sh DESCRIPTION
41The
42.Nm
43utility is a Serial Port Profile daemon.
44It opens RFCOMM connection to the specified
45.Ar address
46server and
47.Ar channel .
48Once connection is established, the
49.Nm
50utility provides access to the server's remote serial port via stdin/stdout
51or via
52.Xr pty 4
53interface if
54.Fl t
55option was specified.
56.Pp
57The
58.Nm
59utility opens both master and slave pseudo terminals.
60This is done to ensure that RFCOMM connection stays open until
61.Nm
62is terminated.
63The data received from the master pseudo terminal are sent over
64the RFCOMM connection.
65The data received from the RFCOMM connection are written
66into master pseudo terminal.
67The application in its turn opens the slave pseudo
68terminal and operates on it just like it would operate over the standard serial
69port.
70.Pp
71The options are as follows:
72.Bl -tag -width indent
73.It Fl a Ar address
74This required option specifies the address of the remote RFCOMM server.
75The address can be specified as BD_ADDR or name.
76If name was specified then the
77.Nm
78utility will attempt to resolve the name via
79.Xr bt_gethostbyname 3 .
80.It Fl b
81Detach from the controlling terminal, i.e., run in background.
82.It Fl c Ar channel
83This option specifies RFCOMM channel to connect to.
84The channel must provide Serial Port service.
85If channel was not specified then
86.Nm
87utility will try to obtain RFCOMM channel via Service Discovery Protocol from
88the server.
89.It Fl h
90Display usage message and exit.
91.It Fl t Ar tty
92Slave pseudo tty name.
93If not set stdin/stdout will be used.
94This option is required if
95.Fl b
96option was specified.
97.El
98.Sh FILES
99.Bl -tag -width ".Pa /dev/tty[p-sP-S][0-9a-v]" -compact
100.It Pa /dev/pty[p-sP-S][0-9a-v]
101master pseudo terminals
102.It Pa /dev/tty[p-sP-S][0-9a-v]
103slave pseudo terminals
104.El
105.Sh EXIT STATUS
106.Ex -std
107.Sh EXAMPLES
108.Dl "rfcomm_sppd -a 00:01:02:03:04:05 -c 1 -t /dev/ttyp1"
109.Pp
110Will start the
111.Nm
112utility and open RFCOMM connection to the server at
113.Li 00:01:02:03:04:05
114and channel
115.Li 1 .
116Once the connection has been established,
117.Pa /dev/ttyp1
118can be used to talk to the remote serial port on the server.
119.Sh SEE ALSO
120.Xr bluetooth 3 ,
121.Xr ng_btsocket 4 ,
122.Xr pty 4 ,
123.Xr rfcomm_pppd 8
124.Sh AUTHORS
125.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
126.Sh BUGS
127Please report if found.
128