git.m6w6.name Git - awesomized/libmemcached/blob - bin/memcat.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>memcat &mdash; libmemcached 1.1.0 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="memcp" href="memcp.html" />
  40     <link rel="prev" title="memexist" href="memexist.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.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 current"><a class="current reference internal" href="#">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"><a class="reference internal" href="memrm.html">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="../copyright.html">Copyright</a></li>
 115 </ul>
 116
 117
 118
 119         </div>
 120       </div>
 121     </nav>
 122
 123     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
 124
 125
 126       <nav class="wy-nav-top" aria-label="top navigation">
 127
 128           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 129           <a href="../index.html">libmemcached</a>
 130
 131       </nav>
 132
 133
 134       <div class="wy-nav-content">
 135
 136         <div class="rst-content">
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154 <div role="navigation" aria-label="breadcrumbs navigation">
 155
 156   <ul class="wy-breadcrumbs">
 157
 158       <li><a href="../index.html">Docs</a> &raquo;</li>
 159
 160           <li><a href="index.html">Client Applications</a> &raquo;</li>
 161
 162       <li>memcat</li>
 163
 164
 165       <li class="wy-breadcrumbs-aside">
 166
 167
 168
 169               <a href="https://github.com/m6w6/libmemcached/blob/v1.x/docs/source/bin/memcat.rst" class="fa fa-github"> Edit on GitHub</a>
 170
 171
 172
 173       </li>
 174
 175   </ul>
 176
 177
 178   <hr/>
 179 </div>
 180           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 181            <div itemprop="articleBody">
 182
 183   <div class="section" id="memcat">
 184 <h1>memcat<a class="headerlink" href="#memcat" title="Permalink to this headline">¶</a></h1>
 185 <div class="section" id="synopsis">
 186 <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
 187 <p>memcat [options] key [key...]</p>
 188 <p>Read and output the value of one key or the values of a set of keys.</p>
 189 </div>
 190 <div class="section" id="description">
 191 <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
 192 <p><strong class="program">memcat</strong> reads and outputs the value of a single or a set of keys
 193 stored in a <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/memcached">memcached(1)</a></em> server.</p>
 194 <p>If any key is not found an error is returned.</p>
 195 <p>It is similar to the standard UNIX <em class="manpage"><a class="manpage reference external" href="https://linux.die.net/man/1/cat">cat(1)</a></em> utility.</p>
 196 </div>
 197 <div class="section" id="options">
 198 <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
 199 <dl class="option">
 200 <dt id="cmdoption-memcat-help">
 201 <code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-help" title="Permalink to this definition">¶</a></dt>
 202 <dd><p>Display help.</p>
 203 </dd></dl>
 204
 205 <dl class="option">
 206 <dt id="cmdoption-memcat-version">
 207 <code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-version" title="Permalink to this definition">¶</a></dt>
 208 <dd><p>Display version.</p>
 209 </dd></dl>
 210
 211 <dl class="option">
 212 <dt id="cmdoption-memcat-quiet">
 213 <code class="descname">--quiet</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-quiet" title="Permalink to this definition">¶</a></dt>
 214 <dd><p>Operate quietly.</p>
 215 </dd></dl>
 216
 217 <dl class="option">
 218 <dt id="cmdoption-memcat-verbose">
 219 <code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-verbose" title="Permalink to this definition">¶</a></dt>
 220 <dd><p>Operate more verbosely.</p>
 221 </dd></dl>
 222
 223 <dl class="option">
 224 <dt id="cmdoption-memcat-debug">
 225 <code class="descname">--debug</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-debug" title="Permalink to this definition">¶</a></dt>
 226 <dd><p>See <a class="reference internal" href="#cmdoption-memcat-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--verbose</span></code></a>.</p>
 227 </dd></dl>
 228
 229 <dl class="option">
 230 <dt id="cmdoption-memcat-servers">
 231 <code class="descname">--servers</code><code class="descclassname"> &lt;list of servers&gt;</code><a class="headerlink" href="#cmdoption-memcat-servers" title="Permalink to this definition">¶</a></dt>
 232 <dd><p>Specify the list of servers as <em>hostname[:port][,hostname[:port]...]</em>.</p>
 233 </dd></dl>
 234
 235 <dl class="option">
 236 <dt id="cmdoption-memcat-binary">
 237 <code class="descname">--binary</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-binary" title="Permalink to this definition">¶</a></dt>
 238 <dd><p>Enable binary protocol.</p>
 239 </dd></dl>
 240
 241 <dl class="option">
 242 <dt id="cmdoption-memcat-hash">
 243 <code class="descname">--hash</code><code class="descclassname"> &lt;algorithm&gt;</code><a class="headerlink" href="#cmdoption-memcat-hash" title="Permalink to this definition">¶</a></dt>
 244 <dd><p>Use <em>algorithm</em> as key hash algo.
 245 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>
 246 </dd></dl>
 247
 248 <dl class="option">
 249 <dt id="cmdoption-memcat-flag">
 250 <code class="descname">--flag</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-memcat-flag" title="Permalink to this definition">¶</a></dt>
 251 <dd><p>Display stored flags.</p>
 252 </dd></dl>
 253
 254 </div>
 255 <div class="section" id="environment">
 256 <h2>ENVIRONMENT<a class="headerlink" href="#environment" title="Permalink to this headline">¶</a></h2>
 257 <dl class="envvar">
 258 <dt id="envvar-MEMCACHED_SERVERS">
 259 <code class="descname">MEMCACHED_SERVERS</code><a class="headerlink" href="#envvar-MEMCACHED_SERVERS" title="Permalink to this definition">¶</a></dt>
 260 <dd><p>Specify a list of servers.</p>
 261 </dd></dl>
 262
 263 </div>
 264 <div class="section" id="see-also">
 265 <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2>
 266 <ul class="simple">
 267 <li><a class="reference internal" href="../libmemcached.html"><span class="doc">C/C++ Client Library for memcached</span></a></li>
 268 <li><a class="reference internal" href="../libmemcached/configuration.html"><span class="doc">libmemcached Configuration</span></a></li>
 269 </ul>
 270 </div>
 271 </div>
 272
 273
 274            </div>
 275
 276           </div>
 277           <footer>
 278
 279     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
 280
 281         <a href="memcp.html" class="btn btn-neutral float-right" title="memcp" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
 282
 283
 284         <a href="memexist.html" class="btn btn-neutral float-left" title="memexist" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
 285
 286     </div>
 287
 288
 289   <hr/>
 290
 291   <div role="contentinfo">
 292     <p>
 293         &copy; <a href="../copyright.html">Copyright</a>
 294
 295     </p>
 296   </div>
 297   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>.
 298
 299 </footer>
 300
 301         </div>
 302       </div>
 303
 304     </section>
 305
 306   </div>
 307
 308
 309
 310   <script type="text/javascript">
 311       jQuery(function () {
 312           SphinxRtdTheme.Navigation.enable(true);
 313       });
 314   </script>
 315
 316
 317
 318
 319
 320
 321 </body>
 322 </html>