svn commit: r368813 - in head/usr.sbin/bluetooth: bluetooth-config hccontrol hcseriald sdpd

Sat Dec 19 13:37:00 UTC 2020

Author: gbe (doc committer)
Date: Sat Dec 19 13:36:59 2020
New Revision: 368813
URL: https://svnweb.freebsd.org/changeset/base/368813

Log:
  bluetooth: Fix a mandoc related issues
  
  - new sentence, new line
  - sections out of conventional order: Sh FILES
  - unusual Xr order: bthost(1) after bthidd(8)
  - no blank before trailing delimiter
  - whitespace at end of input line
  - sections out of conventional order: Sh EXIT STATUS
  
  MFC after:	1 week

Modified:
  head/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8
  head/usr.sbin/bluetooth/hccontrol/hccontrol.8
  head/usr.sbin/bluetooth/hcseriald/hcseriald.8
  head/usr.sbin/bluetooth/sdpd/sdpd.8

Modified: head/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8
==============================================================================

--- head/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8	Sat Dec 19 13:23:26 2020	(r368812)
+++ head/usr.sbin/bluetooth/bluetooth-config/bluetooth-config.8	Sat Dec 19 13:36:59 2020	(r368813)
@@ -45,7 +45,8 @@ The following options are available:
 .It Fl d
 Scan for a specific bluetooth device address.
 .It Fl n
-Limit scan to a specific host controller. Hint: List all netgraph nodes with
+Limit scan to a specific host controller.
+Hint: List all netgraph nodes with
 .Ql /usr/sbin/ngctl list .
 .El
 .Pp
@@ -62,11 +63,6 @@ keyboards, configure and restart
 .Nm
 can bring up any interface and daemon necessary for operation and, if a node is provided on
 command line, will do so automatically for that interface.
-.Sh CAVEATS
-.Nm
-can not parse entries in
-.Xr hcsecd 8
-config file and thus will ask the user to manually modify existing pairing PIN entries.
 .Sh FILES
 .Bl -tag -width ".Pa /etc/bluetooth/hosts" -compact
 .It Pa /etc/bluetooth/hosts
@@ -79,7 +75,8 @@ scan -n ubt0 -a 00:26:bb:7a:58:95
 .Bd -ragged -offset indent
 This will scan the bluetooth controller ubt0hci for a bluetooth device with the address
 00:26:bb:7a:58:95, set up ubt0 if necessary and enter an interactive dialog to pair the
-new device. Since in this example a mouse is paired,
+new device.
+Since in this example a mouse is paired,
 .Nm
 will interact with
 .Xr bthidd 8 ,
@@ -93,9 +90,9 @@ This will scan all bluetooth controllers on the system
 to bring up controllers or daemons along the way.
 .Ed
 .Sh SEE ALSO
+.Xr bthost 1 ,
 .Xr bthidcontrol 8 ,
 .Xr bthidd 8 ,
-.Xr bthost 1 ,
 .Xr hccontrol 8 ,
 .Xr hcsecd 8 ,
 .Xr sdpcontrol 8 ,
@@ -107,5 +104,10 @@ utility first appeared in
 .Fx 12.1 .
 .Sh AUTHORS
 .An Dirk Engling Aq Mt erdgeist at erdgeist.org
+.Sh CAVEATS
+.Nm
+can not parse entries in
+.Xr hcsecd 8
+config file and thus will ask the user to manually modify existing pairing PIN entries.
 .Sh THANKS TO
 Lars Engels and Warren Block for suggestions, help, and testing.

Modified: head/usr.sbin/bluetooth/hccontrol/hccontrol.8
==============================================================================
--- head/usr.sbin/bluetooth/hccontrol/hccontrol.8	Sat Dec 19 13:23:26 2020	(r368812)
+++ head/usr.sbin/bluetooth/hccontrol/hccontrol.8	Sat Dec 19 13:36:59 2020	(r368813)
@@ -147,8 +147,8 @@ are:
 .It Cm Read_RSSI
 .It Cm LE_Enable
 .It Cm LE_Read_Local_Supported_Features
