Ruslan Osmanov avatar Ruslan Osmanov committed 4147d77

Doc

Comments (0)

Files changed (2)

+INSTALLATION OF EVENT PECL EXTENSION
+====================================
+
+Tested under GNU/Linux only. But likely will work on others too. The following
+also concerns GNU/Linux. If you find it useful to publish instructions for
+other platforms, please drop me a note. 
+
+
+PRELIMINARIES
+-------------
+
+Event extension supports `libevent 2.0` or greater. It expects at least
+<libevent_core.so> library to be installed. For extra functions
+<libevent_extra.so>) is required. However, since `libevent 2.0` both should
+come with the libevent distribution.
+
+Note that <libevent.so> exists for historical reasons. Currently it contains
+the contents of both <libevent_core.so> and <libevent_extra.so>. But using
+<libevent.so> is not reliable as it may go away in future releases.
+
+Most OS distributions have `libevent` package in their repositories:
+
+*Debian*, *Ubuntu* and similar:
+	# apt-get install libevent-dev
+
+*Gentoo*
+	# emerge dev-libs/libevent
+	(`ssl` USE-flag may be needed)
+
+*openSUSE*:
+	# zypper in libevent
+
+In a pinch the source code is always available on `libevent`'s homepage:
+<http://libevent.org/>
+
+
+AUTOMATIC INSTALLATION
+----------------------
+
+Just run the following as `root`: 
+
+	# pecl install package.xml
+
+
+MANUAL INSTALLATION
+-------------------
+
+Clone the project or download it as archive. In the package directory run:
+
+	$ phpize
+	$ ./configure --with-event-core --with-event-extra --enable-event-debug
+	$ make 
+
+Optionally run tests:
+
+	$ make test
+
+Install it (as `root`):
+
+	# make install
+
+
+FINALLY
+------
+
+In <php.ini>, or some other configuration like
+</usr/local/etc/php/conf.d/ev.ini> write:
+
+	extension=event.so
+
+
+vim: ft=markdown tw=80
+Event - PECL extension
+======================
+
+Event is a PECL extension providing interface to `libevent` C library.
+
+ABOUT LIBEVENT
+--------------
+
+The `libevent` API provides a mechanism to execute a callback function when a
+specific event occurs on a file descriptor or after a timeout has been reached.
+Furthermore, libevent also support callbacks due to *signals* or regular
+*timeouts*.
+
+`libevent` is meant to replace the event loop found in event driven network
+servers. An application just needs to call `event_dispatch()` and then add or
+remove events dynamically without having to change the event loop.
+
+For details refer to `libevent`'s homepage: <http://libevent.org/>.
+
+For installation instructions see file named <INSTALL.md>.
+
+
+AUTHOR
+======
+
+Ruslan Osmanov <osmanov@php.net>
+
+
+COPYRIGHT
+=========
+
+	Copyright (c) 2013 Ruslan Osmanov <osmanov@php.net>
+
+	This project is subject to version 3.01 of the PHP license, that is bundled
+	with this package in the file LICENSE, and is available through the
+	world-wide-web at the following url: http://www.php.net/license/3_01.txt If you
+	did not receive a copy of the PHP license and are unable to obtain it through
+	the world-wide-web, please send a note to license@php.net so we can mail you a
+	copy immediately.
+
+vim: ft=markdown ts=4 sts=4 sw=4
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.