*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index 3c15d7658dc612b302990967e5856a335995248a..e987765a9321f447c6a48f011fbb7cd0e683d5d9 100644 (file)
--- a/README.embed
+++ b/README.embed
@@ -42,6 +42,7 @@ FILESETS
         ev_poll.c       only when poll backend is enabled (disabled by default)
         ev_epoll.c      only when the epoll backend is enabled (disabled by default)
         ev_kqueue.c     only when the kqueue backend is enabled (disabled by default)
+        ev_port.c       only when the solaris port backend is enabled (disabled by default)
 
     "ev.c" includes the backend files directly when enabled.
 
@@ -85,10 +86,12 @@ PREPROCESSOR SYMBOLS
 
     EV_USE_MONOTONIC
 
-        If undefined or defined to be "1", libev will try to detect the
-        availability of the monotonic clock option at both compiletime and
+        If defined to be "1", libev will try to detect the availability
+        of the monotonic clock option at both compiletime and
         runtime. Otherwise no use of the monotonic clock option will be
-        attempted.
+        attempted. If you enable this, you usually have to link against
+        librt or something similar. Enabling it when the functionality
+        isn't available is safe, though.
 
     EV_USE_REALTIME
 
@@ -106,21 +109,31 @@ 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
-       win32 (this is the case when the select to be used is the winsock
-       select). This means that it will call _get_osfhandle on the fd to
-       convert it to an OS handle. Should not be defined on non-win32
-       platforms.
+       When defined to 1, the select backend will assume that
+       select/socket/connect etc. don't understand file descriptors but
+       wants osf handles on win32 (this is the case when the select to
+       be used is the winsock select). This means that it will call
+       _get_osfhandle on the fd to convert it to an OS handle. Otherwise,
+       it is assumed that all these functions actually work on fds, even
+       on win32. Should not be defined on non-win32 platforms.
 
     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
 
@@ -138,6 +151,17 @@ PREPROCESSOR SYMBOLS
        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
@@ -145,9 +169,14 @@ PREPROCESSOR SYMBOLS
         be used to virtually rename the ev.h header file in case of
         conflicts.
 
+    EV_CONFIG_H
+
+        If EV_STANDALONE isn't 1, this variable can be used to override
+        ev.c's idea of where to find the "config.h" file.
+
     EV_EVENT_H
 
-        Similarly to EV_H, this macro cna be used to override event.c's idea
+        Similarly to EV_H, this macro can be used to override event.c's idea
         of how the event.h header can be found.
 
     EV_PROTOTYPES