umb(4) man page tweaks

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

umb(4) man page tweaks

Stefan Sperling-5
Some information in the umb(4) man page seems to be outdated (IPV4 gateway
handling), or doesn't really belong in a man page ("please hack the driver
to add a device to a blacklist").

Also try to shorten the page a bit and move information about troublesome
devices to CAVEATS.

Index: umb.4
===================================================================
RCS file: /cvs/src/share/man/man4/umb.4,v
retrieving revision 1.1
diff -u -p -r1.1 umb.4
--- umb.4 15 Jun 2016 19:39:34 -0000 1.1
+++ umb.4 19 Jun 2016 12:58:24 -0000
@@ -26,44 +26,27 @@
 The
 .Nm
 driver provides support for USB MBIM devices.
-Those devices establish connections via celluar networks such as
-GPRS, UMTS, and LTE.
 .Pp
-The
-.Nm
-device appears as a regular point-to-point network interface,
+MBIM devices establish connections via cellular networks such as
+GPRS, UMTS, and LTE.
+They appear as a regular point-to-point network interface,
 transporting raw IP frames.
 .Pp
 Required configuration parameters like PIN and APN have to be set
-via
+with
 .Xr ifconfig 8 .
 Once the SIM card has been unlocked with the correct PIN, it
-will remain in this state until the device is power-cycled.
+will remain in this state until the MBIM device is power-cycled.
 In case the device is connected to an "always-on" USB port,
-it is possible to connect to a provider without entering the
-PIN again even afer a reboot of the system.
-.Pp
-If a default gateway route is configured for the
-.Nm
-network interface, the driver will modify the destination IP address
-dynamically, according to the information sent by the network provider.
+it may be possible to connect to a provider without entering the
+PIN again even if the system was rebooted.
 .Sh HARDWARE
-The following devices are known to be supported by the
-.Nm
-driver:
+The following devices should work:
 .Pp
 .Bl -tag -width Ds -offset indent -compact
 .It Tn Sierra Wireless EM8805
 .It Tn Sierra Wireless MC8305
 .El
-.Pp
-There are probably a lot more devices that also work flawlessly.
-If some devices fail to provide a confirming MBIM implementation,
-their vendor and product IDs should be added to the driver's blacklist
-manually.
-Since most devices offer multiple interfaces, blacklisted ones will
-probably be attached by some other driver, such as
-.Xr umsm 4 .
 .Sh SEE ALSO
 .Xr intro 4 ,
 .Xr netintro 4 ,
@@ -78,4 +61,8 @@ probably be attached by some other drive
 .Sh CAVEATS
 The
 .Nm
-driver currently does not support IPv6 addresses.
+driver does not support IPv6.
+.Pp
+Devices which fail to provide a confirming MBIM implementation will
+probably be attached by some other driver, such as
+.Xr umsm 4 .

Reply | Threaded
Open this post in threaded view
|

Re: umb(4) man page tweaks

Gerhard Roth-2
Hallo Stefan,

danke, dass Du Dich darum kuemmerst.

ok gerhard@


On Sun, 19 Jun 2016 15:03:13 +0200 Stefan Sperling <[hidden email]> wrote:

> Some information in the umb(4) man page seems to be outdated (IPV4 gateway
> handling), or doesn't really belong in a man page ("please hack the driver
> to add a device to a blacklist").
>
> Also try to shorten the page a bit and move information about troublesome
> devices to CAVEATS.
>
> Index: umb.4
> ===================================================================
> RCS file: /cvs/src/share/man/man4/umb.4,v
> retrieving revision 1.1
> diff -u -p -r1.1 umb.4
> --- umb.4 15 Jun 2016 19:39:34 -0000 1.1
> +++ umb.4 19 Jun 2016 12:58:24 -0000
> @@ -26,44 +26,27 @@
>  The
>  .Nm
>  driver provides support for USB MBIM devices.
> -Those devices establish connections via celluar networks such as
> -GPRS, UMTS, and LTE.
>  .Pp
> -The
> -.Nm
> -device appears as a regular point-to-point network interface,
> +MBIM devices establish connections via cellular networks such as
> +GPRS, UMTS, and LTE.
> +They appear as a regular point-to-point network interface,
>  transporting raw IP frames.
>  .Pp
>  Required configuration parameters like PIN and APN have to be set
> -via
> +with
>  .Xr ifconfig 8 .
>  Once the SIM card has been unlocked with the correct PIN, it
> -will remain in this state until the device is power-cycled.
> +will remain in this state until the MBIM device is power-cycled.
>  In case the device is connected to an "always-on" USB port,
> -it is possible to connect to a provider without entering the
> -PIN again even afer a reboot of the system.
> -.Pp
> -If a default gateway route is configured for the
> -.Nm
> -network interface, the driver will modify the destination IP address
> -dynamically, according to the information sent by the network provider.
> +it may be possible to connect to a provider without entering the
> +PIN again even if the system was rebooted.
>  .Sh HARDWARE
> -The following devices are known to be supported by the
> -.Nm
> -driver:
> +The following devices should work:
>  .Pp
>  .Bl -tag -width Ds -offset indent -compact
>  .It Tn Sierra Wireless EM8805
>  .It Tn Sierra Wireless MC8305
>  .El
> -.Pp
> -There are probably a lot more devices that also work flawlessly.
> -If some devices fail to provide a confirming MBIM implementation,
> -their vendor and product IDs should be added to the driver's blacklist
> -manually.
> -Since most devices offer multiple interfaces, blacklisted ones will
> -probably be attached by some other driver, such as
> -.Xr umsm 4 .
>  .Sh SEE ALSO
>  .Xr intro 4 ,
>  .Xr netintro 4 ,
> @@ -78,4 +61,8 @@ probably be attached by some other drive
>  .Sh CAVEATS
>  The
>  .Nm
> -driver currently does not support IPv6 addresses.
> +driver does not support IPv6.
> +.Pp
> +Devices which fail to provide a confirming MBIM implementation will
> +probably be attached by some other driver, such as
> +.Xr umsm 4 .

