diff options
author | ru <ru@FreeBSD.org> | 2003-05-20 21:01:21 +0000 |
---|---|---|
committer | ru <ru@FreeBSD.org> | 2003-05-20 21:01:21 +0000 |
commit | 638a31a3e24744379ca4274722cebfb783cb3acd (patch) | |
tree | cc71fbdbb548ae9fb5856beadc19f74dae54e77b /usr.sbin | |
parent | a808871f563c1b6300be2d520e5420fc534e7de7 (diff) | |
download | FreeBSD-src-638a31a3e24744379ca4274722cebfb783cb3acd.zip FreeBSD-src-638a31a3e24744379ca4274722cebfb783cb3acd.tar.gz |
Reapply mdoc(7) fixes that got accidentally lost in the last
Bluetooth update, and fix a few more issues.
Submitted by: Maksim Yevmenkin <m_evmenkin@yahoo.com>, ru
Approved by: re (blanket)
Diffstat (limited to 'usr.sbin')
-rw-r--r-- | usr.sbin/bluetooth/bcmfw/bcmfw.8 | 72 | ||||
-rw-r--r-- | usr.sbin/bluetooth/bt3cfw/bt3cfw.8 | 45 | ||||
-rw-r--r-- | usr.sbin/bluetooth/hccontrol/hccontrol.8 | 199 | ||||
-rw-r--r-- | usr.sbin/bluetooth/hcsecd/hcsecd.8 | 71 | ||||
-rw-r--r-- | usr.sbin/bluetooth/hcseriald/hcseriald.8 | 64 | ||||
-rw-r--r-- | usr.sbin/bluetooth/l2control/l2control.8 | 61 | ||||
-rw-r--r-- | usr.sbin/bluetooth/l2ping/l2ping.8 | 72 | ||||
-rw-r--r-- | usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 | 220 |
8 files changed, 424 insertions, 380 deletions
diff --git a/usr.sbin/bluetooth/bcmfw/bcmfw.8 b/usr.sbin/bluetooth/bcmfw/bcmfw.8 index 945fb21..b961167 100644 --- a/usr.sbin/bluetooth/bcmfw/bcmfw.8 +++ b/usr.sbin/bluetooth/bcmfw/bcmfw.8 @@ -1,8 +1,6 @@ -.\" bcmfw.8 -.\" .\" Copyright (c) 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,74 +21,72 @@ .\" 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: bcmfw.8,v 1.4 2003/04/28 17:10:56 max Exp $ .\" $FreeBSD$ +.\" .Dd March 31, 2003 .Dt BCMFW 8 .Os .Sh NAME -.Nm BCMFW -.Nd Firmware download utility for Broadcom BCM2033 chip based Bluetooth USB devices +.Nm bcmfw +.Nd firmware download utility for Broadcom BCM2033 chip based Bluetooth USB devices .Sh SYNOPSIS .Nm -.Op Fl n Ar device name -.Op Fl m Ar mini-driver file name -.Op Fl f Ar firmware file name .Op Fl h +.Fl f Ar firmware_file_name +.Fl m Ar mini-driver_file_name +.Fl n Ar device_name .Sh DESCRIPTION The .Nm -utility downloads specified mini-driver and firmware files to the specified +utility downloads the specified mini-driver and firmware files to the specified device. .Pp This utility will .Em only -work with Broadcom BCM2033 chip based Bluetooth USB devices. The identification -is currently based on USB vendor ID/product ID pair. The vendor ID should be -0x0a5c ( -.Dv USB_VENDOR_BROADCOM -) and the product ID should be 0x2033. +work with Broadcom BCM2033 chip based Bluetooth USB devices. +The identification is currently based on USB vendor ID/product ID pair. +The vendor ID should be 0x0a5c +.Pq Dv USB_VENDOR_BROADCOM +and the product ID should be 0x2033. .Pp The options are as follows: .Bl -tag -width indent -.It Fl n Ar device name -Specify device name. -.It Fl m Ar mini-driver file name -Specify mini-driver file name for download. -.It Fl f Ar firmware file name +.It Fl f Ar firmware_file_name Specify firmware file name for download. .It Fl h Display usage message and exit. +.It Fl m Ar mini-driver_file_name +Specify mini-driver file name for download. +.It Fl n Ar device_name +Specify device name. .El .Sh FILES -.Bl -tag -width xxxxxxxxxxxxxxxxx -compact -.It BCM2033-MD.hex +.Bl -tag -width ".Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE" -compact +.It Pa BCM2033-MD.hex Mini-driver image. -.It BCM2033-FW.bin +.It Pa BCM2033-FW.bin Firmware image. -.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE +.It Pa /dev/ubtbcmfw Ns Ar N Ns Pa \&. Ns Ar EE Endpoint .Ar EE -of device +of device .Ar N . .El -.Sh Examples -.Bl -tag -width foo -.It bcmfw -n ubtbcmfw0 -m BCM2033-MD.hex -f BCM2033-FW.bin +.Sh EXAMPLES +To download the firmware into the +.Pa /dev/ubtbcmfw0 +device: .Pp -Will download firmware into -.Pa /dev/ubtbcmfw Ns Ar 0 -device. -.El +.Dl "bcmfw -n ubtbcmfw0 -m BCM2033-MD.hex -f BCM2033-FW.bin" .Sh BUGS -Most likely. Please report if found. This code -.Em was not -tested on a real BCM2033 based hardware. +Most likely. +Please report if found. .Sh DIAGNOSTICS .Ex -std .Sh SEE ALSO -.Xr ugen 4 , -.Xr ubtbcmfw 4 +.Xr ubtbcmfw 4 , +.Xr ugen 4 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/usr.sbin/bluetooth/bt3cfw/bt3cfw.8 b/usr.sbin/bluetooth/bt3cfw/bt3cfw.8 index 9e46b86..83a3fcb 100644 --- a/usr.sbin/bluetooth/bt3cfw/bt3cfw.8 +++ b/usr.sbin/bluetooth/bt3cfw/bt3cfw.8 @@ -1,8 +1,6 @@ -.\" bt3cfw.8 -.\" .\" Copyright (c) 2001-2002 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,44 +21,47 @@ .\" 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: bt3cfw.8,v 1.3 2003/04/27 19:45:22 max Exp $ .\" $FreeBSD$ +.\" .Dd November 11, 2002 .Dt BT3CFW 8 .Os .Sh NAME -.Nm BT3CFW -.Nd Firmware download utility for 3Com Bluetooth PC card driver +.Nm bt3cfw +.Nd firmware download utility for 3Com Bluetooth PC card driver .Sh SYNOPSIS .Nm -.Op Fl n Ar Netgraph node name -.Op Fl f Ar Firmware file name .Op Fl h +.Fl f Ar Firmware_file_name +.Fl n Ar Netgraph_node_name .Sh DESCRIPTION The .Nm -utility connects to the specified Netgraph driver node of type +utility connects to the specified Netgraph driver node of type .Dv BTCCC -and downloads specified firmware file. +and downloads the specified firmware file. .Pp -Due to copyright issues I will no longer provide firmware with the card -driver. The firmware can be obtained from the Windows driver package that -can be downloaded from the 3COM web site at no charge. The firmware name -is BT3CPCC.BIN. I'm using original firmware that came with the card on CD-ROM. -.Bd -literal -offset indent -MD5 (BT3CPCC.BIN) = 36170fda56ea9fdbf1702c966f8a97f1 -.Ed +Due to copyright issues, I will no longer provide firmware with the card +driver. +The firmware can be obtained from the Windows driver package that +can be downloaded from the 3COM web site at no charge. +The firmware name is +.Pa BT3CPCC.BIN . +I am using the original firmware that came with the card on CD-ROM. +.Pp +.Dl "MD5 (BT3CPCC.BIN) = 36170fda56ea9fdbf1702c966f8a97f1" .Pp The options are as follows: .Bl -tag -width indent -.It Fl n Ar Netgraph node name -Connect to the specified Netgraph driver node of type -.Dv BTCCC . -.It Fl f Ar Firmware file name +.It Fl f Ar Firmware_file_name Specify firmware file name for download. .It Fl h Display usage message and exit. +.It Fl n Ar Netgraph_node_name +Connect to the specified Netgraph driver node of type +.Dv BTCCC . .El .Sh BUGS Please report if found. diff --git a/usr.sbin/bluetooth/hccontrol/hccontrol.8 b/usr.sbin/bluetooth/hccontrol/hccontrol.8 index c4553db..e55635c 100644 --- a/usr.sbin/bluetooth/hccontrol/hccontrol.8 +++ b/usr.sbin/bluetooth/hccontrol/hccontrol.8 @@ -1,8 +1,6 @@ -.\" hccontrol.8 -.\" .\" Copyright (c) 2001-2002 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,9 +21,10 @@ .\" 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: hccontrol.8,v 1.3 2003/04/27 19:45:23 max Exp $ .\" $FreeBSD$ +.\" .Dd June 14, 2002 .Dt HCCONTROL 8 .Os @@ -34,34 +33,36 @@ .Nd HCI configuration utility .Sh SYNOPSIS .Nm -.Op Fl n Ar HCI node name .Op Fl h -.Op Ar command +.Fl n Ar HCI_node_name +.Ar command .Op Ar parameters ... .Sh DESCRIPTION The .Nm utility connects to the specified Netgraph node of type -.Em HCI -and attempts to send specified command to the HCI Netgraph node or to the +.Dv HCI +and attempts to send specified command to the HCI Netgraph node or to the associated Bluetooth device. +The .Nm -will print results to the standard output and error messages to +utility will print results to the standard output and error messages to the standard error. .Pp The options are as follows: .Bl -tag -width indent -.It Fl n Ar HCI node name -Connect to the specified HCI Netgraph node. .It Fl h Display usage message and exit. -.It command -One of the supported commands (see below). Special command -.Dq help -can be used to obtain the list of all supported commands. To get more -information about specific command use -.Dq help command . -.It parameters +.It Fl n Ar HCI_node_name +Connect to the specified HCI Netgraph node. +.It Ar command +One of the supported commands (see below). +Special command +.Cm help +can be used to obtain the list of all supported commands. +To get more information about specific command use +.Cm help Ar command . +.It Ar parameters One or more optional space separated command parameters. .El .Sh COMMANDS @@ -69,92 +70,92 @@ The currently supported HCI commands in .Nm are: .Pp -.Bd -literal -offset indent -compact -Inquiry -Create_Connection -Disconnect -Add_SCO_Connection -Change_Connection_Packet_Type -Remote_Name_Request -Read_Remote_Supported_Features -Read_Remote_Version_Information -Read_Clock_Offset -Role_Discovery -Switch_Role -Read_Link_Policy_Settings -Write_Link_Policy_Settings -Reset -Read_Pin_Type -Write_Pin_Type -Read_Stored_Link_Key -Write_Stored_Link_Key -Delete_Stored_Link_Key -Change_Local_Name -Read_Local_Name -Read_Connection_Accept_Timeout -Write_Connection_Accept_Timeout -Read_Page_Timeout -Write_Page_Timeout -Read_Scan_Enable -Write_Scan_Enable -Read_Page_Scan_Activity -Write_Page_Scan_Activity -Read_Inquiry_Scan_Activity -Write_Inquiry_Scan_Activity -Read_Authentication_Enable -Write_Authentication_Enable -Read_Encryption_Mode -Write_Encryption_Mode -Read_Class_Of_Device -Write_Class_Of_Device -Read_Voice_Settings -Write_Voice_Settings -Read_Number_Broadcast_Retransmissions -Write_Number_Broadcast_Retransmissions -Read_Hold_Mode_Activity -Write_Hold_Mode_Activity -Read_SCO_Flow_Control_Enable -Write_SCO_Flow_Control_Enable -Read_Link_Supervision_Timeout -Write_Link_Supervision_Timeout -Read_Local_Version_Information -Read_Local_Supported_Features -Read_Buffer_Size -Read_Country_Code -Read_BD_ADDR -Read_Failed_Contact_Counter -Reset_Failed_Contact_Counter -Get_Link_Quality -Read_RSSI -.Ed +.Bl -tag -offset indent -compact +.It Cm Inquiry +.It Cm Create_Connection +.It Cm Disconnect +.It Cm Add_SCO_Connection +.It Cm Change_Connection_Packet_Type +.It Cm Remote_Name_Request +.It Cm Read_Remote_Supported_Features +.It Cm Read_Remote_Version_Information +.It Cm Read_Clock_Offset +.It Cm Role_Discovery +.It Cm Switch_Role +.It Cm Read_Link_Policy_Settings +.It Cm Write_Link_Policy_Settings +.It Cm Reset +.It Cm Read_Pin_Type +.It Cm Write_Pin_Type +.It Cm Read_Stored_Link_Key +.It Cm Write_Stored_Link_Key +.It Cm Delete_Stored_Link_Key +.It Cm Change_Local_Name +.It Cm Read_Local_Name +.It Cm Read_Connection_Accept_Timeout +.It Cm Write_Connection_Accept_Timeout +.It Cm Read_Page_Timeout +.It Cm Write_Page_Timeout +.It Cm Read_Scan_Enable +.It Cm Write_Scan_Enable +.It Cm Read_Page_Scan_Activity +.It Cm Write_Page_Scan_Activity +.It Cm Read_Inquiry_Scan_Activity +.It Cm Write_Inquiry_Scan_Activity +.It Cm Read_Authentication_Enable +.It Cm Write_Authentication_Enable +.It Cm Read_Encryption_Mode +.It Cm Write_Encryption_Mode +.It Cm Read_Class_Of_Device +.It Cm Write_Class_Of_Device +.It Cm Read_Voice_Settings +.It Cm Write_Voice_Settings +.It Cm Read_Number_Broadcast_Retransmissions +.It Cm Write_Number_Broadcast_Retransmissions +.It Cm Read_Hold_Mode_Activity +.It Cm Write_Hold_Mode_Activity +.It Cm Read_SCO_Flow_Control_Enable +.It Cm Write_SCO_Flow_Control_Enable +.It Cm Read_Link_Supervision_Timeout +.It Cm Write_Link_Supervision_Timeout +.It Cm Read_Local_Version_Information +.It Cm Read_Local_Supported_Features +.It Cm Read_Buffer_Size +.It Cm Read_Country_Code +.It Cm Read_BD_ADDR +.It Cm Read_Failed_Contact_Counter +.It Cm Reset_Failed_Contact_Counter +.It Cm Get_Link_Quality +.It Cm Read_RSSI +.El .Pp The currently supported node commands in .Nm are: .Pp -.Bd -literal -offset indent -compact -Read_Node_State -Initialize -Read_Debug_Level -Write_Debug_Level -Read_Node_Buffer_Size -Read_Node_BD_ADDR -Read_Node_Features -Read_Node_Stat -Reset_Node_Stat -Flush_Neighbor_Cache -Read_Neighbor_Cache -Read_Connection_List -Read_Node_Link_Policy_Settings_Mask -Write_Node_Link_Policy_Settings_Mask -Read_Node_Packet_Mask -Write_Node_Packet_Mask -Read_Node_Role_Switch -Write_Node_Role_Switch -.Ed -.Pp +.Bl -tag -offset indent -compact +.It Cm Read_Node_State +.It Cm Initialize +.It Cm Read_Debug_Level +.It Cm Write_Debug_Level +.It Cm Read_Node_Buffer_Size +.It Cm Read_Node_BD_ADDR +.It Cm Read_Node_Features +.It Cm Read_Node_Stat +.It Cm Reset_Node_Stat +.It Cm Flush_Neighbor_Cache +.It Cm Read_Neighbor_Cache +.It Cm Read_Connection_List +.It Cm Read_Node_Link_Policy_Settings_Mask +.It Cm Write_Node_Link_Policy_Settings_Mask +.It Cm Read_Node_Packet_Mask +.It Cm Write_Node_Packet_Mask +.It Cm Read_Node_Role_Switch +.It Cm Write_Node_Role_Switch +.El .Sh BUGS -Most likely. Please report if found. +Most likely. +Please report if found. .Sh DIAGNOSTICS .Ex -std .Sh SEE ALSO diff --git a/usr.sbin/bluetooth/hcsecd/hcsecd.8 b/usr.sbin/bluetooth/hcsecd/hcsecd.8 index 880ee1c..71ffcb8 100644 --- a/usr.sbin/bluetooth/hcsecd/hcsecd.8 +++ b/usr.sbin/bluetooth/hcsecd/hcsecd.8 @@ -1,5 +1,3 @@ -.\" hcsecd.8 -.\" .\" Copyright (c) 2001-2002 Maksim Yevmenkin <m_evmenkin@yahoo.com> .\" All rights reserved. .\" @@ -26,6 +24,7 @@ .\" .\" $Id: hcsecd.8,v 1.3 2003/04/27 19:45:32 max Exp $ .\" $FreeBSD$ +.\" .Dd November 16, 2002 .Dt HCSECD 8 .Os @@ -34,68 +33,74 @@ .Nd control link keys and PIN codes for Bluetooth devices .Sh SYNOPSIS .Nm -.Op Fl f Ar configfile -.Op Fl d -.Op Fl h +.Op Fl dh +.Fl f Ar configfile .Sh DESCRIPTION The .Nm -daemon controls link keys and PIN code for Bluetooth devices. It opens raw -HCI socket and listens for the +daemon controls link keys and PIN code for Bluetooth devices. +It opens raw HCI socket and listens for the .Dv Link_Key_Request and .Dv PIN_Code_Request -HCI events. Once appropriate HCI event has been received, the daemon will -scan configuration file for matching entry. The remove device BD_ADDR is used -as a key. If no matching entry was found then the default entry will be used. -If no default entry was found than it is assumed no link key and no PIN code -exist. For any given entry link key takes precedence over PIN code. If link key -was not specified then it means device must generate link key from PIN code. If -entry was found and has the link key (or PIN code) then -the +HCI events. +Once appropriate HCI event has been received, the daemon will +scan configuration file for matching entry. +The remove device BD_ADDR is used as a key. +If no matching entry was found, the default entry will be used. +If no default entry was found then it is assumed that no link key and no PIN code +exist. +For any given entry, link key takes precedence over PIN code. +If link key was not specified, it means device must generate link key from +PIN code. +If entry was found and has the link key (or PIN code) then the .Dv Link_Key_Request_Reply (or -.Dv PIN_Code_Request_Reply -) command will be sent back to the device. Otherwise the +.Dv PIN_Code_Request_Reply ) +command will be sent back to the device. +Otherwise, the .Dv Link_Key_Request_Negative_Reply (or -.Dv PIN_Code_Request_Negative_Reply -) command will be sent back to the device. +.Dv PIN_Code_Request_Negative_Reply ) +command will be sent back to the device. .Pp The .Nm daemon currently does not handle HCI -.Dv Link_Key_Notification -event and does not cache link keys created from the PIN codes. It means -that the link key only exists while connection is opened. After the connection -has been terminated the user will have to enter PIN code again. +.Dv Link_Key_Notification +event and does not cache link keys created from the PIN codes. +It means that the link key only exists while connection is opened. +After the connection has been terminated, the user will have to enter PIN code +again. .Pp The command line options are as follows: -.Bl -tag -width Ds -.It Fl f Ar filename -Name of configuration file. Default is -.Pa /usr/local/etc/hcsecd.conf . +.Bl -tag -width indent .It Fl d Do not detach from the controlling terminal. +.It Fl f Ar configfile +Specify name of the configuration file. +The default is +.Pa /usr/local/etc/hcsecd.conf . .It Fl h Display usage message and exit. .El .Sh BUGS -Currently there is no way to select link key or PIN code based on which local -device received the request. Everything is based on remote device BD_ADDR. -Also might implement interface for external helpers to obtain link keys and +Currently there is no way to select link key or PIN code based on which local +device received the request. +Everything is based on remote device BD_ADDR. +Also might implement interface for external helpers to obtain link keys and PIN codes. .Sh FILES -.Bl -tag -width /etc/usbd.conf -compact +.Bl -tag -width ".Pa /usr/local/etc/hcsecd.conf" -compact .It Pa /usr/local/etc/hcsecd.conf .It Pa /var/run/hcsecd.pid .El .Sh SEE ALSO .Xr netgraph 3 , .Xr netgraph 4 , -.Xr ng_hci 4 , .Xr ng_btsocket 4 , +.Xr ng_hci 4 , .Xr hccontrol 8 , -.Xr hcseriald 8 +.Xr hcseriald 8 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/usr.sbin/bluetooth/hcseriald/hcseriald.8 b/usr.sbin/bluetooth/hcseriald/hcseriald.8 index d605fa9..25b89b3 100644 --- a/usr.sbin/bluetooth/hcseriald/hcseriald.8 +++ b/usr.sbin/bluetooth/hcseriald/hcseriald.8 @@ -1,8 +1,6 @@ -.\" hcseriald.8 -.\" .\" Copyright (c) 2001-2002 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,9 +21,10 @@ .\" 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: hcseriald.8,v 1.2 2003/04/27 19:45:33 max Exp $ .\" $FreeBSD$ +.\" .Dd June 14, 2002 .Dt HCSERIALD 8 .Os @@ -34,51 +33,54 @@ .Nd supervise serial Bluetooth devices .Sh SYNOPSIS .Nm -.Op Fl f Ar device -.Op Fl n Ar node name +.Op Fl dh +.Fl f Ar device +.Fl n Ar node_name .Op Fl s Ar speed -.Op Fl d -.Op Fl h .Sh DESCRIPTION The .Nm -handles serial Bluetooth devices. It does one simple thing. It opens -specified serial device, sets device parameters and pushes -.Em H4 +utility handles serial Bluetooth devices. +It does one simple thing: +it opens the specified serial device, sets the device parameters, and pushes +the +.Dv H4 line discipline. .Pp The options are as follows: .Bl -tag -width indent +.It Fl d +Do not disassociate from the controlling terminal, i.e., run in foreground. .It Fl f Ar device -Callout device name. Example: -.Fl f -.Pa /dev/cuaa0 . -.It Fl n Ar node name -Set H4 Netgraph node name. Example: -.Fl n Ar sio0 . -.It Fl s Ar speed -Set serial device speed to -.Em speed . +Callout device name. Example: -.Fl s Ar 115200 . -.It Fl d -Do not disassociate from the controlling terminal, i.e. run in foreground. +.Fl f Pa /dev/cuaa0 . .It Fl h Display usage message and exit. +.It Fl n Ar node_name +Set H4 Netgraph node name. +Example: +.Fl n Li sio0 . +.It Fl s Ar speed +Set serial device speed to +.Ar speed . +Example: +.Fl s Li 115200 . .El .Sh FILES -.Bl -tag -width /dev/consolectl -compact -.It Pa /var/run/hcserial.*.pid -process id of the currently running +.Bl -tag -width ".Pa /var/run/hcserial. Ns Ar * Ns Pa .pid" -compact +.It Pa /var/run/hcserial. Ns Ar * Ns Pa .pid +Process ID of the currently running .Nm -daemon. Where -.Dq * -is a H4 Netgraph node name. +daemon. +Where +.Ar * +is an H4 Netgraph node name. .El .Sh SEE ALSO -.Xr tty 4 , .Xr ng_h4 4 , .Xr ng_hci 4 , +.Xr tty 4 , .Xr hccontrol 8 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com diff --git a/usr.sbin/bluetooth/l2control/l2control.8 b/usr.sbin/bluetooth/l2control/l2control.8 index fb09276..dcd05fe 100644 --- a/usr.sbin/bluetooth/l2control/l2control.8 +++ b/usr.sbin/bluetooth/l2control/l2control.8 @@ -1,8 +1,6 @@ -.\" l2control.8 -.\" .\" Copyright (c) 2001-2002 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,9 +21,10 @@ .\" 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: l2control.8,v 1.3 2003/04/27 19:45:34 max Exp $ .\" $FreeBSD$ +.\" .Dd June 14, 2002 .Dt L2CONTROL 8 .Os @@ -34,33 +33,36 @@ .Nd L2CAP configuration utility .Sh SYNOPSIS .Nm -.Op Fl a Ar local BD_ADDR .Op Fl h -.Op Ar command +.Fl a Ar BD_ADDR +.Ar command .Op Ar parameters ... .Sh DESCRIPTION The .Nm -utility connects to the local device with specified BD_ADDR and attempts -to send specified command. +utility connects to the local device with the specified BD_ADDR and attempts +to send the specified command. +The .Nm -will print results to the standard output and error messages to +utility will print results to the standard output and error messages to the standard error. .Pp The options are as follows: .Bl -tag -width indent -.It Fl a Ar local BD_ADDR -Connect to the local device with specified BD_ADDR. Example: -.Fl a Ar 00:01:02:03:04:05 . +.It Fl a Ar BD_ADDR +Connect to the local device with the specified BD_ADDR. +Example: +.Fl a Li 00:01:02:03:04:05 . .It Fl h Display usage message and exit. -.It command -One of the supported commands (see below). Special command -.Dq help -can be used to obtain the list of all supported commands. To get more -information about specific command use -.Dq help command . -.It parameters +.It Ar command +One of the supported commands (see below). +Special command +.Cm help +can be used to obtain the list of all supported commands. +To get more information about specific command use +.Cm help Ar command . +.It Ar parameters One or more optional space separated command parameters. .El .Sh COMMANDS @@ -68,16 +70,15 @@ The currently supported node commands in .Nm are: .Pp -.Bd -literal -offset indent -compact -Read_Node_Flags -Read_Debug_Level -Write_Debug_Level -Read_Connection_List -Read_Channel_List -Read_Auto_Disconnect_Timeout -Write_Auto_Disconnect_Timeout -.Ed -.Pp +.Bl -tag -offset indent -compact +.It Cm Read_Node_Flags +.It Cm Read_Debug_Level +.It Cm Write_Debug_Level +.It Cm Read_Connection_List +.It Cm Read_Channel_List +.It Cm Read_Auto_Disconnect_Timeout +.It Cm Write_Auto_Disconnect_Timeout +.El .Sh DIAGNOSTICS .Ex -std .Sh SEE ALSO diff --git a/usr.sbin/bluetooth/l2ping/l2ping.8 b/usr.sbin/bluetooth/l2ping/l2ping.8 index 831eef8..8ecd11e 100644 --- a/usr.sbin/bluetooth/l2ping/l2ping.8 +++ b/usr.sbin/bluetooth/l2ping/l2ping.8 @@ -1,8 +1,6 @@ -.\" l2ping.8 -.\" .\" Copyright (c) 2001-2002 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,9 +21,10 @@ .\" 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: l2ping.8,v 1.2 2003/04/27 19:45:35 max Exp $ .\" $FreeBSD$ +.\" .Dd June 14, 2002 .Dt L2PING 8 .Os @@ -34,51 +33,62 @@ .Nd send L2CAP ECHO_REQUEST to remote devices .Sh SYNOPSIS .Nm -.Op Fl a Ar remote BD_ADDR -.Op Fl S Ar source BD_ADDR +.Op Fl fh +.Fl a Ar BD_ADDR .Op Fl c Ar count -.Op Fl f .Op Fl i Ar delay +.Op Fl S Ar BD_ADDR .Op Fl s Ar size -.Op Fl h .Sh DESCRIPTION The .Nm -uses L2CAP ECHO_REQUEST datagram to elicit a L2CAP ECHO_RESPONSE from a -remote device. +utility uses L2CAP +.Dv ECHO_REQUEST +datagram to elicit an L2CAP +.Dv ECHO_RESPONSE +from a remote device. .Pp The options are as follows: .Bl -tag -width indent -.It Fl a Ar remote BD_ADDR -Address of remote device to ping. Example: -.Fl a Ar 00:01:02:03:04:05 . -.It Fl S Ar source BD_ADDR -Send L2CAP ECHO_REQUEST from local device that has BD_ADDR. Example: -.Fl S Ar 00:05:04:03:02:01 . +.It Fl a Ar BD_ADDR +Address of remote device to ping. +Example: +.Fl a Li 00:01:02:03:04:05 . .It Fl c Ar count -Number of packets to send. If this option is not specified, +Number of packets to send. +If this option is not specified, .Nm will operate until interrupted. .It Fl f .Dq Flood -ping, i.e. no delay between packets. +ping, i.e., no delay between packets. +.It Fl h +Display usage message and exit. .It Fl i Ar wait -Wait -.Em wait -seconds between sending each packet. The default is to wait for one -second between each packet. This option is ignored if -.Fl f +Wait +.Ar wait +seconds between sending each packet. +The default is to wait for one second between each packet. +This option is ignored if +.Fl f has been specified. +.It Fl S Ar BD_ADDR +Send L2CAP +.Dv ECHO_REQUEST +from local device that has +.Ar BD_ADDR . +Example: +.Fl S Li 00:05:04:03:02:01 . .It Fl s Ar size -Specify the number of payload bytes to be sent. The default is 64. The -maximum size is 65531. Use this option with caution. Some implementations -may not like large sizes and may hang or even crash. -.It Fl h -Display usage message and exit. +Specify the number of payload bytes to be sent. +The default is 64. +The maximum size is 65531. +Use this option with caution. +Some implementations may not like large sizes and may hang or even crash. .El .Sh BUGS -Could collect more statistic. Could check for duplicated, corrupted -and lost packets. +Could collect more statistic. +Could check for duplicated, corrupted and lost packets. .Sh DIAGNOSTICS .Ex -std .Sh SEE ALSO diff --git a/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 b/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 index dbf974e2..d6af46d 100644 --- a/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 +++ b/usr.sbin/bluetooth/rfcomm_pppd/rfcomm_pppd.8 @@ -1,8 +1,6 @@ -.\" rfcomm_pppd.8 -.\" .\" 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: @@ -11,7 +9,7 @@ .\" 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 @@ -23,9 +21,10 @@ .\" 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_pppd.8,v 1.5 2003/04/27 19:45:37 max Exp $ .\" $FreeBSD$ +.\" .Dd February 4, 2003 .Dt RFCOMM_PPPD 8 .Os @@ -34,96 +33,117 @@ .Nd RFCOMM PPP daemon .Sh SYNOPSIS .Nm +.Fl c +.Op Fl dh +.Fl a Ar BD_ADDR +.Fl C Ar channel +.Fl l Ar label +.Nm +.Fl s +.Op Fl dh .Op Fl a Ar BD_ADDR -.Op Fl c -.Op Fl C Ar channel -.Op Fl d -.Op Fl h -.Op Fl l Ar label -.Op Fl s +.Fl C Ar channel +.Fl l Ar label .Sh DESCRIPTION The .Nm daemon is a simple wrapper daemon that allows to use standard -.Nm ppp -on RFCOMM connection. It can operate in two modes: client and server. +.Xr ppp 8 +on RFCOMM connection. +It can operate in two modes: client and server. .Pp -In the client mode -.Nm -opens a RFCOMM connection to the specified server's BD_ADRR and channel. -Once RFCOMM connection is established +In the client mode, +.Nm +opens an RFCOMM connection to the specified server's +.Ar BD_ADRR +and +.Ar channel . +Once RFCOMM connection is established, .Nm executes -.Nm ppp +.Xr ppp 8 in -.Dq direct -mode with the specified label. The -.Nm ppp -in its turn operates over the RFCOMM connection just like it would operate +.Fl direct +mode with the specified +.Ar label . +The +.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 -.Dq dial out +.Dq "dial out" and connect to the Internet. .Pp -In the server mode +In the server mode, .Nm -opens a RFCOMM socket and listens for incomming connections from remote -clients. Once new incomming connection is accepted +opens an RFCOMM socket and listens for incomming connections from remote clients. +Once the new incomming connection is accepted, .Nm forks and executes -.Nm ppp +.Xr ppp 8 in -.Dq direct -mode with the specified label. The -.Nm ppp -in its turn operates over the RFCOMM connection just like it would operate over +.Fl direct +mode with the specified +.Ar label . +The +.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. .Pp The options are as follows: .Bl -tag -width indent .It Fl a Ar BD_ADDR -In the client mode this requied option specifies the remote BD_ADDR of the -RFCOMM server. In the server mode this option can be used to specify the local -BD_ADDR to listen on. By default server will listen on +In the client mode, this required option specifies the remote BD_ADDR of the +RFCOMM server. +In the server mode, this option can be used to specify the local +BD_ADDR to listen on. +By default, server will listen on .Dv ANY address. -.It Fl c -Act as RFCOMM client. This is the default mode. .It Fl C Ar channel -In both client and server modes this required option specifies RFCOMM channel +In both client and server modes, this required option specifies RFCOMM channel to connect to or listen on. +.It Fl c +Act as an 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 foreground. .It Fl h Display usage message and exit. .It Fl l Ar label -In both client and server modes this required option specifies which PPP label -will be used. +In both client and server modes, this required option specifies which +.Xr ppp 8 +label will be used. .It Fl s -Act as RFCOMM server. +Act as an RFCOMM server. .El .Sh PPP CONFIGURATION -.Ss Important notes on PPP configuration -Special attention is required when adding new RFCOMM configurations to the -existing PPP configuration. Please keep in mind that PPP will +.Ss Important Notes on PPP Configuration +Special attention is required when adding new RFCOMM configurations to the +existing PPP configuration. +Please keep in mind that PPP will .Em always execute commands in the -.Dq default +.Dq Li default label of your .Pa /etc/ppp/ppp.conf -file. Please make sure that the -.Dq default -label +file. +Please make sure that the +.Dq Li default +label .Em only contains commands that apply to .Em every -other label. If you need to use PPP for both dialing out and accepting incoming +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 -.Dq default -section into appropriate outgoing label. -.Ss RFCOMM server -One of the typical examples is LAN access. In this example RFCOMM connection -is used as a null-modem connection between client and server. Both client +.Dq Li default +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. .Bd -literal -offset indent rfcomm-server: @@ -139,11 +159,13 @@ rfcomm-server: disable chap deny chap .Ed -.Ss RFCOMM client +.Ss RFCOMM Client +The .Nm -supports both LAN and DUN (DialUp Networking) access. The client's -configuration for the LAN access is very similar to server's and might -look like this. +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. .Bd -literal -offset indent rfcomm-client: enable lqr @@ -160,14 +182,17 @@ rfcomm-client: disable chap .Ed .Pp -The client's configuration for the 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. Note that by default -.Nm ppp -will not execute any configured chat scripts. The -.Dq force-scripts -option can be used to override this behavior. The example of such configuration -is shown below. +The client's configuration for the 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. +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. .Bd -literal -offset indent rfcomm-dialup: # This is IMPORTANT option @@ -178,8 +203,8 @@ rfcomm-dialup: set authkey set phone "*99***1#" - # You might want to adjust dial string as well - set dial "ABORT BUSY ABORT NO\\\sCARRIER TIMEOUT 5 \\ + # You might want to adjust dial string as well + set dial "ABORT BUSY ABORT NO\\\\sCARRIER TIMEOUT 5 \\ \\"\\" AT OK-AT-OK ATE1Q0 OK \\\\dATD\\\\T TIMEOUT 40 CONNECT" set login set timeout 30 @@ -190,57 +215,60 @@ rfcomm-dialup: add default HISADDR .Ed .Pp -Note that by adjusting initialization string one can make CSD (Circuit +Note that by adjusting the initialization string, one can make CSD (Circuit Switched Data), HSCSD (High Speed Circuit Switched Data) or GPRS (General -Packet Radio Service) connection. The availability of the particular connection +Packet Radio Service) connection. +The availability of the particular connection type depends on the phone model and service plan activated on the phone. .Sh EXAMPLES -.Bl -tag -width indent -.It rfcomm_pppd -s -a 00:01:02:03:04:05 -C 1 -l rfcomm-server +.Dl "rfcomm_pppd -s -a 00:01:02:03:04:05 -C 1 -l rfcomm-server" .Pp -Will start +This command will start .Nm -in the server mode. The RFCOMM server will listen on local address -.Em 00:01:02:03:04:05 -and channel -.Em 1 . -Once incomming connection has been accepted +in the server mode. +The RFCOMM server will listen on local address +.Li 00:01:02:03:04:05 +and channel +.Li 1 . +Once the incomming connection has been accepted, .Nm will execute -.Nm ppp +.Xr ppp 8 in -.Dq direct +.Fl direct mode with -.Dq rfcomm-server +.Dq Li rfcomm-server label. -.It rfcomm_pppd -c -a 00:01:02:03:04:05 -C 1 -l rfcomm-client .Pp -Will start +.Dl "rfcomm_pppd -c -a 00:01:02:03:04:05 -C 1 -l rfcomm-client" +.Pp +This command will start .Nm in the client mode. .Nm -will try to connect to the RFCOMM server at -.Em 00:01:02:03:04:05 -address and channel -.Em 1 . -Once connected the +will try to connect to the RFCOMM server at +.Li 00:01:02:03:04:05 +address and channel +.Li 1 . +Once connected, the .Nm will execute -.Nm ppp -in -.Dq direct +.Xr ppp 8 +in +.Fl direct mode with -.Dq rfcomm-client +.Dq Li rfcomm-client label. -.El .Sh DIAGNOSTICS .Ex -std .Sh BUGS +The .Nm -currently is not integrated with SDP (Service Discovery Protocol). +utility +is not currently integrated with the SDP (Service Discovery Protocol). .Sh SEE ALSO -.Xr ppp 8 , +.Xr rfcomm_sppd 1 , .Xr ng_btsocket 4 , -.Xr rfcomm_sppd 1 +.Xr ppp 8 .Sh AUTHORS .An Maksim Yevmenkin Aq m_evmenkin@yahoo.com |