]> git.ipfire.org Git - people/stevee/network.git/blame - man/network-zone-config-pppoe-server.8.in
pppoe-server: Add documentation.
[people/stevee/network.git] / man / network-zone-config-pppoe-server.8.in
CommitLineData
0ed19ba0
MT
1.TH network-zone-config-pppoe-server 8 "24 Jun 2012" "@VERSION@" "network man page"
2
3.SH NAME
4network-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
11This configuration hook enables a \fBPPPoE server\fR functionality to
12a zone which is of an ethernet-like type.
13.PP
14The PPPoE server is mostly for development purpose and performs pretty
15well. However, it is not recommended to use it in production environments.
16.PP
17
18.SH OPTIONS
19The \fBpppoe-server\fR config hook offers various configuration options:
20
21\fB--subnet\fR = 10.0.0.0/24
22.RS 4
23The \fB--subnet=\fR option defines an IPv4 pool of which IP addresses
24are assigned to the remote hosts. The first address of the subnet
25will be used for the gateway which is the PPPoE server itself.
26.PP
27The subnet must at least have two IP addresses. Broadcast and network
28addresses will be used as well.
29.RE
30.PP
31
32\fB--mtu\fR = 1492
33.RS 4
34Set the required MTU (Maximum Transmission Unit) for the PPP connection.
35.PP
36The 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
42This options receives a string which will be used as the service name.
43The service name is sent out to the clients and used for identification
44but not authorization purposes.
45.PP
46The default is an empty.
47.RE
48.PP
49
50.SH SEE ALSO
51network(8), network-zone-config(8)
52
53.SH AUTHOR
54Michael Tremer (michael.tremer@ipfire.org)