xref: /aosp_15_r20/external/libnl/doc/src/toc.c (revision 4dc78e53d49367fa8e61b07018507c90983a077d)
1*4dc78e53SAndroid Build Coastguard Worker /**
2*4dc78e53SAndroid Build Coastguard Worker  * \cond skip
3*4dc78e53SAndroid Build Coastguard Worker  * vim:syntax=doxygen
4*4dc78e53SAndroid Build Coastguard Worker  * \endcond
5*4dc78e53SAndroid Build Coastguard Worker 
6*4dc78e53SAndroid Build Coastguard Worker \mainpage
7*4dc78e53SAndroid Build Coastguard Worker 
8*4dc78e53SAndroid Build Coastguard Worker \section main_intro Introduction
9*4dc78e53SAndroid Build Coastguard Worker 
10*4dc78e53SAndroid Build Coastguard Worker libnl is a set of libraries to deal with the netlink protocol and some
11*4dc78e53SAndroid Build Coastguard Worker of the high level protocols implemented on top of it. The goal is to
12*4dc78e53SAndroid Build Coastguard Worker provide APIs on different levels of abstraction. The core library libnl
13*4dc78e53SAndroid Build Coastguard Worker provides a fundamental set of functions to deal with sockets, construct
14*4dc78e53SAndroid Build Coastguard Worker messages, and send/receive those messages. Additional high level interfaces
15*4dc78e53SAndroid Build Coastguard Worker for several individual netlink protocols are provided in separate
16*4dc78e53SAndroid Build Coastguard Worker libraries (e.g. "nl-route", "nl-genl", ...).
17*4dc78e53SAndroid Build Coastguard Worker 
18*4dc78e53SAndroid Build Coastguard Worker The library is designed to ensure that all components are optional, i.e.
19*4dc78e53SAndroid Build Coastguard Worker even though the core library provides a caching system which allows to
20*4dc78e53SAndroid Build Coastguard Worker easily manage objects of any kind, no application is required to use this
21*4dc78e53SAndroid Build Coastguard Worker caching system if it has no need for it.
22*4dc78e53SAndroid Build Coastguard Worker 
23*4dc78e53SAndroid Build Coastguard Worker The library was developed and tested on 2.6.x and 3.x kernel releases. It
24*4dc78e53SAndroid Build Coastguard Worker may or may not work with older kernel series. Also, although all netlink
25*4dc78e53SAndroid Build Coastguard Worker protocols are required to maintain backwards compatibility, this has not
26*4dc78e53SAndroid Build Coastguard Worker always achieved and undesired side effects can occur if a recent libnl
27*4dc78e53SAndroid Build Coastguard Worker version is used with a considerably older kernel.
28*4dc78e53SAndroid Build Coastguard Worker 
29*4dc78e53SAndroid Build Coastguard Worker \section main_toc Table of Contents
30*4dc78e53SAndroid Build Coastguard Worker 
31*4dc78e53SAndroid Build Coastguard Worker \section main_trees GIT Trees
32*4dc78e53SAndroid Build Coastguard Worker 
33*4dc78e53SAndroid Build Coastguard Worker \subsection tree_dev Development Tree
34*4dc78e53SAndroid Build Coastguard Worker 
35*4dc78e53SAndroid Build Coastguard Worker @code
36*4dc78e53SAndroid Build Coastguard Worker git://git.infradead.org/users/tgr/libnl.git
37*4dc78e53SAndroid Build Coastguard Worker @endcode
38*4dc78e53SAndroid Build Coastguard Worker - Web: http://git.infradead.org/users/tgr/libnl.git
39*4dc78e53SAndroid Build Coastguard Worker 
40*4dc78e53SAndroid Build Coastguard Worker \section main_website Website
41*4dc78e53SAndroid Build Coastguard Worker 
42*4dc78e53SAndroid Build Coastguard Worker - https://www.infradead.org/~tgr/libnl/
43*4dc78e53SAndroid Build Coastguard Worker 
44*4dc78e53SAndroid Build Coastguard Worker \section main_mailinglist Mailinglist
45*4dc78e53SAndroid Build Coastguard Worker 
46*4dc78e53SAndroid Build Coastguard Worker Please post questions and patches to the libnl mailinglist:
47*4dc78e53SAndroid Build Coastguard Worker 
48*4dc78e53SAndroid Build Coastguard Worker @code
49*4dc78e53SAndroid Build Coastguard Worker [email protected]
50*4dc78e53SAndroid Build Coastguard Worker @endcode
51*4dc78e53SAndroid Build Coastguard Worker 
52*4dc78e53SAndroid Build Coastguard Worker - Archives: https://lists.infradead.org/pipermail/libnl/
53*4dc78e53SAndroid Build Coastguard Worker 
54*4dc78e53SAndroid Build Coastguard Worker */
55