Date: Sun, 27 Feb 2005 18:09:10 -0800 (PST) From: Jeremy Chadwick <freebsd@jdc.parodius.com> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/78174: Update for Bluetooth-related manpages Message-ID: <200502280209.j1S29Aod051444@pentarou.parodius.com> Resent-Message-ID: <200502280210.j1S2AG6q096333@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 78174
>Category: docs
>Synopsis: Update for Bluetooth-related manpages
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Mon Feb 28 02:10:16 GMT 2005
>Closed-Date:
>Last-Modified:
>Originator: Jeremy Chadwick
>Release: FreeBSD 4.11-STABLE i386
>Organization:
Parodius Networking
>Environment:
Not applicable. Please note that the "Release" tag for this GNATS is incorrect; these pages
apply to FreeBSD 5.3 (latest RELENG_5 tag). I just happen to send mail from a 4.x box. :-)
>Description:
While doing a "man -k spd" earlier this evening, I found that there were some manpages
which mentioned "spdcontrol" -- which is, in fact, sdpcontrol. The author of the manpages
made some typos, so I've cleaned them up. I also took the liberty of fixing some grammatical
errors and the like in the rfcomm_pppd(8) manpage.
>How-To-Repeat:
n/a
>Fix:
Apply the below THREE patches. If these need to be provided as files, let me know and I
can either attach them as MIME attachments, or put them up on the Web someplace.
--- lib/libsdp/sdp.3.orig Mon Jul 5 10:38:08 2004
+++ lib/libsdp/sdp.3 Sun Feb 27 17:32:51 2005
@@ -359,7 +359,7 @@
if ((ss = sdp_open(NG_HCI_BDADDR_ANY, remote)) == NULL)
/* exit ENOMEM */
if (sdp_error(ss) != 0)
- /* exit spd_error(ss) */
+ /* exit sdp_error(ss) */
if (sdp_search(ss, 1, &serv, 1, &attr, 1, &proto) != 0)
/* exit sdp_error(ss) */
--- usr.sbin/bluetooth/sdpcontrol/sdpcontrol.8.orig Thu Aug 5 09:32:41 2004
+++ usr.sbin/bluetooth/sdpcontrol/sdpcontrol.8 Sun Feb 27 17:35:16 2005
@@ -29,7 +29,7 @@
.Dt SDPCONTROL 8
.Os
.Sh NAME
-.Nm spdcontrol
+.Nm sdpcontrol
.Nd SDP query utility
.Sh SYNOPSIS
.Nm
--- usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8.orig Thu Aug 5 09:32:41 2004
+++ usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 Sun Feb 27 18:01:58 2005
@@ -48,18 +48,18 @@
.Sh DESCRIPTION
The
.Nm
-daemon is a simple wrapper daemon that allows to use standard
+daemon is a simple wrapper daemon that allows use of
.Xr ppp 8
-on RFCOMM connection.
+via a RFCOMM connection.
It can operate in two modes: client and server.
.Pp
-In the client mode,
+In client mode,
.Nm
-opens an RFCOMM connection to the specified server's
+opens a RFCOMM connection to the specified servers
.Ar BD_ADRR
and
.Ar channel .
-Once RFCOMM connection is established,
+Once the connection is established,
.Nm
executes
.Xr ppp 8
@@ -67,17 +67,17 @@
.Fl direct
mode with the specified
.Ar label .
-The
+Likewise,
.Xr ppp 8
-in its turn operates over the RFCOMM connection just like it would operate
-over the standard serial port thus allowing user to
+operates over the RFCOMM connection just like it would over a standard
+serial port, thus allowing a user to
.Dq "dial out"
and connect to the Internet.
.Pp
-In the server mode,
+In server mode,
.Nm
-opens an RFCOMM socket and listens for incomming connections from remote clients.
-Once the new incomming connection is accepted,
+opens a RFCOMM socket and listens for incoming connections from remote clients.
+Once the new incoming connection is accepted,
.Nm
forks and executes
.Xr ppp 8
@@ -85,46 +85,45 @@
.Fl direct
mode with the specified
.Ar label .
-The
+Likewise,
.Xr ppp 8
-in its turn operates over the RFCOMM connection just like it would operate over
-the standard serial port thus providing network connectivity to remote clients.
+operates over the RFCOMM connection just like it would over a standard
+serial port, thus providing network connectivity to remote clients.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl a Ar address
-In the client mode, this required option specifies the address of the remote
+In client mode, this required option specifies the address of the remote
RFCOMM server.
-In the server mode, this option can be used to specify the local
+In server mode, this option can be used to specify the local
address to listen on.
-By default, server will listen on
+By default, in server mode, the daemon will listen on
.Dv ANY
address.
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
+If a hostname is specified, it will attempt to be resolved
+via
.Xr bt_gethostbyname 3 .
.It Fl C Ar channel
-In both client and server modes, this required option specifies RFCOMM channel
-to connect to or listen on.
-In the server mode, RFCOMM channel should be a number between 1 and 30.
-In the client mode, RFCOMM channel could either be a number between 1 and 30
+In both client and server modes, this required option specifies the RFCOMM
+channel to connect to or listen on.
+In server mode, the channel should be a number between 1 and 30.
+In client mode, the channel could either be a number between 1 and 30
or a service name.
Supported service names are:
.Cm DUN
-(for DialUp Networking service) and
+(Dial-Up Networking) and
.Cm LAN
-(for LAN Access Using PPP service).
-If service name was specified instead of numeric RFCOMM channel then
+(LAN Access Using PPP).
+If a service name is used instead of a numeric channel number, then
.Nm
-utility will try to obtain RFCOMM channel for the service via Service
-Discovery Protocol.
+will try to obtain a RFCOMM channel number via SDP
+(Service Discovery Protocol).
.It Fl c
-Act as an RFCOMM client.
+Act as a RFCOMM client.
This is the default mode.
.It Fl d
-Do not detach from the controlling terminal, i.e., run in foreground.
+Do not detach from the controlling terminal, i.e., run in the foreground.
.It Fl h
Display usage message and exit.
.It Fl l Ar label
@@ -132,35 +131,50 @@
.Xr ppp 8
label will be used.
.It Fl S
-In the server mode register the Serial Port (SP) service in addition to the
-LAN Access Using PPP (LAN) service.
-It appears that some cell phones are using so called
+In server mode, register the
+.Cm SP
+(Serial Port) service in addition to the
+.Cm LAN
+(LAN Access Using PPP) service.
+.Pp
+It appears that some cell phones are using a so-called
.Dq callback mechanism .
-In this scenario the user is trying to connect his cell phone to the Internet,
-and, user's host computer is acting as the gateway server.
+In this scenario, the user is trying to connect his cell phone to the Internet,
+while the host computer is acting as the gateway server.
It seems that it is not possible to tell the phone to just connect and start
-using the LAN service.
-Instead the user's host computer must
+using the
+.Cm LAN
+service. Instead the host computer must
.Dq jump start
-the phone by connecting to the phone's SP service.
+the phone by connecting to the cell phones'
+.Cm SP
+service.
What happens next is the phone kills the existing connection and opens another
-connection back to the user's host computer.
-The phone really wants to use LAN service, but for whatever reason it looks
-for the SP service on the user's host computer.
-This brain damaged behavior was reported for Nokia 6600 and Sony/Ericsson P900.
+connection back to the host computer.
+The phone really wants to use the
+.Cm LAN
+service, but for whatever reason it looks
+for the
+.Cm SP
+service on the host computer anyways. This brain-damaged behavior was
+reported for the following cell phone models:
+.Bd -literal -offset indent
+* Nokia 6600
+* Sony/Ericsson P900
+.Ed
.It Fl s
-Act as an RFCOMM server.
+Act as a RFCOMM server.
.It Fl u Ar N
-This option maps directly onto
+This option maps directly to the
.Fl unit
.Xr ppp 8
-command line option and tells
+command-line option and tells
.Nm
to instruct
.Xr ppp 8
to only attempt to open
.Pa /dev/tun Ns Ar N .
-This option only works in the client mode.
+This option only works in client mode.
.El
.Sh PPP CONFIGURATION
.Ss Important Notes on PPP Configuration
@@ -178,8 +192,8 @@
label
.Em only
contains commands that apply to
-.Em every
-other label.
+.Em every other
+label.
If you need to use PPP for both dialing out and accepting incoming
RFCOMM connections, please make sure you have moved all commands related to
dialing out from the
@@ -187,10 +201,10 @@
section into an appropriate outgoing label.
.Ss RFCOMM Server
One of the typical examples is the LAN access.
-In this example, RFCOMM connection
-is used as a null-modem connection between client and server.
-Both client
-and server will start talking PPP right after RFCOMM connection was established.
+In this example, a RFCOMM connection
+is used as a null-modem connection between a client and a server.
+Both the client
+and server will talk PPP right after the RFCOMM connection is established.
.Bd -literal -offset indent
rfcomm-server:
set timeout 0
@@ -209,9 +223,15 @@
The
.Nm
utility
-supports both LAN and DUN (Dial-Up Networking) access.
-The client's configuration for the LAN access is very similar to server's and
-might look like this.
+supports both
+.Cm LAN
+(LAN Access Using PPP)
+and
+.Cm DUN
+(Dial-Up Networking) access.
+The client's configuration for
+.Cm LAN
+access is very similar to servers' and may resemble this:
.Bd -literal -offset indent
rfcomm-client:
enable lqr
@@ -228,17 +248,19 @@
disable chap
.Ed
.Pp
-The client's configuration for the DUN access is different.
+The client configuration for
+.Cm DUN
+access is different.
In this scenario, the client gets connected to the virtual serial port on the
server.
-To open a PPP session, client must dial a number.
+To open a PPP session, the client must dial a number.
Note that by default
.Xr ppp 8
will not execute any configured chat scripts.
The
.Ic force-scripts
option can be used to override this behavior.
-The example of such configuration is shown below.
+An example configuration is shown below:
.Bd -literal -offset indent
rfcomm-dialup:
# This is IMPORTANT option
@@ -261,7 +283,7 @@
add default HISADDR
.Ed
.Pp
-Note that by adjusting the initialization string, one can make CSD (Circuit
+Note that by adjusting the initialization string, one can make a CSD (Circuit
Switched Data), HSCSD (High Speed Circuit Switched Data) or GPRS (General
Packet Radio Service) connection.
The availability of the particular connection
@@ -276,14 +298,14 @@
.Li 00:01:02:03:04:05
and channel
.Li 1 .
-Once the incomming connection has been accepted,
+Once the incoming connection has been accepted,
.Nm
will execute
.Xr ppp 8
in
.Fl direct
-mode with
-.Dq Li rfcomm-server
+mode with the
+.Em rfcomm-server
label.
.Pp
.Dl "rfcomm_pppd -c -a 00:01:02:03:04:05 -C 1 -l rfcomm-client"
@@ -296,25 +318,24 @@
.Li 00:01:02:03:04:05
address and channel
.Li 1 .
-Once connected, the
+Once connected,
.Nm
will execute
.Xr ppp 8
in
.Fl direct
-mode with
-.Dq Li rfcomm-client
+mode with the
+.Em rfcomm-client
label.
.Sh DIAGNOSTICS
.Ex -std
.Sh CAVEAT
The
.Nm
-utility in server mode will try to register Bluetooth LAN Access Over PPP
-service with local SPD daemon.
-If local SDP daemon is not running the
+utility in server mode will try to register the Bluetooth LAN Access Over
+PPP service with the local SDP daemon. If the local SDP daemon is not running,
.Nm
-utility will exit with error.
+will exit with an error.
.Sh SEE ALSO
.Xr rfcomm_sppd 1 ,
.Xr bluetooth 3 ,
>Release-Note:
>Audit-Trail:
>Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200502280209.j1S29Aod051444>