Date: Mon, 17 May 2004 10:46:54 -0700 (PDT) From: Michel Lavondès <fox@vader.aacc.cc.md.us> To: freebsd-gnats-submit@FreeBSD.org Subject: docs/66770: [patch] share/man/man4/ng_pppoe.4 tyops, grammar, and mdoc(7) vigilantism. Message-ID: <200405171746.i4HHksJZ075487@www.freebsd.org> Resent-Message-ID: <200405171750.i4HHoBBX095849@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 66770 >Category: docs >Synopsis: [patch] share/man/man4/ng_pppoe.4 tyops, grammar, and mdoc(7) vigilantism. >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Mon May 17 10:50:10 PDT 2004 >Closed-Date: >Last-Modified: >Originator: Michel Lavondès >Release: 4.8-RELEASE-p13 >Organization: Ecdysiasts United For Overdressing >Environment: >Description: Patch says it all, really >How-To-Repeat: man 4 ng_pppoe on -current >Fix: Also at http://www.livejournal.com/users/pauamma/3175.html --- share/man/man4/ng_pppoe.4.orig Sat May 8 10:57:52 2004 +++ share/man/man4/ng_pppoe.4 Sat May 8 11:44:39 2004 @@ -51,7 +51,8 @@ It is used in conjunction with the .Xr netgraph 4 extensions to the Ethernet framework to divert and inject Ethernet packets -to and from a PPP agent (which is not specified). +to and from a PPP agent +.Pq which is not specified . .Pp The .Dv NGM_PPPOE_GET_STATUS @@ -88,25 +89,25 @@ }; .Ed .It Dv NGM_TEXT_STATUS -This generic message returns is a human-readable version of the node status. -(not yet) +This generic message returns a human-readable version of the node status. +.Pq not yet .It Dv NGM_PPPOE_CONNECT -Tell a nominated newly created hook that it's session should enter -the state machine in a manner to become a client. +Tell a nominated newly created hook that its session should enter +the state machine as a client. It must be newly created and a service name can be given as an argument. -It is legal to specify a zero length service name. +It is legal to specify a zero-length service name. This is common on some DSL setups. A session request packet will be broadcast on the Ethernet. This command uses the .Dv ngpppoe_init_data structure shown below. .It Dv NGM_PPPOE_LISTEN -Tell a nominated newly created hook that it's session should enter -the state machine in a manner to become a server listener. +Tell a nominated newly created hook that its session should enter +the state machine as a server listener. The argument -given is the name of the service to listen on behalf of -a zero length service length will match all requests for service. +given is the name of the service to listen for. +A zero-length service length will match all requests for service. A matching service request packet will be passed unmodified back to the process responsible for starting the service. @@ -116,14 +117,15 @@ .Dv ngpppoe_init_data structure shown below. .It Dv NGM_PPPOE_OFFER -Tell a nominated newly created hook that it's session should enter -the state machine in a manner to become a server. +Tell a nominated newly created hook that its session should enter +the state machine as a server. The argument given is the name of the service to offer. -A zero length service +A zero-length service is legal. The State machine will progress to a state where it will await -a request packet to be forwarded to it from the startup server, -which in turn probably received it from a LISTEN mode hook ( see above). +a request packet to be forwarded to it from the startup server, +which in turn probably received it from a LISTEN mode hook +.Pq see above . This is so that information that is required for the session that is embedded in the original session request packet, is made available to the state machine @@ -148,14 +150,15 @@ This message reports successful Session negotiation. It uses the structure shown below, and reports back the hook name corresponding to the successful session. -.It Dv NGM_NGM_PPPOE_FAIL +.It Dv NGM_PPPOE_FAIL This command is sent to the node that started this session with one of the above messages, and reports a state change. This message reports failed Session negotiation. It uses the structure shown below, and reports back the hook name corresponding to the failed session. -The hook will probably have been removed immediately after sending this message -.It Dv NGM_NGM_PPPOE_CLOSE +The hook will probably have been removed immediately after sending this +message. +.It Dv NGM_PPPOE_CLOSE This command is sent to the node that started this session with one of the above messages, and reports a state change. This message reports a request to close a session. @@ -163,7 +166,9 @@ reports back the hook name corresponding to the closed session. The hook will probably have been removed immediately after sending this message. -At present this message is not yet used and a 'failed' message +At present this message is not yet used and a +.Dv NGM_PPPOE_FAIL +message will be received at closure instead. .It Dv NGM_PPPOE_ACNAME This command is sent to the node that started this session with one of the >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?200405171746.i4HHksJZ075487>