diff --git a/libexec/pppoed/pppoed.8 b/libexec/pppoed/pppoed.8 index 0f7802c3fc80..c54aa4643374 100644 --- a/libexec/pppoed/pppoed.8 +++ b/libexec/pppoed/pppoed.8 @@ -46,8 +46,8 @@ The program listens to the given .Ar interface for PPP over Ethernet (PPPoE) service request packets, and actions them -by negotiating a session then envoking a -.Em PPP +by negotiating a session then invoking a +.Xr ppp 8 program. The negotiation is implemented by the .Dq pppoe @@ -61,7 +61,7 @@ will only offer services to clients requesting services from the given .Ar provider , which is taken as an empty name if not provided. If a provider name of -.Dq \&* +.Dq * is given, any PPPoE requests will be offered service. .Pp The supplied @@ -73,7 +73,7 @@ is given, the current base hostname is used. .Pp After receiving a request (PADI) from the PPPoE netgraph node, .Nm -.Xr fork 2 Ns No s +.Xr fork 2 Ns s a child process and returns to service further requests. The child process offers service (using @@ -81,11 +81,13 @@ The child process offers service and waits for a .Dv SUCCESS indication from the PPPoE node. -On receipt of the SUCCESS indication, +On receipt of the +.Dv SUCCESS +indication, .Nm will execute .Pp -.D1 Ic exec /usr/sbin/ppp -direct Ar label +.D1 Ic exec Pa /usr/sbin/ppp Fl direct Ar label .Pp as a shell sub-process. If @@ -109,7 +111,7 @@ data socket when started. .Pp The environment variable -.Dv HISMACADDR +.Ev HISMACADDR is made available to the child process and is set to the MAC address of the peer. .Pp @@ -120,7 +122,7 @@ will attach a netgraph node to the relevant .Dq ether node using -.Dq Ar interface Ns No \&: +.Dq Ar interface Ns \&: as the node name, and then connect that .Dq pppoe node to a local @@ -128,24 +130,24 @@ node to a local node. If the .Fl F -flag has not been given, +option has not been given, .Nm will then go into the background and disassociate itself from the controlling terminal. When the .Fl F -flag is given, +option is given, .Nm stays in the foreground. .Pp If the .Fl d -flag is given, additional diagnostics are provided (see the +option is given, additional diagnostics are provided (see the .Sx DIAGNOSTICS section below). If the .Fl n -flag is given, +option is given, .Fn NgSetDebug is called with an argument of .Ar ngdebug . @@ -165,11 +167,11 @@ uses to report all incoming connections. If the .Fl d -flag is given, +option is given, .Nm will report on the child processes creation of a new netgraph socket, it's service offer and the invocation of the -.Em PPP +.Xr ppp 8 program. If the .Fl n @@ -178,14 +180,15 @@ option is given, netgraph diagnostic messages are also redirected to .Pp It is sometimes useful to add the following to .Pa /etc/syslog.conf : -.Pp -.Dl !pppoed -.Dl "*.* /var/log/pppoed.log +.Bd -literal -offset indent +!pppoed +*.* /var/log/pppoed.log +.Ed .Pp and the following to .Pa /etc/newsyslog.conf : .Pp -.Dl "/var/log/pppoed.log 640 3 100 * Z +.Dl "/var/log/pppoed.log 640 3 100 * Z" .Sh SEE ALSO .Xr NgSetDebug 3 , .Xr netgraph 4 ,