X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Mainpage.dox;h=03e5784f57114589adf84d5093edc14d71de0e19;hb=33157146abaca548e145c577a0840cd1bd427789;hp=02fc964740525cd148f8079b778d2a02a85b4253;hpb=f11bb3f5a7eeb232a74d13b7d7ddc6746ca2c2d2;p=senf.git diff --git a/Mainpage.dox b/Mainpage.dox index 02fc964..03e5784 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -29,15 +29,12 @@ mailing lists. \see \ref usage\n - \ref example\n - Current status: Cross reference of action points\n - The BerliOS project page\n - The SENF Wiki at BerliOS + \ref example */ /** \page usage Using the SENF framework - The SENF Framework is a collection of lossly coupled + The SENF Framework is a collection of loosely coupled modules. The libraries are heavily object oriented and template based. For compatibility reasons, the libraries are therefore built together with every project making use of the framework. @@ -65,7 +62,8 @@ \li Doxygen (http://www.doxygen.org) \li The \c dia diagram editor (http://www.gnome.org/projects/dia/) - \li \The c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html) + \li HTML \c tidy (http://tidy.sourceforge.net/) + \li The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html) The library is only tested with gcc-3.4 and 4.0 on Linux. On other @@ -93,8 +91,9 @@ repository. Change to your development directory and use the following subversion command -
-      $ svn checkout http://svn.berlios.de/svnroot/repos/senf/trunk senf
+
+    $ svn checkout http://svn.berlios.de/svnroot/repos/senf/trunk senf
+    
This will create a new directory \c senf within the current directory. For further documentation on the use of Subversion, see @@ -108,9 +107,10 @@ To build the library, execute all unit tests and build the Sniffer test application, use -
-      $ scons
-      $ scons all_tests
+
+    $ scons
+    $ scons all_tests
+    
in the \c senf directory. This assumes, that you want to build the library with your default gcc and requires the boost libraries to @@ -222,8 +222,9 @@ check out the needed directories from the BerliOS SENF repository. Change to the 'Foo' directory and type -
-        $ svn propedit svn:externals .
+
+    $ svn propedit svn:externals .
+    
The default editor (probably VI) will be started with the current value of the svn:externals property (which will probably be @@ -235,16 +236,18 @@ For example, if you want to use the \c Scheduler and \c Socket module, the file will look like -
-        senfscons http://svn.berlios.de/svnroot/repos/senf/trunk/senfscons
-        Utils http://svn.berlios.de/svnroot/repos/senf/trunk/Utils
-        Scheduler http://svn.berlios.de/svnroot/repos/senf/trunk/Scheduler
-        Socket http://svn.berlios.de/svnroot/repos/senf/trunk/Socket
+
+    senfscons http://svn.berlios.de/svnroot/repos/senf/trunk/senfscons
+    Utils http://svn.berlios.de/svnroot/repos/senf/trunk/Utils
+    Scheduler http://svn.berlios.de/svnroot/repos/senf/trunk/Scheduler
+    Socket http://svn.berlios.de/svnroot/repos/senf/trunk/Socket
+    
exit the editor and the property will be set. Now run -
-        $ svn update
+
+    $ svn update
+    
and the code will be checked out into the corresponding directories. @@ -267,8 +270,9 @@ add \c SConfig to the list of files ignored by Subversion in the project root. In the project root execute -
-      $ svn propedit svn:ignore .
+
+    $ svn propedit svn:ignore .
+    
and add \c SConfig as a new line to the property. @@ -276,21 +280,24 @@ You should now be able to build your project using -
-      $ scons
+
+    $ scons
+    
If you have not changed the \c SConstruct file, this will build all modules you have importet into your project. To build and execute the unit tests, use -
-      $ scons all_tests
+
+    $ scons all_tests
+    
you can also build only a subdirectory by changing to it and running -
-      $ scons -u [target]
+
+    $ scons -u [target]
+    
\see SENFSCons reference \n SCons documentation \n @@ -343,8 +350,8 @@ library. This library will provide efficient and convenient access to all protocol fields. It supports parsing as well as modifying and creating packets. It has default support - for the most important TCP protocols and is highly extensible - with new protocols. + for the most important internet protocols and is highly + extensible with new protocols. \li Go over the Utils library. It contains small helpers to simplify tasks like daemonization, exception handling,