Clarify that we no longer support i586 but require i686+
[grml.org.git] / online-docs / grml-btnets.8.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4 <head>\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6 <meta name="generator" content="AsciiDoc 7.1.2" />\r
7 <style type="text/css">\r
8 /* Debug borders */\r
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10 /*\r
11   border: 1px solid red;\r
12 */\r
13 }\r
14 \r
15 body {\r
16   margin: 1em 5% 1em 5%;\r
17 }\r
18 \r
19 a {\r
20   color: blue;\r
21   text-decoration: underline;\r
22 }\r
23 a:visited {\r
24   color: fuchsia;\r
25 }\r
26 \r
27 em {\r
28   font-style: italic;\r
29 }\r
30 \r
31 strong {\r
32   font-weight: bold;\r
33 }\r
34 \r
35 tt {\r
36   color: navy;\r
37 }\r
38 \r
39 h1, h2, h3, h4, h5, h6 {\r
40   color: #527bbd;\r
41   font-family: sans-serif;\r
42   margin-top: 1.2em;\r
43   margin-bottom: 0.5em;\r
44   line-height: 1.3;\r
45 }\r
46 \r
47 h1 {\r
48   border-bottom: 2px solid silver;\r
49 }\r
50 h2 {\r
51   border-bottom: 2px solid silver;\r
52   padding-top: 0.5em;\r
53 }\r
54 \r
55 div.sectionbody {\r
56   font-family: serif;\r
57   margin-left: 0;\r
58 }\r
59 \r
60 hr {\r
61   border: 1px solid silver;\r
62 }\r
63 \r
64 p {\r
65   margin-top: 0.5em;\r
66   margin-bottom: 0.5em;\r
67 }\r
68 \r
69 pre {\r
70   padding: 0;\r
71   margin: 0;\r
72 }\r
73 \r
74 span#author {\r
75   color: #527bbd;\r
76   font-family: sans-serif;\r
77   font-weight: bold;\r
78   font-size: 1.2em;\r
79 }\r
80 span#email {\r
81 }\r
82 span#revision {\r
83   font-family: sans-serif;\r
84 }\r
85 \r
86 div#footer {\r
87   font-family: sans-serif;\r
88   font-size: small;\r
89   border-top: 2px solid silver;\r
90   padding-top: 0.5em;\r
91   margin-top: 4.0em;\r
92 }\r
93 div#footer-text {\r
94   float: left;\r
95   padding-bottom: 0.5em;\r
96 }\r
97 div#footer-badges {\r
98   float: right;\r
99   padding-bottom: 0.5em;\r
100 }\r
101 \r
102 div#preamble,\r
103 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
104 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
105 div.admonitionblock {\r
106   margin-right: 10%;\r
107   margin-top: 1.5em;\r
108   margin-bottom: 1.5em;\r
109 }\r
110 div.admonitionblock {\r
111   margin-top: 2.5em;\r
112   margin-bottom: 2.5em;\r
113 }\r
114 \r
115 div.content { /* Block element content. */\r
116   padding: 0;\r
117 }\r
118 \r
119 /* Block element titles. */\r
120 div.title, caption.title {\r
121   font-family: sans-serif;\r
122   font-weight: bold;\r
123   text-align: left;\r
124   margin-top: 1.0em;\r
125   margin-bottom: 0.5em;\r
126 }\r
127 div.title + * {\r
128   margin-top: 0;\r
129 }\r
130 \r
131 td div.title:first-child {\r
132   margin-top: 0.0em;\r
133 }\r
134 div.content div.title:first-child {\r
135   margin-top: 0.0em;\r
136 }\r
137 div.content + div.title {\r
138   margin-top: 0.0em;\r
139 }\r
140 \r
141 div.sidebarblock > div.content {\r
142   background: #ffffee;\r
143   border: 1px solid silver;\r
144   padding: 0.5em;\r
145 }\r
146 \r
147 div.listingblock > div.content {\r
148   border: 1px solid silver;\r
149   background: #f4f4f4;\r
150   padding: 0.5em;\r
151 }\r
152 \r
153 div.quoteblock > div.content {\r
154   padding-left: 2.0em;\r
155 }\r
156 \r
157 div.attribution {\r
158   text-align: right;\r
159 }\r
160 div.verseblock + div.attribution {\r
161   text-align: left;\r
162 }\r
163 \r
164 div.admonitionblock .icon {\r
165   vertical-align: top;\r
166   font-size: 1.1em;\r
167   font-weight: bold;\r
168   text-decoration: underline;\r
169   color: #527bbd;\r
170   padding-right: 0.5em;\r
171 }\r
172 div.admonitionblock td.content {\r
173   padding-left: 0.5em;\r
174   border-left: 2px solid silver;\r
175 }\r
176 \r
177 div.exampleblock > div.content {\r
178   border-left: 2px solid silver;\r
179   padding: 0.5em;\r
180 }\r
181 \r
182 div.verseblock div.content {\r
183   white-space: pre;\r
184 }\r
185 \r
186 div.imageblock div.content { padding-left: 0; }\r
187 div.imageblock img { border: 1px solid silver; }\r
188 span.image img { border-style: none; }\r
189 \r
190 dl {\r
191   margin-top: 0.8em;\r
192   margin-bottom: 0.8em;\r
193 }\r
194 dt {\r
195   margin-top: 0.5em;\r
196   margin-bottom: 0;\r
197   font-style: italic;\r
198 }\r
199 dd > *:first-child {\r
200   margin-top: 0;\r
201 }\r
202 \r
203 ul, ol {\r
204     list-style-position: outside;\r
205 }\r
206 ol.olist2 {\r
207   list-style-type: lower-alpha;\r
208 }\r
209 \r
210 div.tableblock > table {\r
211   border: 3px solid #527bbd;\r
212 }\r
213 thead {\r
214   font-family: sans-serif;\r
215   font-weight: bold;\r
216 }\r
217 tfoot {\r
218   font-weight: bold;\r
219 }\r
220 \r
221 div.hlist {\r
222   margin-top: 0.8em;\r
223   margin-bottom: 0.8em;\r
224 }\r
225 td.hlist1 {\r
226   vertical-align: top;\r
227   font-style: italic;\r
228   padding-right: 0.8em;\r
229 }\r
230 td.hlist2 {\r
231   vertical-align: top;\r
232 }\r
233 \r
234 @media print {\r
235   div#footer-badges { display: none; }\r
236 }\r
237 /* Workarounds for IE6's broken and incomplete CSS2. */\r
238 \r
239 div.sidebar-content {\r
240   background: #ffffee;\r
241   border: 1px solid silver;\r
242   padding: 0.5em;\r
243 }\r
244 div.sidebar-title, div.image-title {\r
245   font-family: sans-serif;\r
246   font-weight: bold;\r
247   margin-top: 0.0em;\r
248   margin-bottom: 0.5em;\r
249 }\r
250 \r
251 div.listingblock div.content {\r
252   border: 1px solid silver;\r
253   background: #f4f4f4;\r
254   padding: 0.5em;\r
255 }\r
256 \r
257 div.quoteblock-content {\r
258   padding-left: 2.0em;\r
259 }\r
260 \r
261 div.exampleblock-content {\r
262   border-left: 2px solid silver;\r
263   padding-left: 0.5em;\r
264 }\r
265 </style>\r
266 <title>GRML-BTNETS(8)</title>\r
267 </head>\r
268 <body>\r
269 <div id="header">\r
270 <h1>GRML-BTNETS(8)</h1>\r
271 <span id="author">Michael Gebetsroither</span><br />\r
272 <span id="email"><tt>&lt;<a href="mailto:michael.geb@gmx.at">michael.geb@gmx.at</a>&gt;</tt></span><br />\r
273 </div>\r
274 <h2>NAME</h2>\r
275 <div class="sectionbody">\r
276 <p>grml-btnets - program to setup a bluetooth network access point (NAP)</p>\r
277 </div>\r
278 <h2>SYNOPSIS</h2>\r
279 <div class="sectionbody">\r
280 <p><strong>grml-btnets</strong> [OPTIONS] <em>&lt;ACTION&gt;</em></p>\r
281 </div>\r
282 <h2>DESCRIPTION</h2>\r
283 <div class="sectionbody">\r
284 <p><strong>grml-btnets</strong> is a program that\r
285 provides an easy wrapper around all the programms to create a ready to run network access point for bluetooth and additionally setup internet forwarding.\r
286 If no pin is given for the bluetooth network, a random pin will be choosen.</p>\r
287 </div>\r
288 <h2>ACTIONS</h2>\r
289 <div class="sectionbody">\r
290 <dl>\r
291 <dt>\r
292 <strong>start</strong>\r
293 </dt>\r
294 <dd>\r
295 <p>\r
296   Start the network access point\r
297 </p>\r
298 </dd>\r
299 <dt>\r
300 <strong>stop</strong>\r
301 </dt>\r
302 <dd>\r
303 <p>\r
304   Stop the network access point\r
305 </p>\r
306 </dd>\r
307 <dt>\r
308 <strong>help</strong>\r
309 </dt>\r
310 <dd>\r
311 <p>\r
312   Show the help message.\r
313 </p>\r
314 </dd>\r
315 </dl>\r
316 </div>\r
317 <h2>OPTIONS</h2>\r
318 <div class="sectionbody">\r
319 <dl>\r
320 <dt>\r
321 <strong>-h, help</strong>\r
322 </dt>\r
323 <dd>\r
324 <p>\r
325 Show summary of options.\r
326 </p>\r
327 </dd>\r
328 <dt>\r
329 <strong>-v</strong>\r
330 </dt>\r
331 <dd>\r
332 <p>\r
333 Show what is going on (more v =&gt; more out).\r
334 </p>\r
335 </dd>\r
336 <dt>\r
337 <strong>-s [subnet] (default=192.168.10.0/24)</strong>\r
338 </dt>\r
339 <dd>\r
340 <p>\r
341 The subnet for the bluetooth clients. There should be at least 8 IPs in this subnet (/28).\r
342 </p>\r
343 </dd>\r
344 <dt>\r
345 <strong>-i [interface] (default=eth0)</strong>\r
346 </dt>\r
347 <dd>\r
348 <p>\r
349 Enable IP-Forwarding for this interface, so that the bluetooth-network could, for example, connect to the internet.\r
350 The nameservers come from your /etc/resolv.conf, so be aware to configure this before you run grml-btnets.\r
351 Grml-btnets does not touch the ip_forward and iptables config without this option!\r
352 Do not use this option if you already have a working internet gateway on your box.\r
353 Grml-btnets assumes that the chain policy of forward is on accept.\r
354 If this is not the case please let packages from interface grmlbtnet pass.\r
355 </p>\r
356 </dd>\r
357 <dt>\r
358 <strong>-p &lt;pin&gt;</strong>\r
359 </dt>\r
360 <dd>\r
361 <p>\r
362 The bluetooth pin. If no or an empty pin is given, a random one will be choosen and printed to stdout.\r
363 </p>\r
364 </dd>\r
365 </dl>\r
366 </div>\r
367 <h2>EXAMPLES</h2>\r
368 <div class="sectionbody">\r
369 <dl>\r
370 <dt>\r
371 <strong>grml-btnets -p 1234 start</strong>\r
372 </dt>\r
373 <dd>\r
374 <p>\r
375 This creates a simple bluetooth access point (NAP) with default values.\r
376 The subnet for the bluetooth network is 192.168.10.0/24.\r
377 There will be no masquerading.\r
378 </p>\r
379 </dd>\r
380 <dt>\r
381 <strong>grml-btnets stop</strong>\r
382 </dt>\r
383 <dd>\r
384 <p>\r
385 Stops the NAP created with the command above.\r
386 </p>\r
387 </dd>\r
388 <dt>\r
389 <strong>grml-btnets -s 192.168.1.0 -i ppp0 start</strong>\r
390 </dt>\r
391 <dd>\r
392 <p>\r
393 This creates a NAP and the bluetooth clients get IPs within 192.168.1.0/24. This also creates masquerading out of ppp0 to let bluetooth clients onto the internet.\r
394 </p>\r
395 </dd>\r
396 <dt>\r
397 <strong>grml-btnets -i ppp0 stop</strong>\r
398 </dt>\r
399 <dd>\r
400 <p>\r
401 This command stops the NAP created with the commando above.\r
402 </p>\r
403 </dd>\r
404 </dl>\r
405 </div>\r
406 <h2>SEE ALSO</h2>\r
407 <div class="sectionbody">\r
408 <p>grml-btnet(8), grml-btnetc(8), pand(1), hcid(8), hcid.conf(5), hciconfig(8), hcidump(1), sdpd(8), sdptool(1)</p>\r
409 </div>\r
410 <h2>AUTHOR</h2>\r
411 <div class="sectionbody">\r
412 <p>grml-btnets was written by Michael Gebetsroither &lt;michael.geb@gmx.at&gt;.</p>\r
413 <p>This manual page was written by Michael Gebetsroither &lt;gebi@grml.org&gt;.</p>\r
414 </div>\r
415 <div id="footer">\r
416 <div id="footer-text">\r
417 Last updated 16-Sep-2007 02:51:30 CEST\r
418 </div>\r
419 </div>\r
420 </body>\r
421 </html>\r