X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Mainpage.dox;h=51f251561ed585a69b87212cd835aea8e5fad3bd;hb=0fff17bd2bcdbb1e91e216bf6e1bebc414713548;hp=7be9e0a0627c597c11e831a0cb5bd5c20f607f80;hpb=e45365d1611099a0a8b8fe8cd5b13d75917356e7;p=senf.git diff --git a/Mainpage.dox b/Mainpage.dox index 7be9e0a..51f2515 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -30,8 +30,8 @@ \see \ref usage\n \ref example\n - The BerliOS project page\n - The SENF Wiki at BerliOS + The BerliOS project page\n + The SENF Wiki at BerliOS */ /** \page usage Using the SENF framework @@ -167,7 +167,7 @@ \li Simple functions to manage daemon processes \li Standard exception classes - \li satcom::lib::intrusive_refcount to simplify the implementation + \li senf::intrusive_refcount to simplify the implementation of classes usable with boost::intrusive_ptr \li boost::bind extensions \li An interface to the \c g++ demangler integrated with type_info @@ -185,7 +185,7 @@ environment. Included are a number of templates to help bootstrapping a new project or component. - \see SENFSCons + \see SENFSCons reference */ @@ -225,7 +225,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 satscons and + 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 \c Utils module, since all other modules depend on it. @@ -234,7 +234,7 @@ module, the file will look like
-        satscons http://svn.berlios.de/svnroot/repos/senf/trunk/satscons
+        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
@@ -250,7 +250,7 @@ \section new_conf Configuring SENFSCons To set up the build environment, copy the - satscons/SConstruct.template to Satscons in the + senfscons/SConstruct.template to Satscons 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 global targets and @@ -258,7 +258,7 @@ If you want to use a non-default compiler or the boost library is not installed in the system directories, you will have to copy - satscons/SConfig.template to SConfig in the + senfscons/SConfig.template to SConfig in the project root and edit it there. You should \e never add \c SConfig to the repository since it should only contain local settings necessary for building on your local system. You should therefore @@ -290,10 +290,10 @@
       $ scons -u [target]
- \see SENFSCons reference \n - SCons documentation \n - Subversion online book \n - Subversion Homepage + \see SENFSCons reference \n + SCons documentation \n + Subversion online book \n + Subversion Homepage */ /** \page overview Introduction to the framework @@ -326,25 +326,25 @@ When building a network Application with SENF, you will use several modules: - \li Use the Socket - library for network communication needs. This library + \li Use the Socket + library for network communication needs. This library includes support for raw and packet sockets to allow low level network access. \li Use the Scheduler - library to coordinate the asynchronous event + href="../../Scheduler/doc/html/index.html">Scheduler + library to coordinate the asynchronous event processing. This drastically reduces the number of threads needed in your application and will greatly enhance the overall responsiveness. \li To interpret low level network packets, use the Packets - library. This library will provide efficient and + href="../../Packets/doc/html/index.html">Packets + 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. - \li Go over the Utils - library. It contains small helpers to + \li Go over the Utils + library. It contains small helpers to simplify tasks like daemonization, exception handling, debugging and so on.