projects / people / stevee / network.git / blame
| Commit | Line | Data |
|---|---|---|
| 0ed19ba0 MT |
1 | .TH network-zone-config-pppoe-server 8 "24 Jun 2012" "@VERSION@" "network man page" |
| 2 | ||
| 3 | .SH NAME | |
| 4 | network-zone-config-pppoe-server \- Network Configuration Control Program | |
| 5 | ||
| 6 | .SH SYNOPSIS | |
| 7 | \fBnetwork [OPTIONS] zone <zone> config create pppoe-server --subnet=...\fR | |
| 8 | .P | |
| 9 | ||
| 10 | .SH DESCRIPTION | |
| 11 | This configuration hook enables a \fBPPPoE server\fR functionality to | |
| 12 | a zone which is of an ethernet-like type. | |
| 13 | .PP | |
| 14 | The PPPoE server is mostly for development purpose and performs pretty | |
| 15 | well. However, it is not recommended to use it in production environments. | |
| 16 | .PP | |
| 17 | ||
| 18 | .SH OPTIONS | |
| 19 | The \fBpppoe-server\fR config hook offers various configuration options: | |
| 20 | ||
| 21 | \fB--subnet\fR = 10.0.0.0/24 | |
| 22 | .RS 4 | |
| 23 | The \fB--subnet=\fR option defines an IPv4 pool of which IP addresses | |
| 24 | are assigned to the remote hosts. The first address of the subnet | |
| 25 | will be used for the gateway which is the PPPoE server itself. | |
| 26 | .PP | |
| 27 | The subnet must at least have two IP addresses. Broadcast and network | |
| 28 | addresses will be used as well. | |
| 29 | .RE | |
| 30 | .PP | |
| 31 | ||
| 32 | \fB--mtu\fR = 1492 | |
| 33 | .RS 4 | |
| 34 | Set the required MTU (Maximum Transmission Unit) for the PPP connection. | |
| 35 | .PP | |
| 36 | The default value is 1492 bytes which is a common MTU for DSL connections. | |
| 37 | .RE | |
| 38 | .PP | |
| 39 | ||
| 40 | \fB--service-name\fR = ... | |
| 41 | .RS 4 | |
| 42 | This options receives a string which will be used as the service name. | |
| 43 | The service name is sent out to the clients and used for identification | |
| 44 | but not authorization purposes. | |
| 45 | .PP | |
| 46 | The default is an empty. | |
| 47 | .RE | |
| 48 | .PP | |
| 49 | ||
| 7ddd9b51 MT |
50 | \fB--max-sessions\fR = 0 |
| 51 | .RS 4 | |
| 52 | Limit the max. number of sessions that may be established by the same | |
| 53 | MAC address. | |
| 54 | .PP | |
| 55 | This must be a positive number. 0 permits an unlimited number of sessions | |
| 56 | per MAC address. | |
| 57 | .RE | |
| 58 | .PP | |
| 59 | ||
| 0ed19ba0 MT |
60 | .SH SEE ALSO |
| 61 | network(8), network-zone-config(8) | |
| 62 | ||
| 63 | .SH AUTHOR | |
| 64 | Michael Tremer (michael.tremer@ipfire.org) |