From: Michael Tremer Date: Sun, 31 Mar 2019 15:15:50 +0000 (+0200) Subject: man: Convert network-zone-config-pppoe-server(8) to asciidoc X-Git-Url: http://git.ipfire.org/?p=people%2Fms%2Fnetwork.git;a=commitdiff_plain;h=718371b565fdb93719f68b5a2dcf719dd57a4e93 man: Convert network-zone-config-pppoe-server(8) to asciidoc Signed-off-by: Michael Tremer --- diff --git a/man/network-zone-config-pppoe-server.txt b/man/network-zone-config-pppoe-server.txt new file mode 100644 index 00000000..72dff8e1 --- /dev/null +++ b/man/network-zone-config-pppoe-server.txt @@ -0,0 +1,50 @@ += network-zone-config-pppoe-server(8) + +== NAME +network-zone-config-pppoe-server - PPPoE Server Settings + +== SYNOPSIS +[verse] +`network zone ZONE config create pppoe-server ...` +`network zone ZONE config pppoe-server edit ...` + +== DESCRIPTION +This configuration hook enables a **PPPoE Server** on a zone. + +== OPTIONS +The following options are understood: + +`--subnet=SUBNET`:: + The `--subnet` 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. + + + The subnet must at least have two IP addresses. + +`--mtu=MTU`:: + Set the required MTU (Maximum Transmission Unit) for the PPP connection. + The default value is 1492 bytes which is a common MTU for DSL connections. + +`--service-name=SERVICE NAME`:: + This option 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 authorisation purposes. + + + The default is an empty value. + +`--max-sessions=0`:: + Limit the number of sessions that may be established by the same MAC address. + This must be a positive number. + 0 permits an unlimited number of sessions per MAC address. + +== EXAMPLES + +This command creates a PPPoE server that will assign an IP address from the +192.168.0.0/16 subnet: + + network zone net0 config create pppoe-server --subnet=192.168.0.0/16 + +== SEE ALSO +link:network[8], +link:network-zone[8], +link:network-zone-config[8] diff --git a/man/network-zone-config-pppoe-server.xml b/man/network-zone-config-pppoe-server.xml deleted file mode 100644 index e6d497ee..00000000 --- a/man/network-zone-config-pppoe-server.xml +++ /dev/null @@ -1,143 +0,0 @@ - - - - - - network-zone-config-pppoe-server - network - - - - Developer - Michael - Tremer - michael.tremer@ipfire.org - - - - - - network-zone-config-pppoe-server - 8 - - - - network-zone-config-pppoe-server - Network Configuration Control Program - - - - - network zone ZONE config create pppoe-server ... - - - - - Description - - - This configuration hook enables a PPPoE server - functionality to a zone which is of an ethernet-like type. - - - The PPPoE server is mostly for development purpose and performs pretty - well. However, it is not recommended to use it in production environments. - - - - - Options - - - The following options are understood: - - - - - - - - - - - The 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. - - - The subnet must at least have two IP addresses. - Broadcast and network addresses will be used as well. - - - - - - - - - - - - Set the required MTU (Maximum Transmission Unit) for - the PPP connection. - - - The default value is 1492 bytes which is a common MTU for - DSL connections. - - - - - - - - - - - - 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. - - - The default is an empty value. - - - - - - - - - - - - Limit the max. number of sessions that may be established - by the same MAC address. - - - This must be a positive number. 0 permits an unlimited - number of sessions per MAC address. - - - - - - - - See Also - - - - network - 8 - , - - network-zone-config - 8 - - - -