]>
Commit | Line | Data |
---|---|---|
a2a6f759 MT |
1 | <?xml version="1.0"?> |
2 | <!DOCTYPE refentry PUBLIC "-//OASIS/DTD DocBook XML V4.2//EN" | |
3 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> | |
4 | ||
5 | <refentry id="network-zone-pppoe"> | |
6 | <refentryinfo> | |
7 | <title>network-zone-pppoe</title> | |
8 | <productname>network</productname> | |
9 | ||
10 | <authorgroup> | |
11 | <author> | |
12 | <contrib>Developer</contrib> | |
13 | <firstname>Michael</firstname> | |
14 | <surname>Tremer</surname> | |
15 | <email>michael.tremer@ipfire.org</email> | |
16 | </author> | |
17 | </authorgroup> | |
18 | </refentryinfo> | |
19 | ||
20 | <refmeta> | |
21 | <refentrytitle>network-zone-pppoe</refentrytitle> | |
22 | <manvolnum>8</manvolnum> | |
23 | </refmeta> | |
24 | ||
25 | <refnamediv> | |
26 | <refname>network-zone-pppoe</refname> | |
27 | <refpurpose>Network Configuration Control Program</refpurpose> | |
28 | </refnamediv> | |
29 | ||
30 | <refsynopsisdiv> | |
31 | <cmdsynopsis> | |
cf0fc8ab | 32 | <command>network zone new <replaceable>ZONE</replaceable> pppoe ...</command> |
a2a6f759 MT |
33 | </cmdsynopsis> |
34 | </refsynopsisdiv> | |
35 | ||
36 | <refsect1> | |
37 | <title>Description</title> | |
38 | ||
39 | <para> | |
40 | The pppoe hook creates a PPPoE connection to your ISP. | |
41 | </para> | |
42 | </refsect1> | |
43 | ||
44 | <refsect1> | |
45 | <title>Options</title> | |
46 | ||
47 | <para> | |
48 | The following options are understood: | |
49 | </para> | |
50 | ||
51 | <variablelist> | |
52 | <varlistentry> | |
53 | <term> | |
54 | <option>--port=<replaceable>PORT</replaceable></option> | |
55 | </term> | |
56 | ||
57 | <listitem> | |
58 | <para> | |
59 | This options sets the port, pppd is using to connect to | |
60 | the modem. | |
61 | </para> | |
62 | <para> | |
63 | This may be a normal ethernet or vlan interface. | |
64 | </para> | |
65 | </listitem> | |
66 | </varlistentry> | |
67 | ||
68 | <varlistentry> | |
69 | <term> | |
70 | <option>--username=<replaceable>USERNAME</replaceable></option> | |
71 | </term> | |
72 | ||
73 | <listitem> | |
74 | <para> | |
75 | Sets the username for authentication. | |
76 | </para> | |
77 | </listitem> | |
78 | </varlistentry> | |
79 | ||
80 | <varlistentry> | |
81 | <term> | |
82 | <option>--password=<replaceable>PASSWORD</replaceable></option> | |
83 | </term> | |
84 | ||
85 | <listitem> | |
86 | <para> | |
87 | Sets the password for authentication. | |
88 | </para> | |
89 | <para> | |
90 | Use the <option>--auth=</option> option to transmit it | |
91 | in a secure manner to the provider. | |
92 | </para> | |
93 | </listitem> | |
94 | </varlistentry> | |
95 | ||
96 | <varlistentry> | |
97 | <term> | |
5f76a54d | 98 | <option>--mtu=<emphasis>N</emphasis></option> |
a2a6f759 MT |
99 | </term> |
100 | ||
101 | <listitem> | |
102 | <para> | |
103 | Sets the default MTU of the PPP connection. | |
a2a6f759 MT |
104 | </para> |
105 | </listitem> | |
106 | </varlistentry> | |
107 | ||
108 | <varlistentry> | |
109 | <term> | |
110 | <option>--auth=[chap|pap]</option> | |
111 | </term> | |
112 | ||
113 | <listitem> | |
114 | <para> | |
115 | Define the authentication method that is used to | |
116 | authenticate against your provider. | |
117 | The default is to use the provider's preference. | |
118 | </para> | |
119 | <itemizedlist> | |
120 | <listitem> | |
121 | <para> | |
122 | <emphasis>Challange-Handshake Authentication Protocol</emphasis> | |
123 | (chap) is the preferred secure method. | |
124 | </para> | |
125 | </listitem> | |
126 | <listitem> | |
127 | <para> | |
128 | <emphasis>Password Authentication Protocol</emphasis> | |
129 | (pap) sends the plaintext password to the authentication | |
130 | server which is the reason why it should be avoided to use PAP. | |
131 | </para> | |
132 | </listitem> | |
133 | </itemizedlist> | |
134 | </listitem> | |
135 | </varlistentry> | |
136 | ||
137 | <varlistentry> | |
138 | <term> | |
139 | <option>--access-concentrator=<replaceable>STRING</replaceable></option> | |
140 | </term> | |
141 | ||
142 | <listitem> | |
143 | <para> | |
144 | By this option, you may define the name of the access concentrator. | |
145 | </para> | |
146 | </listitem> | |
147 | </varlistentry> | |
148 | ||
149 | <varlistentry> | |
150 | <term> | |
151 | <option>--service-name=<replaceable>STRING</replaceable></option> | |
152 | </term> | |
153 | ||
154 | <listitem> | |
155 | <para> | |
156 | By this option, you may define the service name. | |
157 | </para> | |
158 | </listitem> | |
159 | </varlistentry> | |
160 | </variablelist> | |
161 | </refsect1> | |
162 | ||
163 | <refsect1> | |
164 | <title>See Also</title> | |
165 | ||
166 | <para> | |
167 | <citerefentry> | |
168 | <refentrytitle>network</refentrytitle> | |
169 | <manvolnum>8</manvolnum> | |
170 | </citerefentry>, | |
171 | <citerefentry> | |
172 | <refentrytitle>network-zone</refentrytitle> | |
173 | <manvolnum>8</manvolnum> | |
174 | </citerefentry> | |
175 | </para> | |
176 | </refsect1> | |
177 | </refentry> |