Update the work on ipfw tables, reduce diffs.

[ipfw.git] / README

diff --git a/README b/README
index bfd3289..e5b5a4a 100644 (file)
--- a/README
+++ b/README
@@ -1,9 +1,9 @@
 #
-# $Id: README 4363 2009-12-08 16:06:54Z marta $
+# $Id: README 4396 2009-12-09 21:52:46Z luigi $
 #
 
 This directory contains a port of ipfw and dummynet to Linux and OpenWrt
-(a Windows version is in the works but not ready yet).
+(including PlanetLab).  A Windows version is in the works but not ready yet.
 Building the code produces:
 
        a kernel module,        ipfw_mod.ko
@@ -14,17 +14,15 @@ version in RELENG_7 and HEAD as of December 2009), plus some glue code
 and headers written from scratch.
 Unless specified otherwise, all the code here is under a BSD license.
 
-=== To compile for a 2.6 kernel, simply run
+=================== BUILD INSTRUCTIONS ==========================
 
-       make
+***** Linux 2.6.x ******
 
-    Make sure that kernel headers (or sources) are installed on your
-    system, and that the link "/lib/modules/`uname -r`/build" points
-    to the header/source tree matching your kernel.
+       make KERNELPATH=/path/to/linux USRDIR=/path/to/usr
 
-    You can override the default kernel tree with
-
-       make KERNELPATH=your_kernel_source_tree
+    where the two variables are optional an point to the linux kernel
+    sources and the /usr directory. Defaults are USRDIR=/usr and
+    KERNELPATH=/lib/modules/`uname -r`/build   --- XXX check ?
 
     NOTE: make sure CONFIG_NETFILTER is enabled in the kernel
     configuration file. You can enable it by doing
@@ -38,17 +36,19 @@ Unless specified otherwise, all the code here is under a BSD license.
               [*] Network packet filtering framework (Netfilter)
 
 
-=== To compile for a 2.4 kernel:
+***** Linux 2.4.x *****
+
+    Almost as above, with an additional VER=2.4
 
        make VER=2.4 KERNELPATH=...
 
     You need to follow the same instruction for the 2.6 kernel, enabling
-    the kernel options:
+    netfilter in the kernel options:
 
     Networking options  --->
       [*] Network packet filtering (replaces ipchains)
 
-=== To build an Openwrt package
+***** Openwrt package *****
 
     (Tested with kamikaze_8.09.1 and Linux 2.4)
 
@@ -104,4 +104,6 @@ Unless specified otherwise, all the code here is under a BSD license.
     /lib/modules/2.4.35.4/ipfw show             # launch the userspace tool
     rmmod ipfw_mod.o                            # remove the module
 
+***** PLANETLAB BUILD *****
+
 -----------------------------------------------------------------------------