toc.c

00001 /**
00002  * \cond skip
00003  * vim:syntax=doxygen
00004  * \endcond
00005 
00006 \mainpage
00007 
00008 \section main_intro Introduction
00009 
00010 libnl is a set of libraries to deal with the netlink protocol and some
00011 of the high level protocols implemented on top of it. The goal is to
00012 provide APIs on different levels of abstraction. The core library libnl.so
00013 provides a fundamental set of functions to deal with sockets, construct
00014 messages, and send/receive those messages. Additional high level interfaces
00015 for several individual netlink protocols are provided in separate
00016 libraries (e.g. \ref route_doc "nl-route.so", \ref genl_doc "nl-genl.so", ...).
00017 
00018 The library is designed to ensure that all components are optional, i.e.
00019 even though the core library provides a caching system which allows to
00020 easly manage objects of any kind, no application is required to use this
00021 caching system if it has no need for it.
00022 
00023 The library was developed and tested on 2.6.x kernel releases. It may
00024 or may not work with older kernel series. Also, although all netlink
00025 protocols are required to maintain backwards compatibility, this has not
00026 always achieved and undesired side effects can occur if a recent libnl
00027 version is used with a considerably older kernel.
00028 
00029 \section main_toc Table of Contents
00030 
00031 - \subpage core_doc "1. Netlink Core Library (-lnl)"
00032 - \subpage route_doc "2. Routing Netlink Library (-lnl-route)"
00033 - \subpage genl_doc "3. Generic Netlink Library (-lnl-genl)"
00034 - \subpage nf_doc "4. Netfilter Netlink Library (-lnl-nf)"
00035 
00036 \section main_trees GIT Trees
00037 
00038 \subsection tree_dev Development Tree
00039 
00040 @code
00041 git://git.kernel.org/pub/scm/libs/netlink/libnl.git
00042 @endcode
00043 - Web: http://www.kernel.org/pub/scm/libs/netlink/libnl.git
00044 
00045 \subsection tree_stable Stable Tree
00046 
00047 @code
00048 git://git.kernel.org/pub/scm/libs/netlink/libnl-stable.git
00049 @endcode
00050 - Web: http://www.kernel.org/pub/scm/libs/netlink/libnl-stable.git
00051 
00052 \section main_website Website
00053 
00054 - http://www.infradead.org/~tgr/libnl/
00055 
00056 \section main_mailinglist Mailinglist
00057 
00058 Please post question and patches to the libnl mailinglist:
00059 
00060 @code
00061 libnl@lists.infradead.org
00062 @endcode
00063 
00064 - Archives: http://canuck.infradead.org/pipermail/libnl/
00065 
00066 */