201 lines
6.3 KiB
Groff
201 lines
6.3 KiB
Groff
.\" $NetBSD: rfcomm_sppd.1,v 1.1 2006/06/19 15:44:56 gdamore Exp $
|
|
.\"
|
|
.\" Copyright (c) 2006 Itronix Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. The name of Itronix Inc. may not be used to endorse
|
|
.\" or promote products derived from this software without specific
|
|
.\" prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
|
|
.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
|
.\" ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
.\" POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\"
|
|
.\" Copyright (c) 2001-2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" $Id: rfcomm_sppd.1,v 1.1 2006/06/19 15:44:56 gdamore Exp $
|
|
.\" $FreeBSD: src/usr.bin/bluetooth/rfcomm_sppd/rfcomm_sppd.1,v 1.9 2005/12/07 19:41:58 emax Exp $
|
|
.\"
|
|
.Dd March 3, 2006
|
|
.Dt RFCOMM_SPPD 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm rfcomm_sppd
|
|
.Nd RFCOMM Serial Port Profile daemon
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl bh
|
|
.Fl a Ar address
|
|
.Op Fl c Ar channel
|
|
.Op Fl d Ar device
|
|
.Op Fl t Ar tty
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility is a Serial Port Profile daemon.
|
|
It opens RFCOMM connection to the specified
|
|
.Ar address
|
|
server and
|
|
.Ar channel .
|
|
Once connection is established, the
|
|
.Nm
|
|
utility provides access to the server's remote serial port via stdin/stdout
|
|
or via
|
|
.Xr pty 4
|
|
interface if
|
|
.Fl t
|
|
option was specified.
|
|
.Pp
|
|
The
|
|
.Nm
|
|
utility opens both master and slave pseudo terminals.
|
|
This is done to ensure that RFCOMM connection stays open until
|
|
.Nm
|
|
is terminated.
|
|
The data received from the master pseudo terminal are sent over
|
|
the RFCOMM connection.
|
|
The data received from the RFCOMM connection are written
|
|
into master pseudo terminal.
|
|
The application in its turn opens the slave pseudo
|
|
terminal and operates on it just like it would operate over the standard serial
|
|
port.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width indent
|
|
.It Fl a Ar address
|
|
This required option specifies the address of the remote RFCOMM server.
|
|
The address can be specified as BD_ADDR or name.
|
|
If name was specified then the
|
|
.Nm
|
|
utility will attempt to resolve the name via
|
|
.Xr bt_gethostbyname 3 .
|
|
.It Fl b
|
|
Detach from the controlling terminal, i.e., run in background.
|
|
.It Fl c Ar channel
|
|
This option specifies RFCOMM channel to connect to.
|
|
RFCOMM channel could either be a number between 1 and 30 or a service name.
|
|
Supported service names are:
|
|
.Cm DUN
|
|
(for DialUp Networking service),
|
|
.Cm FAX
|
|
(for Fax service),
|
|
.Cm LAN
|
|
(for LAN Access Using PPP service) and
|
|
.Cm SP
|
|
(for Serial Port service).
|
|
If channel was not specified then
|
|
.Nm
|
|
utility will try to obtain RFCOMM channel for Serial Port service via Service
|
|
Discovery Protocol from the server.
|
|
.It Fl d Ar device
|
|
Connect from the local device with the specifed address. The device can
|
|
be specified by BD_ADDR or device name. See
|
|
.Xr btconfig 8
|
|
for a list of devices available. If no
|
|
.Ar device
|
|
is specified, the connection will be set up on a system determined device.
|
|
.It Fl h
|
|
Display usage message and exit.
|
|
.It Fl t Ar tty
|
|
Slave pseudo tty name.
|
|
If not set stdin/stdout will be used.
|
|
This option is required if
|
|
.Fl b
|
|
option was specified.
|
|
.El
|
|
.Sh FILES
|
|
.Bl -tag -width ".Pa /dev/tty[p-sP-S][0-9a-v]" -compact
|
|
.It Pa /dev/pty[p-sP-S][0-9a-v]
|
|
master pseudo terminals
|
|
.It Pa /dev/tty[p-sP-S][0-9a-v]
|
|
slave pseudo terminals
|
|
.El
|
|
.Sh EXIT STATUS
|
|
.Ex -std
|
|
.Sh EXAMPLES
|
|
.Dl "rfcomm_sppd -a 00:01:02:03:04:05 -c 1 -t /dev/ttyp1"
|
|
.Pp
|
|
Will start the
|
|
.Nm
|
|
utility and open RFCOMM connection to the server at
|
|
.Li 00:01:02:03:04:05
|
|
and channel
|
|
.Li 1 .
|
|
Once the connection has been established,
|
|
.Pa /dev/ttyp1
|
|
can be used to talk to the remote serial port on the server, eg
|
|
with the use of
|
|
.Dl "cu -l /dev/ttyp1"
|
|
.Pp
|
|
In order to use
|
|
.Nm
|
|
to automatically create a link for
|
|
.Xr pppd 8 ,
|
|
use
|
|
.Bd -literal
|
|
pty "rfcomm_sppd -d ubt0 -a 00:01:02:03:04:05"
|
|
|
|
.Ed
|
|
in your
|
|
.Pa /etc/ppp/options
|
|
file.
|
|
.Sh SEE ALSO
|
|
.Xr bluetooth 3 ,
|
|
.Xr bluetooth 4 ,
|
|
.Xr pty 4 ,
|
|
.Xr pppd 8
|
|
.Sh AUTHORS
|
|
.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com
|
|
.Sh BUGS
|
|
Please report if found.
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
program first appeared in
|
|
.Fx
|
|
and was ported to
|
|
.Nx 4.0
|
|
by
|
|
.An Iain Hibbert
|
|
under the sponsorship of
|
|
.An Itronix, Inc
|