home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2007 September / maximum-cd-2007-09.iso / Assets / data / AssaultCube_v0.93.exe / source / enet / docs / mainpage.dox < prev    next >
Encoding:
Text File  |  2006-11-06  |  1.8 KB  |  68 lines

  1. /** @mainpage enet
  2.  <center>http://enet.bespin.org</center>
  3.  <hr>
  4.  
  5. ENet's purpose is to provide a relatively thin, simple and robust
  6. network communication layer on top of UDP (User Datagram Protocol).
  7. The primary feature it provides is optional reliable, in-order
  8. delivery of packets.
  9.  
  10. ENet is NOT intended to be a general purpose high level networking
  11. library that handles authentication, lobbying, server discovery,
  12. compression, encryption and other high level, often application level
  13. or dependent tasks.
  14.  
  15. @ref Features
  16.  
  17. @ref SourceDistro
  18.  
  19. @ref Installation
  20.  
  21. @ref Tutorial
  22.  
  23. @ref MailingList
  24.  
  25. @ref FAQ
  26.  
  27. @ref License
  28.  
  29.  */
  30.  
  31. /**
  32. @page SourceDistro Source Distribution
  33.  
  34. You can retrieve the source to ENet by downloading it in either .tar.gz form
  35. or accessing the cvs distribution directly.
  36.  
  37. The most recent stable release (1.0) can be downloaded <a href="http://enet.bespin.org/download/enet-1.0.tar.gz">here</a>.
  38.  
  39. To access ENet via anonymous CVS, you must use the CVSROOT
  40. :pserver:anonymous\@bespin.org:/var/lib/cvs/enet with an empty
  41. password.
  42.  
  43. @code
  44.     $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet login
  45. @endcode
  46.     Hit the return key when prompted for a password.
  47. @code
  48.     $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet co -l .
  49.     $ cvs -z3 co enet
  50. @endcode
  51.  
  52. This will create a CVS directory in the current directory, and with
  53. the second command will proceed to check the enet module out of CVS.
  54. Any problems with CVS access or request for write access should be
  55. sent via email to @ref MailingList.
  56.  
  57. */
  58.  
  59. /**
  60. @page MailingList ENet Mailing List
  61.  
  62. The <a
  63. href="http://lists.cubik.org/mailman/listinfo/enet-discuss">
  64. enet-discuss</a> list is for discussion of ENet, including bug reports
  65. or feature requests.
  66.  
  67. */
  68.