git.m6w6.name Git - awesomized/libmemcached/blob - docs/memcapable.rst

   1 =======================================================================
   2 memcapable - Checking a Memcached server capibilities and compatibility
   3 =======================================================================
   4
   5 .. index:: object: memcached_st
   6
   7 Check the server for compatibility and capabilities
   8
   9
  10 --------
  11 SYNOPSIS
  12 --------
  13
  14 :program:`memcapable`
  15
  16 .. program:: memcapable
  17
  18 -----------
  19 DESCRIPTION
  20 -----------
  21
  22 :program:`memcapable` connects to the specified memcached server and tries to
  23 determine its capabilities by running the various commands and verifying
  24 the response.
  25
  26
  27 -----------
  28 LIMITATIONS
  29 -----------
  30
  31
  32 The current version of memcapable will only verify the binary protocol.
  33
  34
  35 -------
  36 OPTIONS
  37 -------
  38
  39
  40 .. option:: -h hostname
  41
  42 Specify the hostname to connect to. The default is \ *localhost*\
  43
  44 .. option:: -p port
  45
  46 Specify the port number to connect to. The default is \ *11211*\
  47
  48 .. option:: -c
  49
  50 Generate a coredump when it detects an error from the server.
  51
  52 .. option:: -v
  53
  54 Print out the comparison when it detects an error from the server.
  55
  56 .. option:: -t n
  57
  58 Set the timeout from an IO operation to/from the server to \ *n*\  seconds.
  59
  60
  61 ----
  62 HOME
  63 ----
  64
  65
  66 To find out more information please check:
  67 `http://libmemcached.org/ <http://libmemcached.org/>`_
  68
  69
  70 ------
  71 AUTHOR
  72 ------
  73
  74
  75 Trond Norbye, <trond.norbye@gmail.com>
  76
  77
  78 --------
  79 SEE ALSO
  80 --------
  81
  82 :manpage:`memcached(1)` :manpage:`libmemcached(3)`
  83