update docs
[m6w6/libmemcached] / bin / memcp.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>memcp &mdash; libmemcached 1.0.99 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 src="../_static/jquery.js"></script>
25 <script src="../_static/underscore.js"></script>
26 <script src="../_static/doctools.js"></script>
27 <script 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="memtouch" href="memtouch.html" />
40 <link rel="prev" title="memcat" href="memcat.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
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 1.0
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 <p class="caption"><span class="caption-text">libmemcached</span></p>
89 <ul>
90 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
91 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
93 </ul>
94 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
95 <ul>
96 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
97 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
98 </ul>
99 <p class="caption"><span class="caption-text">libhashkit</span></p>
100 <ul>
101 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
102 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
103 </ul>
104 <p class="caption"><span class="caption-text">Client Applications</span></p>
105 <ul class="current">
106 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
107 <li class="toctree-l2 current"><a class="reference internal" href="index.html#data-manipulation">Data Manipulation</a><ul class="current">
108 <li class="toctree-l3"><a class="reference internal" href="memexist.html">memexist — Check for the existence of a key</a></li>
109 <li class="toctree-l3"><a class="reference internal" href="memcat.html">memcat — &quot;cat&quot; data from a server</a></li>
110 <li class="toctree-l3 current"><a class="current reference internal" href="#">memcp — &quot;cp&quot; files to a server</a><ul>
111 <li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
112 <li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
113 <li class="toctree-l4"><a class="reference internal" href="#options">OPTIONS</a></li>
114 <li class="toctree-l4"><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
115 <li class="toctree-l4"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
116 </ul>
117 </li>
118 <li class="toctree-l3"><a class="reference internal" href="memtouch.html">memtouch — &quot;touch&quot; a key</a></li>
119 <li class="toctree-l3"><a class="reference internal" href="memrm.html">memrm – &quot;rm&quot; a key</a></li>
120 </ul>
121 </li>
122 <li class="toctree-l2"><a class="reference internal" href="index.html#tests-and-analysis">Tests and Analysis</a></li>
123 <li class="toctree-l2"><a class="reference internal" href="index.html#server-administration">Server Administration</a></li>
124 </ul>
125 </li>
126 </ul>
127 <p class="caption"><span class="caption-text">Copyright</span></p>
128 <ul>
129 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
130 </ul>
131
132
133
134 </div>
135 </div>
136 </nav>
137
138 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
139
140
141 <nav class="wy-nav-top" aria-label="top navigation">
142
143 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
144 <a href="../index.html">libmemcached</a>
145
146 </nav>
147
148
149 <div class="wy-nav-content">
150
151 <div class="rst-content">
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169 <div role="navigation" aria-label="breadcrumbs navigation">
170
171 <ul class="wy-breadcrumbs">
172
173 <li><a href="../index.html">Docs</a> &raquo;</li>
174
175 <li><a href="index.html">Client Applications</a> &raquo;</li>
176
177 <li>memcp</li>
178
179
180 <li class="wy-breadcrumbs-aside">
181
182
183
184 </li>
185
186 </ul>
187
188
189 <hr/>
190 </div>
191 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
192 <div itemprop="articleBody">
193
194 <div class="section" id="memcp">
195 <h1>memcp<a class="headerlink" href="#memcp" title="Permalink to this headline"></a></h1>
196 <div class="section" id="synopsis">
197 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
198 <p>memcp [options] --servers &lt;hostname[:port]...&gt; &lt;file...&gt;</p>
199 <p>Copy files to a collection of memcached servers.</p>
200 </div>
201 <div class="section" id="description">
202 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
203 <p><strong class="program">memcp</strong> copies one or more files into <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> servers.
204 It is similar to the standard UNIX <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/cp">cp(1)</a></em> command.</p>
205 <p>The key names will be the names of the files, without any directory path.</p>
206 </div>
207 <div class="section" id="options">
208 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
209 <dl class="std option">
210 <dt id="cmdoption-memcp-help">
211 <code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-help" title="Permalink to this definition"></a></dt>
212 <dd><p>Display help.</p>
213 </dd></dl>
214
215 <dl class="std option">
216 <dt id="cmdoption-memcp-version">
217 <code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-version" title="Permalink to this definition"></a></dt>
218 <dd><p>Display version.</p>
219 </dd></dl>
220
221 <dl class="std option">
222 <dt id="cmdoption-memcp-quiet">
223 <code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-quiet" title="Permalink to this definition"></a></dt>
224 <dd><p>Operate quietly.</p>
225 </dd></dl>
226
227 <dl class="std option">
228 <dt id="cmdoption-memcp-verbose">
229 <code class="sig-name descname">--verbose</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-verbose" title="Permalink to this definition"></a></dt>
230 <dd><p>Operate more verbosely.</p>
231 </dd></dl>
232
233 <dl class="std option">
234 <dt id="cmdoption-memcp-debug">
235 <code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-debug" title="Permalink to this definition"></a></dt>
236 <dd><p>See <a class="reference internal" href="#cmdoption-memcp-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
237 </dd></dl>
238
239 <dl class="std option">
240 <dt id="cmdoption-memcp-servers">
241 <code class="sig-name descname">--servers</code><code class="sig-prename descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memcp-servers" title="Permalink to this definition"></a></dt>
242 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
243 </dd></dl>
244
245 <dl class="std option">
246 <dt id="cmdoption-memcp-binary">
247 <code class="sig-name descname">--binary</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-binary" title="Permalink to this definition"></a></dt>
248 <dd><p>Enable binary protocol.</p>
249 </dd></dl>
250
251 <dl class="std option">
252 <dt id="cmdoption-memcp-expire">
253 <code class="sig-name descname">--expire</code><code class="sig-prename descclassname"> &lt;expiration&gt;</code><a class="headerlink" href="#cmdoption-memcp-expire" title="Permalink to this definition"></a></dt>
254 <dd><p>Use <em>expiration</em> seconds (or a UNIX timestamp).</p>
255 </dd></dl>
256
257 <dl class="std option">
258 <dt id="cmdoption-memcp-flag">
259 <code class="sig-name descname">--flag</code><code class="sig-prename descclassname"> &lt;number&gt;</code><a class="headerlink" href="#cmdoption-memcp-flag" title="Permalink to this definition"></a></dt>
260 <dd><p>Use <em>number</em> as flag.</p>
261 </dd></dl>
262
263 <dl class="std option">
264 <dt id="cmdoption-memcp-hash">
265 <code class="sig-name descname">--hash</code><code class="sig-prename descclassname"> &lt;algorithm&gt;</code><a class="headerlink" href="#cmdoption-memcp-hash" title="Permalink to this definition"></a></dt>
266 <dd><p>Use <em>algorithm</em> as key hash algo.
267 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>
268 </dd></dl>
269
270 <dl class="std option">
271 <dt id="cmdoption-memcp-username">
272 <code class="sig-name descname">--username</code><code class="sig-prename descclassname"> &lt;username&gt;</code><a class="headerlink" href="#cmdoption-memcp-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="std option">
277 <dt id="cmdoption-memcp-password">
278 <code class="sig-name descname">--password</code><code class="sig-prename descclassname"> &lt;password&gt;</code><a class="headerlink" href="#cmdoption-memcp-password" title="Permalink to this definition"></a></dt>
279 <dd><p>Use <em>password</em> for SASL authentication.</p>
280 </dd></dl>
281
282 <dl class="std option">
283 <dt id="cmdoption-memcp-udp">
284 <code class="sig-name descname">--udp</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-udp" title="Permalink to this definition"></a></dt>
285 <dd><p>Enable UDP operation mode.</p>
286 </dd></dl>
287
288 <dl class="std option">
289 <dt id="cmdoption-memcp-buffer">
290 <code class="sig-name descname">--buffer</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-buffer" title="Permalink to this definition"></a></dt>
291 <dd><p>Enable internal buffering of commands.</p>
292 </dd></dl>
293
294 <dl class="std option">
295 <dt id="cmdoption-memcp-set">
296 <code class="sig-name descname">--set</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-set" title="Permalink to this definition"></a></dt>
297 <dd><p>Issue <em>SET</em> command(s). This is the default mode.
298 See also <a class="reference internal" href="#cmdoption-memcp-add"><code class="xref std std-option docutils literal notranslate"><span class="pre">--add</span></code></a> and <a class="reference internal" href="#cmdoption-memcp-replace"><code class="xref std std-option docutils literal notranslate"><span class="pre">--replace</span></code></a>.</p>
299 </dd></dl>
300
301 <dl class="std option">
302 <dt id="cmdoption-memcp-add">
303 <code class="sig-name descname">--add</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-add" title="Permalink to this definition"></a></dt>
304 <dd><p>Issue <em>ADD</em> command(s).</p>
305 </dd></dl>
306
307 <dl class="std option">
308 <dt id="cmdoption-memcp-replace">
309 <code class="sig-name descname">--replace</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcp-replace" title="Permalink to this definition"></a></dt>
310 <dd><p>Issue <em>REPLACE</em> command(s).</p>
311 </dd></dl>
312
313 </div>
314 <div class="section" id="environment">
315 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline"></a></h2>
316 <dl class="std envvar">
317 <dt id="envvar-MEMCACHED_SERVERS">
318 <code class="sig-name descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition"></a></dt>
319 <dd><p>Specify the list of servers.</p>
320 </dd></dl>
321
322 </div>
323 <div class="section" id="see-also">
324 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
325 <ul class="simple">
326 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
327 <li><p><a class="reference internal" href="../libmemcached/configuration.html"><span class="doc">libmemcached Configuration</span></a></p></li>
328 <li><p><a class="reference internal" href="../libmemcached/memcached_behavior.html"><span class="doc">Behaviors of the library</span></a></p></li>
329 </ul>
330 </div>
331 </div>
332
333
334 </div>
335
336 </div>
337 <footer>
338
339 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
340
341 <a href="memtouch.html" class="btn btn-neutral float-right" title="memtouch" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
342
343
344 <a href="memcat.html" class="btn btn-neutral float-left" title="memcat" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
345
346 </div>
347
348
349 <hr/>
350
351 <div role="contentinfo">
352 <p>
353 &copy; <a href="../copyright.html">Copyright</a>
354
355 </p>
356 </div>
357 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>.
358
359 </footer>
360
361 </div>
362 </div>
363
364 </section>
365
366 </div>
367
368
369
370 <script type="text/javascript">
371 jQuery(function () {
372 SphinxRtdTheme.Navigation.enable(true);
373 });
374 </script>
375
376
377
378
379
380
381 </body>
382 </html>