Finished libSocket and libUtils documentation

[senf.git] / Mainpage.dox

diff --git a/Mainpage.dox b/Mainpage.dox
index 74b5475..5d0dbeb 100644 (file)
--- a/Mainpage.dox
+++ b/Mainpage.dox
@@ -30,13 +30,14 @@
 
     \see \ref usage\n
          \ref example\n
+         <a href="xref.html">Current status: Cross reference of action points</a>\n
          <a class="ext" href="http://developer.berlios.de/projects/senf">The BerliOS project page</a>\n
          <a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">The SENF Wiki at BerliOS</a>
 */
 
 /** \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 <a href="../../satscons/doc/html/index.html">SENFSCons
+    \see <a href="../../senfscons/doc/html/index.html">SENFSCons
     reference</a>
  */
 
@@ -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
 
       <pre class="fragment">
-        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</pre>
@@ -250,15 +253,15 @@
     \section new_conf Configuring SENFSCons
 
     To set up the build environment, copy the
-    <tt>satscons/SConstruct.template</tt> to <tt>Satscons</tt> in the
-    project root. The default setup of this file is to build all
+    <tt>senfscons/SConstruct.template</tt> to <tt>SConstruct</tt> 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
-    <tt>satscons/SConfig.template</tt> to <tt>SConfig</tt> in the
+    <tt>senfscons/SConfig.template</tt> to <tt>SConfig</tt> 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 @@
     <pre class="fragment">
       $ scons -u [target]</pre>
 
-    \see <a href="../../satscons/doc/html/index.html">SENFSCons reference</a> \n
+    \see <a href="../../senfscons/doc/html/index.html">SENFSCons reference</a> \n
          <a class="ext" href="http://www.scons.org/documentation.php">SCons documentation</a> \n
          <a class="ext" href="http://svnbook.red-bean.com">Subversion online book</a> \n
          <a class="ext" href="http://subversion.tigris.org">Subversion Homepage</a>
@@ -341,8 +344,8 @@
        library</a>. 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 <a href="../../Utils/doc/html/index.html">Utils
        library</a>. It contains small helpers to
        simplify tasks like daemonization, exception handling,