X-Git-Url: https://git.m6w6.name/?a=blobdiff_plain;f=docs%2Fmemslap.rst;h=c99abd774d9113eede45c386e3834d9744f085f0;hb=16ba6539e831e2abcef9dcf56fa26e3a0d5c7f91;hp=134cdf2dce24e4ee1d6bd487aaad3dff41ff3e20;hpb=ef301192f389f5f6ab4f8ed8c204ca7e115fe0b1;p=awesomized%2Flibmemcached diff --git a/docs/memslap.rst b/docs/memslap.rst index 134cdf2d..c99abd77 100644 --- a/docs/memslap.rst +++ b/docs/memslap.rst @@ -8,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. -You can specify servers via the \ **--servers**\ option or via the -environment variable \ ``MEMCACHED_SERVERS``\ . + +------- +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/ '_ + + +------ +AUTHOR +------ + + +Brian Aker, --------