summaryrefslogtreecommitdiff
path: root/lib/tevent/doc/mainpage.dox
blob: 5b76013ace1b2706ef224bb85dfa06b58d8eee73 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
/**
 * @mainpage
 *
 * Tevent is an event system based on the talloc memory management library. It
 * is the core event system used in Samba.
 *
 * The low level tevent has support for many event types, including timers,
 * signals, and the classic file descriptor events.
 *
 * Tevent also provide helpers to deal with asynchronous code providing the
 * tevent_req (tevent request) functions.
 *
 * @section main_tevent_tutorial Tutorial
 *
 * You should start by reading @subpage tevent_tutorial, then reading the
 * documentation of the interesting functions as you go.
 *
 * @section main_tevent_download Download
 *
 * You can download the latest releases of tevent from the
 * <a href="http://samba.org/ftp/tevent" target="_blank">tevent directory</a>
 * on the samba public source archive.
 *
 * @section main_tevent_bugs Discussion and bug reports
 *
 * tevent does not currently have its own mailing list or bug tracking system.
 * For now, please use the
 * <a href="https://lists.samba.org/mailman/listinfo/samba-technical" target="_blank">samba-technical</a>
 * mailing list, and the
 * <a href="http://bugzilla.samba.org/" target="_blank">Samba bugzilla</a>
 * bug tracking system.
 *
 * @section main_tevent_devel Development
 * You can download the latest code either via git or rsync.
 *
 * To fetch via git see the following guide:
 *
 * <a href="http://wiki.samba.org/index.php/Using_Git_for_Samba_Development" target="_blank">Using Git for Samba Development</a>
 *
 * Once you have cloned the tree switch to the master branch and cd into the
 * lib/tevent directory.
 *
 * To fetch via rsync use this command:
 *
 *   rsync -Pavz samba.org::ftp/unpacked/standalone_projects/lib/tevent .
 *
 */