Skip to content

Commit

Permalink
man page search & replace to moxi
Browse files Browse the repository at this point in the history
  • Loading branch information
steveyen authored and ingenthr committed Jun 30, 2009
1 parent d610f2c commit 075f789
Showing 1 changed file with 44 additions and 37 deletions.
81 changes: 44 additions & 37 deletions doc/moxi.1
@@ -1,23 +1,22 @@
.TH MEMCACHED 1 "June 18, 2009"
.TH MOXI 1 "June 18, 2009"
.SH NAME
moxi \- a fast, multithreaded memcached protocol proxy
moxi \- a multithreaded memcached protocol proxy
.SH SYNOPSIS
.B memcached
.B moxi
.RI [ options ]
.br
.SH DESCRIPTION
This manual page documents briefly the
.B memcached
memory object caching daemon.
.B moxi
multithreaded memcached protocol proxy
.PP
.B memcached
is a flexible memory object caching daemon designed to alleviate database load
in dynamic web applications by storing objects in memory. It's based on
libevent to scale to any size needed, and is specifically optimized to avoid
swapping and always use non-blocking I/O.
.B moxi
is a memcached protocol proxy. It's based on libevent to scale to any
size needed, and is specifically optimized to avoid swapping and
always use non-blocking I/O.
.br
.SH OPTIONS
These programs follow the usual GNU command line syntax. A summary of options
These programs follow the usual GNU command line syntax. A summary of options
is included below.
.TP
.B \-s <file>
Expand All @@ -26,15 +25,15 @@ Unix socket path to listen on (disables network support).
.B \-a <perms>
Permissions (in octal format) for Unix socket created with -s option.
.TP
.B \-l <ip_addr>
.B \-l <ip_addr>
Listen on <ip_addr>; default to INADDR_ANY. This is an important option to
consider as there is no other way to secure the installation. Binding to an
consider as there is no other way to secure the installation. Binding to an
internal or firewalled network interface is suggested.
.TP
.B \-d
Run memcached as a daemon.
Run moxi as a daemon.
.TP
.B \-u <username>
.B \-u <username>
Assume the identity of <username> (only when run as root).
.TP
.B \-m <num>
Expand All @@ -44,21 +43,21 @@ Use <num> MB memory max to use for object storage; the default is 64 megabytes.
Use <num> max simultaneous connections; the default is 1024.
.TP
.B \-R <num>
This option seeks to prevent client starvation by setting a limit to the
number of sequential requests the server will process from an individual
client connection. Once a connection has exceeded this value, the server will
attempt to process I/O on other connections before handling any further
This option seeks to prevent client starvation by setting a limit to the
number of sequential requests the server will process from an individual
client connection. Once a connection has exceeded this value, the server will
attempt to process I/O on other connections before handling any further
request from this connection. The default value for this option is 20.
.TP
.B \-k
.B \-k
Lock down all paged memory. This is a somewhat dangerous option with large
caches, so consult the README and memcached homepage for configuration
caches, so consult the README and moxi homepage for configuration
suggestions.
.TP
.B \-p <num>
.B \-p <num>
Listen on TCP port <num>, the default is port 11211.
.TP
.B \-U <num>
.B \-U <num>
Listen on UDP port <num>, the default is port 11211, 0 is off.
.TP
.B \-M
Expand Down Expand Up @@ -86,26 +85,26 @@ packed (smallest) chunks.
Disable the use of CAS (and reduce the per-item size by 8 bytes).
.TP
.B \-h
Show the version of memcached and a summary of options.
Show the version of moxi and a summary of options.
.TP
.B \-v
Be verbose during the event loop; print out errors and warnings.
.TP
.B \-vv
Be even more verbose; same as \-v but also print client commands and
Be even more verbose; same as \-v but also print client commands and
responses.
.TP
.B \-i
Print memcached and libevent licenses.
Print moxi and libevent licenses.
.TP
.B \-P <filename>
Print pidfile to <filename>, only used under -d option.
.TP
.B \-t <threads>
Number of threads to use to process incoming requests. This option is only
meaningful if memcached was compiled with thread support enabled. It is
meaningful if moxi was compiled with thread support enabled. It is
typically not useful to set this higher than the number of CPU cores on the
memcached server. The default is 4.
moxi server. The default is 4.
.TP
.B \-D <char>
Use <char> as the delimiter between key prefixes and IDs. This is used for
Expand All @@ -116,7 +115,7 @@ be turned on by sending the "stats detail on" command to the server.
.B \-L
Try to use large memory pages (if available). Increasing the memory page size
could reduce the number of TLB misses and improve the performance. In order to
get large pages from the OS, memcached will allocate the total item-cache in
get large pages from the OS, moxi will allocate the total item-cache in
one large chunk. Only available if supported on your OS.
.TP
.B \-B <proto>
Expand All @@ -126,18 +125,26 @@ specify the protocol clients must speak. Possible options are "auto"
(the default, autonegotiation behavior), "ascii" and "binary".
.br
.SH LICENSE
The memcached daemon is copyright Danga Interactive and is distributed under
the BSD license. Note that daemon clients are licensed separately.
The moxi daemon is copyright NorthScale, Danga Interactive and is
distributed under the BSD license. Note that clients are licensed
separately.
.br
.SH SEE ALSO
The README file that comes with memcached
The README file that comes with moxi
.br
.B http://www.danga.com/memcached
.B http://www.danga.com/moxi
.SH AUTHOR
The memcached daemon was written by Anatoly Vorobey
The moxi daemon was written by Steve Yen
.B <steve.yen@northscale.com>
, Dustin Sallings
.B <dustin@sallings.org>
, Matt Ingenthron
.B <ingenthr@cep.net>
, Anatoly Vorobey
.B <mellon@pobox.com>
and Brad Fitzpatrick
.B <brad@danga.com>
and the rest of the crew of Danga Interactive
and Brad Fitzpatrick
.B <brad@danga.com>
and the rest of the crew of who worked on memcached
including the Danga Interactive folks
.B http://www.danga.com
.br

0 comments on commit 075f789

Please sign in to comment.