libevent/README

0. BUILDING AND INSTALLATION (Briefly)

$ ./configure
$ make
$ make verify   # (optional)
$ sudo make install

1. BUILDING AND INSTALLATION (In Depth)

To build libevent, type

$ ./configure && make

     (If you got libevent from the git repository, you will
      first need to run the included "autogen.sh" script in order to
      generate the configure script.)

You can run the regression tests by running

$ make verify

Install as root via

# make install

Before, reporting any problems, please run the regression tests.

To enable the low-level tracing build the library as:

   CFLAGS=-DUSE_DEBUG ./configure [...]

Standard configure flags should work.  In particular, see:

   --disable-shared          Only build static libraries
   --prefix                  Install all files relative to this directory.


The configure script also supports the following flags:

   --enable-gcc-warnings     Enable extra compiler checking with GCC.
   --disable-malloc-replacement
                             Don't let applications replace our memory
                             management functions
   --disable-openssl         Disable support for OpenSSL encryption.
   --disable-thread-support  Don't support multithreaded environments.

2. USEFUL LINKS:

For the latest released version of Libevent, see the official website at
http://monkey.org/~provos/libevent/ .

There's a pretty good work-in-progress manual up at
   http://www.wangafu.net/~nickm/libevent-book/ .

For the latest development versions of Libevent, access our Git repository
via
   "git clone git://levent.git.sourceforge.net/gitroot/levent/libevent"

You can browse the git repository online at
http://levent.git.sourceforge.net/git/gitweb-index.cgi .

To report bugs, request features, or submit patches to Libevent,
use the Sourceforge trackers at
https://sourceforge.net/tracker/?group_id=50884 .

There's also a libevent-users mailing list for talking about Libevent
use and development: http://archives.seul.org/libevent/users/

3. ACKNOWLEDGMENTS

The following people have helped with suggestions, ideas, code or
fixing bugs:

  Alejo
  Weston Andros Adamson
  William Ahern
  Ivan Andropov
  Avi Bab
  Gilad Benjamini
  Stas Bekman
  Joachim Bauch
  Denis Bilenko
  Julien Blache
  Kevin Bowling
  Kelly Brock
  Ralph Castain
  Shuo Chen
  Ka-Hing Cheung
  Andrew Danforth
  Christopher Davis
  Mike Davis
  Mihai Draghicioiu
  Mark Ellzey
  Shie Erlich
  Alexander von Gernler
  Artur Grabowski
  Michael Herf
  Sebastian Hahn
  Aaron Hopkins
  Tani Hosokawa
  Claudio Jeker
  Evan Jones
  Valery Kyholodov
  Marko Kreen
  Scott Lamb
  Christopher Layne
  Adam Langley
  Christopher Layne
  Philip Lewis
  Zhou Li
  David Libenzi
  Yan Lin
  Moshe Litvin
  Hagne Mahre
  Lubomir Marinov
  Nick Mathewson
  James Mansion
  Nicholas Marriott
  Andrey Matveev
  Caitlin Mercer
  Dagobert Michelsen
  Felix Nawothnig
  Trond Norbye
  Linus Nordberg
  Richard Nyberg
  Jon Oberheide
  Phil Oleson
  Dave Pacheco
  Tassilo von Parseval
  Simon Perreault
  Pierre Phaneuf
  Ryan Phillips
  Dimitre Piskyulev
  Pavel Plesov
  Jon Poland
  Bert JW Regeer
  Hanna Schroeter
  Ralf Schmitt
  Mike Smellie
  Kevin Springborn
  Ferenc Szalai
  Dug Song
  Brodie Thiesfield
  Jason Toffaletti
  Bas Verhoeven
  Constantine Verutin
  Zack Weinberg
  Taral
  propanbutan
  mmadia

If we have forgotten your name, please contact us.
Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`0. BUILDING AND INSTALLATION (Briefly)`

			`$ ./configure`
			`$ make`
			`$ make verify # (optional)`
			`$ sudo make install`

			`1. BUILDING AND INSTALLATION (In Depth)`

make a separate verify target svn:r124 2004-12-01 19:59:00 +00:00			`To build libevent, type`

			`$ ./configure && make`

Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`(If you got libevent from the git repository, you will`
r16554@catbus: nickm \| 2007-11-07 17:33:49 -0500 Mention autogen.sh in the README, now that we are more vocally encouraging people to try svn. svn:r501 2007-11-07 22:35:15 +00:00			`first need to run the included "autogen.sh" script in order to`
			`generate the configure script.)`

Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`You can run the regression tests by running`
make a separate verify target svn:r124 2004-12-01 19:59:00 +00:00
			`$ make verify`

tweak readme, whatsnew 2010-12-09 11:40:35 -05:00			`Install as root via`

			`# make install`

acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00			`Before, reporting any problems, please run the regression tests.`

