summaryrefslogtreecommitdiffstats
path: root/usr.sbin/bluetooth/hccontrol/hccontrol.8
diff options
context:
space:
mode:
Diffstat (limited to 'usr.sbin/bluetooth/hccontrol/hccontrol.8')
-rw-r--r--usr.sbin/bluetooth/hccontrol/hccontrol.8201
1 files changed, 101 insertions, 100 deletions
diff --git a/usr.sbin/bluetooth/hccontrol/hccontrol.8 b/usr.sbin/bluetooth/hccontrol/hccontrol.8
index 88e9813..c4553db 100644
--- a/usr.sbin/bluetooth/hccontrol/hccontrol.8
+++ b/usr.sbin/bluetooth/hccontrol/hccontrol.8
@@ -1,6 +1,8 @@
+.\" 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:
@@ -9,7 +11,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
@@ -21,9 +23,9 @@
.\" 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
@@ -32,35 +34,34 @@
.Nd HCI configuration utility
.Sh SYNOPSIS
.Nm
-.Op Fl n Ar HCI_node_name
-.Op Ar command
+.Op Fl n Ar HCI node name
+.Op Fl h
+.Op Ar command
.Op Ar parameters ...
.Sh DESCRIPTION
The
.Nm
utility connects to the specified Netgraph node of type
-.Dv HCI
-and attempts to send specified command to the HCI Netgraph node or to the
+.Em HCI
+and attempts to send specified command to the HCI Netgraph node or to the
associated Bluetooth device.
-The
.Nm
-utility
-will print results to the standard output and error messages to
+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
+.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
+.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
-.Cm help Ar command .
-.It Ar parameters
+.Dq help command .
+.It parameters
One or more optional space separated command parameters.
.El
.Sh COMMANDS
@@ -68,92 +69,92 @@ The currently supported HCI commands in
.Nm
are:
.Pp
-.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
+.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
.Pp
The currently supported node commands in
.Nm
are:
.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_Command_Timeout
-.It Cm Write_Command_Timeout
-.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
-.El
+.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
.Sh BUGS
-Most likely.
-Please report if found.
+Most likely. Please report if found.
.Sh DIAGNOSTICS
.Ex -std
.Sh SEE ALSO
OpenPOWER on IntegriCloud