Update from trunk to launchpad
[awesomized/libmemcached] / docs / man / memaslap.1
index cc8c0cb74eb737e173e1c6bd616ae92fad44920f..7672fbb970876be515502148d459f2294d30607a 100644 (file)
@@ -1,4 +1,4 @@
-.TH "MEMASLAP" "1" "April 08, 2011" "0.47" "libmemcached"
+.TH "MEMASLAP" "1" "July 21, 2011" "0.51" "libmemcached"
 .SH NAME
 memaslap \- libmemcached Documentation
 .
@@ -30,31 +30,29 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .\" Man page generated from reStructeredText.
 .
-.sp
-memaslap \- Load testing and benchmarking tool for memcached
 .SH SYNOPSIS
 .sp
-.nf
-.ft C
 memaslap [options]
-.ft P
-.fi
+.INDENT 0.0
+.TP
+.B \-\-help
+.UNINDENT
 .SH DESCRIPTION
 .sp
-\fBmemaslap\fP is a load generation and benchmark tool for memcached(1)
-servers. It generates configurable workload such as threads, concurrencies, connections,
-run time, overwrite, miss rate, key size, value size, get/set proportion,
-expected throughput, and so on. Furthermore, it also supports data
+\fBmemaslap\fP is a load generation and benchmark tool for memcached
+servers. It generates configurable workload such as threads, concurrencies,
+connections, run time, overwrite, miss rate, key size, value size, get/set
+proportion, expected throughput, and so on. Furthermore, it also testss data
 verification, expire\-time verification, UDP, binary protocol, facebook test,
 replication test, multi\-get and reconnection, etc.
 .sp
