README.md

   1 <p align="center">
   2   <img src="https://strcpy.net/libevent3.png" alt="libevent logo"/>
   3 </p>
   4
   5
   6
   7 [![Appveyor Win32 Build Status](https://ci.appveyor.com/api/projects/status/github/libevent/libevent?branch=master&svg=true)](https://ci.appveyor.com/project/nmathewson/libevent)
   8 [![Travis Build Status](https://travis-ci.org/libevent/libevent.svg?branch=master)](https://travis-ci.org/libevent/libevent)
   9
  10
  11
  12 # 0. BUILDING AND INSTALLATION (Briefly)
  13
  14 ## Autoconf
  15
  16      $ ./configure
  17      $ make
  18      $ make verify   # (optional)
  19      $ sudo make install
  20
  21 ## Cmake (General)
  22
  23
  24 The following Libevent specific Cmake variables ar as follows (the values being
  25 the default).
  26
  27 ```
  28 # Installation directory for executables
  29 EVENT_INSTALL_BIN_DIR:PATH=bin
  30
  31 # Installation directory for CMake files
  32 EVENT_INSTALL_CMAKE_DIR:PATH=lib/cmake/libevent
  33
  34 ## Installation directory for header files
  35 EVENT_INSTALL_INCLUDE_DIR:PATH=include
  36
  37 ## Installation directory for libraries
  38 EVENT_INSTALL_LIB_DIR:PATH=lib
  39
  40 ## Define if libevent should be built with shared libraries instead of archives
  41 EVENT__BUILD_SHARED_LIBRARIES:BOOL=OFF
  42
  43 # Enable running gcov to get a test coverage report (only works with
  44 # GCC/CLang). Make sure to enable -DCMAKE_BUILD_TYPE=Debug as well.
  45 EVENT__COVERAGE:BOOL=OFF
  46
  47 # Defines if libevent should build without the benchmark exectuables
  48 EVENT__DISABLE_BENCHMARK:BOOL=OFF
  49
  50 # Define if libevent should build without support for a debug mode
  51 EVENT__DISABLE_DEBUG_MODE:BOOL=OFF
  52
  53 # Define if libevent should not allow replacing the mm functions
  54 EVENT__DISABLE_MM_REPLACEMENT:BOOL=OFF
  55
  56 # Define if libevent should build without support for OpenSSL encrpytion
  57 EVENT__DISABLE_OPENSSL:BOOL=ON
  58
  59 # Disable the regress tests
  60 EVENT__DISABLE_REGRESS:BOOL=OFF
  61
  62 # Disable sample files
  63 EVENT__DISABLE_SAMPLES:BOOL=OFF
  64
  65 # If tests should be compiled or not
  66 EVENT__DISABLE_TESTS:BOOL=OFF
  67
  68 # Define if libevent should not be compiled with thread support
  69 EVENT__DISABLE_THREAD_SUPPORT:BOOL=OFF
  70
  71 # Enables verbose debugging
  72 EVENT__ENABLE_VERBOSE_DEBUG:BOOL=OFF
  73
  74 # When crosscompiling forces running a test program that verifies that Kqueue
  75 # works with pipes. Note that this requires you to manually run the test program
  76 # on the the cross compilation target to verify that it works. See cmake
  77 # documentation for try_run for more details
  78 EVENT__FORCE_KQUEUE_CHECK:BOOL=OFF
  79
  80 # set EVENT_STAGE_VERSION
  81 EVENT__STAGE_VERSION:STRING=beta
  82 ```
  83
  84 __More variables can be found by running `cmake -LAH <sourcedir_path>`__
  85
  86
  87 ## CMake (Windows)
  88
  89 Install CMake: <http://www.cmake.org>
  90
  91
  92      $ md build && cd build
  93      $ cmake -G "Visual Studio 10" ..   # Or whatever generator you want to use cmake --help for a list.
  94      $ start libevent.sln
  95
  96 ## CMake (Unix)
  97
  98      $ mkdir build && cd build
  99      $ cmake ..     # Default to Unix Makefiles.
 100      $ make
 101      $ make verify  # (optional)
 102
 103
 104 # 1. BUILDING AND INSTALLATION (In Depth)
 105
 106 ## Autoconf
 107
 108 To build libevent, type
 109
 110      $ ./configure && make
 111
 112
 113  (If you got libevent from the git repository, you will
 114   first need to run the included "autogen.sh" script in order to
 115   generate the configure script.)
 116
 117 You can run the regression tests by running
 118
 119      $ make verify
 120
 121 Install as root via
 122
 123      $ make install
 124
 125 Before reporting any problems, please run the regression tests.
 126
 127 To enable the low-level tracing build the library as:
 128
 129      $ CFLAGS=-DUSE_DEBUG ./configure [...]
 130
 131 Standard configure flags should work.  In particular, see:
 132
 133    --disable-shared          Only build static libraries
 134    --prefix                  Install all files relative to this directory.
 135
 136
 137 The configure script also supports the following flags:
 138
 139    --enable-gcc-warnings     Enable extra compiler checking with GCC.
 140    --disable-malloc-replacement
 141                              Don't let applications replace our memory
 142                              management functions
 143    --disable-openssl         Disable support for OpenSSL encryption.
 144    --disable-thread-support  Don't support multithreaded environments.
 145
 146 ## CMake (Windows)
 147
 148 (Note that autoconf is currently the most mature and supported build
 149 enviroment for libevent; the cmake instructions here are new and
 150 experimental, though they _should_ be solid.  We hope that cmake will
 151 still be supported in future versions of Libevent, and will try to
 152 make sure that happens.)
 153
 154 First of all install <http://www.cmake.org>.
 155
 156 To build libevent using Microsoft Visual studio open the "Visual Studio Command prompt" and type:
 157
 158 ```
 159 $ cd <libevent source dir>
 160 $ mkdir build && cd build
 161 $ cmake -G "Visual Studio 10" ..   # Or whatever generator you want to use cmake --help for a list.
 162 $ start libevent.sln
 163 ```
 164
 165 In the above, the ".." refers to the dir containing the Libevent source code.
 166 You can build multiple versions (with different compile time settings) from the same source tree
 167 by creating other build directories.
 168
 169 It is highly recommended to build "out of source" when using
 170 CMake instead of "in source" like the normal behaviour of autoconf for this reason.
 171
 172 The "NMake Makefiles" CMake generator can be used to build entirely via the command line.
 173
 174 To get a list of settings available for the project you can type:
 175
 176 ```
 177 $ cmake -LH ..
 178 ```
 179
 180 ### GUI
 181
 182 CMake also provides a GUI that lets you specify the source directory and output (binary) directory
 183 that the build should be placed in.
 184
 185 ### OpenSSL support
 186
 187 To build Libevent with OpenSSL support you will need to have OpenSSL binaries available when building,
 188 these can be found here: <http://www.openssl.org/related/binaries.html>
 189
 190 # 2. USEFUL LINKS:
 191
 192 For the latest released version of Libevent, see the official website at
 193 <http://libevent.org/> .
 194
 195 There's a pretty good work-in-progress manual up at
 196    <http://www.wangafu.net/~nickm/libevent-book/> .
 197
 198 For the latest development versions of Libevent, access our Git repository
 199 via
 200
 201 ```
 202 $ git clone git://levent.git.sourceforge.net/gitroot/levent/libevent
 203 ```
 204
 205 You can browse the git repository online at:
 206
 207 <http://levent.git.sourceforge.net/git/gitweb-index.cgi>
 208
 209 <https://github.com/libevent/Libevent>
 210
 211 To report bugs, request features, or submit patches to Libevent,
 212 use the Sourceforge trackers at
 213
 214 <https://sourceforge.net/tracker/?group_id=50884>
 215
 216 There's also a libevent-users mailing list for talking about Libevent
 217 use and development:
 218
 219 <http://archives.seul.org/libevent/users/>
 220
 221 # 3. ACKNOWLEDGMENTS
 222
 223 The following people have helped with suggestions, ideas, code or
 224 fixing bugs:
 225
 226  * Samy Al Bahra
 227  * Antony Antony
 228  * Jacob Appelbaum
 229  * Arno Bakker
 230  * Weston Andros Adamson
 231  * William Ahern
 232  * Ivan Andropov
 233  * Sergey Avseyev
 234  * Avi Bab
 235  * Joachim Bauch
 236  * Andrey Belobrov
 237  * Gilad Benjamini
 238  * Stas Bekman
 239  * Denis Bilenko
 240  * Julien Blache
 241  * Kevin Bowling
 242  * Tomash Brechko
 243  * Kelly Brock
 244  * Ralph Castain
 245  * Adrian Chadd
 246  * Lawnstein Chan
 247  * Shuo Chen
 248  * Ka-Hing Cheung
 249  * Andrew Cox
 250  * Paul Croome
 251  * George Danchev
 252  * Andrew Danforth
 253  * Ed Day
 254  * Christopher Davis
 255  * Mike Davis
 256  * Frank Denis
 257  * Antony Dovgal
 258  * Mihai Draghicioiu
 259  * Alexander Drozdov
 260  * Mark Ellzey
 261  * Shie Erlich
 262  * Leonid Evdokimov
 263  * Juan Pablo Fernandez
 264  * Christophe Fillot
 265  * Mike Frysinger
 266  * Remi Gacogne
 267  * Artem Germanov
 268  * Alexander von Gernler
 269  * Diego Giagio
 270  * Artur Grabowski
 271  * Diwaker Gupta
 272  * Kuldeep Gupta
 273  * Sebastian Hahn
 274  * Dave Hart
 275  * Greg Hazel
 276  * Nicholas Heath
 277  * Michael Herf
 278  * Sebastian Hahn
 279  * Savg He
 280  * Mark Heily
 281  * Maxime Henrion
 282  * Michael Herf
 283  * Greg Hewgill
 284  * Andrew Hochhaus
 285  * Aaron Hopkins
 286  * Tani Hosokawa
 287  * Jamie Iles
 288  * Xiuqiang Jiang
 289  * Claudio Jeker
 290  * Evan Jones
 291  * Marcin Juszkiewicz
 292  * George Kadianakis
 293  * Makoto Kato
 294  * Phua Keat
 295  * Azat Khuzhin
 296  * Alexander Klauer
 297  * Kevin Ko
 298  * Brian Koehmstedt
 299  * Marko Kreen
 300  * Ondřej Kuzník
 301  * Valery Kyholodov
 302  * Ross Lagerwall
 303  * Scott Lamb
 304  * Christopher Layne
 305  * Adam Langley
 306  * Graham Leggett
 307  * Volker Lendecke
 308  * Philip Lewis
 309  * Zhou Li
 310  * David Libenzi
 311  * Yan Lin
 312  * Moshe Litvin
 313  * Simon Liu
 314  * Mitchell Livingston
 315  * Hagne Mahre
 316  * Lubomir Marinov
 317  * Abilio Marques
 318  * Nicolas Martyanoff
 319  * Abel Mathew
 320  * Nick Mathewson
 321  * James Mansion
 322  * Nicholas Marriott
 323  * Andrey Matveev
 324  * Caitlin Mercer
 325  * Dagobert Michelsen
 326  * Andrea Montefusco
 327  * Mansour Moufid
 328  * Mina Naguib
 329  * Felix Nawothnig
 330  * Trond Norbye
 331  * Linus Nordberg
 332  * Richard Nyberg
 333  * Jon Oberheide
 334  * John Ohl
 335  * Phil Oleson
 336  * Alexey Ozeritsky
 337  * Dave Pacheco
 338  * Derrick Pallas
 339  * Tassilo von Parseval
 340  * Catalin Patulea
 341  * Patrick Pelletier
 342  * Simon Perreault
 343  * Dan Petro
 344  * Pierre Phaneuf
 345  * Amarin Phaosawasdi
 346  * Ryan Phillips
 347  * Dimitre Piskyulev
 348  * Pavel Plesov
 349  * Jon Poland
 350  * Roman Puls
 351  * Nate R
 352  * Robert Ransom
 353  * Balint Reczey
 354  * Bert JW Regeer
 355  * Nate Rosenblum
 356  * Peter Rosin
 357  * Maseeb Abdul Qadir
 358  * Wang Qin
 359  * Alex S
 360  * Gyepi Sam
 361  * Hanna Schroeter
 362  * Ralf Schmitt
 363  * Mike Smellie
 364  * Steve Snyder
 365  * Nir Soffer
 366  * Dug Song
 367  * Dongsheng Song
 368  * Hannes Sowa
 369  * Joakim Soderberg
 370  * Joseph Spadavecchia
 371  * Kevin Springborn
 372  * Harlan Stenn
 373  * Andrew Sweeney
 374  * Ferenc Szalai
 375  * Brodie Thiesfield
 376  * Jason Toffaletti
 377  * Brian Utterback
 378  * Gisle Vanem
 379  * Bas Verhoeven
 380  * Constantine Verutin
 381  * Colin Watt
 382  * Zack Weinberg
 383  * Jardel Weyrich
 384  * Jay R. Wren
 385  * Zack Weinberg
 386  * Mobai Zhang
 387  * Alejo
 388  * Alex
 389  * Taral
 390  * propanbutan
 391  * masksqwe
 392  * mmadia
 393  * yangacer
 394
 395 If we have forgotten your name, please contact us.