<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>memexist — libmemcached 1.0.99 documentation</title>
+ <title>memexist — libmemcached-awesome 1.1.4 documentation</title>
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
- <script src="../_static/jquery.js"></script>
- <script src="../_static/underscore.js"></script>
- <script src="../_static/doctools.js"></script>
- <script src="../_static/language_data.js"></script>
+ <script type="text/javascript" src="../_static/jquery.js"></script>
+ <script type="text/javascript" src="../_static/underscore.js"></script>
+ <script type="text/javascript" src="../_static/doctools.js"></script>
+ <script type="text/javascript" src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
- <a href="../index.html" class="icon icon-home"> libmemcached
+ <a href="../index.html" class="icon icon-home"> libmemcached-awesome
<div class="version">
- 1.0
+ 1.1
</div>
- <p class="caption"><span class="caption-text">libmemcached</span></p>
-<ul>
+ <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libmemcachedutil</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">libhashkit</span></p>
-<ul>
-<li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
-</ul>
-<p class="caption"><span class="caption-text">Client Applications</span></p>
-<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
-<li class="toctree-l2 current"><a class="reference internal" href="index.html#data-manipulation">Data Manipulation</a><ul class="current">
-<li class="toctree-l3 current"><a class="current reference internal" href="#">memexist — Check for the existence of a key</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#options">OPTIONS</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
-<li class="toctree-l4"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="#">memexist — Check for the existence of a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcat.html">memcat — "cat" data from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcp.html">memcp — "cp" files to a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memtouch.html">memtouch — "touch" a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memrm.html">memrm – "rm" a key</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memslap.html">memslap - Load testing and benchmarking a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memping.html">memping – Ping a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memstat.html">memstat – Gather statistics from a server</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memdump.html">memdump — Dump a server's data</a></li>
+<li class="toctree-l2"><a class="reference internal" href="memflush.html">memflush — Flush a server (erase all cached data)</a></li>
</ul>
</li>
-<li class="toctree-l3"><a class="reference internal" href="memcat.html">memcat — "cat" data from a server</a></li>
-<li class="toctree-l3"><a class="reference internal" href="memcp.html">memcp — "cp" files to a server</a></li>
-<li class="toctree-l3"><a class="reference internal" href="memtouch.html">memtouch — "touch" a key</a></li>
-<li class="toctree-l3"><a class="reference internal" href="memrm.html">memrm – "rm" a key</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
</ul>
-</li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#tests-and-analysis">Tests and Analysis</a></li>
-<li class="toctree-l2"><a class="reference internal" href="index.html#server-administration">Server Administration</a></li>
-</ul>
-</li>
-</ul>
-<p class="caption"><span class="caption-text">Copyright</span></p>
<ul>
+<li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
</ul>
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
- <a href="../index.html">libmemcached</a>
+ <a href="../index.html">libmemcached-awesome</a>
</nav>
<li class="wy-breadcrumbs-aside">
+
+ <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/bin/memexist.rst" class="fa fa-github"> Edit on GitHub</a>
+
+
</li>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
-<dl class="std option">
-<dt id="cmdoption-memexist-help">
-<code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-help" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-h-help">
+<code class="descname">-h|--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-h-help" title="Permalink to this definition">¶</a></dt>
<dd><p>Display help.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-version">
-<code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-version" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-v-version">
+<code class="descname">-V|--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-v-version" title="Permalink to this definition">¶</a></dt>
<dd><p>Display version.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-quiet">
-<code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-quiet" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-q-quiet">
+<code class="descname">-q|--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-q-quiet" title="Permalink to this definition">¶</a></dt>
<dd><p>Operate quietly.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-verbose">
-<code class="sig-name descname">--verbose</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-verbose" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-v-verbose">
+<code class="descname">-v|--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-v-verbose" title="Permalink to this definition">¶</a></dt>
<dd><p>Operate more verbosely.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-debug">
-<code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-debug" title="Permalink to this definition">¶</a></dt>
-<dd><p>See <a class="reference internal" href="#cmdoption-memexist-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
+<dl class="option">
+<dt id="cmdoption-memexist-d-debug">
+<code class="descname">-d|--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-d-debug" title="Permalink to this definition">¶</a></dt>
+<dd><p>See <a class="reference internal" href="#cmdoption-memexist-v-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">-v|--verbose</span></code></a>.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-servers">
-<code class="sig-name descname">--servers</code><code class="sig-prename descclassname"> <list of servers></code><a class="headerlink" href="#cmdoption-memexist-servers" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-s-servers">
+<code class="descname">-s|--servers</code><code class="descclassname"> <list of servers></code><a class="headerlink" href="#cmdoption-memexist-s-servers" title="Permalink to this definition">¶</a></dt>
<dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-binary">
-<code class="sig-name descname">--binary</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memexist-binary" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-n-non-blocking">
+<code class="descname">-n|--non-blocking</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-n-non-blocking" title="Permalink to this definition">¶</a></dt>
+<dd><p>Enable non-blocking operations.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memexist-n-tcp-nodelay">
+<code class="descname">-N|--tcp-nodelay</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-n-tcp-nodelay" title="Permalink to this definition">¶</a></dt>
+<dd><p>Disable Nagle's algorithm.</p>
+</dd></dl>
+
+<dl class="option">
+<dt id="cmdoption-memexist-b-binary">
+<code class="descname">-b|--binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-b-binary" title="Permalink to this definition">¶</a></dt>
<dd><p>Enable binary protocol.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-hash">
-<code class="sig-name descname">--hash</code><code class="sig-prename descclassname"> <algorithm></code><a class="headerlink" href="#cmdoption-memexist-hash" title="Permalink to this definition">¶</a></dt>
-<dd><p>Use <em>algorithm</em> as key hash algo.
-See <a class="reference internal" href="../libmemcached/memcached_behavior.html#_CPPv4N20memcached_behavior_t23MEMCACHED_BEHAVIOR_HASHE" title="memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH"><code class="xref cpp cpp-enumerator docutils literal notranslate"><span class="pre">memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH</span></code></a>.</p>
+<dl class="option">
+<dt id="cmdoption-memexist-b-buffer">
+<code class="descname">-B|--buffer</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memexist-b-buffer" title="Permalink to this definition">¶</a></dt>
+<dd><p>Buffer requests.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-username">
-<code class="sig-name descname">--username</code><code class="sig-prename descclassname"> <username></code><a class="headerlink" href="#cmdoption-memexist-username" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-u-username">
+<code class="descname">-u|--username</code><code class="descclassname"> <username></code><a class="headerlink" href="#cmdoption-memexist-u-username" title="Permalink to this definition">¶</a></dt>
<dd><p>Use <em>username</em> for SASL authentication.</p>
</dd></dl>
-<dl class="std option">
-<dt id="cmdoption-memexist-password">
-<code class="sig-name descname">--password</code><code class="sig-prename descclassname"> <password></code><a class="headerlink" href="#cmdoption-memexist-password" title="Permalink to this definition">¶</a></dt>
+<dl class="option">
+<dt id="cmdoption-memexist-p-password">
+<code class="descname">-p|--password</code><code class="descclassname"> <password></code><a class="headerlink" href="#cmdoption-memexist-p-password" title="Permalink to this definition">¶</a></dt>
<dd><p>Use <em>password</em> for SASL authentication.</p>
</dd></dl>
+<dl class="option">
+<dt id="cmdoption-memexist-h-hash">
+<code class="descname">-H|--hash</code><code class="descclassname"> <algorithm></code><a class="headerlink" href="#cmdoption-memexist-h-hash" title="Permalink to this definition">¶</a></dt>
+<dd><p>Use <em>algorithm</em> as key hash algo.
+See <a class="reference internal" href="../libmemcached/memcached_behavior.html#_CPPv4N20memcached_behavior_t23MEMCACHED_BEHAVIOR_HASHE" title="memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH"><code class="xref cpp cpp-enumerator docutils literal notranslate"><span class="pre">memcached_behavior_t::MEMCACHED_BEHAVIOR_HASH</span></code></a>.</p>
+</dd></dl>
+
</div>
<div class="section" id="environment">
<h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
-<dl class="std envvar">
+<dl class="envvar">
<dt id="envvar-MEMCACHED_SERVERS">
-<code class="
sig-name descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
-<dd><p>Specify the list of servers.</p>
+<code class="descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
+<dd><p>Specify a list of servers.</p>
</dd></dl>
+</div>
+<div class="section" id="notes">
+<h2>NOTES<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="program-prefix">
+<h3>PROGRAM PREFIX<a class="headerlink" href="#program-prefix" title="Permalink to this headline">¶</a></h3>
+<p>The prefix of this program is variable, i.e. it can be configured at build time.</p>
+<p>Usually the client programs of <code class="docutils literal notranslate"><span class="pre">libmemcached-awesome</span></code> are prefixed with <code class="docutils literal notranslate"><span class="pre">mem</span></code>, like <code class="docutils literal notranslate"><span class="pre">memcat</span></code> or <code class="docutils literal notranslate"><span class="pre">memcp</span></code>.</p>
+<p>It can be configured, though, to replace the prefix with something else like <code class="docutils literal notranslate"><span class="pre">mc</span></code>, in case of that,
+the client programs of <code class="docutils literal notranslate"><span class="pre">libmemcached-awesome</span></code> would be called <code class="docutils literal notranslate"><span class="pre">mccat</span></code>, <code class="docutils literal notranslate"><span class="pre">mccp</span></code>, etc. respectively.</p>
+</div>
</div>
<div class="section" id="see-also">
<h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
-<li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
-<li><p><a class="reference internal" href="../libmemcached/memcached_exist.html"><span class="doc">Determine if a keys exists.</span></a></p></li>
+<li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
+<li><a class="reference internal" href="../libmemcached/memcached_exist.html"><span class="doc">Determine if a keys exists</span></a></li>
</ul>
</div>
</div>
projects / awesomized / libmemcached / blobdiff