- ipv6 support (-DUSE_IPV6)
[sip-router] / INSTALL
diff --git a/INSTALL b/INSTALL
index fc709ea..165ec1b 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -2,20 +2,22 @@ $Id$
 
 Installation Notes
 
-Supported architectures: Linux, FreeBSD, Solaris, Win* (CYGWIN)
-(for other architectures the Makefile must be edited)
+Supported arhitectures: Linux/i386, Linux/armv4l, FreeBSD/i386, Solaris/sparc64,
+Win*/i386 (CYGWIN)
+(for other arhitectures the Makefile must be edited)
 
 There are various configuration options defined in the Makefile.
 
 Requirements:
 
 
-- gcc
+- gcc >= 2.9x; 3.0.x recommended (it will work with older version but it might
+ require some options tweaking for best performance)
 - bison or yacc (Berkley yacc)
 - flex
 - gmake (on Linux this is the standard "make")
 
-Arhitecture Notes:
+OS Notes:
 
 - FreeBSD: make sure gmake, bison & flex are installed
 - Solaris: as above; you can use Solaris's yacc instead of bison
@@ -24,9 +26,57 @@ Arhitecture Notes:
        (>=0.12). 
        
 
+
+
+Howto:
+(NOTE: if make doesn't work try gmake  instead)
+
+- compile with default options:
+
+make   #builds only ser core, equivalent to make ser
+make modules
+
+or make all #builds everything
+
+- compile with profiling
+
+make PROFILE=-pg all
+
+-compile debug mode version
+
+make mode=debug all
+
+-compile debug version with profiling
+
+make mode=debug PROFILE=-pg all
+
+-compile only the print module
+
+make modules=modules/print modules
+
+-compile all the modules except textops
+
+make exclude_modules="CVS textops" modules
+
+-compile with the "tm" module statically linked and with profiling
+
+make static_modules=tm PROFILE=-pg all
+
+-compile with gcc-3.0 instead of gcc
+
+make CC=gcc-3.0 all
+
+
+
+Make targets:
+
 Clean:
+
 make clean   (clean the modules too)
 make proper  (clean also the dependencies)
+make distclean (the same as proper)
+make mantainer-clean (clean everything, including auto generated files,
+ tags, *.dbg a.s.o)
 
 Compile:
 
@@ -36,6 +86,16 @@ make
 make modules 
 or make modules exclude_modules="CVS print" etc.
 
+Make tags:
+
+make TAGS
+
+Create a tar.gz with the sources:
+
+make tar
+
+
+
 Install(not done yet):
 
 make prefix=/usr/local  install