Gentoo Archives: gentoo-doc-cvs

From: Jan Kundrat <jkt@×××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: hb-net-advanced.xml
Date: Thu, 22 Dec 2005 19:56:01
Message-Id: 200512221955.jBMJtpBD002134@robin.gentoo.org
1 jkt 05/12/22 19:55:49
2
3 Modified: xml/htdocs/doc/en/handbook hb-net-advanced.xml
4 hb-net-functions.xml hb-net-management.xml
5 hb-net-modules.xml hb-net-start.xml
6 hb-net-wireless.xml
7 Log:
8 #116267, hb-net-*: adding <c>s, <path>s, proper capitalization,...
9
10 Revision Changes Path
11 1.11 +49 -44 xml/htdocs/doc/en/handbook/hb-net-advanced.xml
12
13 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-advanced.xml?rev=1.11&content-type=text/x-cvsweb-markup&cvsroot=gentoo
14 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-advanced.xml?rev=1.11&content-type=text/plain&cvsroot=gentoo
15 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-advanced.xml.diff?r1=1.10&r2=1.11&cvsroot=gentoo
16
17 Index: hb-net-advanced.xml
18 ===================================================================
19 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-advanced.xml,v
20 retrieving revision 1.10
21 retrieving revision 1.11
22 diff -u -r1.10 -r1.11
23 --- hb-net-advanced.xml 21 Dec 2005 12:20:43 -0000 1.10
24 +++ hb-net-advanced.xml 22 Dec 2005 19:55:49 -0000 1.11
25 @@ -4,22 +4,22 @@
26 <!-- The content of this document is licensed under the CC-BY-SA license -->
27 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
28
29 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-advanced.xml,v 1.10 2005/12/21 12:20:43 jkt Exp $ -->
30 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-advanced.xml,v 1.11 2005/12/22 19:55:49 jkt Exp $ -->
31
32 <sections>
33
34 -<version>1.3</version>
35 -<date>2005-08-14</date>
36 +<version>1.4</version>
37 +<date>2005-12-22</date>
38
39 <section>
40 <title>Advanced Configuration</title>
41 <body>
42
43 <p>
44 -The config_eth0 variable is the heart of an interface's configuration. It's a
45 -high level instruction list for configuring the interface (eth0 in this case).
46 -Each command in the instruction list is performed sequentially. The interface is
47 -deemed OK if at least one command works.
48 +The <c>config_eth0</c> variable is the heart of an interface configuration. It's
49 +a high level instruction list for configuring the interface (<c>eth0</c> in this
50 +case). Each command in the instruction list is performed sequentially. The
51 +interface is deemed OK if at least one command works.
52 </p>
53
54 <p>
55 @@ -32,11 +32,11 @@
56 <th>Description</th>
57 </tr>
58 <tr>
59 - <ti>null</ti>
60 + <ti><c>null</c></ti>
61 <ti>Do nothing</ti>
62 </tr>
63 <tr>
64 - <ti>noop</ti>
65 + <ti><c>noop</c></ti>
66 <ti>
67 If the interface is up and there is an address then abort configuration
68 successfully
69 @@ -48,12 +48,13 @@
70 </tr>
71 <tr>
72 <ti>
73 - dhcp, adsl or apipa (or a custom command from a 3rd party module)
74 + <c>dhcp</c>, <c>adsl</c> or <c>apipa</c> (or a custom command from a 3rd
75 + party module)
76 </ti>
77 <ti>
78 - Run the module which provides the command. For example "dhcp" will run a
79 - module that provides dhcp which can be one of either dhcpcd, udhcpc,
80 - dhclient or pump.
81 + Run the module which provides the command. For example <c>dhcp</c> will run
82 + a module that provides DHCP which can be one of either <c>dhcpcd</c>,
83 + <c>udhcpc</c>, <c>dhclient</c> or <c>pump</c>.
84 </ti>
85 </tr>
86 </table>
87 @@ -96,16 +97,17 @@
88 </pre>
89
90 <note>
91 -When using the ifconfig module and adding more than one address, interface
92 -aliases are created for each extra address. So with the above two examples you
93 -will get interfaces eth0, eth0:1 and eth0:2. You cannot do anything special with
94 -these interfaces as the kernel and other programs will just treat eth0:1 and
95 -eth0:2 as eth0.
96 +When using the <c>ifconfig</c> module and adding more than one address,
97 +interface aliases are created for each extra address. So with the above two
98 +examples you will get interfaces <c>eth0</c>, <c>eth0:1</c> and <c>eth0:2</c>.
99 +You cannot do anything special with these interfaces as the kernel and other
100 +programs will just treat <c>eth0:1</c> and <c>eth0:2</c> as <c>eth0</c>.
101 </note>
102
103 <impo>
104 -The fallback order is important! If we did not specify the "null" option then
105 -the "apipa" command would only be run if the "noop" command failed.
106 +The fallback order is important! If we did not specify the <c>null</c> option
107 +then the <c>apipa</c> command would only be run if the <c>noop</c> command
108 +failed.
109 </impo>
110
111 <note>
112 @@ -121,8 +123,8 @@
113
114 <p>
115 Init scripts in <path>/etc/init.d</path> can depend on a specific network
116 -interface or just net. "net" can be defined in <path>/etc/conf.d/rc</path> to
117 -mean different things using the <c>RC_NET_STRICT_CHECKING</c> variable.
118 +interface or just net. <c>net</c> can be defined in <path>/etc/conf.d/rc</path>
119 +to mean different things using the <c>RC_NET_STRICT_CHECKING</c> variable.
120 </p>
121
122 <table>
123 @@ -131,43 +133,46 @@
124 <th>Description</th>
125 </tr>
126 <tr>
127 - <ti>none</ti>
128 - <ti>The net service is always considered up</ti>
129 + <ti><c>none</c></ti>
130 + <ti>The <path>net</path> service is always considered up</ti>
131 </tr>
132 <tr>
133 - <ti>no</ti>
134 + <ti><c>no</c></ti>
135 <ti>
136 - This basically means that at least one net.* service besides net.lo must be
137 - up. This can be used by notebook users that have a wifi and a static nic,
138 - and only wants one up at any given time to have the net service seen as up.
139 + This basically means that at least one <path>net.*</path> service besides
140 + <path>net.lo</path> must be up. This can be used by notebook users that
141 + have a WIFI and a static NIC, and only wants one up at any given time to
142 + have the net service seen as up.
143 </ti>
144 </tr>
145 <tr>
146 - <ti>lo</ti>
147 + <ti><c>lo</c></ti>
148 <ti>
149 - This is the same as the 'no' option, but net.lo is also counted. This should
150 - be useful to people that do not care about any specific interface being up
151 - at boot.
152 + This is the same as the <c>no</c> option, but <path>net.lo</path> is also
153 + counted. This should be useful to people that do not care about any specific
154 + interface being up at boot.
155 </ti>
156 </tr>
157 <tr>
158 - <ti>yes</ti>
159 + <ti><c>yes</c></ti>
160 <ti>
161 - For this ALL network interfaces MUST be up for the 'net' service to be
162 - considered up.
163 + For this ALL network interfaces MUST be up for the <path>net</path> service
164 + to be considered up.
165 </ti>
166 </tr>
167 </table>
168
169 <p>
170 -But what about net.br0 depending on net.eth0 and net.eth1? net.eth1 may be a
171 -wireless or ppp device that needs configuration before it can be added to the
172 -bridge. This cannot be done in <path>/etc/init.d/net.br0</path> as that's a
173 -symbolic link to net.lo
174 +But what about <path>net.br0</path> depending on <path>net.eth0</path> and
175 +<path>net.eth1</path>? <path>net.eth1</path> may be a wireless or PPP device
176 +that needs configuration before it can be added to the bridge. This cannot be
177 +done in <path>/etc/init.d/net.br0</path> as that's a symbolic link to
178 +<path>net.lo</path>.
179 </p>
180
181 <p>
182 -The answer is making your own depend() function in <path>/etc/conf.d/net</path>.
183 +The answer is making your own <c>depend()</c> function in
184 +<path>/etc/conf.d/net</path>.
185 </p>
186
187 <pre caption="net.br0 dependency in /etc/conf.d/net">
188 @@ -195,7 +200,7 @@
189 <c>variable_${interface|mac|essid|apmac}</c>. For example, the variable
190 <c>dhcpcd_eth0</c> holds the value for dhcpcd options for eth0 and
191 <c>dhcpcd_essid</c> holds the value for dhcpcd options when any interface
192 -connects to the essid "essid".
193 +connects to the ESSID "essid".
194 </p>
195
196 <p>
197 @@ -211,13 +216,13 @@
198 The downside of all this is that Gentoo uses bash variables for networking -
199 and bash cannot use anything outside of English alpha-numerics. To get around
200 this limitation we change every character that is not an English alpha-numeric
201 -into a _ character.
202 +into a <c>_</c> character.
203 </p>
204
205 <p>
206 Another downside of bash is the content of variables - some characters need to
207 -be escaped. This can be achived by placing the \ character in front of the
208 -character that needs to be escaped. The following list of characters needs
209 +be escaped. This can be achived by placing the <c>\</c> character in front of
210 +the character that needs to be escaped. The following list of characters needs
211 to be escaped in this way: <c>"</c>, <c>'</c> and <c>\</c>.
212 </p>
213
214
215
216
217 1.7 +22 -22 xml/htdocs/doc/en/handbook/hb-net-functions.xml
218
219 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-functions.xml?rev=1.7&content-type=text/x-cvsweb-markup&cvsroot=gentoo
220 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-functions.xml?rev=1.7&content-type=text/plain&cvsroot=gentoo
221 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-functions.xml.diff?r1=1.6&r2=1.7&cvsroot=gentoo
222
223 Index: hb-net-functions.xml
224 ===================================================================
225 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-functions.xml,v
226 retrieving revision 1.6
227 retrieving revision 1.7
228 diff -u -r1.6 -r1.7
229 --- hb-net-functions.xml 21 Dec 2005 13:27:46 -0000 1.6
230 +++ hb-net-functions.xml 22 Dec 2005 19:55:49 -0000 1.7
231 @@ -4,34 +4,34 @@
232 <!-- The content of this document is licensed under the CC-BY-SA license -->
233 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
234
235 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-functions.xml,v 1.6 2005/12/21 13:27:46 jkt Exp $ -->
236 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-functions.xml,v 1.7 2005/12/22 19:55:49 jkt Exp $ -->
237
238 <sections>
239
240 -<version>1.1</version>
241 -<date>2005-06-14</date>
242 +<version>1.2</version>
243 +<date>2005-12-22</date>
244
245 <section>
246 <title>Standard function hooks</title>
247 <body>
248
249 <p>
250 -Four functions can be defined which will be called surrounding the start/stop
251 -operations. The functions are called with the interface name first so that one
252 -function can control multiple adapters.
253 +Four functions can be defined which will be called surrounding the
254 +<c>start</c>/<c>stop</c> operations. The functions are called with the
255 +interface name first so that one function can control multiple adapters.
256 </p>
257
258 <p>
259 -The return values for the preup and predown functions should be 0 (success) to
260 -indicate that configuration or deconfiguration of the interface can continue.
261 -If preup returns a non-zero value, then interface configuration will be aborted.
262 -If predown returns a non-zero value, then the interface will not be allowed to
263 -continue deconfiguration.
264 +The return values for the <c>preup()</c> and <c>predown()</c> functions should
265 +be 0 (success) to indicate that configuration or deconfiguration of the
266 +interface can continue. If <c>preup()</c> returns a non-zero value, then
267 +interface configuration will be aborted. If <c>predown()</c> returns a non-zero
268 +value, then the interface will not be allowed to continue deconfiguration.
269 </p>
270
271 <p>
272 -The return values for the postup and postdown functions are ignored since
273 -there's nothing to do if they indicate failure.
274 +The return values for the <c>postup()</c> and <c>postdown()</c> functions are
275 +ignored since there's nothing to do if they indicate failure.
276 </p>
277
278 <p>
279 @@ -97,7 +97,7 @@
280
281 <note>
282 This will not work with WPA Supplicant - but the <c>${ESSID}</c> and
283 -<c>${ESSIDVAR}</c> variables are available in the postup() function.
284 +<c>${ESSIDVAR}</c> variables are available in the <c>postup()</c> function.
285 </note>
286
287 <p>
288 @@ -107,15 +107,15 @@
289 </p>
290
291 <p>
292 -The return values for the preassociate function should be 0 (success) to
293 -indicate that configuration or deconfiguration of the interface can continue.
294 -If preassociate returns a non-zero value, then interface configuration will be
295 -aborted.
296 +The return values for the <c>preassociate()</c> function should be 0 (success)
297 +to indicate that configuration or deconfiguration of the interface can continue.
298 +If <c>preassociate()</c> returns a non-zero value, then interface configuration
299 +will be aborted.
300 </p>
301
302 <p>
303 -The return value for the postassociate function is ignored since there's nothing
304 -to do if it indicates failure.
305 +The return value for the <c>postassociate()</c> function is ignored since
306 +there's nothing to do if it indicates failure.
307 </p>
308
309 <p>
310 @@ -157,8 +157,8 @@
311 </pre>
312
313 <note>
314 -<c>${ESSID}</c> and <c>${ESSIDVAR}</c> are unavailable in predown() and
315 -postdown() functions.
316 +<c>${ESSID}</c> and <c>${ESSIDVAR}</c> are unavailable in <c>predown()</c> and
317 +<c>postdown()</c> functions.
318 </note>
319
320 </body>
321
322
323
324 1.6 +5 -5 xml/htdocs/doc/en/handbook/hb-net-management.xml
325
326 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-management.xml?rev=1.6&content-type=text/x-cvsweb-markup&cvsroot=gentoo
327 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-management.xml?rev=1.6&content-type=text/plain&cvsroot=gentoo
328 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-management.xml.diff?r1=1.5&r2=1.6&cvsroot=gentoo
329
330 Index: hb-net-management.xml
331 ===================================================================
332 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-management.xml,v
333 retrieving revision 1.5
334 retrieving revision 1.6
335 diff -u -r1.5 -r1.6
336 --- hb-net-management.xml 21 Dec 2005 13:34:15 -0000 1.5
337 +++ hb-net-management.xml 22 Dec 2005 19:55:49 -0000 1.6
338 @@ -4,12 +4,12 @@
339 <!-- The content of this document is licensed under the CC-BY-SA license -->
340 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
341
342 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-management.xml,v 1.5 2005/12/21 13:34:15 jkt Exp $ -->
343 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-management.xml,v 1.6 2005/12/22 19:55:49 jkt Exp $ -->
344
345 <sections>
346
347 -<version>1.1</version>
348 -<date>2005-06-14</date>
349 +<version>1.2</version>
350 +<date>2005-12-22</date>
351
352 <section>
353 <title>Network Management</title>
354 @@ -27,8 +27,8 @@
355 </p>
356
357 <note>
358 -This document only talks about ifplugd, but there are alternatives you can
359 -look into like quickswitch.
360 +This document only talks about <c>ifplugd</c>, but there are alternatives you
361 +can look into like <c>quickswitch</c>.
362 </note>
363
364 </body>
365
366
367
368 1.10 +48 -49 xml/htdocs/doc/en/handbook/hb-net-modules.xml
369
370 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-modules.xml?rev=1.10&content-type=text/x-cvsweb-markup&cvsroot=gentoo
371 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-modules.xml?rev=1.10&content-type=text/plain&cvsroot=gentoo
372 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-modules.xml.diff?r1=1.9&r2=1.10&cvsroot=gentoo
373
374 Index: hb-net-modules.xml
375 ===================================================================
376 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-modules.xml,v
377 retrieving revision 1.9
378 retrieving revision 1.10
379 diff -u -r1.9 -r1.10
380 --- hb-net-modules.xml 21 Dec 2005 13:01:38 -0000 1.9
381 +++ hb-net-modules.xml 22 Dec 2005 19:55:49 -0000 1.10
382 @@ -4,12 +4,12 @@
383 <!-- The content of this document is licensed under the CC-BY-SA license -->
384 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
385
386 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-modules.xml,v 1.9 2005/12/21 13:01:38 jkt Exp $ -->
387 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-modules.xml,v 1.10 2005/12/22 19:55:49 jkt Exp $ -->
388
389 <sections>
390
391 -<version>1.4</version>
392 -<date>2005-09-07</date>
393 +<version>1.5</version>
394 +<date>2005-12-22</date>
395
396 <section>
397 <title>Network Modules</title>
398 @@ -50,14 +50,14 @@
399 <body>
400
401 <p>
402 -We provide two interface handlers presently: ifconfig and iproute2. You need one
403 -of these to do any kind of network configuration.
404 +We provide two interface handlers presently: <c>ifconfig</c> and
405 +<c>iproute2</c>. You need one of these to do any kind of network configuration.
406 </p>
407
408 <p>
409 -ifconfig is the current Gentoo default and it's included in the system profile.
410 -iproute2 is a more powerful and flexible package, but it's not included by
411 -default.
412 +<c>ifconfig</c> is the current Gentoo default and it's included in the system
413 +profile. <c>iproute2</c> is a more powerful and flexible package, but it's not
414 +included by default.
415 </p>
416
417 <pre caption="To install iproute2">
418 @@ -68,9 +68,9 @@
419 </pre>
420
421 <p>
422 -As both ifconfig and iproute2 do very similar things we allow their basic
423 -configuration to work with each other. For example both the below code snippets
424 -work regardless of which module you are using.
425 +As both <c>ifconfig</c> and <c>iproute2</c> do very similar things we allow
426 +their basic configuration to work with each other. For example both the below
427 +code snippet work regardless of which module you are using.
428 </p>
429
430 <pre caption="ifconfig and iproute2 examples">
431 @@ -93,13 +93,13 @@
432 Gateway, etc) from a DHCP server. This means that if there is a DHCP server
433 running on the network, you just have to tell each client to use DHCP and it
434 sets up the network all by itself. Of course, you will have to configure for
435 -other things like wireless, ppp or other things if required before you can use
436 +other things like wireless, PPP or other things if required before you can use
437 DHCP.
438 </p>
439
440 <p>
441 -DHCP can be provided by dhclient, dhcpcd, pump or udhcpc. Each DHCP module has
442 -its pros and cons - here's a quick run down.
443 +DHCP can be provided by <c>dhclient</c>, <c>dhcpcd</c>, <c>pump</c> or
444 +<c>udhcpc</c>. Each DHCP module has its pros and cons - here's a quick run down.
445 </p>
446
447 <table>
448 @@ -110,8 +110,8 @@
449 <th>Cons</th>
450 </tr>
451 <tr>
452 - <ti>dhclient</ti>
453 - <ti>net-misc/dhcp</ti>
454 + <ti><c>dhclient</c></ti>
455 + <ti><c>net-misc/dhcp</c></ti>
456 <ti>
457 Made by ISC, the same people who make the BIND DNS software. Very
458 configurable
459 @@ -122,8 +122,8 @@
460 </ti>
461 </tr>
462 <tr>
463 - <ti>dhcpcd</ti>
464 - <ti>net-misc/dhcpcd</ti>
465 + <ti><c>dhcpcd</c></ti>
466 + <ti><c>net-misc/dhcpcd</c></ti>
467 <ti>
468 Long time Gentoo default, no reliance on outside tools
469 </ti>
470 @@ -133,8 +133,8 @@
471 </ti>
472 </tr>
473 <tr>
474 - <ti>pump</ti>
475 - <ti>net-misc/pump</ti>
476 + <ti><c>pump</c></ti>
477 + <ti><c>net-misc/pump</c></ti>
478 <ti>
479 Lightweight, no reliance on outside tools
480 </ti>
481 @@ -144,10 +144,10 @@
482 </ti>
483 </tr>
484 <tr>
485 - <ti>udhcpc</ti>
486 - <ti>net-misc/udhcp</ti>
487 + <ti><c>udhcpc</c></ti>
488 + <ti><c>net-misc/udhcp</c></ti>
489 <ti>
490 - Lightweight - smallest dhcp client around, made for embedded systems
491 + Lightweight - smallest DHCP client around, made for embedded systems
492 </ti>
493 <ti>
494 Unproven - no distro uses it by default, cannot define a timeout beyond 3
495 @@ -158,24 +158,25 @@
496
497 <p>
498 If you have more than one DHCP client installed, you need to specify which one
499 -to use - otherwise we default to dhcpcd if available.
500 +to use - otherwise we default to <c>dhcpcd</c> if available.
501 </p>
502
503 <p>
504 -To send specific options to the dhcp module, use module_eth0="..."
505 -<e>(change module to the DHCP module you're using - ie dhcpcd_eth0)</e>
506 +To send specific options to the DHCP module, use <c>module_eth0="..."</c>
507 +<e>(change module to the DHCP module you're using - ie <c>dhcpcd_eth0</c>)</e>
508 </p>
509
510 <p>
511 We try and make DHCP relatively agnostic - as such we support the following
512 -commands using the dhcp_eth0 variable. The default is not to set any of them
513 +commands using the <c>dhcp_eth0</c> variable. The default is not to set any of
514 +them:
515 </p>
516
517 <ul>
518 - <li>release - releases the IP address for re-use</li>
519 - <li>nodns - don't overwrite /etc/resolv.conf</li>
520 - <li>nontp - don't overwrite /etc/ntp.conf</li>
521 - <li>nonis - don't overwrite /etc/yp.conf</li>
522 + <li><c>release</c> - releases the IP address for re-use</li>
523 + <li><c>nodns</c> - don't overwrite <path>/etc/resolv.conf</path></li>
524 + <li><c>nontp</c> - don't overwrite <path>/etc/ntp.conf</path></li>
525 + <li><c>nonis</c> - don't overwrite <path>/etc/yp.conf</path></li>
526 </ul>
527
528 <pre caption="Sample DHCP configuration in /etc/conf.d/net">
529 @@ -188,8 +189,8 @@
530 </pre>
531
532 <note>
533 -dhcpcd, udhcpc and pump send the current hostname to the DHCP server by default
534 -so you don't need to specify this anymore.
535 +<c>dhcpcd</c>, <c>udhcpc</c> and <c>pump</c> send the current hostname to the
536 +DHCP server by default so you don't need to specify this anymore.
537 </note>
538
539 </body>
540 @@ -207,13 +208,13 @@
541 </pre>
542
543 <warn>
544 -baselayout-1.11.x supports PPPOE only. Hopefully future versions will support
545 -PPPOA.
546 +<c>baselayout-1.11.x</c> supports PPPoE only. Hopefully future versions will
547 +support PPPoA.
548 </warn>
549
550 <p>
551 -Now we need to instruct configure eth0 to be an ADSL interface and enter our
552 -username.
553 +Now we need to instruct configure <c>eth0</c> to be an ADSL interface and enter
554 +our username.
555 </p>
556
557 <pre caption="Configure eth0 for ADSL">
558 @@ -223,7 +224,7 @@
559
560 <p>
561 Finally you need to define your username and password in
562 -<path>/etc/ppp/pap-secrets</path>
563 +<path>/etc/ppp/pap-secrets</path>.
564 </p>
565
566 <pre caption="sample /etc/ppp/pap-secrets">
567 @@ -249,7 +250,7 @@
568 </p>
569
570 <p>
571 -For APIPA support, emerge net-misc/iputils or net-analyzer/arping
572 +For APIPA support, emerge <c>net-misc/iputils</c> or <c>net-analyzer/arping</c>.
573 </p>
574
575 <pre caption="APIPA configuration in /etc/conf.d/net">
576 @@ -268,7 +269,7 @@
577 <body>
578
579 <p>
580 -For link bonding/trunking emerge net-misc/ifenslave
581 +For link bonding/trunking emerge <c>net-misc/ifenslave</c>.
582 </p>
583
584 <p>
585 @@ -297,7 +298,7 @@
586 <body>
587
588 <p>
589 -For bridging support emerge net-misc/bridge-utils
590 +For bridging support emerge <c>net-misc/bridge-utils</c>.
591 </p>
592
593 <p>
594 @@ -328,9 +329,8 @@
595 </pre>
596
597 <impo>
598 -For using some bridge setups, you may need to consult the
599 -<uri link="?part=4&amp;chap=2#variable_name">variable name</uri>
600 -documentation.
601 +For using some bridge setups, you may need to consult the <uri
602 +link="?part=4&amp;chap=2#variable_name">variable name</uri> documentation.
603 </impo>
604
605 </body>
606 @@ -343,7 +343,7 @@
607 You don't need to emerge anything for changing the MAC address of your interface
608 if you change to a specific address. However, if you need to change to a random
609 address or a random address of a given type then you need to emerge
610 -net-analyzer/macchanger.
611 +<c>net-analyzer/macchanger</c>.
612 </p>
613
614 <pre caption="MAC Address change example">
615 @@ -395,7 +395,7 @@
616 <body>
617
618 <p>
619 -For VLAN support, emerge net-misc/vconfig
620 +For VLAN support, emerge <c>net-misc/vconfig</c>.
621 </p>
622
623 <p>
624 @@ -421,9 +421,8 @@
625 </pre>
626
627 <impo>
628 -For using some VLAN setups, you may need to consult the
629 -<uri link="?part=4&amp;chap=2#variable_name">variable name</uri>
630 -documentation.
631 +For using some VLAN setups, you may need to consult the <uri
632 +link="?part=4&amp;chap=2#variable_name">variable name</uri> documentation.
633 </impo>
634
635 </body>
636
637
638
639 1.5 +8 -8 xml/htdocs/doc/en/handbook/hb-net-start.xml
640
641 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-start.xml?rev=1.5&content-type=text/x-cvsweb-markup&cvsroot=gentoo
642 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-start.xml?rev=1.5&content-type=text/plain&cvsroot=gentoo
643 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-start.xml.diff?r1=1.4&r2=1.5&cvsroot=gentoo
644
645 Index: hb-net-start.xml
646 ===================================================================
647 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-start.xml,v
648 retrieving revision 1.4
649 retrieving revision 1.5
650 diff -u -r1.4 -r1.5
651 --- hb-net-start.xml 14 Jul 2005 10:22:46 -0000 1.4
652 +++ hb-net-start.xml 22 Dec 2005 19:55:49 -0000 1.5
653 @@ -4,12 +4,12 @@
654 <!-- The content of this document is licensed under the CC-BY-SA license -->
655 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
656
657 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-start.xml,v 1.4 2005/07/14 10:22:46 fox2mike Exp $ -->
658 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-start.xml,v 1.5 2005/12/22 19:55:49 jkt Exp $ -->
659
660 <sections>
661
662 -<version>1.2</version>
663 -<date>2005-07-14</date>
664 +<version>1.3</version>
665 +<date>2005-12-22</date>
666
667 <section>
668 <title>Getting started</title>
669 @@ -18,18 +18,18 @@
670 <note>
671 This document assumes that you have correctly configured your kernel, its
672 modules for your hardware and you know the interface name of your hardware.
673 -We also assume that you are configuring eth0, but it could also be
674 -eth1, wlan0, etc.
675 +We also assume that you are configuring <c>eth0</c>, but it could also be
676 +<c>eth1</c>, <c>wlan0</c>, etc.
677 </note>
678
679 <note>
680 -This document requires you are running baselayout-1.11.11 or better.
681 +This document requires you are running <c>baselayout-1.11.11</c> or better.
682 </note>
683
684 <p>
685 To get started configuring your network card, you need to tell the Gentoo RC
686 -system about it. This is done by creating a symbolic link from <c>net.lo</c>
687 -to <c>net.eth0</c> in <path>/etc/init.d</path>
688 +system about it. This is done by creating a symbolic link from
689 +<path>net.lo</path> to <path>net.eth0</path> in <path>/etc/init.d</path>.
690 </p>
691
692 <pre caption="Symlinking net.eth0 to net.lo">
693
694
695
696 1.7 +65 -66 xml/htdocs/doc/en/handbook/hb-net-wireless.xml
697
698 file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-wireless.xml?rev=1.7&content-type=text/x-cvsweb-markup&cvsroot=gentoo
699 plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-wireless.xml?rev=1.7&content-type=text/plain&cvsroot=gentoo
700 diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/handbook/hb-net-wireless.xml.diff?r1=1.6&r2=1.7&cvsroot=gentoo
701
702 Index: hb-net-wireless.xml
703 ===================================================================
704 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-wireless.xml,v
705 retrieving revision 1.6
706 retrieving revision 1.7
707 diff -u -r1.6 -r1.7
708 --- hb-net-wireless.xml 21 Dec 2005 13:16:02 -0000 1.6
709 +++ hb-net-wireless.xml 22 Dec 2005 19:55:49 -0000 1.7
710 @@ -4,42 +4,43 @@
711 <!-- The content of this document is licensed under the CC-BY-SA license -->
712 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
713
714 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-wireless.xml,v 1.6 2005/12/21 13:16:02 jkt Exp $ -->
715 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/handbook/hb-net-wireless.xml,v 1.7 2005/12/22 19:55:49 jkt Exp $ -->
716
717 <sections>
718
719 -<version>1.2</version>
720 -<date>2005-08-02</date>
721 +<version>1.3</version>
722 +<date>2005-12-22</date>
723
724 <section>
725 <title>Introduction</title>
726 <body>
727
728 <p>
729 -Currently we support wireless setup either by wireless-tools or wpa_supplicant.
730 -The important thing to remember is that you configure for wireless networks on a
731 -global basis and not an interface basis.
732 +Currently we support wireless setup either by <c>wireless-tools</c> or
733 +<c>wpa_supplicant</c>. The important thing to remember is that you configure for
734 +wireless networks on a global basis and not an interface basis.
735 </p>
736
737 <p>
738 -wpa_suppliant is the best choice, but it does not support all drivers. For a
739 -list of supported drivers, <uri
740 +<c>wpa_suppliant</c> is the best choice, but it does not support all drivers.
741 +For a list of supported drivers, <uri
742 link="http://hostap.epitest.fi/wpa_supplicant">read the wpa_supplicant
743 -site</uri>. Also, wpa_supplicant can currently only connect to SSID's that
744 -you have configured for.
745 +site</uri>. Also, <c>wpa_supplicant</c> can currently only connect to SSID's
746 +that you have configured for.
747 </p>
748
749 <p>
750 -wireless-tools supports nearly all cards and drivers, but it cannot connect to
751 -WPA only Access Points.
752 +<c>wireless-tools</c> supports nearly all cards and drivers, but it cannot
753 +connect to WPA only Access Points.
754 </p>
755
756 <warn>
757 -The linux-wlan-ng driver is not supported by baselayout at this time. This is
758 -because linux-wlan-ng have their own setup and configuration which is completely
759 -different to everyone else's. The linux-wlan-ng devs are rumoured to be changing
760 -their setup over to wireless-tools - when this happens you may use linux-wlan-ng
761 -with baselayout.
762 +The <c>linux-wlan-ng</c> driver is not supported by <c>baselayout</c> at this
763 +time. This is because <c>linux-wlan-ng</c> have their own setup and
764 +configuration which is completely different to everyone else's. The
765 +<c>linux-wlan-ng</c> devs are rumoured to be changing their setup over to
766 +<c>wireless-tools</c> - when this happens you may use <c>linux-wlan-ng</c>
767 +with <c>baselayout</c>.
768 </warn>
769
770 </body>
771 @@ -59,14 +60,14 @@
772 </pre>
773
774 <impo>
775 -You have to have CONFIG_PACKET enabled in your kernel for wpa_supplicant to
776 -work.
777 +You have to have <c>CONFIG_PACKET</c> enabled in your kernel for
778 +<c>wpa_supplicant</c> to work.
779 </impo>
780
781 <p>
782 Now we have to configure <path>/etc/conf.d/net</path> to so that we prefer
783 -wpa_supplicant over wireless-tools (if both are installed, wireless-tools is the
784 -default).
785 +<c>wpa_supplicant</c> over <c>wireless-tools</c> (if both are installed,
786 +<c>wireless-tools</c> is the default).
787 </p>
788
789 <pre caption="configure /etc/conf.d/net for wpa_supplicant">
790 @@ -79,18 +80,18 @@
791 </pre>
792
793 <note>
794 -If you're using the host-ap driver you will need to put the card in Managed mode
795 -before it can be used with wpa_supplicant correctly. You can use
796 +If you're using the host-ap driver you will need to put the card in <e>Managed
797 +mode</e> before it can be used with <c>wpa_supplicant</c> correctly. You can use
798 <e>iwconfig_eth0="mode managed"</e> to achieve this in
799 <path>/etc/conf.d/net</path>.
800 </note>
801
802 <p>
803 -That was simple wasn't it? However, we still have to configure wpa_supplicant
804 -itself which is a bit more tricky depending on how secure the Access Points are
805 -that you are trying to connect to. The below example is taken and simplified
806 -from <path>/etc/wpa_supplicant.conf.example</path> which ships with
807 -wpa_supplicant.
808 +That was simple wasn't it? However, we still have to configure
809 +<c>wpa_supplicant</c> itself which is a bit more tricky depending on how secure
810 +the Access Points are that you are trying to connect to. The below example is
811 +taken and simplified from <path>/etc/wpa_supplicant.conf.example</path> which
812 +ships with <c>wpa_supplicant</c>.
813 </p>
814
815 <pre caption="an example /etc/wpa_supplicant.conf">
816 @@ -258,37 +259,37 @@
817 <th>Description</th>
818 </tr>
819 <tr>
820 - <ti>any</ti>
821 + <ti><c>any</c></ti>
822 <ti>Default behaviour</ti>
823 </tr>
824 <tr>
825 - <ti>preferredonly</ti>
826 + <ti><c>preferredonly</c></ti>
827 <ti>We will only connect to visible APs in the preferred list</ti>
828 </tr>
829 <tr>
830 - <ti>forcepreferred</ti>
831 + <ti><c>forcepreferred</c></ti>
832 <ti>
833 We will forceably connect to APs in the preferred order if they are not
834 found in a scan
835 </ti>
836 </tr>
837 <tr>
838 - <ti>forcepreferredonly</ti>
839 + <ti><c>forcepreferredonly</c></ti>
840 <ti>
841 Do not scan for APs - instead just try to connect to each one in order
842 </ti>
843 </tr>
844 <tr>
845 - <ti>forceany</ti>
846 + <ti><c>forceany</c></ti>
847 <ti>Same as forcepreferred + connect to any other available AP</ti>
848 </tr>
849 </table>
850
851 <p>
852 -Finally we have some blacklist_aps and unique_ap selection. blacklist_aps works
853 -in a similar way to preferred_aps. unique_ap is a yes or no value that says if a
854 -second wireless interface can connect to the same Access Point as the first
855 -interface.
856 +Finally we have some <c>blacklist_aps</c> and <c>unique_ap</c> selection.
857 +<c>blacklist_aps</c> works in a similar way to <c>preferred_aps</c>.
858 +<c>unique_ap</c> is a yes or no value that says if a second wireless interface
859 +can connect to the same Access Point as the first interface.
860 </p>
861
862 <pre caption="blacklist_aps and unique_ap example">
863 @@ -369,64 +370,63 @@
864 <th>Description</th>
865 </tr>
866 <tr>
867 - <ti>iwconfig_eth0</ti>
868 + <ti><c>iwconfig_eth0</c></ti>
869 <ti/>
870 - <ti>See the iwconfig man page for details on what to send iwconfig</ti>
871 + <ti>See the iwconfig man page for details on what to send <c>iwconfig</c></ti>
872 </tr>
873 <tr>
874 - <ti>iwpriv_eth0</ti>
875 + <ti><c>iwpriv_eth0</c></ti>
876 <ti/>
877 - <ti>See the iwpriv man page for details on what to send iwpriv</ti>
878 + <ti>See the iwpriv man page for details on what to send <c>iwpriv</c></ti>
879 </tr>
880 <tr>
881 - <ti>sleep_scan_eth0</ti>
882 - <ti>0</ti>
883 + <ti><c>sleep_scan_eth0</c></ti>
884 + <ti><c>0</c></ti>
885 <ti>
886 The number of seconds to sleep before attempting to scan. This is needed
887 when the driver/firmware needs more time to active before it can be used.
888 </ti>
889 </tr>
890 <tr>
891 - <ti>sleep_associate_eth0</ti>
892 - <ti>5</ti>
893 + <ti><c>sleep_associate_eth0</c></ti>
894 + <ti><c>5</c></ti>
895 <ti>
896 The number of seconds to wait for the interface to associate with the
897 Access Point before moving onto the next one
898 </ti>
899 </tr>
900 <tr>
901 - <ti>associate_test_eth0</ti>
902 - <ti>MAC</ti>
903 + <ti><c>associate_test_eth0</c></ti>
904 + <ti><c>MAC</c></ti>
905 <ti>
906 - Some drivers do not reset the MAC address associated with to an
907 - invalid one when they loose or attempt to associate.
908 - Some drivers do not reset the quality level when they loose
909 - or attempt assocciation.
910 - Valid settings are MAC, quality and all.
911 + Some drivers do not reset the MAC address associated with to an invalid one
912 + when they loose or attempt to associate. Some drivers do not reset the
913 + quality level when they loose or attempt assocciation. Valid settings are
914 + <c>MAC</c>, <c>quality</c> and <c>all</c>.
915 </ti>
916 </tr>
917 <tr>
918 - <ti>scan_mode_eth0</ti>
919 + <ti><c>scan_mode_eth0</c></ti>
920 <ti/>
921 <ti>
922 Some drivers have to scan in ad-hoc mode, so if scanning fails
923 - try setting ad-hoc here
924 + try setting <c>ad-hoc</c> here
925 </ti>
926 </tr>
927 <tr>
928 - <ti>iwpriv_scan_pre_eth0</ti>
929 + <ti><c>iwpriv_scan_pre_eth0</c></ti>
930 <ti/>
931 <ti>
932 - Sends some iwpriv commands to the interface before scanning.
933 - See the iwpriv man page for more details
934 + Sends some <c>iwpriv</c> commands to the interface before scanning.
935 + See the iwpriv man page for more details.
936 </ti>
937 </tr>
938 <tr>
939 - <ti>iwpriv_scan_post_eth0</ti>
940 + <ti><c>iwpriv_scan_post_eth0</c></ti>
941 <ti/>
942 <ti>
943 - Sends some iwpriv commands to the interface after scanning.
944 - See the iwpriv man page for more details
945 + Sends some <c>iwpriv</c> commands to the interface after scanning.
946 + See the iwpriv man page for more details.
947 </ti>
948 </tr>
949 </table>
950 @@ -439,9 +439,9 @@
951 <body>
952
953 <p>
954 -Someones when you connect to ESSID1 you need a static IP and when you connect to
955 -ESSID2 you need DHCP. Infact most module variables we can change per ESSID.
956 -Here's how we do this.
957 +Someones when you connect to <e>ESSID1</e> you need a static IP and when you
958 +connect to <e>ESSID2</e> you need DHCP. Infact most module variables we can
959 +change per ESSID. Here's how we do this.
960 </p>
961
962 <note>
963 @@ -449,9 +449,8 @@
964 </note>
965
966 <impo>
967 -You <e>will</e> need to consult the
968 -<uri link="?part=4&amp;chap=2#variable_name">variable name</uri>
969 -documentation.
970 +You <e>will</e> need to consult the <uri
971 +link="?part=4&amp;chap=2#variable_name">variable name</uri> documentation.
972 </impo>
973
974 <pre caption="override network settings per ESSID">
975
976
977
978 --
979 gentoo-doc-cvs@g.o mailing list