Fix for building docs.

[awesomized/libmemcached] / docs / source / bin / memslap.rst

diff --git a/docs/source/bin/memslap.rst b/docs/source/bin/memslap.rst
new file mode 100644 (file)
index 0000000..fbaa5fe
--- /dev/null
+++ b/docs/source/bin/memslap.rst
@@ -0,0 +1,63 @@
+=================================================
+memslap - Load testing  and benchmarking a server
+=================================================
+
+
+--------
+SYNOPSIS
+--------
+
+memslap [options]
+
+.. program::  memslap
+
+-----------
+DESCRIPTION
+-----------
+
+
+:program:`memslap` 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. 
+
+
+-------
+OPTIONS
+-------
+
+
+You can specify servers via the option:
+
+.. option:: --servers  
+
+or via the environment variable:
+
+.. envvar:: `MEMCACHED_SERVERS`
+
+For a full list of operations run the tool with:
+
+.. option:: --help
+
+
+----
+HOME
+----
+
+
+To find out more information please check:
+'http://libmemcached.org/ <http://libmemcached.org/>'_
+
+
+------
+AUTHOR
+------
+
+
+Brian Aker, <brian@tangent.org>
+
+
+--------
+SEE ALSO
+--------
+
+
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`