Changeset 1183 for trunk/batman

Show
Ignore:
Timestamp:
01/14/09 03:40:35 (20 months ago)
Author:
marek
Message:

remove weird chars from INSTALL file

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • trunk/batman/INSTALL

    r1182 r1183  
    44################################### 
    55 
     6<<<<<<< .mine 
     7 
     8 
     9======= 
     10>>>>>>> .r1182 
    611Compiling from source 
    712===================== 
     
    1116 
    1217You need the usual compile environment and the libpthread-library 
    13 and the kernel module "tun". Both should already be installed on  
    14 your machine, if you use a PC with Linux. On embedded devices  
     18and the kernel module "tun". Both should already be installed on 
     19your machine, if you use a PC with Linux. On embedded devices 
    1520both may not be installed in order to save space. 
    1621 
    17 The *BSD and Mac OS operating systems are currently unmaintained,  
     22The *BSD and Mac OS operating systems are currently unmaintained, 
    1823make targets are still available but will most probably not work. 
    1924If you're interested in porting and maintaining B.A.T.M.A.N. for 
     
    2328--------- 
    2429 
    25 You don't necessarily need to compile. Our download store at  
     30You don't necessarily need to compile. Our download store at 
    2631downloads.open-mesh.net likely offers precompiled packages 
    2732for your system. 
    2833 
    29 Download and compile the latest stable sources from the download  
     34Download and compile the latest stable sources from the download 
    3035section http://open-mesh.net/batman/downloads by executing eg.: 
    3136 
    32  $ wget http://downloads.open-mesh.net/batman/releases/batman-0.3.1/batman-0.3.1.tar.gz 
    33  $ tar xzvf batman-0.3.1.tar.gz 
    34  $ cd batmand-0.3.1 
    35  $ make 
     37$ wget http://downloads.open-mesh.net/batman/releases/batman-0.3.1/batman-0.3.1.tar.gz 
     38$ tar xzvf batman-0.3.1.tar.gz 
     39$ cd batmand-0.3.1 
     40$ make 
    3641 
    37 After the compilation process is finished you'll find a executable  
    38 file called 'batmand'. This executable is quite big because it is  
     42After the compilation process is finished you'll find a executable 
     43file called 'batmand'. This executable is quite big because it is 
    3944not stripped. Don't strip it if you want to help us finding a bug 
    4045in the daemon. Strip it by executing: 
    4146 
    42  $ strip batmand 
     47$ strip batmand 
    4348 
    4449Install by executing (as root): 
    4550 
    46  $ make install 
     51$ make install 
    4752 
    48 Or start it right from the directory where you compiled it by  
     53Or start it right from the directory where you compiled it by 
    4954issuing: 
    5055 
    51 ./batmand  
     56./batmand 
    5257 
    5358 
     
    5560================================= 
    5661 
    57 Just to be sure, there has been some confusion with outdated  
    58 batman(d) packages. So its a good idea to check for any old  
     62Just to be sure, there has been some confusion with outdated 
     63batman(d) packages. So its a good idea to check for any old 
    5964package by login into your router and executing: 
    6065 
    61  $ ipkg status | grep batman 
     66$ ipkg status | grep batman 
    6267 
    6368Remove everything listed by doing for example: 
    6469 
    65  $ ipkg remove batman batman-iii freifunk-batman-de ... 
     70$ ipkg remove batman batman-iii freifunk-batman-de ... 
    6671 
    6772Then continue with the installation of fresh and stable batman packages! 
     
    7075use the ipkg-package management system. Add the line: 
    7176 
    72   src lui http://freifunk.schmudde.com/ipkg 
     77 src lui http://freifunk.schmudde.com/ipkg 
    7378 
    74 to your package sources file ( /etc/ipkg.conf ) and update the list of  
     79to your package sources file (/etc/ipkg.conf) and update the list of 
    7580available packages by executing: 
    7681 
    77  $ ipkg update 
    78  $ ipkg install batmand 
    79  $ ipkg install freifunk-batman 
     82$ ipkg update 
     83$ ipkg install batmand 
     84$ ipkg install freifunk-batman 
    8085 
    81 If not already installed (or automatically resolved) you may also need to  
     86If not already installed (or automatically resolved) you may also need to 
    8287explicitly install the libpthread and kmod-tun package. Do this by executing: 
    8388 
    84  $ ipkg install libpthread 
    85  $ ipkg install kmod-tun 
     89$ ipkg install libpthread 
     90$ ipkg install kmod-tun 
    8691 
    87 Afterwards, reboot your WRT and check the web interface. You need to enable  
    88 batman for one (or several) interfaces and specify the netmask and IP address  
     92Afterwards, reboot your WRT and check the web interface. You need to enable 
     93batman for one (or several) interfaces and specify the netmask and IP address 
    8994as well as other optionally parameters. 
    9095 
    91 Alternatively you can get the latest stable release (as well as development)  
    92 versions from  http://open-mesh.net/batman/downoads/ 
     96Alternatively you can get the latest stable release (as well as development) 
     97versions from http://open-mesh.net/batman/downoads/ 
    9398 
    9499For example to install batmand-0.2 on a freifunk WRT do: 
    95100 
    96  $ ipkg install http://downloads.open-mesh.net/batman/stable/wrt-freifunk/batmand_0.2-current_mipsel-wr-elf-32-lsb-dynamic.ipk 
     101$ ipkg install http://downloads.open-mesh.net/batman/stable/wrt-freifunk/batmand_0.2-current_mipsel-wr-elf-32-lsb-dynamic.ipk 
    97102 
    98   Be aware that, a recent batmand-...ipk from open-mesh.net  
    99   should be equal to the batmand-...ipk from freifunk.schmudde.com/ipkg. 
    100   Both packages install /usr/sbin/batmand and the last installed  
    101   one will overwrite the previous one. 
     103 Be aware that, a recent batmand-...ipk from open-mesh.net 
     104 should be equal to the batmand-...ipk from freifunk.schmudde.com/ipkg. 
     105 Both packages install /usr/sbin/batmand and the last installed 
     106 one will overwrite the previous one. 
    102107 
    103108 
     
    106111===== 
    107112 
    108 Make sure you have no firewall running that is blocking UDP  
    109 port 4305 (originator messages), port 4306 (gateway traffic).  
     113Make sure you have no firewall running that is blocking UDP 
     114port 4305 (originator messages), port 4306 (gateway traffic). 
    110115Port 4307 has to be open for incoming UDP traffic if you run the 
    111116B.A.T.M.A.N. visualization server. 
    112117 
    113118First the network interfaces supposed to participate 
    114 in the batman mesh must be configured properly. Assuming you  
    115 are already running olsr on interface eth1 with the IP address  
    116 104.1.12.123/8 and now want to run batman in parallel to olsr  
     119in the batman mesh must be configured properly. Assuming you 
     120are already running olsr on interface eth1 with the IP address 
     121104.1.12.123/8 and now want to run batman in parallel to olsr 
    117122on the same physical interface but with a 105.1.12.123/8 IP/netmask. 
    118123 
    119  $ ifconfig eth1:bat 105.1.12.123 netmask 255.0.0.0 broadcast 105.255.255.255 
    120  $ batmand -d 3 eth1:bat 
    121   
     124$ ifconfig eth1:bat 105.1.12.123 netmask 255.0.0.0 broadcast 105.255.255.255 
     125$ batmand -d 3 eth1:bat 
     126 
    122127This will configure an alias interface on top of eth1 named eth1:bat and start 
    123128the batman daemon with debug level 3 on that alias interface. As soon as 
    124 another running batmand (with the same netmask and broadcast address) is  
    125 connected to that link (or within the range of the wireless link)  
     129another running batmand (with the same netmask and broadcast address) is 
     130connected to that link (or within the range of the wireless link) 
    126131both batman daemons should see each other and indicate this in the debug output. 
    127132 
    128133The daemon started with debug level 3 can be terminated with ctrl-c. 
    129134If no debuglevel is given at startup, using 
    130   
     135 
    131136$ batmand eth1:bat 
    132137 
    133 the daemon will immediateley fork to the background (as is the usual behavior  
    134 of a daemon). However you can always connect to the main daemon (running  
    135 in background) by launching a client-batmand process with the  
    136 -c and -d <number> option, where the number represents the desired  
    137 debug-level. The following command will connect to a running batmand  
     138the daemon will immediateley fork to the background (as is the usual behavior 
     139of a daemon). However you can always connect to the main daemon (running 
     140in background) by launching a client-batmand process with the 
     141-c and -d <number> option, where the number represents the desired 
     142debug-level. The following command will connect to a running batmand 
    138143process providing debug-level 1 informations. 
    139   
     144 
    140145$ batmand -c -d 1 # shows a list of other nodes in the mesh 
    141146 
     
    146151For a full list of supported debug-levels and other startup options see 
    147152 
    148  $ batmand -h # providing a brief summary of options and 
     153$ batmand -h # providing a brief summary of options and 
    149154 
    150  $ batmand -H # for a more detailed list of options 
     155$ batmand -H # for a more detailed list of options 
    151156 
    152 Use ctrl-c to terminate a process running in foreground and  
    153   
     157Use ctrl-c to terminate a process running in foreground and 
     158 
    154159$ killall batmand 
    155160 
    156161to terminate the main batmand daemon running in background. 
    157162 
    158 If you want to use one of the batman-internet gateways showed with  
     163If you want to use one of the batman-internet gateways showed with 
    159164debug-level 2 launch the main batmand using: 
    160165 
    161  $ batmand -r 3 eth1:bat # to automatically select a reasonable GW 
    162   
    163  $ batmand -r 3 -p <ip-of-batmand-gw-node> eth1:bat # to set a preferred GW 
     166$ batmand -r 3 eth1:bat # to automatically select a reasonable GW 
    164167 
    165 In case of success this will setup a tunnel to a (preferred) batman-gw-node  
    166 and configure the routing table that all packets matching the default route  
     168$ batmand -r 3 -p <ip-of-batmand-gw-node> eth1:bat # to set a preferred GW 
     169 
     170In case of success this will setup a tunnel to a (preferred) batman-gw-node 
     171and configure the routing table that all packets matching the default route 
    167172are forwarded (tunneled) respectively. 
    168173More information is available using the -h and -H options.