[dragonfly.git] / usr.bin / rfcomm_sppd / rfcomm_sppd.1

.\" $NetBSD: rfcomm_sppd.1,v 1.5 2007/04/21 06:15:23 plunky Exp $
.\" $DragonFly: src/usr.bin/rfcomm_sppd/rfcomm_sppd.1,v 1.1 2008/02/08 14:06:25 hasso 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.
.\"
.Dd April 10, 2007
.Dt RFCOMM_SPPD 1
.Os
.Sh NAME
.Nm rfcomm_sppd
.Nd RFCOMM Serial Port Profile daemon
.Sh SYNOPSIS
.Nm
.Op Fl d Ar device
.Op Fl m Ar mode
.Op Fl s Ar service
.Op Fl t Ar tty
.Brq Fl a Ar address | Fl c Ar channel
.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
.Ar service
at the remote
.Ar address .
.Pp
In server mode,
.Nm
registers the
.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
Client mode.
Specify the address of the remote RFCOMM device.
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
Server mode.
Specify the RFCOMM channel number to listen on.
.Nm
will register the service with the local
.Xr sdpd 8
daemon.
Note that registering services with
.Xr sdpd 8
is a privileged operation.
.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 available devices.
If no
.Ar device
is specified, the connection will be set up on a system determined device.
.It Fl m Ar mode
Set connection link mode.
Supported modes are:
.Pp
.Bl -tag -compact -offset indent
.It auth
require devices be paired.
.It encrypt
auth, plus enable encryption.
.It secure
encryption, plus change of link key.
.El
.It Fl s Ar service
This is the service class that will be searched for on the remote device.
If no
.Ar service
is given, the default
.Qq Serial Port
service class will be used.
Known service classes are:
.Pp
.Bl -tag -compact -offset indent
.It DUN
Dialup Networking
.It LAN
LAN access using PPP
.It SP
Serial Port
.El
.Pp
In client mode, the service class may be given as a channel number, for instances
where the remote device does not provide Service Discovery.
.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
.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 -s 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 secured link for
.Xr pppd 8 ,
use
.Dl pty Qo rfcomm_sppd -a 00:01:02:03:04:05 -s DUN -m secure 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.
Commit	Line	Data
e68b3c58	1	.\" $NetBSD: rfcomm_sppd.1,v 1.5 2007/04/21 06:15:23 plunky Exp $
6b5c5d0d	2	.\" $DragonFly: src/usr.bin/rfcomm_sppd/rfcomm_sppd.1,v 1.1 2008/02/08 14:06:25 hasso Exp $
e68b3c58 HT	3	.\"
	4	.\" Copyright (c) 2006 Itronix Inc.
	5	.\" All rights reserved.
	6	.\"
	7	.\" Redistribution and use in source and binary forms, with or without
	8	.\" modification, are permitted provided that the following conditions
	9	.\" are met:
	10	.\" 1. Redistributions of source code must retain the above copyright
	11	.\" notice, this list of conditions and the following disclaimer.
	12	.\" 2. Redistributions in binary form must reproduce the above copyright
	13	.\" notice, this list of conditions and the following disclaimer in the
	14	.\" documentation and/or other materials provided with the distribution.
	15	.\" 3. The name of Itronix Inc. may not be used to endorse
	16	.\" or promote products derived from this software without specific
	17	.\" prior written permission.
	18	.\"
	19	.\" THIS SOFTWARE IS PROVIDED BY ITRONIX INC. ``AS IS'' AND
	20	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
	21	.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
	22	.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ITRONIX INC. BE LIABLE FOR ANY
	23	.\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
	24	.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
	25	.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
	26	.\" ON ANY THEORY OF LIABILITY, WHETHER IN
	27	.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
	28	.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
	29	.\" POSSIBILITY OF SUCH DAMAGE.
	30	.\"
	31	.\"
	32	.\" Copyright (c) 2001-2003 Maksim Yevmenkin <m_evmenkin@yahoo.com>
	33	.\" All rights reserved.
	34	.\"
	35	.\" Redistribution and use in source and binary forms, with or without
	36	.\" modification, are permitted provided that the following conditions
	37	.\" are met:
	38	.\" 1. Redistributions of source code must retain the above copyright
	39	.\" notice, this list of conditions and the following disclaimer.
	40	.\" 2. Redistributions in binary form must reproduce the above copyright
	41	.\" notice, this list of conditions and the following disclaimer in the
	42	.\" documentation and/or other materials provided with the distribution.
	43	.\"
	44	.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
	45	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	46	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	47	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
	48	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	49	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	50	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	51	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	52	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	53	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	54	.\" SUCH DAMAGE.
	55	.\"
	56	.Dd April 10, 2007
	57	.Dt RFCOMM_SPPD 1
	58	.Os
	59	.Sh NAME
	60	.Nm rfcomm_sppd
	61	.Nd RFCOMM Serial Port Profile daemon
	62	.Sh SYNOPSIS
	63	.Nm
	64	.Op Fl d Ar device
	65	.Op Fl m Ar mode
	66	.Op Fl s Ar service