Reply | Threaded
Open this post in threaded view
|

Re: umb(4) man page tweaks

Gerhard Roth-2
On Mon, 20 Jun 2016 08:50:05 +0200 Gerhard Roth <[hidden email]> wrote:
> Hallo Stefan,
>
> danke, dass Du Dich darum kuemmerst.
>
> ok gerhard@

Sorry for the German. This mail was intended to go to Stefan only and not
the mailing list. My mistake.

Gerhard

>
>
> On Sun, 19 Jun 2016 15:03:13 +0200 Stefan Sperling <[hidden email]> wrote:
> > Some information in the umb(4) man page seems to be outdated (IPV4 gateway
> > handling), or doesn't really belong in a man page ("please hack the driver
> > to add a device to a blacklist").
> >
> > Also try to shorten the page a bit and move information about troublesome
> > devices to CAVEATS.
> >
> > Index: umb.4
> > ===================================================================
> > RCS file: /cvs/src/share/man/man4/umb.4,v
> > retrieving revision 1.1
> > diff -u -p -r1.1 umb.4
> > --- umb.4 15 Jun 2016 19:39:34 -0000 1.1
> > +++ umb.4 19 Jun 2016 12:58:24 -0000
> > @@ -26,44 +26,27 @@
> >  The
> >  .Nm
> >  driver provides support for USB MBIM devices.
> > -Those devices establish connections via celluar networks such as
> > -GPRS, UMTS, and LTE.
> >  .Pp
> > -The
> > -.Nm
> > -device appears as a regular point-to-point network interface,
> > +MBIM devices establish connections via cellular networks such as
> > +GPRS, UMTS, and LTE.
> > +They appear as a regular point-to-point network interface,
> >  transporting raw IP frames.
> >  .Pp
> >  Required configuration parameters like PIN and APN have to be set
> > -via
> > +with
> >  .Xr ifconfig 8 .
> >  Once the SIM card has been unlocked with the correct PIN, it
> > -will remain in this state until the device is power-cycled.
> > +will remain in this state until the MBIM device is power-cycled.
> >  In case the device is connected to an "always-on" USB port,
> > -it is possible to connect to a provider without entering the
> > -PIN again even afer a reboot of the system.
> > -.Pp
> > -If a default gateway route is configured for the
> > -.Nm
> > -network interface, the driver will modify the destination IP address
> > -dynamically, according to the information sent by the network provider.
> > +it may be possible to connect to a provider without entering the
> > +PIN again even if the system was rebooted.
> >  .Sh HARDWARE
> > -The following devices are known to be supported by the
> > -.Nm
> > -driver:
> > +The following devices should work:
> >  .Pp
> >  .Bl -tag -width Ds -offset indent -compact
> >  .It Tn Sierra Wireless EM8805
> >  .It Tn Sierra Wireless MC8305
> >  .El
> > -.Pp
> > -There are probably a lot more devices that also work flawlessly.
> > -If some devices fail to provide a confirming MBIM implementation,
> > -their vendor and product IDs should be added to the driver's blacklist
> > -manually.
> > -Since most devices offer multiple interfaces, blacklisted ones will
> > -probably be attached by some other driver, such as
> > -.Xr umsm 4 .
> >  .Sh SEE ALSO
> >  .Xr intro 4 ,
> >  .Xr netintro 4 ,
> > @@ -78,4 +61,8 @@ probably be attached by some other drive
> >  .Sh CAVEATS
> >  The
> >  .Nm
> > -driver currently does not support IPv6 addresses.
> > +driver does not support IPv6.
> > +.Pp
> > +Devices which fail to provide a confirming MBIM implementation will
> > +probably be attached by some other driver, such as
> > +.Xr umsm 4 .