X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Mainpage.dox;h=98afe2b575cf5940f42d45af74c74b78a5338424;hb=0b68624566e2e5c855dde09254f3280c029d621d;hp=19a6d1f37c3f5757a3bc67af84c1fd6f11031d16;hpb=25d1f561a4f5096d026934b7286dd6efa5377402;p=senf.git diff --git a/Mainpage.dox b/Mainpage.dox index 19a6d1f..98afe2b 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -44,7 +44,7 @@ want to contribute, read the docs and \e please adhere to the \ref conventions. \see \ref usage\n - \ref example + Examples */ /** \page usage Using the SENF framework @@ -53,7 +53,7 @@ oriented and template based. For compatibility reasons, the libraries are therefore built together with every project making use of the framework. - When starting a new Projekt based on the SENF framework, it is advisable, to make use of the + When starting a new project based on the SENF framework, it is advisable, to make use of the SENFSCons build environment and use SVN to manage the code repository. This is the configuration, described in this documentation. @@ -64,7 +64,7 @@ \section Preliminaries - Before starting the devlopment, make sure to fulfill the following requirements: + Before starting the development, make sure to fulfill the following requirements: \li GNU g++, version at least 3.4 \li The Boost libraries (http://www.boost.org) @@ -76,6 +76,7 @@ \li The \c dia diagram editor (http://www.gnome.org/projects/dia/) \li HTML \c tidy (http://tidy.sourceforge.net/) \li The \c xsltproc XSLT processor (http://xmlsoft.org/XSLT/xsltproc2.html) + \li The \c graphviz library (http://www.graphviz.org) The library is only tested with gcc-3.4 and 4.0 on Linux. On other POSIX platforms with a BSD @@ -145,7 +146,7 @@ \section libPackets libPackets: Network packet manipulation - This libarary provides a very flexible infrastructure to parse, create and otherwise manipulate + This library provides a very flexible infrastructure to parse, create and otherwise manipulate packetized network data. Included is a library of several protocol parsers covering the basic IPv4 and IPv6 network protocols down to the Ethernet layer. @@ -207,7 +208,7 @@ You now have to decide, which modules you want to use. Every module resides in it's own subdirectory in the SENF repository. Instead of directly checking out the code, we will use \c - svn:externals. This will instruct \c svn to auutomatically check out the needed directories from + svn:externals. This will instruct \c svn to automatically check out the needed directories from the BerliOS SENF repository. Change to the 'Foo' directory and type
@@ -216,7 +217,7 @@ The default editor (probably VI) will be started with the current value of the svn:externals property (which will probably be empty). Now add all the modules you want plus \c senfscons and - possibly \c doclib (if you want to build the documentation). You will almost certainly neeed the + possibly \c doclib (if you want to build the documentation). You will almost certainly need the \c Utils module, since all other modules depend on it. For example, if you want to use the \c Scheduler and \c Socket module, the file will look like @@ -240,7 +241,7 @@ To set up the build environment, copy the senfscons/SConstruct.template to SConstruct in the project root. The default setup of this file is to build all - subdirectories (using the \c SConscript files of the subdirectories). You can add additonal + subdirectories (using the \c SConscript files of the subdirectories). You can add additional global targets and configuration parameters here. If you want to use a non-default compiler or the boost library is not installed in the system @@ -264,7 +265,7 @@ $ scons- If you have not changed the \c SConstruct file, this will build all modules you have importet + If you have not changed the \c SConstruct file, this will build all modules you have imported into your project. To build and execute the unit tests, use
@@ -323,7 +324,7 @@ The simplest way to get started is: copy the Sniffer application and start to modify it. - \see \ref example \n + \see Examples \n \ref components \n \ref svnsetup \n \ref build @@ -363,7 +364,7 @@- \c .cci C++ implementation of inline non-template functions and members + \c .cti C++ implementation of inline template fuanctions and members \c .cti C++ implementation of inline template functions and members \c .mpp Special include file used for external iteration by the Boost.Preprocessor library