KBDocs3

[m6w6/libmemcached] / docs / memslap.rst

diff --git a/docs/memslap.rst b/docs/memslap.rst
index 62cf2a3a4d06195c8276978a971457642fe8129c..c99abd774d9113eede45c386e3834d9744f085f0 100644 (file)
--- a/docs/memslap.rst
+++ b/docs/memslap.rst
@@ -1,9 +1,6 @@
-=======
-memslap
-=======
-
-
-memslap - Load testing and benchmarking tool for memcached
+=================================================
+memslap - Load testing  and benchmarking a server
+=================================================
 
 
 --------
@@ -11,21 +8,52 @@ SYNOPSIS
 --------
 
 
-.. program::  memslap [options]
+:program: `memslap`
 
+.. program::  memslap
 
 -----------
 DESCRIPTION
 -----------
 
 
-\ **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. 
+: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
+------
+
 
-You can specify servers via the \ **--servers**\  option or via the
-environment variable \ ``MEMCACHED_SERVERS``\ .
+Brian Aker, <brian@tangent.org>
 
 
 --------
@@ -33,4 +61,4 @@ SEE ALSO
 --------
 
 
-:manpage:`memcached(1)` :manpage:`libmemcached(3)` :manpage:`memcached_strerror(3)`
+:manpage:`memcached(1)` :manpage:`libmemcached(3)`