[libt2n] / doc / index.doc

// mainpage should not be here

/*! \mainpage libt2n - (talk to neighbor)
 \section intro_sec Introduction
 libt2n (talk to neighbor) is a C++ library for inter-process communication (IPC, s.a. http://en.wikipedia.org/wiki/Inter-process_communication)
 with an additional code generator to make remote procedure calls simple. 
 \par 
 XXX: improve this paragraph: The input for the code generator is standard C++ code (in fact we use gccxml to parse the C++ code and the code generator takes the XML as input) and you mark the procedures you want to expose to other processes.
 It then generates the stubs needed.
 The exported procedures can be grouped. For each group the code generator is called and generates 6 output files: group_common.hxx, group_common.cpp, group_client.hxx, group_client.cpp, group_server.hxx, group_server.cpp. The _common files are used by client and server whereas the _client files are used by the client and the _server files by the server only.
 \par
 To simplify the build process a Makefile snippet is provided that allows to create a server program and a client library (including a corresponding .pc file) using the autotools easily.
 \section install_sec Installation

 \subsection requirements Requirements
 - boost <http://www.boost.org/> (serialization <http://www.boost.org/libs/serialization/doc/>)
 - gccxml <http://www.gccxml.org>
 - libxmlpp <http://libxmlplusplus.sourceforge.net/>

 \subsection recommended Recommended
 - pkg-config <http://pkgconfig.freedesktop.org/wiki/>
 - autotools (automake, autoconf, libtool)

 \subsection Compilation
 \verbatim
 ./configure && make install
 \endverbatim

 \subsection Usage
 Take a look at the example file:../../../libt2n-examples/doc/html/index.html

*/