]> git.ipfire.org Git - people/ms/network.git/blame - man/network-zone-pppoe.8.in
route: Add documentation.
[people/ms/network.git] / man / network-zone-pppoe.8.in
CommitLineData
97cb552e
MT
1.TH network-zone-pppoe 8 "21 Jun 2012" "@VERSION@" "network man page"
2
3.SH NAME
4network-zone-pppoe \- Network Configuration Control Program
5
6.SH SYNOPSIS
7\fBnetwork [OPTIONS] zone create <zone> pppoe ...\fR
8.P
9All options may be edited on zones which have already been set up with the \fBpppoe\fR hook:
10.P
11\fBnetwork [OPTIONS] zone <zone> edit ...\fR
12
13.SH DESCRIPTION
14The pppoe hook creates a PPPoE connection to your ISP.
15.PP
16
17.SH OPTIONS
18The \fBpppoe\fR hook offers various configuration options:
19
20\fB--port\fR = ...
21.RS 4
22This options sets the port, pppd is using to connect to the modem.
23.PP
24This may be a normal ethernet or vlan interface.
25.RE
26.PP
27
28\fB--username\fR = ...
29.RS 4
30Sets the username for authentication.
31.RE
32.PP
33
34\fB--password\fR = ...
35.RS 4
36Sets the password for authentication.
37.PP
38Use the \fB--auth=\fR option to transmit it in a secure manner to the provider.
39.RE
40.PP
41
42\fB--mtu\fR = 1492
43.RS 4
44Sets the default MTU of the PPP connection. The default value is 1492 which is
45a common MTU used for DSL.
46.RE
47.PP
48
49\fB--auth\fR = [chap|pap]
50.RS 4
51Define the authentication method that is used to authenticate
52against your provider. The default is to use the provider's preference.
53.PP
54* \fBChallange-Handshake Authentication Protocol\fR (chap) is the preferred
55secure method.
56.PP
57* \fBPassword Authentication Protocol\fR (pap) sends the plaintext password
58to the authentication server which is the reason why it should be avoided
59to use PAP.
60.RE
61.PP
62
63\fB--access-concentrator\fR = ...
64.RS 4
65By this option, you may define the name of the access concentrator.
66.RE
67.PP
68
69\fB--service-name\fR = ...
70.RS 4
71By this option, you may define the service name.
72.RE
73.PP
74
75.SH SEE ALSO
76network(8), network-zone(8)
77
78.SH AUTHOR
79Michael Tremer (michael.tremer@ipfire.org)