src/enet/docs/mainpage.dox

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