Deploy to GitHub pages
[awesomized/libmemcached] / bin / memrm.html
1
2
3 <!DOCTYPE html>
4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>memrm &mdash; libmemcached-awesome 1.1.4 documentation</title>
12
13
14
15
16
17
18
19
20 <script type="text/javascript" src="../_static/js/modernizr.min.js"></script>
21
22
23 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
24 <script type="text/javascript" src="../_static/jquery.js"></script>
25 <script type="text/javascript" src="../_static/underscore.js"></script>
26 <script type="text/javascript" src="../_static/doctools.js"></script>
27 <script type="text/javascript" src="../_static/language_data.js"></script>
28
29 <script type="text/javascript" src="../_static/js/theme.js"></script>
30
31
32
33
34 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
35 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
36 <link rel="index" title="Index" href="../genindex.html" />
37 <link rel="search" title="Search" href="../search.html" />
38 <link rel="copyright" title="Copyright" href="../copyright.html" />
39 <link rel="next" title="memaslap - Load testing and benchmarking a server" href="memaslap.html" />
40 <link rel="prev" title="memtouch" href="memtouch.html" />
41 </head>
42
43 <body class="wy-body-for-nav">
44
45
46 <div class="wy-grid-for-nav">
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search" >
51
52
53
54 <a href="../index.html" class="icon icon-home"> libmemcached-awesome
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 1.1
65 </div>
66
67
68
69
70 <div role="search">
71 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76 </div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85
86
87
88 <ul class="current">
89 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
91 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
92 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
93 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
94 <li class="toctree-l2"><a class="reference internal" href="memexist.html">memexist — Check for the existence of a key</a></li>
95 <li class="toctree-l2"><a class="reference internal" href="memcat.html">memcat — &quot;cat&quot; data from a server</a></li>
96 <li class="toctree-l2"><a class="reference internal" href="memcp.html">memcp — &quot;cp&quot; files to a server</a></li>
97 <li class="toctree-l2"><a class="reference internal" href="memtouch.html">memtouch — &quot;touch&quot; a key</a></li>
98 <li class="toctree-l2 current"><a class="current reference internal" href="#">memrm – &quot;rm&quot; a key</a></li>
99 <li class="toctree-l2"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
100 <li class="toctree-l2"><a class="reference internal" href="memslap.html">memslap - Load testing and benchmarking a server</a></li>
101 <li class="toctree-l2"><a class="reference internal" href="memping.html">memping – Ping a server</a></li>
102 <li class="toctree-l2"><a class="reference internal" href="memstat.html">memstat – Gather statistics from a server</a></li>
103 <li class="toctree-l2"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
104 <li class="toctree-l2"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
105 <li class="toctree-l2"><a class="reference internal" href="memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
106 <li class="toctree-l2"><a class="reference internal" href="memdump.html">memdump — Dump a server's data</a></li>
107 <li class="toctree-l2"><a class="reference internal" href="memflush.html">memflush — Flush a server (erase all cached data)</a></li>
108 </ul>
109 </li>
110 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Miscellaneous</a></li>
111 </ul>
112 <ul>
113 <li class="toctree-l1"><a class="reference internal" href="../changelogs.html">Change Logs</a></li>
114 <li class="toctree-l1"><a class="reference internal" href="../issues.html">Known issues</a></li>
115 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
116 </ul>
117
118
119
120 </div>
121 </div>
122 </nav>
123
124 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
125
126
127 <nav class="wy-nav-top" aria-label="top navigation">
128
129 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
130 <a href="../index.html">libmemcached-awesome</a>
131
132 </nav>
133
134
135 <div class="wy-nav-content">
136
137 <div class="rst-content">
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155 <div role="navigation" aria-label="breadcrumbs navigation">
156
157 <ul class="wy-breadcrumbs">
158
159 <li><a href="../index.html">Docs</a> &raquo;</li>
160
161 <li><a href="index.html">Client Applications</a> &raquo;</li>
162
163 <li>memrm</li>
164
165
166 <li class="wy-breadcrumbs-aside">
167
168
169
170 <a href="https://github.com/awesomized/libmemcached/blob/v1.x/docs/source/bin/memrm.rst" class="fa fa-github"> Edit on GitHub</a>
171
172
173
174 </li>
175
176 </ul>
177
178
179 <hr/>
180 </div>
181 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
182 <div itemprop="articleBody">
183
184 <div class="section" id="memrm">
185 <h1>memrm<a class="headerlink" href="#memrm" title="Permalink to this headline"></a></h1>
186 <div class="section" id="synopsis">
187 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
188 <p>memrm [options] &lt;key ...&gt;</p>
189 <p>Remove key(s) from a collection of memcached servers</p>
190 </div>
191 <div class="section" id="description">
192 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
193 <p><strong class="program">memrm</strong> removes items, specified by key, from <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> servers.</p>
194 </div>
195 <div class="section" id="options">
196 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
197 <dl class="option">
198 <dt id="cmdoption-memrm-h-help">
199 <code class="descname">-h|--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-h-help" title="Permalink to this definition"></a></dt>
200 <dd><p>Display help.</p>
201 </dd></dl>
202
203 <dl class="option">
204 <dt id="cmdoption-memrm-v-version">
205 <code class="descname">-V|--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-v-version" title="Permalink to this definition"></a></dt>
206 <dd><p>Display version.</p>
207 </dd></dl>
208
209 <dl class="option">
210 <dt id="cmdoption-memrm-q-quiet">
211 <code class="descname">-q|--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-q-quiet" title="Permalink to this definition"></a></dt>
212 <dd><p>Operate quietly.</p>
213 </dd></dl>
214
215 <dl class="option">
216 <dt id="cmdoption-memrm-v-verbose">
217 <code class="descname">-v|--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-v-verbose" title="Permalink to this definition"></a></dt>
218 <dd><p>Operate more verbosely.</p>
219 </dd></dl>
220
221 <dl class="option">
222 <dt id="cmdoption-memrm-d-debug">
223 <code class="descname">-d|--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-d-debug" title="Permalink to this definition"></a></dt>
224 <dd><p>See <a class="reference internal" href="#cmdoption-memrm-v-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">-v|--verbose</span></code></a>.</p>
225 </dd></dl>
226
227 <dl class="option">
228 <dt id="cmdoption-memrm-e-expire">
229 <code class="descname">-e|--expire</code><code class="descclassname"> &lt;expiration&gt;</code><a class="headerlink" href="#cmdoption-memrm-e-expire" title="Permalink to this definition"></a></dt>
230 <dd><p>Use <em>expiration</em> seconds (or a UNIX timestamp).</p>
231 </dd></dl>
232
233 <dl class="option">
234 <dt id="cmdoption-memrm-h-hash">
235 <code class="descname">-H|--hash</code><code class="descclassname"> &lt;algorithm&gt;</code><a class="headerlink" href="#cmdoption-memrm-h-hash" title="Permalink to this definition"></a></dt>
236 <dd><p>Use <em>algorithm</em> as key hash algo.
237 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>
238 </dd></dl>
239
240 <dl class="option">
241 <dt id="cmdoption-memrm-s-servers">
242 <code class="descname">-s|--servers</code><code class="descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memrm-s-servers" title="Permalink to this definition"></a></dt>
243 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
244 </dd></dl>
245
246 <dl class="option">
247 <dt id="cmdoption-memrm-n-non-blocking">
248 <code class="descname">-n|--non-blocking</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-n-non-blocking" title="Permalink to this definition"></a></dt>
249 <dd><p>Enable non-blocking operations.</p>
250 </dd></dl>
251
252 <dl class="option">
253 <dt id="cmdoption-memrm-n-tcp-nodelay">
254 <code class="descname">-N|--tcp-nodelay</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-n-tcp-nodelay" title="Permalink to this definition"></a></dt>
255 <dd><p>Disable Nagle's algorithm.</p>
256 </dd></dl>
257
258 <dl class="option">
259 <dt id="cmdoption-memrm-b-binary">
260 <code class="descname">-b|--binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-b-binary" title="Permalink to this definition"></a></dt>
261 <dd><p>Enable binary protocol.</p>
262 </dd></dl>
263
264 <dl class="option">
265 <dt id="cmdoption-memrm-b-buffer">
266 <code class="descname">-B|--buffer</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memrm-b-buffer" title="Permalink to this definition"></a></dt>
267 <dd><p>Buffer requests.</p>
268 </dd></dl>
269
270 <dl class="option">
271 <dt id="cmdoption-memrm-u-username">
272 <code class="descname">-u|--username</code><code class="descclassname"> &lt;username&gt;</code><a class="headerlink" href="#cmdoption-memrm-u-username" title="Permalink to this definition"></a></dt>
273 <dd><p>Use <em>username</em> for SASL authentication.</p>
274 </dd></dl>
275
276 <dl class="option">
277 <dt id="cmdoption-memrm-p-password">
278 <code class="descname">-p|--password</code><code class="descclassname"> &lt;password&gt;</code><a class="headerlink" href="#cmdoption-memrm-p-password" title="Permalink to this definition"></a></dt>
279 <dd><p>Use <em>password</em> for SASL authentication.</p>
280 </dd></dl>
281
282 </div>
283 <div class="section" id="environment">
284 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline"></a></h2>
285 <dl class="envvar">
286 <dt id="envvar-MEMCACHED_SERVERS">
287 <code class="descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition"></a></dt>
288 <dd><p>Specify a list of servers.</p>
289 </dd></dl>
290
291 </div>
292 <div class="section" id="notes">
293 <h2>NOTES<a class="headerlink" href="#notes" title="Permalink to this headline"></a></h2>
294 <div class="section" id="program-prefix">
295 <h3>PROGRAM PREFIX<a class="headerlink" href="#program-prefix" title="Permalink to this headline"></a></h3>
296 <p>The prefix of this program is variable, i.e. it can be configured at build time.</p>
297 <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>
298 <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,
299 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>
300 </div>
301 </div>
302 <div class="section" id="see-also">
303 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
304 <ul class="simple">
305 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
306 <li><a class="reference internal" href="../libmemcached/memcached_delete.html"><span class="doc">Deleting data from a server</span></a></li>
307 </ul>
308 </div>
309 </div>
310
311
312 </div>
313
314 </div>
315 <footer>
316
317 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
318
319 <a href="memaslap.html" class="btn btn-neutral float-right" title="memaslap - Load testing and benchmarking a server" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
320
321
322 <a href="memtouch.html" class="btn btn-neutral float-left" title="memtouch" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
323
324 </div>
325
326
327 <hr/>
328
329 <div role="contentinfo">
330 <p>
331 &copy; <a href="../copyright.html">Copyright</a>
332
333 </p>
334 </div>
335 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
336
337 </footer>
338
339 </div>
340 </div>
341
342 </section>
343
344 </div>
345
346
347
348 <script type="text/javascript">
349 jQuery(function () {
350 SphinxRtdTheme.Navigation.enable(true);
351 });
352 </script>
353
354
355
356
357
358
359 </body>
360 </html>