lib/tevent/doc/mainpage.dox

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