*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index 815e8b44a24044d9506352415664ec0a7c475c01..06c4c6cbd8eed3f5af3dcf12b0776df5e03e3cf7 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -35,7 +35,8 @@ FILESETS
         ev.c
         ev_vars.h
         ev_wrap.h
-        ev_win32.c
+
+        ev_win32.c      required on win32 platforms only
 
         ev_select.c     only when select backend is enabled (which is is by default)
         ev_poll.c       only when poll backend is enabled (disabled by default)
@@ -61,10 +62,17 @@ FILESETS
         event.h
         event.c
 
+AUTOCONF SUPPORT
+
+    Instead of using EV_STANDALONE=1 and providing your config in whatever
+    way you want, you can also m4_include([libev.m4]) in your configure.ac
+    and leave EV_STANDALONE off. ev.c will then include "config.h" and
+    configure itself accordingly.
+
 PREPROCESSOR SYMBOLS
 
     Libev can be configured via a variety of preprocessor symbols you have to define
-    before including any of its files. The default is not to build for mulciplicity
+    before including any of its files. The default is not to build for multiplicity
     and only include the select backend.
 
     EV_STANDALONE
@@ -98,7 +106,17 @@ PREPROCESSOR SYMBOLS
        done: if no other method takes over, select will be it. Otherwise
        the select backend will not be compiled in.
 
-    EV_SELECT_USE_WIN32_HANDLES
+    EV_SELECT_USE_FD_SET
+
+       If defined to 1, then the select backend will use the system fd_set
+       structure. This is useful if libev doesn't compile due to a missing
+       NFDBITS or fd_mask definition or it misguesses the bitset layout on
+       exotic systems. This usually limits the range of file descriptors
+       to some low limit such as 1024 or might have other limitations
+       (winsocket only allows 64 sockets). The FD_SETSIZE macro, set
+       before compilation, might influence the size of the fd_set used.
+
+    EV_SELECT_IS_WINSOCKET
 
        When defined to 1, the select backend will assume that select
        doesn't understand file descriptors but wants osf handles on
@@ -110,9 +128,8 @@ PREPROCESSOR SYMBOLS
     EV_USE_POLL
 
        If defined to be "1", libev will compile in support for the poll(2)
-       backend. No attempt at autodetection will be done. poll usually
-       performs worse than select, so its not enabled by default (it is
-       also slightly less portable).
+       backend. Otherwise it will be enabled on non-win32 platforms. It
+       takes precedence over select.
 
     EV_USE_EPOLL
 
@@ -126,10 +143,21 @@ PREPROCESSOR SYMBOLS
        If defined to be "1", libev will compile in support for the BSD
        style kqueue backend. Its availability will be detected at runtime,
        otherwise another method will be used as fallback. This is the
-       preferred backend for BSD and BSd-like systems. Darwin brokenness
+       preferred backend for BSD and BSD-like systems. Darwin brokenness
        will be detected at runtime and routed around by disabling this
        backend.
 
+    EV_USE_PORT
+
+       If defined to be "1", libev will compile in support for the Solaris
+       10 port style backend. Its availability will be detected at runtime,
+       otherwise another method will be used as fallback. This is the
+       preferred backend for Solaris 10 systems.
+
+    EV_USE_DEVPOLL
+    
+       reserved for future expansion, works like the USE symbols above.
+
     EV_H
 
         The name of the ev.h header file used to include it. The default
@@ -142,19 +170,6 @@ PREPROCESSOR SYMBOLS
         Similarly to EV_H, this macro cna be used to override event.c's idea
         of how the event.h header can be found.
 
-    EV_COMMON
- 
-       By default, all watchers have a "void *data" member. By redefining
-       this macro to a something else you can include more and other types
-       of members. You have to define it each time you include one of the
-       files, though, and it must be identical each time.
-
-       For example, the perl EV module uses this:
-
-           #define EV_COMMON                       \
-             SV *self; /* contains this struct */  \
-             SV *cb_sv, *fh /* note no trailing ";" */
-
     EV_PROTOTYPES
 
        If defined to be "0", then "ev.h" will not define any function
@@ -170,6 +185,24 @@ PREPROCESSOR SYMBOLS
        event loop pointer argument. Instead, all functions act on the
        single default loop.
 
+    EV_PERIODICS
+
+       If undefined or defined to be "1", then periodic timers are
+       supported, otherwise not. This saves a few kb of code.
+
+    EV_COMMON
+ 
+       By default, all watchers have a "void *data" member. By redefining
+       this macro to a something else you can include more and other types
+       of members. You have to define it each time you include one of the
+       files, though, and it must be identical each time.
+
+       For example, the perl EV module uses this:
+
+           #define EV_COMMON                       \
+             SV *self; /* contains this struct */  \
+             SV *cb_sv, *fh /* note no trailing ";" */
+
     EV_CB_DECLARE(type)
     EV_CB_INVOKE(watcher,revents)
     ev_set_cb(ev,cb)