67	.Op Fl t Ar tty
ba098af4	68	.Brq Fl a Ar address \| Fl c Ar channel
e68b3c58 HT	69	.Sh DESCRIPTION
	70	The
	71	.Nm
	72	utility is a Serial Port Profile daemon, providing serial access over
	73	an RFCOMM connection to a remote device.
	74	.Nm
	75	can work in client or server mode.
	76	.Pp
	77	In client mode,
	78	.Nm
	79	initiates an RFCOMM connection to the
	80	.Ar service
	81	at the remote
	82	.Ar address .
	83	.Pp
	84	In server mode,
	85	.Nm
	86	registers the
	87	.Ar service
	88	with the local SDP server and listens on the specified RFCOMM
	89	.Ar channel
	90	for an incoming connection.
	91	.Pp
	92	The options are as follows:
	93	.Bl -tag -width ".Fl c Ar channel"
	94	.It Fl a Ar address
	95	Client mode.
	96	Specify the address of the remote RFCOMM device.
	97	The address can be specified as BD_ADDR or name.
	98	If given as a name, then the
	99	.Nm
	100	utility will attempt to resolve the name via
	101	.Xr bt_gethostbyname 3 .
	102	.It Fl c Ar channel
	103	Server mode.
	104	Specify the RFCOMM channel number to listen on.
	105	.Nm
	106	will register the service with the local
	107	.Xr sdpd 8
	108	daemon.
	109	Note that registering services with
	110	.Xr sdpd 8
	111	is a privileged operation.
	112	.It Fl d Ar device
	113	Use the local device with the specifed address.
	114	The device can be specified by BD_ADDR or device name.
	115	See
	116	.Xr btconfig 8
	117	for a list of available devices.
	118	If no
	119	.Ar device
	120	is specified, the connection will be set up on a system determined device.
	121	.It Fl m Ar mode
	122	Set connection link mode.
	123	Supported modes are:
	124	.Pp
	125	.Bl -tag -compact -offset indent
	126	.It auth
	127	require devices be paired.
	128	.It encrypt
	129	auth, plus enable encryption.
	130	.It secure
	131	encryption, plus change of link key.
	132	.El
133	.It Fl s Ar service
134	This is the service class that will be searched for on the remote device.
135	If no
136	.Ar service
137	is given, the default
138	.Qq Serial Port
139	service class will be used.
140	Known service classes are:
141	.Pp
142	.Bl -tag -compact -offset indent
143	.It DUN
144	Dialup Networking
145	.It LAN
146	LAN access using PPP
147	.It SP
148	Serial Port
149	.El
150	.Pp
151	In client mode, the service class may be given as a channel number, for instances
152	where the remote device does not provide Service Discovery.
153	.It Fl t Ar tty
154	Slave pseudo tty name.
155	If this option is given,
156	.Nm
157	will detach from the controlling process after the bluetooth connection is
158	made, and operate over the named
159	.Xr pty 4
160	pair.
161	Otherwise, stdin/stdout will be used.
162	.El
e68b3c58 HT	163	.Sh FILES
	164	.Bl -tag -width ".Pa /dev/tty[p-sP-S][0-9a-v]" -compact
	165	.It Pa /dev/pty[p-sP-S][0-9a-v]
	166	master pseudo terminals
	167	.It Pa /dev/tty[p-sP-S][0-9a-v]
	168	slave pseudo terminals
	169	.El
a68e0df0 SW	170	.Sh EXIT STATUS
a68e0df0 SW	171	.Ex -std
e68b3c58 HT	172	.Sh EXAMPLES
	173	.Dl rfcomm_sppd -a 00:01:02:03:04:05 -s 1 -t /dev/ttyp1
	174	.Pp
	175	Will open an RFCOMM connection to the server at
	176	.Li 00:01:02:03:04:05
	177	on channel
	178	.Li 1 .
	179	Once the connection has been established,
	180	.Nm
	181	will detach and
	182	.Pa /dev/ttyp1
	183	can be used to communicate with the remote serial port on the
	184	server, e.g. with the use of
	185	.Pp
	186	.Dl cu -l /dev/ttyp1
	187	.Pp
	188	In order to use
	189	.Nm
	190	to automatically create a secured link for
	191	.Xr pppd 8 ,
	192	use
	193	.Dl pty Qo rfcomm_sppd -a 00:01:02:03:04:05 -s DUN -m secure Qc
	194	.Pp
	195	in your
	196	.Xr pppd 8
	197	configuration file.
	198	.Sh SEE ALSO
	199	.Xr bluetooth 3 ,
	200	.Xr bluetooth 4 ,
	201	.Xr pty 4 ,
	202	.Xr btconfig 8 ,
	203	.Xr pppd 8 ,
	204	.Xr sdpd 8
	205	.Sh HISTORY
	206	The
	207	.Nm
	208	program first appeared in
	209	.Fx
	210	and was ported to
	211	.Nx 4.0
	212	by
	213	.An Iain Hibbert
	214	under the sponsorship of
	215	.An Itronix, Inc .
	216	.Sh AUTHORS
	217	.An Maksim Yevmenkin Aq m_evmenkin@yahoo.com ,
	218	.An Iain Hibbert
	219	.Sh BUGS
	220	Please report if found.