update docs
[m6w6/libmemcached] / bin / memstat.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>memstat &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="memerror" href="memerror.html" />
41 <link rel="prev" title="memping" href="memping.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 current"><a class="current reference internal" href="#">memstat – Gather statistics from a server</a><ul>
115 <li class="toctree-l4"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
116 <li class="toctree-l4"><a class="reference internal" href="#description">DESCRIPTION</a></li>
117 <li class="toctree-l4"><a class="reference internal" href="#options">OPTIONS</a></li>
118 <li class="toctree-l4"><a class="reference internal" href="#environment">ENVIRONMENT</a></li>
119 <li class="toctree-l4"><a class="reference internal" href="#see-also">SEE ALSO</a></li>
120 </ul>
121 </li>
122 <li class="toctree-l3"><a class="reference internal" href="memerror.html">memerror — Translate libmemcached error codes</a></li>
123 <li class="toctree-l3"><a class="reference internal" href="memparse.html">memparse — Parse and validate an option string</a></li>
124 <li class="toctree-l3"><a class="reference internal" href="memcapable.html">memcapable — Check a server's capabilities and compatibility</a></li>
125 </ul>
126 </li>
127 <li class="toctree-l2"><a class="reference internal" href="index.html#server-administration">Server Administration</a></li>
128 </ul>
129 </li>
130 </ul>
131 <p class="caption"><span class="caption-text">Copyright</span></p>
132 <ul>
133 <li class="toctree-l1"><a class="reference internal" href="../copyright.html">Copyright</a></li>
134 </ul>
135
136
137
138 </div>
139
140 </div>
141 </nav>
142
143 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
144
145
146 <nav class="wy-nav-top" aria-label="top navigation">
147
148 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
149 <a href="../index.html">libmemcached</a>
150
151 </nav>
152
153
154 <div class="wy-nav-content">
155
156 <div class="rst-content">
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174 <div role="navigation" aria-label="breadcrumbs navigation">
175
176 <ul class="wy-breadcrumbs">
177
178 <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
179
180 <li><a href="index.html">Client Applications</a> &raquo;</li>
181
182 <li>memstat</li>
183
184
185 <li class="wy-breadcrumbs-aside">
186
187
188
189 </li>
190
191 </ul>
192
193
194 <hr/>
195 </div>
196 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
197 <div itemprop="articleBody">
198
199 <div class="section" id="memstat">
200 <h1>memstat<a class="headerlink" href="#memstat" title="Permalink to this headline"></a></h1>
201 <div class="section" id="synopsis">
202 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline"></a></h2>
203 <p>memstat [options]</p>
204 <p>Gather statistics from a server</p>
205 </div>
206 <div class="section" id="description">
207 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline"></a></h2>
208 <p><strong class="program">memstat</strong> dumps the state of <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> servers.
209 It prints all data to stdout.</p>
210 </div>
211 <div class="section" id="options">
212 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline"></a></h2>
213 <dl class="std option">
214 <dt id="cmdoption-memstat-help">
215 <code class="sig-name descname">--help</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-help" title="Permalink to this definition"></a></dt>
216 <dd><p>Display help.</p>
217 </dd></dl>
218
219 <dl class="std option">
220 <dt id="cmdoption-memstat-version">
221 <code class="sig-name descname">--version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-version" title="Permalink to this definition"></a></dt>
222 <dd><p>Display version.</p>
223 </dd></dl>
224
225 <dl class="std option">
226 <dt id="cmdoption-memstat-quiet">
227 <code class="sig-name descname">--quiet</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-quiet" title="Permalink to this definition"></a></dt>
228 <dd><p>Operate quietly.</p>
229 </dd></dl>
230
231 <dl class="std option">
232 <dt id="cmdoption-memstat-verbose">
233 <code class="sig-name descname">--verbose</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-verbose" title="Permalink to this definition"></a></dt>
234 <dd><p>Operate more verbosely.</p>
235 </dd></dl>
236
237 <dl class="std option">
238 <dt id="cmdoption-memstat-debug">
239 <code class="sig-name descname">--debug</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-debug" title="Permalink to this definition"></a></dt>
240 <dd><p>See <a class="reference internal" href="#cmdoption-memstat-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
241 </dd></dl>
242
243 <dl class="std option">
244 <dt id="cmdoption-memstat-servers">
245 <code class="sig-name descname">--servers</code><code class="sig-prename descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memstat-servers" title="Permalink to this definition"></a></dt>
246 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
247 </dd></dl>
248
249 <dl class="std option">
250 <dt id="cmdoption-memstat-binary">
251 <code class="sig-name descname">--binary</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-binary" title="Permalink to this definition"></a></dt>
252 <dd><p>Enable binary protocol.</p>
253 </dd></dl>
254
255 <dl class="std option">
256 <dt id="cmdoption-memstat-username">
257 <code class="sig-name descname">--username</code><code class="sig-prename descclassname"> &lt;username&gt;</code><a class="headerlink" href="#cmdoption-memstat-username" title="Permalink to this definition"></a></dt>
258 <dd><p>Use <em>username</em> for SASL authentication.</p>
259 </dd></dl>
260
261 <dl class="std option">
262 <dt id="cmdoption-memstat-password">
263 <code class="sig-name descname">--password</code><code class="sig-prename descclassname"> &lt;password&gt;</code><a class="headerlink" href="#cmdoption-memstat-password" title="Permalink to this definition"></a></dt>
264 <dd><p>Use <em>password</em> for SASL authentication.</p>
265 </dd></dl>
266
267 <dl class="std option">
268 <dt id="cmdoption-memstat-analyze">
269 <code class="sig-name descname">--analyze</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-analyze" title="Permalink to this definition"></a></dt>
270 <dd><p>Analyze and print differences of a server cluster. A memory and uptime comparison is performed by default.</p>
271 <p>Available additional modes:</p>
272 <dl class="option-list">
273 <dt><kbd><span class="option">--analyze=<var>latency</var></span></kbd></dt>
274 <dd><p>Network latency comparison</p>
275 </dd>
276 </dl>
277 </dd></dl>
278
279 <dl class="std option">
280 <dt id="cmdoption-memstat-server-version">
281 <code class="sig-name descname">--server-version</code><code class="sig-prename descclassname"></code><a class="headerlink" href="#cmdoption-memstat-server-version" title="Permalink to this definition"></a></dt>
282 <dd><p>Obtain and print server version(s) only.</p>
283 </dd></dl>
284
285 </div>
286 <div class="section" id="environment">
287 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline"></a></h2>
288 <dl class="std envvar">
289 <dt id="envvar-MEMCACHED_SERVERS">
290 <code class="sig-name descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition"></a></dt>
291 <dd><p>Specify the list of servers.</p>
292 </dd></dl>
293
294 </div>
295 <div class="section" id="see-also">
296 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline"></a></h2>
297 <ul class="simple">
298 <li><p><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></p></li>
299 <li><p><a class="reference internal" href="../libmemcached/memcached_stats.html"><span class="doc">Working with statistical information from a server</span></a></p></li>
300 </ul>
301 </div>
302 </div>
303
304
305 </div>
306
307 </div>
308 <footer>
309
310 <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
311
312 <a href="memerror.html" class="btn btn-neutral float-right" title="memerror" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
313
314
315 <a href="memping.html" class="btn btn-neutral float-left" title="memping" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
316
317 </div>
318
319
320 <hr/>
321
322 <div role="contentinfo">
323 <p>
324
325
326 &copy; <a href="../copyright.html">Copyright</a>
327
328 </p>
329 </div>
330
331
332
333 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
334
335 <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
336
337 provided by <a href="https://readthedocs.org">Read the Docs</a>.
338
339 </footer>
340
341 </div>
342 </div>
343
344 </section>
345
346 </div>
347
348
349 <script type="text/javascript">
350 jQuery(function () {
351 SphinxRtdTheme.Navigation.enable(true);
352 });
353 </script>
354
355
356
357
358
359
360 </body>
361 </html>