git: 2407b84c6835 - main - uhso.4: describe better, SYNOPSIS, HARDWARE, SPDX

From: Alexander Ziaee <ziaee_at_FreeBSD.org>
Date: Mon, 21 Sep 2026 16:51:40 UTC
The branch main has been updated by ziaee:

URL: https://cgit.FreeBSD.org/src/commit/?id=2407b84c683582ad2fb8840df5a13637d0a8f405

commit 2407b84c683582ad2fb8840df5a13637d0a8f405
Author:     Alexander Ziaee <ziaee@FreeBSD.org>
AuthorDate: 2026-09-21 16:43:06 +0000
Commit:     Alexander Ziaee <ziaee@FreeBSD.org>
CommitDate: 2026-09-21 16:49:05 +0000

    uhso.4: describe better, SYNOPSIS, HARDWARE, SPDX
    
    + Update SYNOPSIS to the new standard format
    + Give this a clearer description in apropos
    + Give this a clearer description in hardware note
    + Spinoff SYSCTL VARIABLES from HARDWARE
    + Pet linter for long lines and trailing punctuation
    + Tag SPDX
    
    MFC after:      3 days
---
 share/man/man4/uhso.4 | 55 ++++++++++++++++++++++++++++++---------------------
 1 file changed, 33 insertions(+), 22 deletions(-)

diff --git a/share/man/man4/uhso.4 b/share/man/man4/uhso.4
index d88c925212eb..f91a7837085e 100644
--- a/share/man/man4/uhso.4
+++ b/share/man/man4/uhso.4
@@ -1,3 +1,6 @@
+.\"
+.\" SPDX-License-Identifier: BSD-2-Clause
+.\"
 .\" Copyright (c) 2009 Fredrik Lindberg
 .\" All rights reserved.
 .\"
@@ -21,23 +24,30 @@
 .\" (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 July 20, 2010
+.Dd September 21, 2026
 .Dt UHSO 4
 .Os
 .Sh NAME
 .Nm uhso
-.Nd support for several HSxPA devices from Option N.V.
+.Nd USB support for Option N.V. HSxPA 3G cellular modems
 .Sh SYNOPSIS
-The module can be loaded at boot time by placing the following line in
+.Cd device usb
+.Cd device uhso
+.Pp
+In
 .Xr loader.conf 5 :
-.Bd -literal -offset indent
-uhso_load="YES"
-.Ed
+.Cd uhso_load="YES"
+.Pp
+In
+.Xr loader.conf 5
+or
+.Xr sysctl.conf 5 :
+.Cd hw.usb.uhso.auto_switch
 .Sh DESCRIPTION
 The
 .Nm
-driver provides support for several HSxPA devices from Option N.V. that are
-based on their packet interface.
+driver provides support for several HSxPA devices from Option N.V.
+that are based on their packet interface.
 Each device has a set of serial ports and a raw IP packet interface.
 The serial ports of the device are accessed through the
 .Xr ucom 4
@@ -46,32 +56,33 @@ driver which makes them behave like
 devices.
 The packet interface is exposed as a network interface.
 .Pp
-Establishing a connection on the packet interface is achieved by using the
-proprietary AT commands
+Establishing a connection on the packet interface is achieved by using
+the proprietary AT commands
 .Dq Li AT_OWANCALL
 and
 .Dq Li AT_OWANDATA
 on any of the available serial ports.
 .Pp
-The network interface must be configured manually using the data obtain from
-these calls.
+The network interface must be configured manually
+using the data obtained from these calls.
 .Pp
-Each device usually have at least two or more serial ports, their individual purpose
-can be identified through
+Each device usually have at least two or more serial ports,
+their individual purpose can be identified through
 .Xr sysctl 8 .
 Ports identified as
 .Dq Modem
 features a normal modem interface that can be used with PPP.
 Ports identified as
 .Dq Diagnostic
-uses a proprietary binary interface used for firmware upgrades, this port does not
+uses a proprietary binary interface used for firmware upgrades,
+this port does not
 have a AT command interface and can not be used to control the device.
-Other ports features an AT command interface that can be used for normal device control.
+Other ports features an AT command interface that can be used for normal
+device control.
 .Sh HARDWARE
 The
 .Nm
-driver should work with most devices from Option.
-The following devices have been verified to work
+driver supports the following Option N.V. HSxPA 3G cellular modems:
 .Pp
 .Bl -bullet -compact
 .It
@@ -85,7 +96,7 @@ Option iCON 452
 .It
 Option iCON 505
 .El
-.Pp
+.Sh SYSCTL VARIABLES
 The device features a mass storage device referred to as
 .Dq Zero-CD
 which contains drivers for Microsoft Windows; this is the default
@@ -101,11 +112,11 @@ to 0 using
 .Xr sysctl 8 .
 .Sh FILES
 .Bl -tag -width "XXXXXX"
-.It Pa /dev/cuaU?.?
+.It Pa /dev/cuaU?.?\&
 .El
 .Sh EXAMPLES
-Establishing a packet interface connection using the AT command interface available
-at one of the serial ports
+Establish a packet interface connection using the AT command interface
+available at one of the serial ports
 .Bd -literal -offset indent
 AT+CGDCONT=1,,"apn.provider"
 AT_OWANCALL=1,1,1