From: Michael Tremer <michael.tremer@ipfire.org>
Date: Sat, 23 Jun 2012 22:57:57 +0000 (+0000)
Subject: pppoe-server: Add documentation.
X-Git-Tag: 004~7
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ed19ba032347d915a816b4c55845425e5d7c034;p=network.git

pppoe-server: Add documentation.
---

diff --git a/man/Makefile b/man/Makefile
index a9e07ac0..f73f80d5 100644
--- a/man/Makefile
+++ b/man/Makefile
@@ -32,6 +32,7 @@ MANPAGES8   = \
 	network-dns.8 \
 	network-zone.8 \
 	network-zone-bridge.8 \
+	network-zone-config-pppoe-server.8 \
 	network-zone-pppoe.8
 
 .PHONY: all
diff --git a/man/network-zone-config-pppoe-server.8.in b/man/network-zone-config-pppoe-server.8.in
new file mode 100644
index 00000000..0274fb38
--- /dev/null
+++ b/man/network-zone-config-pppoe-server.8.in
@@ -0,0 +1,54 @@
+.TH network-zone-config-pppoe-server 8 "24 Jun 2012" "@VERSION@" "network man page"
+
+.SH NAME
+network-zone-config-pppoe-server \- Network Configuration Control Program
+
+.SH SYNOPSIS
+\fBnetwork [OPTIONS] zone <zone> config create pppoe-server --subnet=...\fR
+.P
+
+.SH DESCRIPTION
+This configuration hook enables a \fBPPPoE server\fR functionality to
+a zone which is of an ethernet-like type.
+.PP
+The PPPoE server is mostly for development purpose and performs pretty
+well. However, it is not recommended to use it in production environments.
+.PP
+
+.SH OPTIONS
+The \fBpppoe-server\fR config hook offers various configuration options:
+
+\fB--subnet\fR = 10.0.0.0/24
+.RS 4
+The \fB--subnet=\fR option defines an IPv4 pool of which IP addresses
+are assigned to the remote hosts. The first address of the subnet
+will be used for the gateway which is the PPPoE server itself.
+.PP
+The subnet must at least have two IP addresses. Broadcast and network
+addresses will be used as well.
+.RE
+.PP
+
+\fB--mtu\fR = 1492
+.RS 4
+Set the required MTU (Maximum Transmission Unit) for the PPP connection.
+.PP
+The default value is 1492 bytes which is a common MTU for DSL connections.
+.RE
+.PP
+
+\fB--service-name\fR = ...
+.RS 4
+This options receives a string which will be used as the service name.
+The service name is sent out to the clients and used for identification
+but not authorization purposes.
+.PP
+The default is an empty.
+.RE
+.PP
+
+.SH SEE ALSO
+network(8), network-zone-config(8)
+
+.SH AUTHOR
+Michael Tremer (michael.tremer@ipfire.org)