| pppoed.8 (79754) | pppoed.8 (80728) |
|---|---|
| 1.\"- | 1.\"- |
| 2.\" Copyright (c) 1999 Brian Somers | 2.\" Copyright (c) 1999-2001 Brian Somers <brian@Awfulhak.org> |
| 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright --- 7 unchanged lines hidden (view full) --- 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" | 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. 10.\" 2. Redistributions in binary form must reproduce the above copyright --- 7 unchanged lines hidden (view full) --- 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" |
| 26.\" $FreeBSD: head/libexec/pppoed/pppoed.8 79754 2001-07-15 07:53:42Z dd $ | 26.\" $FreeBSD: head/libexec/pppoed/pppoed.8 80728 2001-07-31 11:45:53Z brian $ |
| 27.\" 28.Dd November 8, 1999 29.Dt PPPOED 8 30.Os 31.Sh NAME 32.Nm pppoed 33.Nd handle incoming PPP over Ethernet connections 34.Sh SYNOPSIS 35.Nm 36.Op Fl Fd\& 37.Op Fl P Ar pidfile 38.Op Fl a Ar name | 27.\" 28.Dd November 8, 1999 29.Dt PPPOED 8 30.Os 31.Sh NAME 32.Nm pppoed 33.Nd handle incoming PPP over Ethernet connections 34.Sh SYNOPSIS 35.Nm 36.Op Fl Fd\& 37.Op Fl P Ar pidfile 38.Op Fl a Ar name |
| 39.Op Fl e Ar exec | 39.Op Fl e Ar exec No \&| Fl l Ar label |
| 40.Op Fl n Ar ngdebug 41.Op Fl p Ar provider 42.Ar interface 43.Sh DESCRIPTION 44The 45.Nm 46program listens to the given 47.Ar interface 48for PPP over Ethernet (PPPoE) service request packets, and actions them 49by negotiating a session then envoking a 50.Em PPP | 40.Op Fl n Ar ngdebug 41.Op Fl p Ar provider 42.Ar interface 43.Sh DESCRIPTION 44The 45.Nm 46program listens to the given 47.Ar interface 48for PPP over Ethernet (PPPoE) service request packets, and actions them 49by negotiating a session then envoking a 50.Em PPP |
| 51program. The negotiation is implemented by the | 51program. 52The negotiation is implemented by the |
| 52.Dq pppoe | 53.Dq pppoe |
| 53netgraph node. See | 54netgraph node. 55See |
| 54.Xr ng_pppoe 4 55for details. 56.Pp 57.Nm 58will only offer services to clients requesting services from the given 59.Ar provider , 60which is taken as an empty name if not provided. 61If a provider name of 62.Dq \&* 63is given, any PPPoE requests will be offered service. 64.Pp 65The supplied 66.Ar name | 56.Xr ng_pppoe 4 57for details. 58.Pp 59.Nm 60will only offer services to clients requesting services from the given 61.Ar provider , 62which is taken as an empty name if not provided. 63If a provider name of 64.Dq \&* 65is given, any PPPoE requests will be offered service. 66.Pp 67The supplied 68.Ar name |
| 67will be given as the access concentrator name when establishing the 68connection. If no | 69will be given as the access concentrator name when establishing the connection. 70If no |
| 69.Ar name 70is given, the current base hostname is used. 71.Pp 72After receiving a request (PADI) from the PPPoE netgraph node, 73.Nm 74.Xr fork 2 Ns No s | 71.Ar name 72is given, the current base hostname is used. 73.Pp 74After receiving a request (PADI) from the PPPoE netgraph node, 75.Nm 76.Xr fork 2 Ns No s |
| 75a child process and returns to service further requests. The child process 76offers service | 77a child process and returns to service further requests. 78The child process offers service |
| 77.Pq using Ar name 78and waits for a 79.Dv SUCCESS | 79.Pq using Ar name 80and waits for a 81.Dv SUCCESS |
| 80indication from the PPPoE node. On receipt of the SUCCESS indication, | 82indication from the PPPoE node. 83On receipt of the SUCCESS indication, |
| 81.Nm 82will execute 83.Pp | 84.Nm 85will execute 86.Pp |
| 84.D1 Ic exec /usr/sbin/ppp -direct Ar provider | 87.D1 Ic exec /usr/sbin/ppp -direct Ar label |
| 85.Pp | 88.Pp |
| 86as a shell sub-process. It is possible to specify another command using the | 89as a shell sub-process. 90If 91.Ar label 92has not been specified, it defaults to 93.Ar provider . 94It is possible to specify another command using the |
| 87.Ar exec | 95.Ar exec |
| 88argument. This is mandatory if | 96argument. 97This is mandatory if |
| 89.Ar provider | 98.Ar provider |
| 90is not given. The child process will have standard input and standard output | 99and 100.Ar label 101are not given. 102The child process will have standard input and standard output |
| 91attached to the same 92.Xr netgraph 4 93data socket 94.Pq see Xr ng_socket 4 95when started. 96.Pp 97Upon invocation, 98.Nm 99will attach a 100.Dq pppoe 101netgraph node to the relevant 102.Dq ether 103node using 104.Dq Ar interface Ns No \&: 105as the node name, and then connect that 106.Dq pppoe 107node to a local 108.Dq socket | 103attached to the same 104.Xr netgraph 4 105data socket 106.Pq see Xr ng_socket 4 107when started. 108.Pp 109Upon invocation, 110.Nm 111will attach a 112.Dq pppoe 113netgraph node to the relevant 114.Dq ether 115node using 116.Dq Ar interface Ns No \&: 117as the node name, and then connect that 118.Dq pppoe 119node to a local 120.Dq socket |
| 109node. If the | 121node. 122If the |
| 110.Fl F 111flag has not been given, 112.Nm 113will then go into the background and disassociate itself from the controlling | 123.Fl F 124flag has not been given, 125.Nm 126will then go into the background and disassociate itself from the controlling |
| 114terminal. When the | 127terminal. 128When the |
| 115.Fl F 116flag is given, 117.Nm 118stays in the foreground. 119.Pp 120If the 121.Fl d 122flag is given, additional diagnostics are provided (see the --- 13 unchanged lines hidden (view full) --- 136will write its process ID to this file on startup. 137.Sh DIAGNOSTICS 138After creating the necessary 139.Xr netgraph 4 140nodes as described above, 141.Nm 142uses 143.Xr syslogd 8 | 129.Fl F 130flag is given, 131.Nm 132stays in the foreground. 133.Pp 134If the 135.Fl d 136flag is given, additional diagnostics are provided (see the --- 13 unchanged lines hidden (view full) --- 150will write its process ID to this file on startup. 151.Sh DIAGNOSTICS 152After creating the necessary 153.Xr netgraph 4 154nodes as described above, 155.Nm 156uses 157.Xr syslogd 8 |
| 144to report all incoming connections. If the | 158to report all incoming connections. 159If the |
| 145.Fl d 146flag is given, 147.Nm 148will report on the child processes creation of a new netgraph socket, it's 149service offer and the invocation of the 150.Em PPP 151program. 152If the --- 18 unchanged lines hidden (view full) --- 171.Xr ng_pppoe 4 , 172.Xr ng_socket 4 , 173.Xr syslog.conf 5 , 174.Xr ppp 8 , 175.Xr syslogd 8 176.Sh BUGS 177If another netgraph node is using the given interface, 178.Nm | 160.Fl d 161flag is given, 162.Nm 163will report on the child processes creation of a new netgraph socket, it's 164service offer and the invocation of the 165.Em PPP 166program. 167If the --- 18 unchanged lines hidden (view full) --- 186.Xr ng_pppoe 4 , 187.Xr ng_socket 4 , 188.Xr syslog.conf 5 , 189.Xr ppp 8 , 190.Xr syslogd 8 191.Sh BUGS 192If another netgraph node is using the given interface, 193.Nm |
| 179will fail to start. This is because | 194will fail to start. 195This is because |
| 180.Xr netgraph 4 | 196.Xr netgraph 4 |
| 181does not currently allow node chaining. This may change in the future. | 197does not currently allow node chaining. 198This may change in the future. |
| 182.Sh HISTORY 183The 184.Nm 185program was written by 186.An Brian Somers Aq brian@Awfulhak.org 187and first appeared in 188.Fx 3.4 . | 199.Sh HISTORY 200The 201.Nm 202program was written by 203.An Brian Somers Aq brian@Awfulhak.org 204and first appeared in 205.Fx 3.4 . |