do not undefine USE_DEBUG in header file; allow CFLAGS specification; from Stas Bekman svn:r191 2005-12-17 20:18:10 +00:00			`To enable the low-level tracing build the library as:`

Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`CFLAGS=-DUSE_DEBUG ./configure [...]`

			`Standard configure flags should work. In particular, see:`

			`--disable-shared Only build static libraries`
			`--prefix Install all files relative to this directory.`


			`The configure script also supports the following flags:`

			`--enable-gcc-warnings Enable extra compiler checking with GCC.`
			`--disable-malloc-replacement`
			`Don't let applications replace our memory`
			`management functions`
			`--disable-openssl Disable support for OpenSSL encryption.`
			`--disable-thread-support Don't support multithreaded environments.`

			`2. USEFUL LINKS:`

			`For the latest released version of Libevent, see the official website at`
			`http://monkey.org/~provos/libevent/ .`

			`There's a pretty good work-in-progress manual up at`
			`http://www.wangafu.net/~nickm/libevent-book/ .`

			`For the latest development versions of Libevent, access our Git repository`
			`via`
			`"git clone git://levent.git.sourceforge.net/gitroot/levent/libevent"`

			`You can browse the git repository online at`
			`http://levent.git.sourceforge.net/git/gitweb-index.cgi .`

			`To report bugs, request features, or submit patches to Libevent,`
			`use the Sourceforge trackers at`
			`https://sourceforge.net/tracker/?group_id=50884 .`

			`There's also a libevent-users mailing list for talking about Libevent`
			`use and development: http://archives.seul.org/libevent/users/`
r16554@catbus: nickm \| 2007-11-07 17:33:49 -0500 Mention autogen.sh in the README, now that we are more vocally encouraging people to try svn. svn:r501 2007-11-07 22:35:15 +00:00
Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`3. ACKNOWLEDGMENTS`
acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00
more credits svn:r164 2005-05-10 17:27:58 +00:00			`The following people have helped with suggestions, ideas, code or`
			`fixing bugs:`
acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Alejo`
			`Weston Andros Adamson`
			`William Ahern`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Ivan Andropov`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Avi Bab`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Gilad Benjamini`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Stas Bekman`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Joachim Bauch`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Denis Bilenko`
			`Julien Blache`
			`Kevin Bowling`
Add more acknowledgements to the readme for 2.0.10-stable 2010-12-15 14:30:04 -05:00			`Kelly Brock`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Ralph Castain`
			`Shuo Chen`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Ka-Hing Cheung`
acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00			`Andrew Danforth`
Improve the README with more information and links. (Also, try to test out the new commit script.) 2009-11-20 12:37:47 -05:00			`Christopher Davis`
acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00			`Mike Davis`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Mihai Draghicioiu`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Mark Ellzey`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Shie Erlich`
more credits svn:r164 2005-05-10 17:27:58 +00:00			`Alexander von Gernler`
do not remove kq inkernel flag before event_del gets to it; bug reported by Tassilo von Parseval; also add a test for this behavior. svn:r190 2005-12-17 20:15:25 +00:00			`Artur Grabowski`
Changelog and readme for 2.0.8-rc 2010-10-14 18:35:11 -04:00			`Michael Herf`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Sebastian Hahn`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Aaron Hopkins`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Tani Hosokawa`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Claudio Jeker`
Add more acknowledgements to the readme for 2.0.10-stable 2010-12-15 14:30:04 -05:00			`Evan Jones`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Valery Kyholodov`
			`Marko Kreen`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Scott Lamb`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Christopher Layne`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Adam Langley`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Christopher Layne`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Philip Lewis`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Zhou Li`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`David Libenzi`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Yan Lin`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Moshe Litvin`
			`Hagne Mahre`
			`Lubomir Marinov`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Nick Mathewson`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`James Mansion`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Nicholas Marriott`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Andrey Matveev`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Caitlin Mercer`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Dagobert Michelsen`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Felix Nawothnig`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Trond Norbye`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Linus Nordberg`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Richard Nyberg`
			`Jon Oberheide`
spell Oleson correctly svn:r348 2007-03-05 06:49:45 +00:00			`Phil Oleson`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Dave Pacheco`
do not undefine USE_DEBUG in header file; allow CFLAGS specification; from Stas Bekman svn:r191 2005-12-17 20:18:10 +00:00			`Tassilo von Parseval`
Changelog and readme for 2.0.8-rc 2010-10-14 18:35:11 -04:00			`Simon Perreault`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Pierre Phaneuf`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Ryan Phillips`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Dimitre Piskyulev`
			`Pavel Plesov`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Jon Poland`
			`Bert JW Regeer`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Hanna Schroeter`
Make all versioning changes for 2.0.7-rc, and add ChangeLog 2010-09-09 14:59:27 -04:00			`Ralf Schmitt`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Mike Smellie`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Kevin Springborn`
			`Ferenc Szalai`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Dug Song`
Changlog and new acknowledgements for 2.0.6-rc 2010-08-06 21:11:01 -04:00			`Brodie Thiesfield`
Changelog and readme for 2.0.8-rc 2010-10-14 18:35:11 -04:00			`Jason Toffaletti`
Changelog and acknowledgments for 2.0.9-rc 2010-11-23 11:08:30 -05:00			`Bas Verhoeven`
Add more acknowledgements to the readme for 2.0.10-stable 2010-12-15 14:30:04 -05:00			`Constantine Verutin`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`Zack Weinberg`
add people I forgot to give credit to; but in alphabetical order; from dug song (he had to remind me of this; how embarassing) svn:r320 2007-02-08 16:27:26 +00:00			`Taral`
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`propanbutan`
			`mmadia`
acknowledgements and new version svn:r143 2005-04-04 00:35:14 +00:00
Add more people who wrote patches to the acknowledgments The names came from grepping ChangeLog for 'patch/code from/by'. 2009-11-20 12:46:00 -05:00			`If we have forgotten your name, please contact us.`