mainpage.dox 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. /** @mainpage enet
  2. <center>http://enet.bespin.org</center>
  3. <hr>
  4. ENet's purpose is to provide a relatively thin, simple and robust
  5. network communication layer on top of UDP (User Datagram Protocol).
  6. The primary feature it provides is optional reliable, in-order
  7. delivery of packets.
  8. ENet omits certain higher level networking features such as authentication,
  9. lobbying, server discovery, encryption, or other similar tasks that are
  10. particularly application specific so that the library remains flexible,
  11. portable, and easily embeddable.
  12. @ref Features
  13. @ref SourceDistro
  14. @ref Installation
  15. @ref Tutorial
  16. @ref MailingList
  17. @ref IRCChannel
  18. @ref FAQ
  19. @ref License
  20. */
  21. /**
  22. @page SourceDistro Source Distribution
  23. You can retrieve the source to ENet by downloading it in either .tar.gz form
  24. or accessing the cvs distribution directly.
  25. The most recent stable release (1.3.0) can be downloaded <a href="http://enet.bespin.org/download/enet-1.3.0.tar.gz">here</a>.
  26. The last release that is protocol compatible with the 1.2 series or earlier (1.2.2) can be downloaded <a href="http://enet.bespin.org/download/enet-1.2.2.tar.gz">here</a>
  27. To access ENet via anonymous CVS, you must use the CVSROOT
  28. :pserver:anonymous\@bespin.org:/var/lib/cvs/enet with an empty
  29. password.
  30. @code
  31. $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet login
  32. @endcode
  33. Hit the return key when prompted for a password.
  34. @code
  35. $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet co -l .
  36. $ cvs -z3 co enet
  37. @endcode
  38. This will create a CVS directory in the current directory, and with
  39. the second command will proceed to check the enet module out of CVS.
  40. Any problems with CVS access or request for write access should be
  41. sent via email to @ref MailingList.
  42. */
  43. /**
  44. @page MailingList ENet Mailing List
  45. The <a href="http://lists.cubik.org/mailman/listinfo/enet-discuss">enet-discuss</a> list is for discussion of ENet, including bug reports or feature requests.
  46. */
  47. /**
  48. @page IRCChannel ENet IRC Channel
  49. Join the \#enet channel on the freenode IRC network (irc.freenode.net) for real-time discussion about the ENet library.
  50. */