Added initial PPP API documentation.

git-svn-id: file:///srv/svn/repos/haiku/trunk/current@7729 a95241bf-73f2-0310-859d-f6bbb57e9c96
2004-06-01 14:58:47 +00:00
parent 46c44a04fb
commit 700c9b5dad
5 changed files with 101 additions and 2 deletions
@@ -0,0 +1,18 @@
+/*!
+\page ppp The PPP Kits
+
+The PPP stack is a kernel module that interfaces with the network stack.
+Thanks to its modular nature new protocols and extensions can be added without
+having to recompile the PPP stack.
+
+
+- \ref kernelppp
+- \ref userlandppp
+
+The kernel API is mostly intended for developers who want to write extension modules,
+but you can also create and control PPP interfaces from within your own kernel modules.
+
+You should use the userland API for your applications because it exports helper
+classes for accessing the kernel module from userland. Alternatively, you can talk
+to the PPP interface manager directly through an \c ioctl() interface.
+*/