]>
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> | |
a2a6f759 MT |
52 | |
53 | <varlistentry> | |
54 | <term> | |
55 | <option>--username=<replaceable>USERNAME</replaceable></option> | |
56 | </term> | |
57 | ||
58 | <listitem> | |
59 | <para> | |
60 | Sets the username for authentication. | |
61 | </para> | |
62 | </listitem> | |
63 | </varlistentry> | |
64 | ||
65 | <varlistentry> | |
66 | <term> | |
67 | <option>--password=<replaceable>PASSWORD</replaceable></option> | |
68 | </term> | |
69 | ||
70 | <listitem> | |
71 | <para> | |
72 | Sets the password for authentication. | |
73 | </para> | |
74 | <para> | |
75 | Use the <option>--auth=</option> option to transmit it | |
76 | in a secure manner to the provider. | |
77 | </para> | |
78 | </listitem> | |
79 | </varlistentry> | |
80 | ||
81 | <varlistentry> | |
82 | <term> | |
5f76a54d | 83 | <option>--mtu=<emphasis>N</emphasis></option> |
a2a6f759 MT |
84 | </term> |
85 | ||
86 | <listitem> | |
87 | <para> | |
88 | Sets the default MTU of the PPP connection. | |
a2a6f759 MT |
89 | </para> |
90 | </listitem> | |
91 | </varlistentry> | |
92 | ||
93 | <varlistentry> | |
94 | <term> | |
95 | <option>--auth=[chap|pap]</option> | |
96 | </term> | |
97 | ||
98 | <listitem> | |
99 | <para> | |
100 | Define the authentication method that is used to | |
101 | authenticate against your provider. | |
102 | The default is to use the provider's preference. | |
103 | </para> | |
104 | <itemizedlist> | |
105 | <listitem> | |
106 | <para> | |
107 | <emphasis>Challange-Handshake Authentication Protocol</emphasis> | |
108 | (chap) is the preferred secure method. | |
109 | </para> | |
110 | </listitem> | |
111 | <listitem> | |
112 | <para> | |
113 | <emphasis>Password Authentication Protocol</emphasis> | |
114 | (pap) sends the plaintext password to the authentication | |
115 | server which is the reason why it should be avoided to use PAP. | |
116 | </para> | |
117 | </listitem> | |
118 | </itemizedlist> | |
119 | </listitem> | |
120 | </varlistentry> | |
121 | ||
122 | <varlistentry> | |
123 | <term> | |
124 | <option>--access-concentrator=<replaceable>STRING</replaceable></option> | |
125 | </term> | |
126 | ||
127 | <listitem> | |
128 | <para> | |
129 | By this option, you may define the name of the access concentrator. | |
130 | </para> | |
131 | </listitem> | |
132 | </varlistentry> | |
133 | ||
134 | <varlistentry> | |
135 | <term> | |
136 | <option>--service-name=<replaceable>STRING</replaceable></option> | |
137 | </term> | |
138 | ||
139 | <listitem> | |
140 | <para> | |
141 | By this option, you may define the service name. | |
142 | </para> | |
143 | </listitem> | |
144 | </varlistentry> | |
1e01a092 JS |
145 | |
146 | <varlistentry> | |
147 | <term> | |
148 | <option>--ipv6=[<emphasis>on</emphasis>|off]</option> | |
149 | </term> | |
150 | ||
151 | <listitem> | |
152 | <para> | |
153 | By this option, you may enable or disable IPv6 | |
154 | </para> </listitem> | |
155 | </varlistentry> | |
156 | ||
157 | <varlistentry> | |
158 | <term> | |
159 | <option>--prefix-delegation=[<emphasis>on</emphasis>|off]</option> | |
160 | </term> | |
161 | ||
162 | <listitem> | |
163 | <para> | |
164 | By this option, you may enable or disable the delegation through your provider of one IPv6 prefix to your system. | |
165 | </para> | |
166 | </listitem> | |
167 | </varlistentry> | |
168 | ||
a2a6f759 MT |
169 | </variablelist> |
170 | </refsect1> | |
171 | ||
172 | <refsect1> | |
173 | <title>See Also</title> | |
174 | ||
175 | <para> | |
176 | <citerefentry> | |
177 | <refentrytitle>network</refentrytitle> | |
178 | <manvolnum>8</manvolnum> | |
179 | </citerefentry>, | |
180 | <citerefentry> | |
181 | <refentrytitle>network-zone</refentrytitle> | |
182 | <manvolnum>8</manvolnum> | |
183 | </citerefentry> | |
184 | </para> | |
185 | </refsect1> | |
186 | </refentry> |