xref: /freebsd/usr.bin/bluetooth/rfcomm_sppd/rfcomm_sppd.1 (revision d37ea99837e6ad50837fd9fe1771ddf1c3ba6002)
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 BD_ADDR
38.Fl c Ar channel
39.Fl t Ar tty
40.Sh DESCRIPTION
41The
42.Nm
43utility is a Serial Port Profile daemon.
44It opens RFCOMM connection to the specified server's
45.Ar BD_ADDR
46and
47.Ar channel .
48Once connection is established, the
49.Nm
50utility provides access to the server's remote serial port via
51.Xr pty 4
52interface.
53.Pp
54The
55.Nm
56utility opens both master and slave pseudo terminals.
57This is done to ensure that RFCOMM connection stays open until
58.Nm
59is terminated.
60The data received from the master pseudo terminal are sent over
61the RFCOMM connection.
62The data received from the RFCOMM connection are written
63into master pseudo terminal.
64The application in its turn opens the slave pseudo
65terminal and operates on it just like it would operate over the standard serial
66port.
67.Pp
68The options are as follows:
69.Bl -tag -width indent
70.It Fl a Ar BD_ADDR
71This required option specifies the remote BD_ADDR of the RFCOMM server.
72.It Fl b
73Detach from the controlling terminal, i.e., run in background.
74.It Fl c Ar channel
75This option specifies RFCOMM channel to connect to.
76The channel must provide Serial Port service.
77If channel was not specified then
78.Nm
79utility will try to obtain RFCOMM channel via Service Discovery Protocol from
80the server.
81.It Fl h
82Display usage message and exit.
83.It Fl t Ar tty
84Slave pseudo tty name.
85.El
86.Sh EXAMPLES
87.Dl "rfcomm_sppd -a 00:01:02:03:04:05 -c 1 -t /dev/ttyp1"
88.Pp
89Will start the
90.Nm
91utility and open RFCOMM connection to the server at
92.Li 00:01:02:03:04:05
93and channel
94.Li 1 .
95Once the connection has been established,
96.Pa /dev/ttyp1
97can be used to talk to the remote serial port on the server.
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 DIAGNOSTICS
106.Ex -std
107.Sh BUGS
108Please report if found.
109.Sh SEE ALSO
110.Xr ng_btsocket 4 ,
111.Xr pty 4 ,
112.Xr rfcomm_pppd 8
113.Sh AUTHORS
114.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
115