feat: Added FreeBSD man pages

1 files changed, 175 insertions, 0 deletions

diff --git a/static/freebsd/man4/u3g.4 b/static/freebsd/man4/u3g.4
new file mode 100644
index 00000000..c7bf1f98
--- /dev/null
+++ b/static/freebsd/man4/u3g.4
@@ -0,0 +1,175 @@
+.\"-
+.\" SPDX-License-Identifier: ISC
+.\"
+.\" Copyright (c) 2008 AnyWi Technologies
+.\" All rights reserved.
+.\"
+.\" This code is derived from uark.c
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd December 5, 2024
+.Dt U3G 4
+.Os
+.Sh NAME
+.Nm u3g
+.Nd USB support for 3G and 4G cellular modems
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device usb"
+.Cd "device ucom"
+.Cd "device u3g"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+u3g_load="YES"
+.Ed
+.Pp
+If neither of the above is done, the driver will be
+automatically loaded by devd(8) when the device is connected.
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for USB-to-serial interfaces
+exposed by many 3G and 4G modems.
+The supported adapters provide the necessary modem port for
+.Xr ppp 8 ,
+or
+.Pa net/mpd5
+connections.
+Depending on the specific device, extra ports provide other functions
+such as an additional command port, diagnostic port,
+GPS receiver port, or SIM toolkit port.
+.Pp
+The device is accessed through the
+.Xr ucom 4
+driver which makes it behave like a
+.Xr tty 4 .
+.Pp
+In some adapters a mass storage device supported by the
+.Xr umass 4
+driver is present which contains Windows and Mac OS X drivers.
+The device starts up in disk mode (TruInstall, ZeroCD, etc.)
+and requires additional commands to switch it to modem mode.
+If your device is not switching automatically, please try to add quirks.
+See
+.Xr usbconfig 8
+and
+.Xr usb_quirk 4 .
+.Sh HARDWARE
+The
+.Nm
+driver supports the following cellular modems:
+.Pp
+.Bl -bullet -compact
+.It
+Option GT 3G Fusion, GT Fusion Quad, etc.
+.Pq 3G only, not WLAN
+.It
+Option GT 3G, GT 3G Quad, etc.
+.It
+Vodafone Mobile Connect Card 3G
+.It
+Vodafone Mobile Broadband K3772-Z
+.It
+Qualcomm Inc. CDMA MSM
+.It
+Qualcomm Inc. GOBI 1000, 2000 and 3000 devices with MDM1000 or MDM2000 chipsets
+.It
+QUECTEL BGX, ECX, EGX, EMX, EPX, RGX series
+.It
+Quectel EM160R, EM060K
+.Pq see Sx CAVEATS
+.It
+Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, ('<Huawei Mobile>')
+.It
+Novatel U740, MC950D, X950D, etc.
+.It
+Sierra MC875U, MC8775U, EM7590, etc.
+.It
+Panasonic CF-F9 GOBI
+.El
+.Pp
+Many more are supported, see
+.Pa /sys/dev/usb/serial/u3g.c
+for the complete list.
+.Sh FILES
+.Bl -tag -width "/dev/ttyU*.*.init" -compact
+.It Pa /dev/ttyU*.*
+for callin ports
+.It Pa /dev/ttyU*.*.init
+.It Pa /dev/ttyU*.*.lock
+corresponding callin initial-state and lock-state devices
+.Pp
+.It Pa /dev/cuaU*.*
+for callout ports
+.It Pa /dev/cuaU*.*.init
+.It Pa /dev/cuaU*.*.lock
+corresponding callout initial-state and lock-state devices
+.El
+.Sh EXAMPLES
+Connect to the Internet using the default configuration:
+.Bd -literal -offset indent
+ppp -background u3g
+.Ed
+.Sh SEE ALSO
+.Xr tty 4 ,
+.Xr ucom 4 ,
+.Xr usb 4 ,
+.Xr usb_quirk 4 ,
+.Xr devd 8 ,
+.Xr ppp 8 ,
+.Xr usbconfig 8
+.Sh HISTORY
+The
+.Nm
+driver appeared in
+.Fx 7.2 ,
+is based on the
+.Xr uark 4
+driver, and written by
+.An Andrea Guzzo Aq Mt aguzzo@anywi.com
+in September 2008.
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Andrea Guzzo Aq Mt aguzzo@anywi.com
+and
+.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
+Hardware for testing was provided by AnyWi Technologies, Leiden, NL.
+.Sh CAVEATS
+The Quectel EM160R is not officially supported in PPP mode.
+In order to use it in PPP mode, the ctsrts option needs to be turned off,
+for example, by adding:
+.Pp
+.Dl set ctsrts off
+.Pp
+to
+.Pa /etc/ppp/ppp.conf
+in the correct section.
+.Sh BUGS
+The automatic mode switch from disk mode to modem mode does not work unless
+the driver is either built into the kernel or loaded before the device is
+connected.
+.Pp
+The GOBI-based devices require the gobi loader available from the
+.Pa sysutils/gobi_loader
+port.