-Memslap manages network connections like memcached with
+Memaslap manages network connections like memcached with
 libevent. Each thread of memaslap is bound with a CPU core, all
 the threads don\(aqt communicate with each other, and there are several socket
 connections in each thread. Each connection keeps key size distribution,
 value size distribution, and command distribution by itself.
 .sp
-You can specify servers via the \fB\-\-servers\fP option or via the
+You can specify servers via the \fI\-\-servers\fP option or via the
 environment variable \fBMEMCACHED_SERVERS\fP.
 .SH FEATURES
 .sp
@@ -94,7 +92,7 @@ memaslap can handle network very efficiently.
 .sp
 Memslap has the similar implementation of multi\-threads to
 memcached. Memslap creates one or more self\-governed threads;
-each thread is bound with one CPU core if the system supports setting CPU
+each thread is bound with one CPU core if the system testss setting CPU
 core affinity.
 .sp
 In addition, each thread has a libevent to manage the events of the network;
@@ -165,9 +163,9 @@ layer.
 .sp
 Because each thread is self\-governed, memaslap can assign
 different threads to handle different memcached servers. This is just one of
-the ways in which memaslap supports multiple servers. The only
+the ways in which memaslap tests multiple servers. The only
 limitation is that the number of servers cannot be greater than the number
-of threads. The other way to support multiple servers is for replication
+of threads. The other way to test multiple servers is for replication
 test. Each concurrency has one socket connection to each memcached server.
 For the implementation, memaslap can set some objects to one
 memcached server, and get these objects from the other servers.
@@ -176,10 +174,10 @@ By default, Memslap does single get. If the user specifies
 multi\-get option, memaslap will collect enough get commands and
 pack and send the commands together.
 .sp
-Memslap supports both the ASCII protocol and binary protocol,
+Memslap testss both the ASCII protocol and binary protocol,
 but it runs on the ASCII protocol by default.
 Memslap by default runs on the TCP protocol, but it also
-supports UDP. Because UDP is unreliable, dropped packages and out\-of\-order
+tests UDP. Because UDP is unreliable, dropped packages and out\-of\-order
 packages may occur. Memslap creates a memory buffer to handle
 these problems. Memslap tries to read all the response data of
 one command from the server and reorders the response data. If some packages
@@ -246,8 +244,8 @@ rounded to 3 decimal places.
 The minimum value size is 1 bytes; the maximum value size is 1M bytes. The
 precision of proportion is 0.001. The proportion of distribution will be
 rounded to 3 decimal places.
-Currently, memaslap only supports set and get commands. And it
-supports 100% set and 100% get. For 100% get, it will preset some objects to
+Currently, memaslap only testss set and get commands. And it
+testss 100% set and 100% get. For 100% get, it will preset some objects to
 the server.
 .SS Multi\-thread and concurrency
 .sp
@@ -257,7 +255,7 @@ number of them. The default number of threads is 1; the default number of
 concurrency is 16. The user can use “—threads” and “\-\-concurrency” to
 specify these variables.
 .sp
-If the system supports setting CPU affinity and the number of threads
+If the system tests setting CPU affinity and the number of threads
 specified by the user is greater than 1, memaslap will try to
 bind each thread to a different CPU core. So if you want to get the best
 performance memaslap, it is better to specify the number of
@@ -316,7 +314,7 @@ throughput using “\-\-tps” option.
 Most of the time, the user does not need to specify the window size. The
 default window size is 10k. For Schooner Memcached, the user can specify
 different window sizes to get different cache miss rates based on the test
-case. Memslap supports cache miss rate between 0% and 100%.
+case. Memslap testss cache miss rate between 0% and 100%.
 If you use this utility to test the performance of Schooner Memcached, you
 can specify a proper window size to get the expected cache miss rate. The
 formula for calculating window size is as follows:
@@ -364,11 +362,11 @@ The formula for calculating window size for cache miss rate 5%:
 cache_size / concurrency / (key_size + value_size) * 0.7
 .SS Verification
 .sp
-Memslap supports both data verification and expire\-time
+Memslap testss both data verification and expire\-time
 verification. The user can use "\-\-verify=" or "\-v" to specify the proportion
-of data verification. In theory, it supports 100% data verification. The
+of data verification. In theory, it testss 100% data verification. The
 user can use "\-\-exp_verify=" or "\-e" to specify the proportion of
-expire\-time verification. In theory, it supports 100% expire\-time
+expire\-time verification. In theory, it testss 100% expire\-time
 verification. Specify the "\-\-verbose" options to get more detailed error
 information.
 .sp
@@ -376,9 +374,9 @@ For example: \-\-exp_verify=0.01 –verify=0.1 , it means that 1% of the objects
 set with expire\-time, 10% of the objects gotten will be verified. If the
 objects are gotten, memaslap will verify the expire\-time and
 value.
-.SS multi\-servers and multi\-clients
+.SS multi\-servers and multi\-config
 .sp
-Memslap supports multi\-servers based on self\-governed thread.
+Memslap testss multi\-servers based on self\-governed thread.
 There is a limitation that the number of servers cannot be greater than the
 number of threads. Memslap assigns one thread to handle one
 server at least. The user can use the "\-\-servers=" or "\-s" option to specify
@@ -427,10 +425,10 @@ For more information on the format of dumping statistic information, refer to 
 .SS Multi\-get
 .sp
 The user can use "\-\-division=" or "\-d" to specify multi\-get keys count.
-Memslap by default does single get with TCP. Memslap also supports data
+Memslap by default does single get with TCP. Memslap also testss data
 verification and expire\-time verification for multi\-get.
 .sp
-Memslap supports multi\-get with both TCP and UDP. Because of
+Memslap testss multi\-get with both TCP and UDP. Because of
 the different implementation of the ASCII protocol and binary protocol,
 there are some differences between the two. For the ASCII protocol,
 memaslap sends one “multi\-get” to the server once. For the
@@ -438,7 +436,7 @@ binary protocol, memaslap sends several single get commands
 together as “multi\-get” to the server.
 .SS UDP and TCP
 .sp
-Memslap supports both UDP and TCP. For TCP,
+Memslap testss both UDP and TCP. For TCP,
 memaslap does not reconnect the memcached server if socket connections are
 lost. If all the socket connections are lost or memcached server crashes,
 memaslap will exit. If the user specifies the “\-\-reconnect”
@@ -449,10 +447,10 @@ limitations:
 .sp
 UDP cannot set data more than 1400 bytes.
 .sp
-UDP is not supported by the binary protocol because the binary protocol of
-memcached does not support that.
+UDP is not testsed by the binary protocol because the binary protocol of
+memcached does not tests that.
 .sp
-UDP doesn’t support reconnection.
+UDP doesn’t tests reconnection.
 .SS Facebook test
 .sp
 Set data with TCP and multi\-get with UDP. Specify the following options:
@@ -492,8 +490,8 @@ server 0 and server 1 crash, memaslap will exit.
 .SS Supports thousands of TCP connections
 .sp
 Start memaslap with "\-\-conn_sock=" or "\-n" to enable this
-feature. Make sure that your system can support opening thousands of files
-and creating thousands of sockets. However, this feature does not support
+feature. Make sure that your system can tests opening thousands of files
+and creating thousands of sockets. However, this feature does not tests
 reconnection if sockets disconnect.
 .sp
 For example:
@@ -507,7 +505,7 @@ connections, and the total number of TCP socket connections is 128 * 128 =
 .SS Supports binary protocol
 .sp
 Start memaslap with "\-\-binary" or "\-B" options to enable this
-feature. It supports all the above features except UDP, because the latest
+feature. It testss all the above features except UDP, because the latest
 memcached 1.3.3 does not implement binary UDP protocol.
 .sp
 For example:
@@ -515,7 +513,7 @@ For example:
 \-\-binary
 .sp
 Since memcached 1.3.3 doesn\(aqt implement binary UDP protocol,
-memaslap does not support UDP. In addition, memcached 1.3.3 does not support
+memaslap does not tests UDP. In addition, memcached 1.3.3 does not tests
 multi\-get. If you specify "\-\-division=50" option, it just sends 50 get
 commands together as “mulit\-get” to the server.
 .SH CONFIGURATION FILE
@@ -528,7 +526,7 @@ Below is a sample configuration file:
 .sp
 .nf
 .ft C
-***************************************************************************
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
 #comments should start with \(aq#\(aq
 #key
 #start_len end_len proportion
@@ -583,7 +581,7 @@ value
 #cmd
 #cmd_type cmd_proportion
 #
-#currently memaslap only supports get and set command.
+#currently memaslap only testss get and set command.
 #
 #cmd_type
 #set     0
@@ -1150,11 +1148,11 @@ Default never overwrite object.
 .TP
 .B \-R,  \-\-reconnect
 .
-Reconnect support, when connection is closed it will be reconnected.
+Reconnect tests, when connection is closed it will be reconnected.
 .TP
 .B \-U,  \-\-udp
 .
-UDP support, default memaslap uses TCP, TCP port and UDP port of
+UDP tests, default memaslap uses TCP, TCP port and UDP port of
 server must be same.
 .TP
 .B \-a,  \-\-facebook
@@ -1207,18 +1205,18 @@ memaslap \-s 127.0.0.1:11211,127.0.0.1:11212 \-F config \-t 2m \-p 2
 .SH HOME
 .sp
 To find out more information please check:
-\fI\%http://launchpad.org/libmemcached\fP
+\fI\%http://libmemcached.org/\fP
 .SH AUTHORS
 .sp
 Mingqiang Zhuang <\fI\%mingqiangzhuang@hengtiansoft.com\fP> (Schooner Technolgy)
 Brian Aker, <\fI\%brian@tangent.org\fP>
 .SH SEE ALSO
 .sp
-\fImemcached(1)\fP \fIlibmemcached(3)\fP \fImemcached_strerror(3)\fP
+\fImemcached(1)\fP \fIlibmemcached(3)\fP
 .SH AUTHOR
 Brian Aker
 .SH COPYRIGHT
-2011, Brian Aker
+2011, Brian Aker DataDifferential, http://datadifferential.com/
 .\" Generated by docutils manpage writer.
 .\" 
 .