update docs
[m6w6/libmemcached] / bin / memcapable.html
1
2
3 <!DOCTYPE html>
4 <html class="writer-html5" lang="en" >
5 <head>
6 <meta charset="utf-8">
7
8 <meta name="viewport" content="width=device-width, initial-scale=1.0">
9
10 <title>memcapable &mdash; libmemcached 1.0.99 documentation</title>
11
12
13
14 <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
15 <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
16
17
18
19
20
21
22
23 <!--[if lt IE 9]>
24 <script src="../_static/js/html5shiv.min.js"></script>
25 <![endif]-->
26
27
28 <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
29 <script src="../_static/jquery.js"></script>
30 <script src="../_static/underscore.js"></script>
31 <script src="../_static/doctools.js"></script>
32 <script src="../_static/language_data.js"></script>
33
34 <script type="text/javascript" src="../_static/js/theme.js"></script>
35
36
37 <link rel="index" title="Index" href="../genindex.html" />
38 <link rel="search" title="Search" href="../search.html" />
39 <link rel="copyright" title="Copyright" href="../copyright.html" />
40 <link rel="next" title="memdump" href="memdump.html" />
41 <link rel="prev" title="memparse" href="memparse.html" />
42 </head>
43
44 <body class="wy-body-for-nav">
45
46
47 <div class="wy-grid-for-nav">
48
49 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
50 <div class="wy-side-scroll">
51 <div class="wy-side-nav-search" >
52
53
54
55 <a href="../index.html" class="icon icon-home" alt="Documentation Home"> libmemcached
56
57
58
59 </a>
60
61
62
63
64 <div class="version">
65 1.0
66 </div>
67
68
69
70
71 <div role="search">
72 <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
73 <input type="text" name="q" placeholder="Search docs" />
74 <input type="hidden" name="check_keywords" value="yes" />
75 <input type="hidden" name="area" value="default" />
76 </form>
77 </div>
78
79
80 </div>
81
82
83 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
84
85
86
87
88
89
90 <p class="caption"><span class="caption-text">libmemcached</span></p>
91 <ul>
92 <li class="toctree-l1"><a class="reference internal" href="../libmemcached.html">Introduction</a></li>
93 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index.html">libmemcached API</a></li>
94 <li class="toctree-l1"><a class="reference internal" href="../libmemcached/index_misc.html">Misc</a></li>
95 </ul>
96 <p class="caption"><span class="caption-text">libmemcachedutil</span></p>
97 <ul>
98 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil.html">Introduction</a></li>
99 <li class="toctree-l1"><a class="reference internal" href="../libmemcachedutil/index.html">libmemcachedutil API</a></li>
100 </ul>
101 <p class="caption"><span class="caption-text">libhashkit</span></p>
102 <ul>
103 <li class="toctree-l1"><a class="reference internal" href="../libhashkit.html">Introduction</a></li>
104 <li class="toctree-l1"><a class="reference internal" href="../libhashkit/index.html">libhashkit API</a></li>
105 </ul>
106 <p class="caption"><span class="caption-text">Client Applications</span></p>
107 <ul class="current">
108 <li class="toctree-l1 current"><a class="reference internal" href="index.html">Client Applications</a><ul class="current">
109 <li class="toctree-l2"><a class="reference internal" href="index.html#data-manipulation">Data Manipulation</a></li>
110 <li class="toctree-l2 current"><a class="reference internal" href="index.html#tests-and-analysis">Tests and Analysis</a><ul class="current">
111 <li class="toctree-l3"><a class="reference internal" href="memaslap.html">memaslap - Load testing and benchmarking a server</a></li>
112 <li class="toctree-l3"><a class="reference internal" href="memslap.html">memslap</a></li>
113 <li class="toctree-l3"><a class="reference internal" href="memping.html">memping – Ping a server</a></li>
114 <li class="toctree-l3"><a class="reference internal" href="memstat.html">memstat – Gather statistics from a server</a></li>
115 <li class="toctree-l3"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
116 <li class="toctree-l3"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
117 <li class="toctree-l3 current"><a class="current reference internal" href="#">memcapable — Check a server's capabilities and compatibility</a><ul>
118 <li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
119 <li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
120 <li class="toctree-l4"><a class="reference internal" href="#options">OPTIONS</a></li>
121 <li class="toctree-l4"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
122 </ul>
123 </li>
124 </ul>
125 </li>
126 <li class="toctree-l2"><a class="reference internal" href="index.html#server-administration">Server Administration</a></li>
127 </ul>
128 </li>
129 </ul>
130 <p class="caption"><span class="caption-text">Copyright</span></p>
131 <ul>
132 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
133 </ul>
134
135
136
137 </div>
138
139 </div>
140 </nav>
141
142 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
143
144
145 <nav class="wy-nav-top" aria-label="top navigation">
146
147 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
148 <a href="../index.html">libmemcached</a>
149
150 </nav>
151
152
153 <div class="wy-nav-content">
154
155 <div class="rst-content">
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173 <div role="navigation" aria-label="breadcrumbs navigation">
174
175 <ul class="wy-breadcrumbs">
176
177 <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
178
179 <li><a href="index.html">Client Applications</a> &raquo;</li>
180
181 <li>memcapable</li>
182
183
184 <li class="wy-breadcrumbs-aside">
185
186
187
188 </li>
189
190 </ul>
191
192
193 <hr/>
194 </div>
195 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
196 <div itemprop="articleBody">
197
198 <div class="section" id="memcapable">
199 <h1>memcapable<a class="headerlink" href="#memcapable" title="Permalink to this headline"></a></h1>
200 <div class="section" id="synopsis">
201 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
202 <p>memcapable [options]</p>
203 <p>Check a memcached server's capabilities and compatibility.</p>
204 </div>
205 <div class="section" id="description">
206 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
207 <p><strong class="program">memcapable</strong> connects to the specified memcached server and tries to
208 determine its capabilities by running various commands and verifying the response.</p>
209 </div>
210 <div class="section" id="options">
211 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
212 <dl class="std option">
213 <dt id="cmdoption-memcapable-h">
214 <code class="sig-name descname">-h</code><code class="sig-prename descclassname"> hostname</code><a class="headerlink" href="#cmdoption-memcapable-h" title="Permalink to this definition"></a></dt>
215 <dd><p>Specify the hostname to connect to. The default is <em>localhost</em>.</p>
216 </dd></dl>
217
218 <dl class="std option">
219 <dt id="cmdoption-memcapable-p">
220 <code class="sig-name descname">-p</code><code class="sig-prename descclassname"> port</code><a class="headerlink" href="#cmdoption-memcapable-p" title="Permalink to this definition"></a></dt>
221 <dd><p>Specify the port number to connect to. The default is <em>11211</em>.</p>
222 </dd></dl>
223
224 <dl class="std option">
225 <dt id="cmdoption-memcapable-c">
226 <code class="sig-name descname">-c</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcapable-c" title="Permalink to this definition"></a></dt>
227 <dd><p><em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/3/abort">abort(3)</a></em> when detecting an error from the server.</p>
228 </dd></dl>
229
230 <dl class="std option">
231 <dt id="cmdoption-memcapable-v">
232 <code class="sig-name descname">-v</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memcapable-v" title="Permalink to this definition"></a></dt>
233 <dd><p>Print out the comparison when it detects an error from the server.</p>
234 </dd></dl>
235
236 <dl class="std option">
237 <dt id="cmdoption-memcapable-t">
238 <code class="sig-name descname">-t</code><code class="sig-prename descclassname"> n</code><a class="headerlink" href="#cmdoption-memcapable-t" title="Permalink to this definition"></a></dt>
239 <dd><p>Set the timeout for an IO operation to/from the server to <em>n</em> seconds.</p>
240 </dd></dl>
241
242 </div>
243 <div class="section" id="see-also">
244 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
245 <ul class="simple">
246 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
247 </ul>
248 </div>
249 </div>
250
251
252 </div>
253
254 </div>
255 <footer>
256
257 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
258
259 <a href="memdump.html" class="btn btn-neutral float-right" title="memdump" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
260
261
262 <a href="memparse.html" class="btn btn-neutral float-left" title="memparse" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
263
264 </div>
265
266
267 <hr/>
268
269 <div role="contentinfo">
270 <p>
271
272
273 &copy; <a href="../copyright.html">Copyright</a>
274
275 </p>
276 </div>
277
278
279
280 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
281
282 <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
283
284 provided by <a href="https://readthedocs.org">Read the Docs</a>.
285
286 </footer>
287
288 </div>
289 </div>
290
291 </section>
292
293 </div>
294
295
296 <script type="text/javascript">
297 jQuery(function () {
298 SphinxRtdTheme.Navigation.enable(true);
299 });
300 </script>
301
302
303
304
305
306
307 </body>
308 </html>