ppp.8: Fix typo cuad0 -> cuau0

Fix a typo that was missed probably because it was capitalized.
Mark up with .Pa and fix capitalization.

Specify that cuaUX and cuauX are for USB and UART attachments
respectively.

- Silence most lint warnings
- Update outdated links
- Minor style fixes
- Some igor(1) warnings were ignored on purpose

PR:		248359
Reviewed by:	imp, mhorne, Alexander Ziaee <concussious.bugzilla@runbox.com>
Approved by:	emaste (mentor)
Fixes:	839f11a4fe ("A number of places in the source tree still reference cuad.* after sio(4) was deprecated by uart(4).")
MFC after:	1 week
Pull Request:	https://github.com/freebsd/freebsd-src/pull/1515
This commit is contained in:
Jose Luis Duran 2024-11-05 04:07:07 +00:00
parent 5399052c63
commit 21ca690b56
No known key found for this signature in database
GPG Key ID: 5415E244477475CC

View File

@ -23,7 +23,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd June 27, 2022 .Dd November 18, 2024
.Dt PPP 8 .Dt PPP 8
.Os .Os
.Sh NAME .Sh NAME
@ -263,7 +263,8 @@ will force it to exit.
.It Supports client callback. .It Supports client callback.
.Nm .Nm
can use either the standard LCP callback protocol or the Microsoft can use either the standard LCP callback protocol or the Microsoft
CallBack Control Protocol (https://winprotocoldoc.blob.core.windows.net/productionwindowsarchives/MS-CBCP/[MS-CBCP].pdf). CallBack Control Protocol
.Pq Lk https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net/MS-CBCP/%5bMS-CBCP%5d.pdf .
.It Supports NAT or packet aliasing. .It Supports NAT or packet aliasing.
Packet aliasing (a.k.a.\& IP masquerading) allows computers on a Packet aliasing (a.k.a.\& IP masquerading) allows computers on a
private, unregistered network to access the Internet. private, unregistered network to access the Internet.
@ -339,7 +340,7 @@ to check the packet flow over the
link. link.
.It Supports PPP over TCP and PPP over UDP. .It Supports PPP over TCP and PPP over UDP.
If a device name is specified as If a device name is specified as
.Em host Ns No : Ns Em port Ns .Em host : Ns Em port Ns
.Xo .Xo
.Op / Ns tcp|udp , .Op / Ns tcp|udp ,
.Xc .Xc
@ -353,7 +354,7 @@ into synchronous mode.
If If
.Nm .Nm
is given a device specification of the format is given a device specification of the format
.No PPPoE: Ns Ar iface Ns Xo .No PPPoE\&: Ns Ar iface Ns Xo
.Op \&: Ns Ar provider Ns .Op \&: Ns Ar provider Ns
.Xc .Xc
and if and if
@ -2166,13 +2167,22 @@ set device /dev/cuau0
set speed 115200 set speed 115200
.Ed .Ed
.Pp .Pp
Cuad0 is the first serial port on .Pa cuaU0
.Fx . and
.Pa cuau0
are the first
.Xr usb 4
and
.Xr uart 4
serial ports found by
.Fx ,
respectively.
If you are running If you are running
.Nm .Nm
on on
.Ox , .Ox ,
cua00 is the first. .Pa cua00
is the first.
A speed of 115200 should be specified A speed of 115200 should be specified
if you have a modem capable of bit rates of 28800 or more. if you have a modem capable of bit rates of 28800 or more.
In general, the serial speed should be about four times the modem speed. In general, the serial speed should be about four times the modem speed.
@ -2734,7 +2744,7 @@ Default: Disabled and Denied.
This option allows DNS negotiation. This option allows DNS negotiation.
.Pp .Pp
If If
.Dq enable Ns No d, .Dq enable Ns No d ,
.Nm .Nm
will request that the peer confirms the entries in will request that the peer confirms the entries in
.Pa /etc/resolv.conf . .Pa /etc/resolv.conf .
@ -2743,7 +2753,7 @@ If the peer NAKs our request (suggesting new IP numbers),
is updated and another request is sent to confirm the new entries. is updated and another request is sent to confirm the new entries.
.Pp .Pp
If If
.Dq accept Ns No ed, .Dq accept Ns No ed ,
.Nm .Nm
will answer any DNS queries requested by the peer rather than rejecting will answer any DNS queries requested by the peer rather than rejecting
them. them.
@ -3446,8 +3456,7 @@ This command gives a summary of available nat commands.
This option causes various NAT statistics and information to This option causes various NAT statistics and information to
be logged to the file be logged to the file
.Pa /var/log/alias.log . .Pa /var/log/alias.log .
.It nat port Ar proto Ar targetIP Ns Xo .It nat port Ar proto Ar targetIP Ns Xo : Ns Ar targetPort Ns
.No : Ns Ar targetPort Ns
.Oo .Oo
.No - Ns Ar targetPort .No - Ns Ar targetPort
.Oc Ar aliasPort Ns .Oc Ar aliasPort Ns
@ -4390,8 +4399,8 @@ This is required (in addition to one or more other callback
options) if you wish callback to be optional. options) if you wish callback to be optional.
.El .El
.It set cbcp Oo .It set cbcp Oo
.No *| Ns Ar number Ns Oo .No *| Ns Ar number Ns
.No , Ns Ar number Ns ...\& Oc .Oo , Ns Ar number Ns ...\& Oc
.Op Ar delay Op Ar retry .Op Ar delay Op Ar retry
.Oc .Oc
If no arguments are given, CBCP (Microsoft's CallBack Control Protocol) If no arguments are given, CBCP (Microsoft's CallBack Control Protocol)
@ -4403,7 +4412,7 @@ requesting no callback in the CBCP phase.
Otherwise, Otherwise,
.Nm .Nm
attempts to use the given phone attempts to use the given phone
.Ar number Ns No (s). .Ar number Ns No (s) .
.Pp .Pp
In server mode In server mode
.Pq Fl direct , .Pq Fl direct ,
@ -4421,7 +4430,7 @@ is specified,
.Nm .Nm
will expect the peer to specify the number. will expect the peer to specify the number.
.It set cd Oo .It set cd Oo
.No off| Ns Ar seconds Ns Op !\& .No off\&| Ns Ar seconds Ns Op !\&
.Oc .Oc
Normally, Normally,
.Nm .Nm
@ -4578,7 +4587,7 @@ does not begin with
it must either begin with an exclamation mark it must either begin with an exclamation mark
.Pq Dq !\& , .Pq Dq !\& ,
be of the format be of the format
.No PPPoE: Ns Ar iface Ns Xo .No PPPoE\&: Ns Ar iface Ns Xo
.Op \&: Ns Ar provider Ns .Op \&: Ns Ar provider Ns
.Xc .Xc
(on (on
@ -4596,7 +4605,7 @@ Standard input, output and error are fed back to
and are read and written as if they were a regular device. and are read and written as if they were a regular device.
.Pp .Pp
If a If a
.No PPPoE: Ns Ar iface Ns Xo .No PPPoE\&: Ns Ar iface Ns Xo
.Op \&: Ns Ar provider Ns .Op \&: Ns Ar provider Ns
.Xc .Xc
specification is given, specification is given,
@ -4635,7 +4644,7 @@ and
for further details. for further details.
.Pp .Pp
If a If a
.Ar host Ns No : Ns Ar port Ns Oo .Ar host : Ns Ar port Ns Oo
.No /tcp|udp .No /tcp|udp
.Oc .Oc
specification is given, specification is given,
@ -4864,7 +4873,7 @@ It allows the user to specify a set of characters that will be
.Sq escaped .Sq escaped
as they travel across the link. as they travel across the link.
.It set filter dial|alive|in|out Ar rule-no Xo .It set filter dial|alive|in|out Ar rule-no Xo
.No permit|deny|clear| Ns Ar rule-no .No permit|deny|clear\&| Ns Ar rule-no
.Op !\& .Op !\&
.Oo Op host .Oo Op host
.Ar src_addr Ns Op / Ns Ar width .Ar src_addr Ns Op / Ns Ar width