NetBSD/usr.bin/rfcomm_sppd/rfcomm_sppd.1

216 lines
6.2 KiB
Groff

.\" $NetBSD: rfcomm_sppd.1,v 1.3 2007/02/01 06:54:40 wiz 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.
.\"
.\" $FreeBSD: src/usr.bin/bluetooth/rfcomm_sppd/rfcomm_sppd.1,v 1.9 2005/12/07 19:41:58 emax Exp $
.\"
.Dd January 24, 2007
.Dt RFCOMM_SPPD 1
.Os
.Sh NAME
.Nm rfcomm_sppd
.Nd RFCOMM Serial Port Profile daemon
.Sh SYNOPSIS
.Nm
.Op Fl c Ar channel
.Op Fl d Ar device
.Op Fl t Ar tty
.Fl a Ar address
.Nm
.Op Fl d Ar device
.Op Fl t Ar tty
.Fl c Ar channel
.Fl s Ar service
.Sh DESCRIPTION
The
.Nm
utility is a Serial Port Profile daemon, providing serial access over
an RFCOMM connection to a remote device.
.Nm
can work in client or server mode.
.Pp
In client mode,
.Nm
initiates an RFCOMM connection to the remote
.Ar address
and
.Ar channel .
.Pp
In server mode,
.Nm
registers the given
.Ar service
with the local SDP server and listens on the specified RFCOMM
.Ar channel
for an incoming connection.
.Pp
The options are as follows:
.Bl -tag -width ".Fl c Ar channel"
.It Fl a Ar address
Specify the address of the remote RFCOMM device, to connect in client mode.
The address can be specified as BD_ADDR or name.
If given as a name, then the
.Nm
utility will attempt to resolve the name via
.Xr bt_gethostbyname 3 .
.It Fl c Ar channel
This option specifies the RFCOMM channel to use.
The
.Ar channel
may be specified as a number or, in client mode, the name of
the service on the remote device.
If no remote
.Ar channel
is specified, then
.Nm
will search for the Serial Port service by default.
.It Fl d Ar device
Use 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 s Ar service
Server mode.
When this option is given,
.Nm
will register as the
.Ar service
with the local SDP server and listen for an incoming connection on the given
.Ar channel .
Note that registering services with
.Xr sdpd 8
is a privileged operation.
.It Fl t Ar tty
Slave pseudo tty name.
If this option is given,
.Nm
will detach from the controlling process after the bluetooth connection is
made, and operate over the named
.Xr pty 4
pair.
Otherwise, stdin/stdout will be used.
.El
.Pp
Known services are:
.Pp
.Bl -tag -compact -offset indent
.It DUN
Dialup Networking
.It LAN
LAN access using PPP
.It SP
Serial Port service
.El
.Sh EXIT STATUS
.Ex -std
.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 EXAMPLES
.Dl rfcomm_sppd -a 00:01:02:03:04:05 -c 1 -t /dev/ttyp1
.Pp
Will open an RFCOMM connection to the server at
.Li 00:01:02:03:04:05
on channel
.Li 1 .
Once the connection has been established,
.Nm
will detach and
.Pa /dev/ttyp1
can be used to communicate with the remote serial port on the
server, e.g. with the use of
.Pp
.Dl cu -l /dev/ttyp1
.Pp
In order to use
.Nm
to automatically create a link for
.Xr pppd 8 ,
use
.Dl pty Qo rfcomm_sppd -a 00:01:02:03:04:05 -c dun Qc
.Pp
in your
.Xr pppd 8
configuration file.
.Sh SEE ALSO
.Xr bluetooth 3 ,
.Xr bluetooth 4 ,
.Xr pty 4 ,
.Xr btconfig 8 ,
.Xr pppd 8 ,
.Xr sdpd 8
.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 .
.Sh AUTHORS
.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com ,
.An Iain Hibbert
.Sh BUGS
Please report if found.