View | Details | Raw Unified | Return to bug 66770
Collapse All | Expand All

(-)share/man/man4/ng_pppoe.4 (-19 / +24 lines)
Lines 51-57 Link Here
51 
It is used in conjunction with the
 51 
It is used in conjunction with the
52 
.Xr netgraph 4
 52 
.Xr netgraph 4
53 
extensions to the Ethernet framework to divert and inject Ethernet packets
 53 
extensions to the Ethernet framework to divert and inject Ethernet packets
54 
to and from a PPP agent (which is not specified).
 54 
to and from a PPP agent
55 
.Pq which is not specified .
55 
.Pp
 56 
.Pp
56 
The
 57 
The
57 
.Dv NGM_PPPOE_GET_STATUS
 58 
.Dv NGM_PPPOE_GET_STATUS
Lines 88-112 Link Here
88 
};
 89 
};
89 
.Ed
 90 
.Ed
90 
.It Dv NGM_TEXT_STATUS
 91 
.It Dv NGM_TEXT_STATUS
91 
This generic message returns is a human-readable version of the node status.
 92 
This generic message returns a human-readable version of the node status.
92 
(not yet)
 93 
.Pq not yet
93 
.It Dv NGM_PPPOE_CONNECT
 94 
.It Dv NGM_PPPOE_CONNECT
94 
Tell a nominated newly created hook that it's session should enter
 95 
Tell a nominated newly created hook that its session should enter
95 
the state machine in a manner to become a client.
 96 
the state machine as a client.
96 
It must be newly created and
 97 
It must be newly created and
97 
a service name can be given as an argument.
 98 
a service name can be given as an argument.
98 
It is legal to specify a zero length service name.
 99 
It is legal to specify a zero-length service name.
99 
This is common on some DSL setups.
 100 
This is common on some DSL setups.
100 
A session request packet will be broadcast on the Ethernet.
 101 
A session request packet will be broadcast on the Ethernet.
101 
This command uses the
 102 
This command uses the
102 
.Dv ngpppoe_init_data
 103 
.Dv ngpppoe_init_data
103 
structure shown below.
 104 
structure shown below.
104 
.It Dv NGM_PPPOE_LISTEN
 105 
.It Dv NGM_PPPOE_LISTEN
105 
Tell a nominated newly created hook that it's session should enter
 106 
Tell a nominated newly created hook that its session should enter
106 
the state machine in a manner to become a server listener.
 107 
the state machine as a server listener.
107 
The argument
 108 
The argument
108 
given is the name of the service to listen on behalf of
 109 
given is the name of the service to listen for.
109 
a zero length service length will match all requests for service.
 110 
A zero-length service length will match all requests for service.
110 
A matching service request
 111 
A matching service request
111 
packet will be passed unmodified back to the process responsible
 112 
packet will be passed unmodified back to the process responsible
112 
for starting the service.
 113 
for starting the service.
Lines 116-129 Link Here
116 
.Dv ngpppoe_init_data
 117 
.Dv ngpppoe_init_data
117 
structure shown below.
 118 
structure shown below.
118 
.It Dv NGM_PPPOE_OFFER
 119 
.It Dv NGM_PPPOE_OFFER
119 
Tell a nominated newly created hook that it's session should enter
 120 
Tell a nominated newly created hook that its session should enter
120 
the state machine in a manner to become a server.
 121 
the state machine as a server.
121 
The argument given is the name of the service to offer.
 122 
The argument given is the name of the service to offer.
122 
A zero length service
 123 
A zero-length service
123 
is legal.
 124 
is legal.
124 
The State machine will progress to a state where it will await
 125 
The State machine will progress to a state where it will await
125 
a request packet to be forwarded to it from  the startup server,
 126 
a request packet to be forwarded to it from the startup server,
126 
which in turn probably received it from a LISTEN mode hook ( see above).
 127 
which in turn probably received it from a LISTEN mode hook
128 
.Pq see above .
127 
This is so
 129 
This is so
128 
that information that is required for the session that is embedded in
 130 
that information that is required for the session that is embedded in
129 
the original session request packet, is made available to the state machine
 131 
the original session request packet, is made available to the state machine
Lines 148-161 Link Here
148 
This message reports successful Session negotiation.
 150 
This message reports successful Session negotiation.
149 
It uses the structure shown below, and
 151 
It uses the structure shown below, and
150 
reports back the hook name corresponding to the successful session.
 152 
reports back the hook name corresponding to the successful session.
151 
.It Dv NGM_NGM_PPPOE_FAIL
 153 
.It Dv NGM_PPPOE_FAIL
152 
This command is sent to the node that started this session with one of the
 154 
This command is sent to the node that started this session with one of the
153 
above messages, and reports a state change.
 155 
above messages, and reports a state change.
154 
This message reports failed Session negotiation.
 156 
This message reports failed Session negotiation.
155 
It uses the structure shown below, and
 157 
It uses the structure shown below, and
156 
reports back the hook name corresponding to the failed session.
 158 
reports back the hook name corresponding to the failed session.
157 
The hook will probably have been removed immediately after sending this message
 159 
The hook will probably have been removed immediately after sending this
158 
.It Dv NGM_NGM_PPPOE_CLOSE
 160 
message.
161 
.It Dv NGM_PPPOE_CLOSE
159 
This command is sent to the node that started this session with one of the
 162 
This command is sent to the node that started this session with one of the
160 
above messages, and reports a state change.
 163 
above messages, and reports a state change.
161 
This message reports a request to close a session.
 164 
This message reports a request to close a session.
Lines 163-169 Link Here
163 
reports back the hook name corresponding to the closed session.
 166 
reports back the hook name corresponding to the closed session.
164 
The hook will probably have been removed immediately after sending this
 167 
The hook will probably have been removed immediately after sending this
165 
message.
 168 
message.
166 
At present this message is not yet used and a 'failed' message
 169 
At present this message is not yet used and a
170 
.Dv NGM_PPPOE_FAIL
171 
message
167 
will be received at closure instead.
 172 
will be received at closure instead.
168 
.It Dv NGM_PPPOE_ACNAME
 173 
.It Dv NGM_PPPOE_ACNAME
169 
This command is sent to the node that started this session with one of the
 174 
This command is sent to the node that started this session with one of the

Return to bug 66770