-.It Cm LE_Set_Advertising_Parameters 
-.It Cm LE_Read_Advertising_Physical_Channel_Tx_Power 
+.It Cm LE_Set_Advertising_Parameters
+.It Cm LE_Read_Advertising_Physical_Channel_Tx_Power
 .It Cm LE_Set_Advertising_Data
 .It Cm LE_Set_Scan_Response_Data
 .It Cm LE_Set_Advertising_Enable
@@ -192,10 +192,11 @@ are:
 .It Cm Write_Node_Role_Switch
 .It Cm Read_Node_List
 .El
+.Sh EXIT STATUS
+.Ex -std
 .Sh EXAMPLES
 Make the blutooth LE host, ubt0hci, scannable through
 .Xr hccontrol 8 commands:
-.Pp
 .Bd -literal -offset indent
 hccontrol -n ubt0hci le_set_advertising_enable disable
 hccontrol -n ubt0hci le_set_advertising_param
@@ -204,8 +205,6 @@ hccontrol -n ubt0hci le_set_advertising_data
 hccontrol -n ubt0hci le_set_scan_response -n FBSD_Host
 hccontrol -n ubt0hci le_set_advertising_enable enable
 .Ed
-.Sh EXIT STATUS
-.Ex -std
 .Sh SEE ALSO
 .Xr bluetooth 3 ,
 .Xr netgraph 3 ,

Modified: head/usr.sbin/bluetooth/hcseriald/hcseriald.8
==============================================================================
--- head/usr.sbin/bluetooth/hcseriald/hcseriald.8	Sat Dec 19 13:23:26 2020	(r368812)
+++ head/usr.sbin/bluetooth/hcseriald/hcseriald.8	Sat Dec 19 13:36:59 2020	(r368813)
@@ -69,7 +69,7 @@ Example:
 .El
 .Sh FILES
 .Bl -tag -width ".Pa /var/run/hcserial. Ns Ar * Ns Pa .pid" -compact
-.It Pa /var/run/hcserial. Ns Ar * Ns Pa .pid
+.It Pa /var/run/hcserial . Ns Ar * Ns Pa .pid
 Process ID of the currently running
 .Nm
 daemon.

Modified: head/usr.sbin/bluetooth/sdpd/sdpd.8
==============================================================================
--- head/usr.sbin/bluetooth/sdpd/sdpd.8	Sat Dec 19 13:23:26 2020	(r368812)
+++ head/usr.sbin/bluetooth/sdpd/sdpd.8	Sat Dec 19 13:36:59 2020	(r368813)
@@ -98,7 +98,16 @@ was started as root.
 The default user name is
 .Dq Li nobody .
 .El
-.Sh CAVEAT
+.Sh FILES
+.Bl -tag -width ".Pa /var/run/sdp" -compact
+.It Pa /var/run/sdp
+.El
+.Sh SEE ALSO
+.Xr sdp 3 ,
+.Xr sdpcontrol 8
+.Sh AUTHORS
+.An Maksim Yevmenkin Aq Mt m_evmenkin at yahoo.com
+.Sh CAVEATS
 The
 .Nm
 daemon
@@ -126,15 +135,6 @@ It only performs minimal checking on the service data 
 Register request.
 It is assumed that application must obtain all required resources such
 as RFCOMM channels etc., before registering the service.
-.Sh FILES
-.Bl -tag -width ".Pa /var/run/sdp" -compact
-.It Pa /var/run/sdp
-.El
-.Sh SEE ALSO
-.Xr sdp 3 ,
-.Xr sdpcontrol 8
-.Sh AUTHORS
-.An Maksim Yevmenkin Aq Mt m_evmenkin at yahoo.com
 .Sh BUGS
 Most likely.
 Please report if found.
