X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Mainpage.dox;h=5d0dbeba7bf91981bf4b7c5bf7fc4176583decbf;hb=553781d9e9bce316dca24ac4f0c42e5613e849e0;hp=74b54758dbcc31a9df4fb9322a5aecfce4314678;hpb=05633cf2fb569dad4bf2118ec5203e61974b35f5;p=senf.git diff --git a/Mainpage.dox b/Mainpage.dox index 74b5475..5d0dbeb 100644 --- a/Mainpage.dox +++ b/Mainpage.dox @@ -30,13 +30,14 @@ \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 */ /** \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. @@ -64,6 +65,8 @@ \li Doxygen (http://www.doxygen.org) \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) The library is only tested with gcc-3.4 and 4.0 on Linux. On other @@ -167,7 +170,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 +188,7 @@ environment. Included are a number of templates to help bootstrapping a new project or component. - \see SENFSCons + \see SENFSCons reference */ @@ -225,7 +228,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 +237,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,15 +253,15 @@ \section new_conf Configuring SENFSCons To set up the build environment, copy the - satscons/SConstruct.template to Satscons in the - project root. The default setup of this file is to build all + 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 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 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,7 +293,7 @@
       $ scons -u [target]
- \see SENFSCons reference \n + \see SENFSCons reference \n SCons documentation \n Subversion online book \n Subversion Homepage @@ -341,8 +344,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,