Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/external/enet/docs/mainpage.dox @ 10031

Last change on this file since 10031 was 7459, checked in by adrfried, 14 years ago

Merged ipv6 branch

Orxonox now includes a modified version of ENet 1.3.0

  • Property svn:eol-style set to native
File size: 2.1 KB
Line 
1/** @page enet
2 <center>http://enet.bespin.org</center>
3 <hr>
4
5ENet's purpose is to provide a relatively thin, simple and robust
6network communication layer on top of UDP (User Datagram Protocol).
7The primary feature it provides is optional reliable, in-order
8delivery of packets.
9
10ENet omits certain higher level networking features such as authentication,
11lobbying, server discovery, encryption, or other similar tasks that are
12particularly application specific so that the library remains flexible,
13portable, and easily embeddable.
14
15@ref Features
16
17@ref SourceDistro
18
19@ref Installation
20
21@ref Tutorial
22
23@ref MailingList
24
25@ref IRCChannel
26
27@ref FAQ
28
29@ref License
30
31 */
32
33/**
34@page SourceDistro Source Distribution
35
36You can retrieve the source to ENet by downloading it in either .tar.gz form
37or accessing the cvs distribution directly.
38
39The 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>.
40The 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>
41
42To access ENet via anonymous CVS, you must use the CVSROOT
43:pserver:anonymous\@bespin.org:/var/lib/cvs/enet with an empty
44password.
45
46@code
47        $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet login
48@endcode
49        Hit the return key when prompted for a password.
50@code
51        $ cvs -z3 -d :pserver:anonymous@bespin.org:/var/lib/cvs/enet co -l .
52        $ cvs -z3 co enet
53@endcode
54
55This will create a CVS directory in the current directory, and with
56the second command will proceed to check the enet module out of CVS.
57Any problems with CVS access or request for write access should be
58sent via email to @ref MailingList.
59
60*/
61
62/**
63@page MailingList ENet Mailing List
64
65The <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.
66
67*/
68
69/**
70@page IRCChannel ENet IRC Channel
71
72Join the \#enet channel on the freenode IRC network (irc.freenode.net) for real-time discussion about the ENet library.
73
74*/
75
Note: See TracBrowser for help on using the repository browser.