Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
View | Details | Raw Unified | Return to bug 116267 | Differences between
and this patch

Collapse All | Expand All

(-)doc/en/handbook/hb-net-functions.xml (-21 / +21 lines)
Lines 8-37 Link Here
8
8
9
<sections>
9
<sections>
10
10
11
<version>1.1</version>
11
<version>1.2</version>
12
<date>2005-06-14</date>
12
<date>2005-12-21</date>
13
13
14
<section>
14
<section>
15
<title>Standard function hooks</title>
15
<title>Standard function hooks</title>
16
<body>
16
<body>
17
17
18
<p>
18
<p>
19
Four functions can be defined which will be called surrounding the start/stop
19
Four functions can be defined which will be called surrounding the
20
operations.  The functions are called with the interface name first so that one
20
<c>start</c>/<c>stop</c> operations.  The functions are called with the
21
function can control multiple adapters.
21
interface name first so that one function can control multiple adapters.
22
</p>
22
</p>
23
23
24
<p>
24
<p>
25
The return values for the preup and predown functions should be 0 (success) to
25
The return values for the <c>preup()</c> and <c>predown()</c> functions should
26
indicate that configuration or deconfiguration of the interface can continue. 
26
be 0 (success) to indicate that configuration or deconfiguration of the
27
If preup returns a non-zero value, then interface configuration will be aborted.
27
interface can continue. If <c>preup()</c> returns a non-zero value, then
28
If predown returns a non-zero value, then the interface will not be allowed to
28
interface configuration will be aborted. If <c>predown()</c> returns a non-zero
29
continue deconfiguration.
29
value, then the interface will not be allowed to continue deconfiguration.
30
</p>
30
</p>
31
31
32
<p>
32
<p>
33
The return values for the postup and postdown functions are ignored since
33
The return values for the <c>postup()</c> and <c>postdown()</c> functions are
34
there's nothing to do if they indicate failure.
34
ignored since there's nothing to do if they indicate failure.
35
</p>
35
</p>
36
36
37
<p>
37
<p>
Lines 97-103 Link Here
97
97
98
<note>
98
<note>
99
This will not work with WPA Supplicant - but the <c>${ESSID}</c> and
99
This will not work with WPA Supplicant - but the <c>${ESSID}</c> and
100
<c>${ESSIDVAR}</c> variables are available in the postup() function.
100
<c>${ESSIDVAR}</c> variables are available in the <c>postup()</c> function.
101
</note>
101
</note>
102
102
103
<p>
103
<p>
Lines 107-121 Link Here
107
</p>
107
</p>
108
108
109
<p>
109
<p>
110
The return values for the preassociate function should be 0 (success) to
110
The return values for the <c>preassociate()</c> function should be 0 (success)
111
indicate that configuration or deconfiguration of the interface can continue. 
111
to indicate that configuration or deconfiguration of the interface can continue.
112
If preassociate returns a non-zero value, then interface configuration will be
112
If <c>preassociate()</c> returns a non-zero value, then interface configuration
113
aborted.
113
will be aborted.
114
</p>
114
</p>
115
115
116
<p>
116
<p>
117
The return value for the postassociate function is ignored since there's nothing
117
The return value for the <c>postassociate()</c> function is ignored since
118
to do if it indicates failure.
118
there's nothing to do if it indicates failure.
119
</p>
119
</p>
120
120
121
<p>
121
<p>
Lines 157-164 Link Here
157
</pre>
157
</pre>
158
158
159
<note>
159
<note>
160
<c>${ESSID}</c> and <c>${ESSIDVAR}</c> are unavailable in predown() and
160
<c>${ESSID}</c> and <c>${ESSIDVAR}</c> are unavailable in <c>predown()</c> and
161
postdown() functions.
161
<c>postdown()</c> functions.
162
</note>
162
</note>
163
163
164
</body>
164
</body>

Return to bug 116267