xref: /memcached-1.4.29/README.md (revision d342d0ae)
1# Memcached
2
3## Dependencies
4
5* libevent, http://www.monkey.org/~provos/libevent/ (libevent-dev)
6
7## Environment
8
9### Linux
10
11If using Linux, you need a kernel with epoll.  Sure, libevent will
12work with normal select, but it sucks.
13
14epoll isn't in Linux 2.4, but there's a backport at:
15
16    http://www.xmailserver.org/linux-patches/nio-improve.html
17
18You want the epoll-lt patch (level-triggered).
19
20### Mac OS X
21
22If you're using MacOS, you'll want libevent 1.1 or higher to deal with
23a kqueue bug.
24
25Also, be warned that the -k (mlockall) option to memcached might be
26dangerous when using a large cache.  Just make sure the memcached machines
27don't swap.  memcached does non-blocking network I/O, but not disk.  (it
28should never go to disk, or you've lost the whole point of it)
29
30## Website
31
32* http://www.memcached.org
33
34## Contributing
35
36Want to contribute?  Up-to-date pointers should be at:
37
38* http://contributing.appspot.com/memcached
39