*** empty log message ***

[software/libev.git] / README.embed

diff --git a/README.embed b/README.embed
index b7e3ea473bf5233b95fbcc21a942545397496618..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_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.
 
 
     "ev.c" includes the backend files directly when enabled.
 


@@ -85,10 +86,12 @@ PREPROCESSOR SYMBOLS
 
     EV_USE_MONOTONIC
 
 
     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
         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
 
 
     EV_USE_REALTIME
 


@@ -118,12 +121,13 @@ PREPROCESSOR SYMBOLS
 
     EV_SELECT_IS_WINSOCKET
 
 
     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
 
 
     EV_USE_POLL
 


@@ -147,8 +151,14 @@ PREPROCESSOR SYMBOLS
        will be detected at runtime and routed around by disabling this
        backend.
 
        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
     EV_USE_DEVPOLL

-    EV_USE_PORTS

     
        reserved for future expansion, works like the USE symbols above.
 
     
        reserved for future expansion, works like the USE symbols above.
 


@@ -159,9 +169,14 @@ PREPROCESSOR SYMBOLS
         be used to virtually rename the ev.h header file in case of
         conflicts.
 
         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
 
     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
         of how the event.h header can be found.
 
     EV_PROTOTYPES