Mercurial > hg > memcached

comparison doc/memcached.1 @ 0:30782bb1fc04 MEMCACHED_1_2_3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
memcached-1.2.3
author Maxim Dounin <mdounin@mdounin.ru>
date Sun, 23 Sep 2007 03:58:34 +0400
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:30782bb1fc04
1 .TH MEMCACHED 1 "April 11, 2005"
2 .SH NAME
3 memcached \- high-performance memory object caching system
4 .SH SYNOPSIS
5 .B memcached
6 .RI [ options ]
7 .br
8 .SH DESCRIPTION
9 This manual page documents briefly the
10 .B memcached
11 memory object caching daemon.
12 .PP
13 .B memcached
14 is a flexible memory object caching daemon designed to alleviate database load
15 in dynamic web applications by storing objects in memory. It's based on
16 libevent to scale to any size needed, and is specifically optimized to avoid
17 swapping and always use non-blocking I/O.
18 .br
19 .SH OPTIONS
20 These programs follow the usual GNU command line syntax. A summary of options
21 is included below.
22 .TP
23 .B \-l <ip_addr>
24 Listen on <ip_addr>; default to INDRR_ANY. This is an important option to
25 consider as there is no other way to secure the installation. Binding to an
26 internal or firewalled network interface is suggested.
27 .TP
28 .B \-d
29 Run memcached as a daemon.
30 .TP
31 .B \-u <username>
32 Assume the identity of <username> (only when run as root).
33 .TP
34 .B \-m <num>
35 Use <num> MB memory max to use for object storage; the default is 64 megabytes.
36 .TP
37 .B \-c <num>
38 Use <num> max simultaneous connections; the default is 1024.
39 .TP
40 .B \-k
41 Lock down all paged memory. This is a somewhat dangerous option with large
42 caches, so consult the README and memcached homepage for configuration
43 suggestions.
44 .TP
45 .B \-p <num>
46 Listen on TCP port <num>, the default is port 11211.
47 .TP
48 .B \-U <num>
49 Listen on UDP port <num>, the default is port 11211.
50 .TP
51 .B \-M
52 Disable automatic removal of items from the cache when out of memory.
53 Additions will not be possible until adequate space is freed up.
54 .TP
55 .B \-r
56 Raise the core file size limit to the maximum allowable.
57 .TP
58 .B \-f <factor>
59 Use <factor> as the multiplier for computing the sizes of memory chunks that
60 items are stored in. A lower value may result in less wasted memory depending
61 on the total amount of memory available and the distribution of item sizes.
62 The default is 1.25.
63 .TP
64 .B \-s <size>
65 Allocate a minimum of <size> bytes for the item key, value, and flags. The
66 default is 48. If you have a lot of small keys and values, you can get a
67 significant memory efficiency gain with a lower value. If you use a high
68 chunk growth factor (-f option), on the other hand, you may want to increase
69 the size to allow a bigger percentage of your items to fit in the most densely
70 packed (smallest) chunks.
71 .TP
72 .B \-h
73 Show the version of memcached and a summary of options.
74 .TP
75 .B \-v
76 Be verbose during the event loop; print out errors and warnings.
77 .TP
78 .B \-vv
79 Be even more verbose; same as \-v but also print client commands and
80 responses.
81 .TP
82 .B \-i
83 Print memcached and libevent licenses.
84 .TP
85 .B \-P <filename>
86 Print pidfile to <filename>, only used under -d option.
87 .TP
88 .B \-t <threads>
89 Number of threads to use to process incoming requests. This option is only
90 meaningful if memcached was compiled with thread support enabled. It is
91 typically not useful to set this higher than the number of CPU cores on the
92 memcached server.
93 .TP
94 .B \-D <char>
95 Use <char> as the delimiter between key prefixes and IDs. This is used for
96 per-prefix stats reporting. The default is ":" (colon). If this option is
97 specified, stats collection is turned on automatically; if not, then it may
98 be turned on by sending the "stats detail on" command to the server.
99 .br
100 .SH LICENSE
101 The memcached daemon is copyright Danga Interactive and is distributed under
102 the BSD license. Note that daemon clients are licensed separately.
103 .br
104 .SH SEE ALSO
105 The README file that comes with memcached
106 .br
107 .B http://www.danga.com/memcached
108 .SH AUTHOR
109 The memcached daemon was written by Anatoly Vorobey
110 .B <mellon@pobox.com>
111 and Brad Fitzpatrick
112 .B <brad@danga.com>
113 and the rest of the crew of Danga Interactive
114 .B http://www.danga.com
115 .br