Added header guard to device.h, wrote typedef in a cleaner way
[mtetherd] / README
1 mtetherd 0.1
2 ------------
3
4 Description:
5
6 mtetherd allows you to use your N900 as an Internet router.
7 Once a USB network or Bluetooth PAN connection is opened to the device,
8 it will automatically configure networking and start a dnsmasq instance
9 that serves DHCP requests and forwards DNS queries.
10 You can also use it to automatically configure network interfaces
11 for development.
12
13 Requirements:
14
15 The iptables and bluetooth-dun packages must be installed.
16 They are required for setting up NAT and Bluetooth PAN support.
17
18 Usage:
19
20 Bluetooth:
21 1. Pair your host with the N900 and make sure the PAN (Bluetooth networking)
22    service is recognized on the host.
23 2. Open a PAN connection to the N900.
24 3. Routing should setup automatically and you can access the Internet
25    right away.
26
27 USB:
28 1. Connect host and N900 with a USB cable.
29 2. Wait until the USB mode dialog pops up on the N900 and dismiss it.
30 3. Open MAD Developer.
31 4. Tap "Manage USB".
32 5. Tap "Load g_ether".
33 6. The USB mode is kept between cable disconnects, you only have to
34    reload the g_ether module after a reboot or mode change.
35 7. Start surfing on the host.
36 3a.It is also possible to load the module from the Terminal (untested):
37 rmmod g_nokia
38 rmmod g_file_storage
39 modprobe g_ether
40
41 Notes:
42
43 IP addresses are currently hardcoded into the program. A later version
44 will add support for an external configuration file.
45 The assigned addresses are the following:
46 USB: N900: 192.168.253.254 DHCP: 192.168.253.1-192.168.253.253
47 Bluetooth: N900: 192.168.254.254 DHCP: 192.168.254.1-192.168.254.253
48
49 If you connect while no GPRS/UMTS connection is active, forwarding will
50 not be enabled. This is the case when the device is connected to a
51 Wireless LAN, for example.
52 You can still communicate with the device, but not surf the internet
53 from your host. Just disconnect and reconnect again when the GPRS/UMTS
54 connection is available.
55
56 Bugs:
57
58 If you find any, please report them via the Maemo Garage bug tracker at
59 https://garage.maemo.org/projects/mtetherd/ or send an email to
60 onitake@gmail.com
61
62 Legal:
63
64 mtetherd is (c) 2010 by Gregor Riepl <onitake@gmail.com>
65
66 This program is free software: you can redistribute it and/or modify
67 it under the terms of the GNU General Public License as published by
68 the Free Software Foundation, either version 3 of the License, or
69 (at your option) any later version.
70
71 This program is distributed in the hope that it will be useful,
72 but WITHOUT ANY WARRANTY; without even the implied warranty of
73 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
74 GNU General Public License for more details.
75
76 You should have received a copy of the GNU General Public License
77 along with this program.  If not, see <http://www.gnu.org/licenses/>.