path: root/README
diff options
author/C=DE/ST=Berlin/L=Berlin/O=Netfilter Project/OU=Development/CN=laforge/ </C=DE/ST=Berlin/L=Berlin/O=Netfilter Project/OU=Development/CN=laforge/>2005-09-23 16:00:32 +0000
committer/C=DE/ST=Berlin/L=Berlin/O=Netfilter Project/OU=Development/CN=laforge/ </C=DE/ST=Berlin/L=Berlin/O=Netfilter Project/OU=Development/CN=laforge/>2005-09-23 16:00:32 +0000
commit1e77f8302ef9b0d173325dccb0ad06b88ee06a5c (patch)
treefa2d08d5f5c84bb1a14f3742c2ebb763d38f358a /README
parentf1e31e0ee65ef71a2ae30ca21325a31ad0fbcd8a (diff)
add README that is suitable for the initial release
Diffstat (limited to 'README')
1 files changed, 27 insertions, 17 deletions
diff --git a/README b/README
index d8c317c..6403144 100644
--- a/README
+++ b/README
@@ -1,27 +1,37 @@
-Infrastructure libnfnetlink / libctnetlink
+libnfnetlink - userspace library for handling of netfilter netlink messages
+(C) 2001-2005 Netfilter Core Team <>
-- provides low layer communications between netlink socket and high layer
- library
-- provides generic functions to create and parse nf_attr's
-- hides all details of netlink socket
-- provides open/close/receive/listen functions only to be used by other
- libraries (libctnetlink/libpkttnetlink/...)
+What is nfnetlink?
+nfnetlink is a netlink(7) based kernel/userspace transport layer. It
+provides a unified kernel/userspace interface for the various netfilter
-- provides high layer interface for applications interfacing with conntrack
- kernel code
-- event messages (to be implemented)
-- reading and deleting ip_conntrack's
-- reading, deleting and creating ip_conntrack_expect's
+What is libnfnetlink?
+libnfnetlink is a userspace library that provides some low-level
+nfnetlink handling functions. It is used as a foundation for other, netfilter
+subsystem specific libraries such as libnfnetlink_conntrack, libnfnetlink_log
+and libnfnetlink_queue.
+Where can I find documentation?
-Layout of nfnetlink data packet
+At the moment, you will have to RTFS. Sorry, but we have barely anough
+manpower to keep development ongoing. If you want to conribute documentation,
+please contact us.
-struct nlmsghdr - netlink internal
-struct nfgenmsg - information about
+It has bugs. Where do I report them?
+Please report all libnfnetlink bugs to, using
+the "libnfnetlink" Product.
+Where do I get support?
+The and
+mailinglists server as support forum.