include embedding doc in main doc

[software/libev.git] / ev.3

diff --git a/ev.3 b/ev.3
index 5fda0313c33f5dd523af71d11266490a404002f3..5ff2d6540c75a5b943b932603412304ce35c1c39 100644 (file)
--- a/ev.3
+++ b/ev.3
@@ -129,7 +129,7 @@
 .\" ========================================================================
 .\"
 .IX Title ""<STANDARD INPUT>" 1"
 .\" ========================================================================
 .\"
 .IX Title ""<STANDARD INPUT>" 1"

-.TH "<STANDARD INPUT>" 1 "2007-11-23" "perl v5.8.8" "User Contributed Perl Documentation"
+.TH "<STANDARD INPUT>" 1 "2007-11-24" "perl v5.8.8" "User Contributed Perl Documentation"

 .SH "NAME"
 libev \- a high performance full\-featured event loop written in C
 .SH "SYNOPSIS"
 .SH "NAME"
 libev \- a high performance full\-featured event loop written in C
 .SH "SYNOPSIS"


@@ -175,7 +175,8 @@ Libev represents time as a single floating point number, representing the
 (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
 the beginning of 1970, details are complicated, don't ask). This type is
 called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases
 (fractional) number of seconds since the (\s-1POSIX\s0) epoch (somewhere near
 the beginning of 1970, details are complicated, don't ask). This type is
 called \f(CW\*(C`ev_tstamp\*(C'\fR, which is what you should use too. It usually aliases

-to the double type in C.
+to the \f(CW\*(C`double\*(C'\fR type in C, and when you need to do any calculations on
+it, you should treat it as such.

 .SH "GLOBAL FUNCTIONS"
 .IX Header "GLOBAL FUNCTIONS"
 These functions can be called anytime, even before initialising the
 .SH "GLOBAL FUNCTIONS"
 .IX Header "GLOBAL FUNCTIONS"
 These functions can be called anytime, even before initialising the


@@ -201,6 +202,46 @@ Usually, it's a good idea to terminate if the major versions mismatch,
 as this indicates an incompatible change.  Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.
 as this indicates an incompatible change.  Minor versions are usually
 compatible to older versions, so a larger minor version alone is usually
 not a problem.

+.Sp
+Example: make sure we haven't accidentally been linked against the wrong
+version:
+.Sp
+.Vb 3
+\&  assert (("libev version mismatch",
+\&           ev_version_major () == EV_VERSION_MAJOR
+\&           && ev_version_minor () >= EV_VERSION_MINOR));
+.Ve
+.IP "unsigned int ev_supported_backends ()" 4
+.IX Item "unsigned int ev_supported_backends ()"
+Return the set of all backends (i.e. their corresponding \f(CW\*(C`EV_BACKEND_*\*(C'\fR
+value) compiled into this binary of libev (independent of their
+availability on the system you are running on). See \f(CW\*(C`ev_default_loop\*(C'\fR for
+a description of the set values.
+.Sp
+Example: make sure we have the epoll method, because yeah this is cool and
+a must have and can we have a torrent of it please!!!11
+.Sp
+.Vb 2
+\&  assert (("sorry, no epoll, no sex",
+\&           ev_supported_backends () & EVBACKEND_EPOLL));
+.Ve
+.IP "unsigned int ev_recommended_backends ()" 4
+.IX Item "unsigned int ev_recommended_backends ()"
+Return the set of all backends compiled into this binary of libev and also
+recommended for this platform. This set is often smaller than the one
+returned by \f(CW\*(C`ev_supported_backends\*(C'\fR, as for example kqueue is broken on
+most BSDs and will not be autodetected unless you explicitly request it
+(assuming you know what you are doing). This is the set of backends that
+libev will probe for if you specify no backends explicitly.
+.IP "unsigned int ev_embeddable_backends ()" 4
+.IX Item "unsigned int ev_embeddable_backends ()"
+Returns the set of backends that are embeddable in other event loops. This
+is the theoretical, all\-platform, value. To find which backends
+might be supported on the current system, you would need to look at
+\&\f(CW\*(C`ev_embeddable_backends () & ev_supported_backends ()\*(C'\fR, likewise for
+recommended ones.
+.Sp
+See the description of \f(CW\*(C`ev_embed\*(C'\fR watchers for more info.

 .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
 .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
 Sets the allocation function to use (the prototype is similar to the
 .IP "ev_set_allocator (void *(*cb)(void *ptr, long size))" 4
 .IX Item "ev_set_allocator (void *(*cb)(void *ptr, long size))"
 Sets the allocation function to use (the prototype is similar to the


@@ -212,6 +253,34 @@ destructive action. The default is your system realloc function.
 You could override this function in high-availability programs to, say,
 free some memory if it cannot allocate memory, to use a special allocator,
 or even to sleep a while and retry until some memory is available.
 You could override this function in high-availability programs to, say,
 free some memory if it cannot allocate memory, to use a special allocator,
 or even to sleep a while and retry until some memory is available.

+.Sp
+Example: replace the libev allocator with one that waits a bit and then
+retries: better than mine).
+.Sp
+.Vb 6
+\&   static void *
+\&   persistent_realloc (void *ptr, long size)
+\&   {
+\&     for (;;)
+\&       {
+\&         void *newptr = realloc (ptr, size);
+.Ve
+.Sp
+.Vb 2
+\&         if (newptr)
+\&           return newptr;
+.Ve
+.Sp
+.Vb 3
+\&         sleep (60);
+\&       }
+\&   }
+.Ve
+.Sp
+.Vb 2
+\&   ...
+\&   ev_set_allocator (persistent_realloc);
+.Ve

 .IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
 .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
 Set the callback function to call on a retryable syscall error (such
 .IP "ev_set_syserr_cb (void (*cb)(const char *msg));" 4
 .IX Item "ev_set_syserr_cb (void (*cb)(const char *msg));"
 Set the callback function to call on a retryable syscall error (such


@@ -221,6 +290,22 @@ callback is set, then libev will expect it to remedy the sitution, no
 matter what, when it returns. That is, libev will generally retry the
 requested operation, or, if the condition doesn't go away, do bad stuff
 (such as abort).
 matter what, when it returns. That is, libev will generally retry the
 requested operation, or, if the condition doesn't go away, do bad stuff
 (such as abort).

+.Sp
+Example: do the same thing as libev does internally:
+.Sp
+.Vb 6
+\&   static void
+\&   fatal_error (const char *msg)
+\&   {
+\&     perror (msg);
+\&     abort ();
+\&   }
+.Ve
+.Sp
+.Vb 2
+\&   ...
+\&   ev_set_syserr_cb (fatal_error);
+.Ve

 .SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
 .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
 An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two
 .SH "FUNCTIONS CONTROLLING THE EVENT LOOP"
 .IX Header "FUNCTIONS CONTROLLING THE EVENT LOOP"
 An event loop is described by a \f(CW\*(C`struct ev_loop *\*(C'\fR. The library knows two


@@ -238,15 +323,15 @@ done correctly, because it's hideous and inefficient).
 This will initialise the default event loop if it hasn't been initialised
 yet and return it. If the default loop could not be initialised, returns
 false. If it already was initialised it simply returns it (and ignores the
 This will initialise the default event loop if it hasn't been initialised
 yet and return it. If the default loop could not be initialised, returns
 false. If it already was initialised it simply returns it (and ignores the

-flags).
+flags. If that is troubling you, check \f(CW\*(C`ev_backend ()\*(C'\fR afterwards).

 .Sp
 If you don't know what event loop to use, use the one returned from this
 function.
 .Sp
 The flags argument can be used to specify special behaviour or specific
 .Sp
 If you don't know what event loop to use, use the one returned from this
 function.
 .Sp
 The flags argument can be used to specify special behaviour or specific

-backends to use, and is usually specified as 0 (or \s-1EVFLAG_AUTO\s0).
+backends to use, and is usually specified as \f(CW0\fR (or \f(CW\*(C`EVFLAG_AUTO\*(C'\fR).

 .Sp
 .Sp

-It supports the following flags:
+The following flags are supported:

 .RS 4
 .ie n .IP """EVFLAG_AUTO""" 4
 .el .IP "\f(CWEVFLAG_AUTO\fR" 4
 .RS 4
 .ie n .IP """EVFLAG_AUTO""" 4
 .el .IP "\f(CWEVFLAG_AUTO\fR" 4


@@ -262,24 +347,24 @@ or setgid) then libev will \fInot\fR look at the environment variable
 override the flags completely if it is found in the environment. This is
 useful to try out specific backends to test their performance, or to work
 around bugs.
 override the flags completely if it is found in the environment. This is
 useful to try out specific backends to test their performance, or to work
 around bugs.

-.ie n .IP """EVMETHOD_SELECT""  (value 1, portable select backend)" 4
-.el .IP "\f(CWEVMETHOD_SELECT\fR  (value 1, portable select backend)" 4
-.IX Item "EVMETHOD_SELECT  (value 1, portable select backend)"
+.ie n .IP """EVBACKEND_SELECT""  (value 1, portable select backend)" 4
+.el .IP "\f(CWEVBACKEND_SELECT\fR  (value 1, portable select backend)" 4
+.IX Item "EVBACKEND_SELECT  (value 1, portable select backend)"

 This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
 libev tries to roll its own fd_set with no limits on the number of fds,
 but if that fails, expect a fairly low limit on the number of fds when
 using this backend. It doesn't scale too well (O(highest_fd)), but its usually
 the fastest backend for a low number of fds.
 This is your standard \fIselect\fR\|(2) backend. Not \fIcompletely\fR standard, as
 libev tries to roll its own fd_set with no limits on the number of fds,
 but if that fails, expect a fairly low limit on the number of fds when
 using this backend. It doesn't scale too well (O(highest_fd)), but its usually
 the fastest backend for a low number of fds.

-.ie n .IP """EVMETHOD_POLL""    (value 2, poll backend, available everywhere except on windows)" 4
-.el .IP "\f(CWEVMETHOD_POLL\fR    (value 2, poll backend, available everywhere except on windows)" 4
-.IX Item "EVMETHOD_POLL    (value 2, poll backend, available everywhere except on windows)"
+.ie n .IP """EVBACKEND_POLL""    (value 2, poll backend, available everywhere except on windows)" 4
+.el .IP "\f(CWEVBACKEND_POLL\fR    (value 2, poll backend, available everywhere except on windows)" 4
+.IX Item "EVBACKEND_POLL    (value 2, poll backend, available everywhere except on windows)"

 And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than
 select, but handles sparse fds better and has no artificial limit on the
 number of fds you can use (except it will slow down considerably with a
 lot of inactive fds). It scales similarly to select, i.e. O(total_fds).
 And this is your standard \fIpoll\fR\|(2) backend. It's more complicated than
 select, but handles sparse fds better and has no artificial limit on the
 number of fds you can use (except it will slow down considerably with a
 lot of inactive fds). It scales similarly to select, i.e. O(total_fds).

-.ie n .IP """EVMETHOD_EPOLL""   (value 4, Linux)" 4
-.el .IP "\f(CWEVMETHOD_EPOLL\fR   (value 4, Linux)" 4
-.IX Item "EVMETHOD_EPOLL   (value 4, Linux)"
+.ie n .IP """EVBACKEND_EPOLL""   (value 4, Linux)" 4
+.el .IP "\f(CWEVBACKEND_EPOLL\fR   (value 4, Linux)" 4
+.IX Item "EVBACKEND_EPOLL   (value 4, Linux)"

 For few fds, this backend is a bit little slower than poll and select,
 but it scales phenomenally better. While poll and select usually scale like
 O(total_fds) where n is the total number of fds (or the highest fd), epoll scales
 For few fds, this backend is a bit little slower than poll and select,
 but it scales phenomenally better. While poll and select usually scale like
 O(total_fds) where n is the total number of fds (or the highest fd), epoll scales


@@ -290,35 +375,44 @@ result in some caching, there is still a syscall per such incident
 (because the fd could point to a different file description now), so its
 best to avoid that. Also, \fIdup()\fRed file descriptors might not work very
 well if you register events for both fds.
 (because the fd could point to a different file description now), so its
 best to avoid that. Also, \fIdup()\fRed file descriptors might not work very
 well if you register events for both fds.

-.ie n .IP """EVMETHOD_KQUEUE""  (value 8, most \s-1BSD\s0 clones)" 4
-.el .IP "\f(CWEVMETHOD_KQUEUE\fR  (value 8, most \s-1BSD\s0 clones)" 4
-.IX Item "EVMETHOD_KQUEUE  (value 8, most BSD clones)"
+.Sp
+Please note that epoll sometimes generates spurious notifications, so you
+need to use non-blocking I/O or other means to avoid blocking when no data
+(or space) is available.
+.ie n .IP """EVBACKEND_KQUEUE""  (value 8, most \s-1BSD\s0 clones)" 4
+.el .IP "\f(CWEVBACKEND_KQUEUE\fR  (value 8, most \s-1BSD\s0 clones)" 4
+.IX Item "EVBACKEND_KQUEUE  (value 8, most BSD clones)"

 Kqueue deserves special mention, as at the time of this writing, it
 was broken on all BSDs except NetBSD (usually it doesn't work with
 anything but sockets and pipes, except on Darwin, where of course its
 Kqueue deserves special mention, as at the time of this writing, it
 was broken on all BSDs except NetBSD (usually it doesn't work with
 anything but sockets and pipes, except on Darwin, where of course its

-completely useless). For this reason its not being \*(L"autodetected\*(R" unless
-you explicitly specify the flags (i.e. you don't use \s-1EVFLAG_AUTO\s0).
+completely useless). For this reason its not being \*(L"autodetected\*(R"
+unless you explicitly specify it explicitly in the flags (i.e. using
+\&\f(CW\*(C`EVBACKEND_KQUEUE\*(C'\fR).

 .Sp
 It scales in the same way as the epoll backend, but the interface to the
 kernel is more efficient (which says nothing about its actual speed, of
 course). While starting and stopping an I/O watcher does not cause an
 extra syscall as with epoll, it still adds up to four event changes per
 incident, so its best to avoid that.
 .Sp
 It scales in the same way as the epoll backend, but the interface to the
 kernel is more efficient (which says nothing about its actual speed, of
 course). While starting and stopping an I/O watcher does not cause an
 extra syscall as with epoll, it still adds up to four event changes per
 incident, so its best to avoid that.

-.ie n .IP """EVMETHOD_DEVPOLL"" (value 16, Solaris 8)" 4
-.el .IP "\f(CWEVMETHOD_DEVPOLL\fR (value 16, Solaris 8)" 4
-.IX Item "EVMETHOD_DEVPOLL (value 16, Solaris 8)"
+.ie n .IP """EVBACKEND_DEVPOLL"" (value 16, Solaris 8)" 4
+.el .IP "\f(CWEVBACKEND_DEVPOLL\fR (value 16, Solaris 8)" 4
+.IX Item "EVBACKEND_DEVPOLL (value 16, Solaris 8)"

 This is not implemented yet (and might never be).
 This is not implemented yet (and might never be).

-.ie n .IP """EVMETHOD_PORT""    (value 32, Solaris 10)" 4
-.el .IP "\f(CWEVMETHOD_PORT\fR    (value 32, Solaris 10)" 4
-.IX Item "EVMETHOD_PORT    (value 32, Solaris 10)"
+.ie n .IP """EVBACKEND_PORT""    (value 32, Solaris 10)" 4
+.el .IP "\f(CWEVBACKEND_PORT\fR    (value 32, Solaris 10)" 4
+.IX Item "EVBACKEND_PORT    (value 32, Solaris 10)"

 This uses the Solaris 10 port mechanism. As with everything on Solaris,
 it's really slow, but it still scales very well (O(active_fds)).
 This uses the Solaris 10 port mechanism. As with everything on Solaris,
 it's really slow, but it still scales very well (O(active_fds)).

-.ie n .IP """EVMETHOD_ALL""" 4
-.el .IP "\f(CWEVMETHOD_ALL\fR" 4
-.IX Item "EVMETHOD_ALL"
+.Sp
+Please note that solaris ports can result in a lot of spurious
+notifications, so you need to use non-blocking I/O or other means to avoid
+blocking when no data (or space) is available.
+.ie n .IP """EVBACKEND_ALL""" 4
+.el .IP "\f(CWEVBACKEND_ALL\fR" 4
+.IX Item "EVBACKEND_ALL"

 Try all backends (even potentially broken ones that wouldn't be tried
 with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as
 Try all backends (even potentially broken ones that wouldn't be tried
 with \f(CW\*(C`EVFLAG_AUTO\*(C'\fR). Since this is a mask, you can do stuff such as

-\&\f(CW\*(C`EVMETHOD_ALL & ~EVMETHOD_KQUEUE\*(C'\fR.
+\&\f(CW\*(C`EVBACKEND_ALL & ~EVBACKEND_KQUEUE\*(C'\fR.

 .RE
 .RS 4
 .Sp
 .RE
 .RS 4
 .Sp


@@ -326,6 +420,28 @@ If one or more of these are ored into the flags value, then only these
 backends will be tried (in the reverse order as given here). If none are
 specified, most compiled-in backend will be tried, usually in reverse
 order of their flag values :)
 backends will be tried (in the reverse order as given here). If none are
 specified, most compiled-in backend will be tried, usually in reverse
 order of their flag values :)

+.Sp
+The most typical usage is like this:
+.Sp
+.Vb 2
+\&  if (!ev_default_loop (0))
+\&    fatal ("could not initialise libev, bad $LIBEV_FLAGS in environment?");
+.Ve
+.Sp
+Restrict libev to the select and poll backends, and do not allow
+environment settings to be taken into account:
+.Sp
+.Vb 1
+\&  ev_default_loop (EVBACKEND_POLL | EVBACKEND_SELECT | EVFLAG_NOENV);
+.Ve
+.Sp
+Use whatever libev has to offer, but make sure that kqueue is used if
+available (warning, breaks stuff, best use only with your own private
+event loop and only if you know the \s-1OS\s0 supports your types of fds):
+.Sp
+.Vb 1
+\&  ev_default_loop (ev_recommended_backends () | EVBACKEND_KQUEUE);
+.Ve

 .RE
 .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
 .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"
 .RE
 .IP "struct ev_loop *ev_loop_new (unsigned int flags)" 4
 .IX Item "struct ev_loop *ev_loop_new (unsigned int flags)"


@@ -333,11 +449,23 @@ Similar to \f(CW\*(C`ev_default_loop\*(C'\fR, but always creates a new event loo
 always distinct from the default loop. Unlike the default loop, it cannot
 handle signal and child watchers, and attempts to do so will be greeted by
 undefined behaviour (or a failed assertion if assertions are enabled).
 always distinct from the default loop. Unlike the default loop, it cannot
 handle signal and child watchers, and attempts to do so will be greeted by
 undefined behaviour (or a failed assertion if assertions are enabled).

+.Sp
+Example: try to create a event loop that uses epoll and nothing else.
+.Sp
+.Vb 3
+\&  struct ev_loop *epoller = ev_loop_new (EVBACKEND_EPOLL | EVFLAG_NOENV);
+\&  if (!epoller)
+\&    fatal ("no epoll found here, maybe it hides under your chair");
+.Ve

 .IP "ev_default_destroy ()" 4
 .IX Item "ev_default_destroy ()"
 Destroys the default loop again (frees all memory and kernel state
 .IP "ev_default_destroy ()" 4
 .IX Item "ev_default_destroy ()"
 Destroys the default loop again (frees all memory and kernel state

-etc.). This stops all registered event watchers (by not touching them in
-any way whatsoever, although you cannot rely on this :).
+etc.). None of the active event watchers will be stopped in the normal
+sense, so e.g. \f(CW\*(C`ev_is_active\*(C'\fR might still return true. It is your
+responsibility to either stop all watchers cleanly yoursef \fIbefore\fR
+calling this function, or cope with the fact afterwards (which is usually
+the easiest thing, youc na just ignore the watchers and/or \f(CW\*(C`free ()\*(C'\fR them
+for example).

 .IP "ev_loop_destroy (loop)" 4
 .IX Item "ev_loop_destroy (loop)"
 Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an
 .IP "ev_loop_destroy (loop)" 4
 .IX Item "ev_loop_destroy (loop)"
 Like \f(CW\*(C`ev_default_destroy\*(C'\fR, but destroys an event loop created by an


@@ -360,30 +488,40 @@ quite nicely into a call to \f(CW\*(C`pthread_atfork\*(C'\fR:
 .Vb 1
 \&    pthread_atfork (0, 0, ev_default_fork);
 .Ve
 .Vb 1
 \&    pthread_atfork (0, 0, ev_default_fork);
 .Ve

+.Sp
+At the moment, \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and \f(CW\*(C`EVBACKEND_POLL\*(C'\fR are safe to use
+without calling this function, so if you force one of those backends you
+do not need to care.

 .IP "ev_loop_fork (loop)" 4
 .IX Item "ev_loop_fork (loop)"
 Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
 \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
 after fork, and how you do this is entirely your own problem.
 .IP "ev_loop_fork (loop)" 4
 .IX Item "ev_loop_fork (loop)"
 Like \f(CW\*(C`ev_default_fork\*(C'\fR, but acts on an event loop created by
 \&\f(CW\*(C`ev_loop_new\*(C'\fR. Yes, you have to call this on every allocated event loop
 after fork, and how you do this is entirely your own problem.

-.IP "unsigned int ev_method (loop)" 4
-.IX Item "unsigned int ev_method (loop)"
-Returns one of the \f(CW\*(C`EVMETHOD_*\*(C'\fR flags indicating the event backend in
+.IP "unsigned int ev_backend (loop)" 4
+.IX Item "unsigned int ev_backend (loop)"
+Returns one of the \f(CW\*(C`EVBACKEND_*\*(C'\fR flags indicating the event backend in

 use.
 .IP "ev_tstamp ev_now (loop)" 4
 .IX Item "ev_tstamp ev_now (loop)"
 Returns the current \*(L"event loop time\*(R", which is the time the event loop
 use.
 .IP "ev_tstamp ev_now (loop)" 4
 .IX Item "ev_tstamp ev_now (loop)"
 Returns the current \*(L"event loop time\*(R", which is the time the event loop

-got events and started processing them. This timestamp does not change
-as long as callbacks are being processed, and this is also the base time
-used for relative timers. You can treat it as the timestamp of the event
-occuring (or more correctly, the mainloop finding out about it).
+received events and started processing them. This timestamp does not
+change as long as callbacks are being processed, and this is also the base
+time used for relative timers. You can treat it as the timestamp of the
+event occuring (or more correctly, libev finding out about it).

 .IP "ev_loop (loop, int flags)" 4
 .IX Item "ev_loop (loop, int flags)"
 Finally, this is it, the event handler. This function usually is called
 after you initialised all your watchers and you want to start handling
 events.
 .Sp
 .IP "ev_loop (loop, int flags)" 4
 .IX Item "ev_loop (loop, int flags)"
 Finally, this is it, the event handler. This function usually is called
 after you initialised all your watchers and you want to start handling
 events.
 .Sp

-If the flags argument is specified as 0, it will not return until either
-no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called.
+If the flags argument is specified as \f(CW0\fR, it will not return until
+either no event watchers are active anymore or \f(CW\*(C`ev_unloop\*(C'\fR was called.
+.Sp
+Please note that an explicit \f(CW\*(C`ev_unloop\*(C'\fR is usually better than
+relying on all watchers to be stopped when deciding when a program has
+finished (especially in interactive programs), but having a program that
+automatically loops as long as it has to and no longer by virtue of
+relying on its watchers stopping correctly is a thing of beauty.

 .Sp
 A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle
 those events and any outstanding ones, but will not block your process in
 .Sp
 A flags value of \f(CW\*(C`EVLOOP_NONBLOCK\*(C'\fR will look for new events, will handle
 those events and any outstanding ones, but will not block your process in


@@ -392,30 +530,42 @@ case there are no events and will return after one iteration of the loop.
 A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if
 neccessary) and will handle those and any outstanding ones. It will block
 your process until at least one new event arrives, and will return after
 A flags value of \f(CW\*(C`EVLOOP_ONESHOT\*(C'\fR will look for new events (waiting if
 neccessary) and will handle those and any outstanding ones. It will block
 your process until at least one new event arrives, and will return after

-one iteration of the loop.
-.Sp
-This flags value could be used to implement alternative looping
-constructs, but the \f(CW\*(C`prepare\*(C'\fR and \f(CW\*(C`check\*(C'\fR watchers provide a better and
-more generic mechanism.
-.Sp
-Here are the gory details of what ev_loop does:
-.Sp
-.Vb 15
-\&   1. If there are no active watchers (reference count is zero), return.
-\&   2. Queue and immediately call all prepare watchers.
-\&   3. If we have been forked, recreate the kernel state.
-\&   4. Update the kernel state with all outstanding changes.
-\&   5. Update the "event loop time".
-\&   6. Calculate for how long to block.
-\&   7. Block the process, waiting for events.
-\&   8. Update the "event loop time" and do time jump handling.
-\&   9. Queue all outstanding timers.
-\&  10. Queue all outstanding periodics.
-\&  11. If no events are pending now, queue all idle watchers.
-\&  12. Queue all check watchers.
-\&  13. Call all queued watchers in reverse order (i.e. check watchers first).
-\&  14. If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
-\&      was used, return, otherwise continue with step #1.
+one iteration of the loop. This is useful if you are waiting for some
+external event in conjunction with something not expressible using other
+libev watchers. However, a pair of \f(CW\*(C`ev_prepare\*(C'\fR/\f(CW\*(C`ev_check\*(C'\fR watchers is
+usually a better approach for this kind of thing.
+.Sp
+Here are the gory details of what \f(CW\*(C`ev_loop\*(C'\fR does:
+.Sp
+.Vb 18
+\&   * If there are no active watchers (reference count is zero), return.
+\&   - Queue prepare watchers and then call all outstanding watchers.
+\&   - If we have been forked, recreate the kernel state.
+\&   - Update the kernel state with all outstanding changes.
+\&   - Update the "event loop time".
+\&   - Calculate for how long to block.
+\&   - Block the process, waiting for any events.
+\&   - Queue all outstanding I/O (fd) events.
+\&   - Update the "event loop time" and do time jump handling.
+\&   - Queue all outstanding timers.
+\&   - Queue all outstanding periodics.
+\&   - If no events are pending now, queue all idle watchers.
+\&   - Queue all check watchers.
+\&   - Call all queued watchers in reverse order (i.e. check watchers first).
+\&     Signals and child watchers are implemented as I/O watchers, and will
+\&     be handled here by queueing them when their watcher gets executed.
+\&   - If ev_unloop has been called or EVLOOP_ONESHOT or EVLOOP_NONBLOCK
+\&     were used, return, otherwise continue with step *.
+.Ve
+.Sp
+Example: queue some jobs and then loop until no events are outsanding
+anymore.
+.Sp
+.Vb 4
+\&   ... queue jobs here, make sure they register event watchers as long
+\&   ... as they still have work to do (even an idle watcher will do..)
+\&   ev_loop (my_loop, 0);
+\&   ... jobs done. yeah!

 .Ve
 .IP "ev_unloop (loop, how)" 4
 .IX Item "ev_unloop (loop, how)"
 .Ve
 .IP "ev_unloop (loop, how)" 4
 .IX Item "ev_unloop (loop, how)"


@@ -439,6 +589,23 @@ visible to the libev user and should not keep \f(CW\*(C`ev_loop\*(C'\fR from exi
 no event watchers registered by it are active. It is also an excellent
 way to do this for generic recurring timers or from within third-party
 libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR.
 no event watchers registered by it are active. It is also an excellent
 way to do this for generic recurring timers or from within third-party
 libraries. Just remember to \fIunref after start\fR and \fIref before stop\fR.

+.Sp
+Example: create a signal watcher, but keep it from keeping \f(CW\*(C`ev_loop\*(C'\fR
+running when nothing else is active.
+.Sp
+.Vb 4
+\&  struct dv_signal exitsig;
+\&  ev_signal_init (&exitsig, sig_cb, SIGINT);
+\&  ev_signal_start (myloop, &exitsig);
+\&  evf_unref (myloop);
+.Ve
+.Sp
+Example: for some weird reason, unregister the above signal handler again.
+.Sp
+.Vb 2
+\&  ev_ref (myloop);
+\&  ev_signal_stop (myloop, &exitsig);
+.Ve

 .SH "ANATOMY OF A WATCHER"
 .IX Header "ANATOMY OF A WATCHER"
 A watcher is a structure that you create and register to record your
 .SH "ANATOMY OF A WATCHER"
 .IX Header "ANATOMY OF A WATCHER"
 A watcher is a structure that you create and register to record your


@@ -484,12 +651,7 @@ corresponding stop function (\f(CW\*(C`ev_<type>_stop (loop, watcher *)\*(C'\fR.
 .PP
 As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never
 .PP
 As long as your watcher is active (has been started but not stopped) you
 must not touch the values stored in it. Most specifically you must never

-reinitialise it or call its set method.
-.PP
-You can check whether an event is active by calling the \f(CW\*(C`ev_is_active
-(watcher *)\*(C'\fR macro. To see whether an event is outstanding (but the
-callback for it has not been called yet) you can use the \f(CW\*(C`ev_is_pending
-(watcher *)\*(C'\fR macro.
+reinitialise it or call its \f(CW\*(C`set\*(C'\fR macro.

 .PP
 Each and every callback receives the event loop pointer as first, the
 registered watcher structure as second, and a bitset of received events as
 .PP
 Each and every callback receives the event loop pointer as first, the
 registered watcher structure as second, and a bitset of received events as


@@ -557,6 +719,75 @@ for example it might indicate that a fd is readable or writable, and if
 your callbacks is well-written it can just attempt the operation and cope
 with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded
 programs, though, so beware.
 your callbacks is well-written it can just attempt the operation and cope
 with the error from \fIread()\fR or \fIwrite()\fR. This will not work in multithreaded
 programs, though, so beware.

+.Sh "\s-1SUMMARY\s0 \s-1OF\s0 \s-1GENERIC\s0 \s-1WATCHER\s0 \s-1FUNCTIONS\s0"
+.IX Subsection "SUMMARY OF GENERIC WATCHER FUNCTIONS"
+In the following description, \f(CW\*(C`TYPE\*(C'\fR stands for the watcher type,
+e.g. \f(CW\*(C`timer\*(C'\fR for \f(CW\*(C`ev_timer\*(C'\fR watchers and \f(CW\*(C`io\*(C'\fR for \f(CW\*(C`ev_io\*(C'\fR watchers.
+.ie n .IP """ev_init"" (ev_TYPE *watcher, callback)" 4
+.el .IP "\f(CWev_init\fR (ev_TYPE *watcher, callback)" 4
+.IX Item "ev_init (ev_TYPE *watcher, callback)"
+This macro initialises the generic portion of a watcher. The contents
+of the watcher object can be arbitrary (so \f(CW\*(C`malloc\*(C'\fR will do). Only
+the generic parts of the watcher are initialised, you \fIneed\fR to call
+the type-specific \f(CW\*(C`ev_TYPE_set\*(C'\fR macro afterwards to initialise the
+type-specific parts. For each type there is also a \f(CW\*(C`ev_TYPE_init\*(C'\fR macro
+which rolls both calls into one.
+.Sp
+You can reinitialise a watcher at any time as long as it has been stopped
+(or never started) and there are no pending events outstanding.
+.Sp
+The callbakc is always of type \f(CW\*(C`void (*)(ev_loop *loop, ev_TYPE *watcher,
+int revents)\*(C'\fR.
+.ie n .IP """ev_TYPE_set"" (ev_TYPE *, [args])" 4
+.el .IP "\f(CWev_TYPE_set\fR (ev_TYPE *, [args])" 4
+.IX Item "ev_TYPE_set (ev_TYPE *, [args])"
+This macro initialises the type-specific parts of a watcher. You need to
+call \f(CW\*(C`ev_init\*(C'\fR at least once before you call this macro, but you can
+call \f(CW\*(C`ev_TYPE_set\*(C'\fR any number of times. You must not, however, call this
+macro on a watcher that is active (it can be pending, however, which is a
+difference to the \f(CW\*(C`ev_init\*(C'\fR macro).
+.Sp
+Although some watcher types do not have type-specific arguments
+(e.g. \f(CW\*(C`ev_prepare\*(C'\fR) you still need to call its \f(CW\*(C`set\*(C'\fR macro.
+.ie n .IP """ev_TYPE_init"" (ev_TYPE *watcher, callback, [args])" 4
+.el .IP "\f(CWev_TYPE_init\fR (ev_TYPE *watcher, callback, [args])" 4
+.IX Item "ev_TYPE_init (ev_TYPE *watcher, callback, [args])"
+This convinience macro rolls both \f(CW\*(C`ev_init\*(C'\fR and \f(CW\*(C`ev_TYPE_set\*(C'\fR macro
+calls into a single call. This is the most convinient method to initialise
+a watcher. The same limitations apply, of course.
+.ie n .IP """ev_TYPE_start"" (loop *, ev_TYPE *watcher)" 4
+.el .IP "\f(CWev_TYPE_start\fR (loop *, ev_TYPE *watcher)" 4
+.IX Item "ev_TYPE_start (loop *, ev_TYPE *watcher)"
+Starts (activates) the given watcher. Only active watchers will receive
+events. If the watcher is already active nothing will happen.
+.ie n .IP """ev_TYPE_stop"" (loop *, ev_TYPE *watcher)" 4
+.el .IP "\f(CWev_TYPE_stop\fR (loop *, ev_TYPE *watcher)" 4
+.IX Item "ev_TYPE_stop (loop *, ev_TYPE *watcher)"
+Stops the given watcher again (if active) and clears the pending
+status. It is possible that stopped watchers are pending (for example,
+non-repeating timers are being stopped when they become pending), but
+\&\f(CW\*(C`ev_TYPE_stop\*(C'\fR ensures that the watcher is neither active nor pending. If
+you want to free or reuse the memory used by the watcher it is therefore a
+good idea to always call its \f(CW\*(C`ev_TYPE_stop\*(C'\fR function.
+.IP "bool ev_is_active (ev_TYPE *watcher)" 4
+.IX Item "bool ev_is_active (ev_TYPE *watcher)"
+Returns a true value iff the watcher is active (i.e. it has been started
+and not yet been stopped). As long as a watcher is active you must not modify
+it.
+.IP "bool ev_is_pending (ev_TYPE *watcher)" 4
+.IX Item "bool ev_is_pending (ev_TYPE *watcher)"
+Returns a true value iff the watcher is pending, (i.e. it has outstanding
+events but its callback has not yet been invoked). As long as a watcher
+is pending (but not active) you must not call an init function on it (but
+\&\f(CW\*(C`ev_TYPE_set\*(C'\fR is safe) and you must make sure the watcher is available to
+libev (e.g. you cnanot \f(CW\*(C`free ()\*(C'\fR it).
+.IP "callback = ev_cb (ev_TYPE *watcher)" 4
+.IX Item "callback = ev_cb (ev_TYPE *watcher)"
+Returns the callback currently set on the watcher.
+.IP "ev_cb_set (ev_TYPE *watcher, callback)" 4
+.IX Item "ev_cb_set (ev_TYPE *watcher, callback)"
+Change the callback. You can change the callback at virtually any time
+(modulo threads).

 .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change
 .Sh "\s-1ASSOCIATING\s0 \s-1CUSTOM\s0 \s-1DATA\s0 \s-1WITH\s0 A \s-1WATCHER\s0"
 .IX Subsection "ASSOCIATING CUSTOM DATA WITH A WATCHER"
 Each watcher has, by default, a member \f(CW\*(C`void *data\*(C'\fR that you can change


@@ -614,8 +845,8 @@ to the same underlying file/socket etc. description (that is, they share
 the same underlying \*(L"file open\*(R").
 .PP
 If you must do this, then force the use of a known-to-be-good backend
 the same underlying \*(L"file open\*(R").
 .PP
 If you must do this, then force the use of a known-to-be-good backend

-(at the time of this writing, this includes only \s-1EVMETHOD_SELECT\s0 and
-\&\s-1EVMETHOD_POLL\s0).
+(at the time of this writing, this includes only \f(CW\*(C`EVBACKEND_SELECT\*(C'\fR and
+\&\f(CW\*(C`EVBACKEND_POLL\*(C'\fR).

 .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
 .IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
 .PD 0
 .IP "ev_io_init (ev_io *, callback, int fd, int events)" 4
 .IX Item "ev_io_init (ev_io *, callback, int fd, int events)"
 .PD 0


@@ -625,6 +856,39 @@ If you must do this, then force the use of a known-to-be-good backend
 Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive
 events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ |
 EV_WRITE\*(C'\fR to receive the given events.
 Configures an \f(CW\*(C`ev_io\*(C'\fR watcher. The fd is the file descriptor to rceeive
 events for and events is either \f(CW\*(C`EV_READ\*(C'\fR, \f(CW\*(C`EV_WRITE\*(C'\fR or \f(CW\*(C`EV_READ |
 EV_WRITE\*(C'\fR to receive the given events.

+.Sp
+Please note that most of the more scalable backend mechanisms (for example
+epoll and solaris ports) can result in spurious readyness notifications
+for file descriptors, so you practically need to use non-blocking I/O (and
+treat callback invocation as hint only), or retest separately with a safe
+interface before doing I/O (XLib can do this), or force the use of either
+\&\f(CW\*(C`EVBACKEND_SELECT\*(C'\fR or \f(CW\*(C`EVBACKEND_POLL\*(C'\fR, which don't suffer from this
+problem. Also note that it is quite easy to have your callback invoked
+when the readyness condition is no longer valid even when employing
+typical ways of handling events, so its a good idea to use non-blocking
+I/O unconditionally.
+.PP
+Example: call \f(CW\*(C`stdin_readable_cb\*(C'\fR when \s-1STDIN_FILENO\s0 has become, well
+readable, but only once. Since it is likely line\-buffered, you could
+attempt to read a whole line in the callback:
+.PP
+.Vb 6
+\&  static void
+\&  stdin_readable_cb (struct ev_loop *loop, struct ev_io *w, int revents)
+\&  {
+\&     ev_io_stop (loop, w);
+\&    .. read from stdin here (or from w->fd) and haqndle any I/O errors
+\&  }
+.Ve
+.PP
+.Vb 6
+\&  ...
+\&  struct ev_loop *loop = ev_default_init (0);
+\&  struct ev_io stdin_readable;
+\&  ev_io_init (&stdin_readable, stdin_readable_cb, STDIN_FILENO, EV_READ);
+\&  ev_io_start (loop, &stdin_readable);
+\&  ev_loop (loop, 0);
+.Ve

 .ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts"
 .el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts"
 .IX Subsection "ev_timer - relative and optionally recurring timeouts"
 .ie n .Sh """ev_timer"" \- relative and optionally recurring timeouts"
 .el .Sh "\f(CWev_timer\fP \- relative and optionally recurring timeouts"
 .IX Subsection "ev_timer - relative and optionally recurring timeouts"


@@ -684,6 +948,46 @@ configure an \f(CW\*(C`ev_timer\*(C'\fR with after=repeat=60 and calling ev_time
 time you successfully read or write some data. If you go into an idle
 state where you do not expect data to travel on the socket, you can stop
 the timer, and again will automatically restart it if need be.
 time you successfully read or write some data. If you go into an idle
 state where you do not expect data to travel on the socket, you can stop
 the timer, and again will automatically restart it if need be.

+.PP
+Example: create a timer that fires after 60 seconds.
+.PP
+.Vb 5
+\&  static void
+\&  one_minute_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
+\&  {
+\&    .. one minute over, w is actually stopped right here
+\&  }
+.Ve
+.PP
+.Vb 3
+\&  struct ev_timer mytimer;
+\&  ev_timer_init (&mytimer, one_minute_cb, 60., 0.);
+\&  ev_timer_start (loop, &mytimer);
+.Ve
+.PP
+Example: create a timeout timer that times out after 10 seconds of
+inactivity.
+.PP
+.Vb 5
+\&  static void
+\&  timeout_cb (struct ev_loop *loop, struct ev_timer *w, int revents)
+\&  {
+\&    .. ten seconds without any activity
+\&  }
+.Ve
+.PP
+.Vb 4
+\&  struct ev_timer mytimer;
+\&  ev_timer_init (&mytimer, timeout_cb, 0., 10.); /* note, only repeat used */
+\&  ev_timer_again (&mytimer); /* start timer */
+\&  ev_loop (loop, 0);
+.Ve
+.PP
+.Vb 3
+\&  // and in some piece of code that gets executed on any "activity":
+\&  // reset the timeout to start ticking again at 10 seconds
+\&  ev_timer_again (&mytimer);
+.Ve

 .ie n .Sh """ev_periodic"" \- to cron or not to cron"
 .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron"
 .IX Subsection "ev_periodic - to cron or not to cron"
 .ie n .Sh """ev_periodic"" \- to cron or not to cron"
 .el .Sh "\f(CWev_periodic\fP \- to cron or not to cron"
 .IX Subsection "ev_periodic - to cron or not to cron"


@@ -693,8 +997,8 @@ Periodic watchers are also timers of a kind, but they are very versatile
 Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
 but on wallclock time (absolute time). You can tell a periodic watcher
 to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a
 Unlike \f(CW\*(C`ev_timer\*(C'\fR's, they are not based on real time (or relative time)
 but on wallclock time (absolute time). You can tell a periodic watcher
 to trigger \*(L"at\*(R" some specific point in time. For example, if you tell a

-periodic watcher to trigger in 10 seconds (by specifiying e.g. c<ev_now ()
-+ 10.>) and then reset your system clock to the last year, then it will
+periodic watcher to trigger in 10 seconds (by specifiying e.g. \f(CW\*(C`ev_now ()
++ 10.\*(C'\fR) and then reset your system clock to the last year, then it will

 take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger
 roughly 10 seconds later and of course not if you reset your system time
 again).
 take a year to trigger the event (unlike an \f(CW\*(C`ev_timer\*(C'\fR, which would trigger
 roughly 10 seconds later and of course not if you reset your system time
 again).


@@ -785,6 +1089,51 @@ Simply stops and restarts the periodic watcher again. This is only useful
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).
 when you changed some parameters or the reschedule callback would return
 a different time than the last time it was called (e.g. in a crond like
 program when the crontabs have changed).

+.PP
+Example: call a callback every hour, or, more precisely, whenever the
+system clock is divisible by 3600. The callback invocation times have
+potentially a lot of jittering, but good long-term stability.
+.PP
+.Vb 5
+\&  static void
+\&  clock_cb (struct ev_loop *loop, struct ev_io *w, int revents)
+\&  {
+\&    ... its now a full hour (UTC, or TAI or whatever your clock follows)
+\&  }
+.Ve
+.PP
+.Vb 3
+\&  struct ev_periodic hourly_tick;
+\&  ev_periodic_init (&hourly_tick, clock_cb, 0., 3600., 0);
+\&  ev_periodic_start (loop, &hourly_tick);
+.Ve
+.PP
+Example: the same as above, but use a reschedule callback to do it:
+.PP
+.Vb 1
+\&  #include <math.h>
+.Ve
+.PP
+.Vb 5
+\&  static ev_tstamp
+\&  my_scheduler_cb (struct ev_periodic *w, ev_tstamp now)
+\&  {
+\&    return fmod (now, 3600.) + 3600.;
+\&  }
+.Ve
+.PP
+.Vb 1
+\&  ev_periodic_init (&hourly_tick, clock_cb, 0., 0., my_scheduler_cb);
+.Ve
+.PP
+Example: call a callback every hour, starting now:
+.PP
+.Vb 4
+\&  struct ev_periodic hourly_tick;
+\&  ev_periodic_init (&hourly_tick, clock_cb,
+\&                    fmod (ev_now (loop), 3600.), 3600., 0);
+\&  ev_periodic_start (loop, &hourly_tick);
+.Ve

 .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled"
 .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled"
 .IX Subsection "ev_signal - signal me when a signal gets signalled"
 .ie n .Sh """ev_signal"" \- signal me when a signal gets signalled"
 .el .Sh "\f(CWev_signal\fP \- signal me when a signal gets signalled"
 .IX Subsection "ev_signal - signal me when a signal gets signalled"


@@ -824,6 +1173,22 @@ at the \f(CW\*(C`rstatus\*(C'\fR member of the \f(CW\*(C`ev_child\*(C'\fR watche
 the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
 \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
 process causing the status change.
 the status word (use the macros from \f(CW\*(C`sys/wait.h\*(C'\fR and see your systems
 \&\f(CW\*(C`waitpid\*(C'\fR documentation). The \f(CW\*(C`rpid\*(C'\fR member contains the pid of the
 process causing the status change.

+.PP
+Example: try to exit cleanly on \s-1SIGINT\s0 and \s-1SIGTERM\s0.
+.PP
+.Vb 5
+\&  static void
+\&  sigint_cb (struct ev_loop *loop, struct ev_signal *w, int revents)
+\&  {
+\&    ev_unloop (loop, EVUNLOOP_ALL);
+\&  }
+.Ve
+.PP
+.Vb 3
+\&  struct ev_signal signal_watcher;
+\&  ev_signal_init (&signal_watcher, sigint_cb, SIGINT);
+\&  ev_signal_start (loop, &sigint_cb);
+.Ve

 .ie n .Sh """ev_idle"" \- when you've got nothing better to do"
 .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do"
 .IX Subsection "ev_idle - when you've got nothing better to do"
 .ie n .Sh """ev_idle"" \- when you've got nothing better to do"
 .el .Sh "\f(CWev_idle\fP \- when you've got nothing better to do"
 .IX Subsection "ev_idle - when you've got nothing better to do"


@@ -847,6 +1212,25 @@ event loop has handled all outstanding events.
 Initialises and configures the idle watcher \- it has no parameters of any
 kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
 believe me.
 Initialises and configures the idle watcher \- it has no parameters of any
 kind. There is a \f(CW\*(C`ev_idle_set\*(C'\fR macro, but using it is utterly pointless,
 believe me.

+.PP
+Example: dynamically allocate an \f(CW\*(C`ev_idle\*(C'\fR, start it, and in the
+callback, free it. Alos, use no error checking, as usual.
+.PP
+.Vb 7
+\&  static void
+\&  idle_cb (struct ev_loop *loop, struct ev_idle *w, int revents)
+\&  {
+\&    free (w);
+\&    // now do something you wanted to do when the program has
+\&    // no longer asnything immediate to do.
+\&  }
+.Ve
+.PP
+.Vb 3
+\&  struct ev_idle *idle_watcher = malloc (sizeof (struct ev_idle));
+\&  ev_idle_init (idle_watcher, idle_cb);
+\&  ev_idle_start (loop, idle_cb);
+.Ve

 .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop"
 .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop"
 .IX Subsection "ev_prepare and ev_check - customise your event loop"
 .ie n .Sh """ev_prepare""\fP and \f(CW""ev_check"" \- customise your event loop"
 .el .Sh "\f(CWev_prepare\fP and \f(CWev_check\fP \- customise your event loop"
 .IX Subsection "ev_prepare and ev_check - customise your event loop"


@@ -854,9 +1238,10 @@ Prepare and check watchers are usually (but not always) used in tandem:
 prepare watchers get invoked before the process blocks and check watchers
 afterwards.
 .PP
 prepare watchers get invoked before the process blocks and check watchers
 afterwards.
 .PP

-Their main purpose is to integrate other event mechanisms into libev. This
-could be used, for example, to track variable changes, implement your own
-watchers, integrate net-snmp or a coroutine library and lots more.
+Their main purpose is to integrate other event mechanisms into libev and
+their use is somewhat advanced. This could be used, for example, to track
+variable changes, implement your own watchers, integrate net-snmp or a
+coroutine library and lots more.

 .PP
 This is done by examining in each prepare call which file descriptors need
 to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for
 .PP
 This is done by examining in each prepare call which file descriptors need
 to be watched by the other library, registering \f(CW\*(C`ev_io\*(C'\fR watchers for


@@ -884,6 +1269,100 @@ low-priority coroutines to idle/background tasks).
 Initialises and configures the prepare or check watcher \- they have no
 parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
 macros, but using them is utterly, utterly and completely pointless.
 Initialises and configures the prepare or check watcher \- they have no
 parameters of any kind. There are \f(CW\*(C`ev_prepare_set\*(C'\fR and \f(CW\*(C`ev_check_set\*(C'\fR
 macros, but using them is utterly, utterly and completely pointless.

+.PP
+Example: *TODO*.
+.ie n .Sh """ev_embed"" \- when one backend isn't enough"
+.el .Sh "\f(CWev_embed\fP \- when one backend isn't enough"
+.IX Subsection "ev_embed - when one backend isn't enough"
+This is a rather advanced watcher type that lets you embed one event loop
+into another (currently only \f(CW\*(C`ev_io\*(C'\fR events are supported in the embedded
+loop, other types of watchers might be handled in a delayed or incorrect
+fashion and must not be used).
+.PP
+There are primarily two reasons you would want that: work around bugs and
+prioritise I/O.
+.PP
+As an example for a bug workaround, the kqueue backend might only support
+sockets on some platform, so it is unusable as generic backend, but you
+still want to make use of it because you have many sockets and it scales
+so nicely. In this case, you would create a kqueue-based loop and embed it
+into your default loop (which might use e.g. poll). Overall operation will
+be a bit slower because first libev has to poll and then call kevent, but
+at least you can use both at what they are best.
+.PP
+As for prioritising I/O: rarely you have the case where some fds have
+to be watched and handled very quickly (with low latency), and even
+priorities and idle watchers might have too much overhead. In this case
+you would put all the high priority stuff in one loop and all the rest in
+a second one, and embed the second one in the first.
+.PP
+As long as the watcher is active, the callback will be invoked every time
+there might be events pending in the embedded loop. The callback must then
+call \f(CW\*(C`ev_embed_sweep (mainloop, watcher)\*(C'\fR to make a single sweep and invoke
+their callbacks (you could also start an idle watcher to give the embedded
+loop strictly lower priority for example). You can also set the callback
+to \f(CW0\fR, in which case the embed watcher will automatically execute the
+embedded loop sweep.
+.PP
+As long as the watcher is started it will automatically handle events. The
+callback will be invoked whenever some events have been handled. You can
+set the callback to \f(CW0\fR to avoid having to specify one if you are not
+interested in that.
+.PP
+Also, there have not currently been made special provisions for forking:
+when you fork, you not only have to call \f(CW\*(C`ev_loop_fork\*(C'\fR on both loops,
+but you will also have to stop and restart any \f(CW\*(C`ev_embed\*(C'\fR watchers
+yourself.
+.PP
+Unfortunately, not all backends are embeddable, only the ones returned by
+\&\f(CW\*(C`ev_embeddable_backends\*(C'\fR are, which, unfortunately, does not include any
+portable one.
+.PP
+So when you want to use this feature you will always have to be prepared
+that you cannot get an embeddable loop. The recommended way to get around
+this is to have a separate variables for your embeddable loop, try to
+create it, and if that fails, use the normal loop for everything:
+.PP
+.Vb 3
+\&  struct ev_loop *loop_hi = ev_default_init (0);
+\&  struct ev_loop *loop_lo = 0;
+\&  struct ev_embed embed;
+.Ve
+.PP
+.Vb 5
+\&  // see if there is a chance of getting one that works
+\&  // (remember that a flags value of 0 means autodetection)
+\&  loop_lo = ev_embeddable_backends () & ev_recommended_backends ()
+\&    ? ev_loop_new (ev_embeddable_backends () & ev_recommended_backends ())
+\&    : 0;
+.Ve
+.PP
+.Vb 8
+\&  // if we got one, then embed it, otherwise default to loop_hi
+\&  if (loop_lo)
+\&    {
+\&      ev_embed_init (&embed, 0, loop_lo);
+\&      ev_embed_start (loop_hi, &embed);
+\&    }
+\&  else
+\&    loop_lo = loop_hi;
+.Ve
+.IP "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
+.IX Item "ev_embed_init (ev_embed *, callback, struct ev_loop *embedded_loop)"
+.PD 0
+.IP "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)" 4
+.IX Item "ev_embed_set (ev_embed *, callback, struct ev_loop *embedded_loop)"
+.PD
+Configures the watcher to embed the given loop, which must be
+embeddable. If the callback is \f(CW0\fR, then \f(CW\*(C`ev_embed_sweep\*(C'\fR will be
+invoked automatically, otherwise it is the responsibility of the callback
+to invoke it (it will continue to be called until the sweep has been done,
+if you do not want thta, you need to temporarily stop the embed watcher).
+.IP "ev_embed_sweep (loop, ev_embed *)" 4
+.IX Item "ev_embed_sweep (loop, ev_embed *)"
+Make a single, non-blocking sweep over the embedded loop. This works
+similarly to \f(CW\*(C`ev_loop (embedded_loop, EVLOOP_NONBLOCK)\*(C'\fR, but in the most
+apropriate way for embedded loops.

 .SH "OTHER FUNCTIONS"
 .IX Header "OTHER FUNCTIONS"
 There are some other functions of possible interest. Described. Here. Now.
 .SH "OTHER FUNCTIONS"
 .IX Header "OTHER FUNCTIONS"
 There are some other functions of possible interest. Described. Here. Now.


@@ -922,18 +1401,19 @@ value passed to \f(CW\*(C`ev_once\*(C'\fR:
 .Vb 1
 \&  ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
 .Ve
 .Vb 1
 \&  ev_once (STDIN_FILENO, EV_READ, 10., stdin_ready, 0);
 .Ve

-.IP "ev_feed_event (loop, watcher, int events)" 4
-.IX Item "ev_feed_event (loop, watcher, int events)"
+.IP "ev_feed_event (ev_loop *, watcher *, int revents)" 4
+.IX Item "ev_feed_event (ev_loop *, watcher *, int revents)"

 Feeds the given event set into the event loop, as if the specified event
 had happened for the specified watcher (which must be a pointer to an
 initialised but not necessarily started event watcher).
 Feeds the given event set into the event loop, as if the specified event
 had happened for the specified watcher (which must be a pointer to an
 initialised but not necessarily started event watcher).

-.IP "ev_feed_fd_event (loop, int fd, int revents)" 4
-.IX Item "ev_feed_fd_event (loop, int fd, int revents)"
+.IP "ev_feed_fd_event (ev_loop *, int fd, int revents)" 4
+.IX Item "ev_feed_fd_event (ev_loop *, int fd, int revents)"

 Feed an event on the given fd, as if a file descriptor backend detected
 the given events it.
 Feed an event on the given fd, as if a file descriptor backend detected
 the given events it.

-.IP "ev_feed_signal_event (loop, int signum)" 4
-.IX Item "ev_feed_signal_event (loop, int signum)"
-Feed an event as if the given signal occured (loop must be the default loop!).
+.IP "ev_feed_signal_event (ev_loop *loop, int signum)" 4
+.IX Item "ev_feed_signal_event (ev_loop *loop, int signum)"
+Feed an event as if the given signal occured (\f(CW\*(C`loop\*(C'\fR must be the default
+loop!).

 .SH "LIBEVENT EMULATION"
 .IX Header "LIBEVENT EMULATION"
 Libev offers a compatibility emulation layer for libevent. It cannot
 .SH "LIBEVENT EMULATION"
 .IX Header "LIBEVENT EMULATION"
 Libev offers a compatibility emulation layer for libevent. It cannot


@@ -954,7 +1434,395 @@ emulate the internals of libevent, so here are some usage hints:
 .PD
 .SH "\*(C+ SUPPORT"
 .IX Header " SUPPORT"
 .PD
 .SH "\*(C+ SUPPORT"
 .IX Header " SUPPORT"

-\&\s-1TBD\s0.
+Libev comes with some simplistic wrapper classes for \*(C+ that mainly allow
+you to use some convinience methods to start/stop watchers and also change
+the callback model to a model using method callbacks on objects.
+.PP
+To use it,
+.PP
+.Vb 1
+\&  #include <ev++.h>
+.Ve
+.PP
+(it is not installed by default). This automatically includes \fIev.h\fR
+and puts all of its definitions (many of them macros) into the global
+namespace. All \*(C+ specific things are put into the \f(CW\*(C`ev\*(C'\fR namespace.
+.PP
+It should support all the same embedding options as \fIev.h\fR, most notably
+\&\f(CW\*(C`EV_MULTIPLICITY\*(C'\fR.
+.PP
+Here is a list of things available in the \f(CW\*(C`ev\*(C'\fR namespace:
+.ie n .IP """ev::READ""\fR, \f(CW""ev::WRITE"" etc." 4
+.el .IP "\f(CWev::READ\fR, \f(CWev::WRITE\fR etc." 4
+.IX Item "ev::READ, ev::WRITE etc."
+These are just enum values with the same values as the \f(CW\*(C`EV_READ\*(C'\fR etc.
+macros from \fIev.h\fR.
+.ie n .IP """ev::tstamp""\fR, \f(CW""ev::now""" 4
+.el .IP "\f(CWev::tstamp\fR, \f(CWev::now\fR" 4
+.IX Item "ev::tstamp, ev::now"
+Aliases to the same types/functions as with the \f(CW\*(C`ev_\*(C'\fR prefix.
+.ie n .IP """ev::io""\fR, \f(CW""ev::timer""\fR, \f(CW""ev::periodic""\fR, \f(CW""ev::idle""\fR, \f(CW""ev::sig"" etc." 4
+.el .IP "\f(CWev::io\fR, \f(CWev::timer\fR, \f(CWev::periodic\fR, \f(CWev::idle\fR, \f(CWev::sig\fR etc." 4
+.IX Item "ev::io, ev::timer, ev::periodic, ev::idle, ev::sig etc."
+For each \f(CW\*(C`ev_TYPE\*(C'\fR watcher in \fIev.h\fR there is a corresponding class of
+the same name in the \f(CW\*(C`ev\*(C'\fR namespace, with the exception of \f(CW\*(C`ev_signal\*(C'\fR
+which is called \f(CW\*(C`ev::sig\*(C'\fR to avoid clashes with the \f(CW\*(C`signal\*(C'\fR macro
+defines by many implementations.
+.Sp
+All of those classes have these methods:
+.RS 4
+.IP "ev::TYPE::TYPE (object *, object::method *)" 4
+.IX Item "ev::TYPE::TYPE (object *, object::method *)"
+.PD 0
+.IP "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)" 4
+.IX Item "ev::TYPE::TYPE (object *, object::method *, struct ev_loop *)"
+.IP "ev::TYPE::~TYPE" 4
+.IX Item "ev::TYPE::~TYPE"
+.PD
+The constructor takes a pointer to an object and a method pointer to
+the event handler callback to call in this class. The constructor calls
+\&\f(CW\*(C`ev_init\*(C'\fR for you, which means you have to call the \f(CW\*(C`set\*(C'\fR method
+before starting it. If you do not specify a loop then the constructor
+automatically associates the default loop with this watcher.
+.Sp
+The destructor automatically stops the watcher if it is active.
+.IP "w\->set (struct ev_loop *)" 4
+.IX Item "w->set (struct ev_loop *)"
+Associates a different \f(CW\*(C`struct ev_loop\*(C'\fR with this watcher. You can only
+do this when the watcher is inactive (and not pending either).
+.IP "w\->set ([args])" 4
+.IX Item "w->set ([args])"
+Basically the same as \f(CW\*(C`ev_TYPE_set\*(C'\fR, with the same args. Must be
+called at least once.  Unlike the C counterpart, an active watcher gets
+automatically stopped and restarted.
+.IP "w\->start ()" 4
+.IX Item "w->start ()"
+Starts the watcher. Note that there is no \f(CW\*(C`loop\*(C'\fR argument as the
+constructor already takes the loop.
+.IP "w\->stop ()" 4
+.IX Item "w->stop ()"
+Stops the watcher if it is active. Again, no \f(CW\*(C`loop\*(C'\fR argument.
+.ie n .IP "w\->again ()       ""ev::timer""\fR, \f(CW""ev::periodic"" only" 4
+.el .IP "w\->again ()       \f(CWev::timer\fR, \f(CWev::periodic\fR only" 4
+.IX Item "w->again ()       ev::timer, ev::periodic only"
+For \f(CW\*(C`ev::timer\*(C'\fR and \f(CW\*(C`ev::periodic\*(C'\fR, this invokes the corresponding
+\&\f(CW\*(C`ev_TYPE_again\*(C'\fR function.
+.ie n .IP "w\->sweep ()       ""ev::embed"" only" 4
+.el .IP "w\->sweep ()       \f(CWev::embed\fR only" 4
+.IX Item "w->sweep ()       ev::embed only"
+Invokes \f(CW\*(C`ev_embed_sweep\*(C'\fR.
+.RE
+.RS 4
+.RE
+.PP
+Example: Define a class with an \s-1IO\s0 and idle watcher, start one of them in
+the constructor.
+.PP
+.Vb 4
+\&  class myclass
+\&  {
+\&    ev_io   io;   void io_cb   (ev::io   &w, int revents);
+\&    ev_idle idle  void idle_cb (ev::idle &w, int revents);
+.Ve
+.PP
+.Vb 2
+\&    myclass ();
+\&  }
+.Ve
+.PP
+.Vb 6
+\&  myclass::myclass (int fd)
+\&  : io   (this, &myclass::io_cb),
+\&    idle (this, &myclass::idle_cb)
+\&  {
+\&    io.start (fd, ev::READ);
+\&  }
+.Ve
+.SH "EMBEDDING"
+.IX Header "EMBEDDING"
+Libev can (and often is) directly embedded into host
+applications. Examples of applications that embed it include the Deliantra
+Game Server, the \s-1EV\s0 perl module, the \s-1GNU\s0 Virtual Private Ethernet (gvpe)
+and rxvt\-unicode.
+.PP
+The goal is to enable you to just copy the neecssary files into your
+source directory without having to change even a single line in them, so
+you can easily upgrade by simply copying (or having a checked-out copy of
+libev somewhere in your source tree).
+.Sh "\s-1FILESETS\s0"
+.IX Subsection "FILESETS"
+Depending on what features you need you need to include one or more sets of files
+in your app.
+.PP
+\fI\s-1CORE\s0 \s-1EVENT\s0 \s-1LOOP\s0\fR
+.IX Subsection "CORE EVENT LOOP"
+.PP
+To include only the libev core (all the \f(CW\*(C`ev_*\*(C'\fR functions), with manual
+configuration (no autoconf):
+.PP
+.Vb 2
+\&  #define EV_STANDALONE 1
+\&  #include "ev.c"
+.Ve
+.PP
+This will automatically include \fIev.h\fR, too, and should be done in a
+single C source file only to provide the function implementations. To use
+it, do the same for \fIev.h\fR in all files wishing to use this \s-1API\s0 (best
+done by writing a wrapper around \fIev.h\fR that you can include instead and
+where you can put other configuration options):
+.PP
+.Vb 2
+\&  #define EV_STANDALONE 1
+\&  #include "ev.h"
+.Ve
+.PP
+Both header files and implementation files can be compiled with a \*(C+
+compiler (at least, thats a stated goal, and breakage will be treated
+as a bug).
+.PP
+You need the following files in your source tree, or in a directory
+in your include path (e.g. in libev/ when using \-Ilibev):
+.PP
+.Vb 4
+\&  ev.h
+\&  ev.c
+\&  ev_vars.h
+\&  ev_wrap.h
+.Ve
+.PP
+.Vb 1
+\&  ev_win32.c      required on win32 platforms only
+.Ve
+.PP
+.Vb 5
+\&  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)
+\&  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)
+.Ve
+.PP
+\&\fIev.c\fR includes the backend files directly when enabled, so you only need
+to compile a single file.
+.PP
+\fI\s-1LIBEVENT\s0 \s-1COMPATIBILITY\s0 \s-1API\s0\fR
+.IX Subsection "LIBEVENT COMPATIBILITY API"
+.PP
+To include the libevent compatibility \s-1API\s0, also include:
+.PP
+.Vb 1
+\&  #include "event.c"
+.Ve
+.PP
+in the file including \fIev.c\fR, and:
+.PP
+.Vb 1
+\&  #include "event.h"
+.Ve
+.PP
+in the files that want to use the libevent \s-1API\s0. This also includes \fIev.h\fR.
+.PP
+You need the following additional files for this:
+.PP
+.Vb 2
+\&  event.h
+\&  event.c
+.Ve
+.PP
+\fI\s-1AUTOCONF\s0 \s-1SUPPORT\s0\fR
+.IX Subsection "AUTOCONF SUPPORT"
+.PP
+Instead of using \f(CW\*(C`EV_STANDALONE=1\*(C'\fR and providing your config in
+whatever way you want, you can also \f(CW\*(C`m4_include([libev.m4])\*(C'\fR in your
+\&\fIconfigure.ac\fR and leave \f(CW\*(C`EV_STANDALONE\*(C'\fR off. \fIev.c\fR will then include
+\&\fIconfig.h\fR and configure itself accordingly.
+.PP
+For this of course you need the m4 file:
+.PP
+.Vb 1
+\&  libev.m4
+.Ve
+.Sh "\s-1PREPROCESSOR\s0 \s-1SYMBOLS/MACROS\s0"
+.IX Subsection "PREPROCESSOR SYMBOLS/MACROS"
+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 multiplicity
+and only include the select backend.
+.IP "\s-1EV_STANDALONE\s0" 4
+.IX Item "EV_STANDALONE"
+Must always be \f(CW1\fR if you do not use autoconf configuration, which
+keeps libev from including \fIconfig.h\fR, and it also defines dummy
+implementations for some libevent functions (such as logging, which is not
+supported). It will also not define any of the structs usually found in
+\&\fIevent.h\fR that are not directly supported by the libev core alone.
+.IP "\s-1EV_USE_MONOTONIC\s0" 4
+.IX Item "EV_USE_MONOTONIC"
+If defined to be \f(CW1\fR, 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. 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, althoguh you have
+to make sure you link against any libraries where the \f(CW\*(C`clock_gettime\*(C'\fR
+function is hiding in (often \fI\-lrt\fR).
+.IP "\s-1EV_USE_REALTIME\s0" 4
+.IX Item "EV_USE_REALTIME"
+If defined to be \f(CW1\fR, libev will try to detect the availability of the
+realtime clock option at compiletime (and assume its availability at
+runtime if successful). Otherwise no use of the realtime clock option will
+be attempted. This effectively replaces \f(CW\*(C`gettimeofday\*(C'\fR by \f(CW\*(C`clock_get
+(CLOCK_REALTIME, ...)\*(C'\fR and will not normally affect correctness. See tzhe note about libraries
+in the description of \f(CW\*(C`EV_USE_MONOTONIC\*(C'\fR, though.
+.IP "\s-1EV_USE_SELECT\s0" 4
+.IX Item "EV_USE_SELECT"
+If undefined or defined to be \f(CW1\fR, libev will compile in support for the
+\&\f(CW\*(C`select\*(C'\fR(2) backend. No attempt at autodetection will be done: if no
+other method takes over, select will be it. Otherwise the select backend
+will not be compiled in.
+.IP "\s-1EV_SELECT_USE_FD_SET\s0" 4
+.IX Item "EV_SELECT_USE_FD_SET"
+If defined to \f(CW1\fR, then the select backend will use the system \f(CW\*(C`fd_set\*(C'\fR
+structure. This is useful if libev doesn't compile due to a missing
+\&\f(CW\*(C`NFDBITS\*(C'\fR or \f(CW\*(C`fd_mask\*(C'\fR 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 \f(CW\*(C`FD_SETSIZE\*(C'\fR macro, set before compilation, might
+influence the size of the \f(CW\*(C`fd_set\*(C'\fR used.
+.IP "\s-1EV_SELECT_IS_WINSOCKET\s0" 4
+.IX Item "EV_SELECT_IS_WINSOCKET"
+When defined to \f(CW1\fR, 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
+\&\f(CW\*(C`_get_osfhandle\*(C'\fR on the fd to convert it to an \s-1OS\s0 handle. Otherwise,
+it is assumed that all these functions actually work on fds, even
+on win32. Should not be defined on non\-win32 platforms.
+.IP "\s-1EV_USE_POLL\s0" 4
+.IX Item "EV_USE_POLL"
+If defined to be \f(CW1\fR, libev will compile in support for the \f(CW\*(C`poll\*(C'\fR(2)
+backend. Otherwise it will be enabled on non\-win32 platforms. It
+takes precedence over select.
+.IP "\s-1EV_USE_EPOLL\s0" 4
+.IX Item "EV_USE_EPOLL"
+If defined to be \f(CW1\fR, libev will compile in support for the Linux
+\&\f(CW\*(C`epoll\*(C'\fR(7) backend. Its availability will be detected at runtime,
+otherwise another method will be used as fallback. This is the
+preferred backend for GNU/Linux systems.
+.IP "\s-1EV_USE_KQUEUE\s0" 4
+.IX Item "EV_USE_KQUEUE"
+If defined to be \f(CW1\fR, libev will compile in support for the \s-1BSD\s0 style
+\&\f(CW\*(C`kqueue\*(C'\fR(2) backend. Its actual availability will be detected at runtime,
+otherwise another method will be used as fallback. This is the preferred
+backend for \s-1BSD\s0 and BSD-like systems, although on most BSDs kqueue only
+supports some types of fds correctly (the only platform we found that
+supports ptys for example was NetBSD), so kqueue might be compiled in, but
+not be used unless explicitly requested. The best way to use it is to find
+out wether kqueue supports your type of fd properly and use an embedded
+kqueue loop.
+.IP "\s-1EV_USE_PORT\s0" 4
+.IX Item "EV_USE_PORT"
+If defined to be \f(CW1\fR, 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.
+.IP "\s-1EV_USE_DEVPOLL\s0" 4
+.IX Item "EV_USE_DEVPOLL"
+reserved for future expansion, works like the \s-1USE\s0 symbols above.
+.IP "\s-1EV_H\s0" 4
+.IX Item "EV_H"
+The name of the \fIev.h\fR header file used to include it. The default if
+undefined is \f(CW\*(C`<ev.h>\*(C'\fR in \fIevent.h\fR and \f(CW"ev.h"\fR in \fIev.c\fR. This
+can be used to virtually rename the \fIev.h\fR header file in case of conflicts.
+.IP "\s-1EV_CONFIG_H\s0" 4
+.IX Item "EV_CONFIG_H"
+If \f(CW\*(C`EV_STANDALONE\*(C'\fR isn't \f(CW1\fR, this variable can be used to override
+\&\fIev.c\fR's idea of where to find the \fIconfig.h\fR file, similarly to
+\&\f(CW\*(C`EV_H\*(C'\fR, above.
+.IP "\s-1EV_EVENT_H\s0" 4
+.IX Item "EV_EVENT_H"
+Similarly to \f(CW\*(C`EV_H\*(C'\fR, this macro can be used to override \fIevent.c\fR's idea
+of how the \fIevent.h\fR header can be found.
+.IP "\s-1EV_PROTOTYPES\s0" 4
+.IX Item "EV_PROTOTYPES"
+If defined to be \f(CW0\fR, then \fIev.h\fR will not define any function
+prototypes, but still define all the structs and other symbols. This is
+occasionally useful if you want to provide your own wrapper functions
+around libev functions.
+.IP "\s-1EV_MULTIPLICITY\s0" 4
+.IX Item "EV_MULTIPLICITY"
+If undefined or defined to \f(CW1\fR, then all event-loop-specific functions
+will have the \f(CW\*(C`struct ev_loop *\*(C'\fR as first argument, and you can create
+additional independent event loops. Otherwise there will be no support
+for multiple event loops and there is no first event loop pointer
+argument. Instead, all functions act on the single default loop.
+.IP "\s-1EV_PERIODICS\s0" 4
+.IX Item "EV_PERIODICS"
+If undefined or defined to be \f(CW1\fR, then periodic timers are supported,
+otherwise not. This saves a few kb of code.
+.IP "\s-1EV_COMMON\s0" 4
+.IX Item "EV_COMMON"
+By default, all watchers have a \f(CW\*(C`void *data\*(C'\fR 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.
+.Sp
+For example, the perl \s-1EV\s0 module uses something like this:
+.Sp
+.Vb 3
+\&  #define EV_COMMON                       \e
+\&    SV *self; /* contains this struct */  \e
+\&    SV *cb_sv, *fh /* note no trailing ";" */
+.Ve
+.IP "\s-1EV_CB_DECLARE\s0(type)" 4
+.IX Item "EV_CB_DECLARE(type)"
+.PD 0
+.IP "\s-1EV_CB_INVOKE\s0(watcher,revents)" 4
+.IX Item "EV_CB_INVOKE(watcher,revents)"
+.IP "ev_set_cb(ev,cb)" 4
+.IX Item "ev_set_cb(ev,cb)"
+.PD
+Can be used to change the callback member declaration in each watcher,
+and the way callbacks are invoked and set. Must expand to a struct member
+definition and a statement, respectively. See the \fIev.v\fR header file for
+their default definitions. One possible use for overriding these is to
+avoid the ev_loop pointer as first argument in all cases, or to use method
+calls instead of plain function calls in \*(C+.
+.Sh "\s-1EXAMPLES\s0"
+.IX Subsection "EXAMPLES"
+For a real-world example of a program the includes libev
+verbatim, you can have a look at the \s-1EV\s0 perl module
+(<http://software.schmorp.de/pkg/EV.html>). It has the libev files in
+the \fIlibev/\fR subdirectory and includes them in the \fI\s-1EV/EVAPI\s0.h\fR (public
+interface) and \fI\s-1EV\s0.xs\fR (implementation) files. Only the \fI\s-1EV\s0.xs\fR file
+will be compiled. It is pretty complex because it provides its own header
+file.
+.Sp
+The usage in rxvt-unicode is simpler. It has a \fIev_cpp.h\fR header file
+that everybody includes and which overrides some autoconf choices:
+.Sp
+.Vb 4
+\&   #define EV_USE_POLL 0
+\&   #define EV_MULTIPLICITY 0
+\&   #define EV_PERIODICS 0
+\&   #define EV_CONFIG_H <config.h>
+.Ve
+.Sp
+.Vb 1
+\&   #include "ev++.h"
+.Ve
+.Sp
+And a \fIev_cpp.C\fR implementation file that contains libev proper and is compiled:
+.Sp
+.Vb 1
+\&   #include "rxvttoolkit.h"
+.Ve
+.Sp
+.Vb 2
+\&   /* darwin has problems with its header files in C++, requiring this namespace juggling */
+\&   using namespace ev;
+.Ve
+.Sp
+.Vb 1
+\&   #include "ev.c"
+.Ve

 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Marc Lehmann <libev@schmorp.de>.
 .SH "AUTHOR"
 .IX Header "AUTHOR"
 Marc Lehmann <libev@schmorp.de>.