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