====== Interacting with LSMCD ======

In order to connect to and interact with LSMCD, you can use telnet to connect to a one of the IP addresses and port numbers set in **Cached.Addr**. For example, with the default settings, you would connect using the following command:
<code>
telnet 127.0.0.1 11211
</code>

====== LSMCD Commands ======

The following is a list of LSMCD commands useable in telnet, each with a description, an example use (including user input and system output), syntax, and an explanation of potentially confusing values. Note: for syntax, < and > indicate a required value while [ and ] indicate an optional one.

===== get =====
Read a value.

**syntax:** 
<code>
get <key>
</code>
**example:**
<code>
get mykey

VALUE mykey 0 10
myvalueabc
END
</code>
**notes:**
  * **0** → no flags
  * **10** → Size in bytes
  * **myvalueabc** → value of "mykey"

===== bget =====

Binary get.

**syntax:**
<code>
bget <key>
</code>
**example:**
<code>
bget mykey
</code>
**output:**
<code>VALUE mykey 0 10
	myvalueabc
	END</code>
**output notes:**
  * **0** → no flags
  * **10** → Size in bytes
  * **myvalueabc** → value of "mykey"

===== gets =====
Read a value and its **cas token** (to be used with the **cas** command).

**syntax:** 
<code>
gets <key>
</code>
**example:** 
<code>
gets mykey
</code>
**output:** 
<code>
VALUE mykey 0 10 9
	myvalueabc
	END
</code>
**output notes:**
  * **0** → no flags
  * **10** → Size in bytes
  * **9** → unique **cas token** number

===== add =====
Add a new key/value pair, but only if the server doesn’t already hold data for this key.

**syntax:** 
<code>
add <key> <flags> <TTL> <length> [noreply] \r\n <value> \r\n
</code>
**example:** 
<code>
add newkey 0 120 10
</code>
**output:** 
<code>
myvalueabc
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size in bytes
  * **myvalueabc** → value to set "newkey" to

===== set =====
Store a key/value pair, if the key exists already, overwrite it.

**syntax:** 
<code>
set <key> <flags> <TTL> <length> [noreply] \r\n <value> \r\n
</code>
**example:** 
<code>
set mykey 0 120 10
</code>
**output:**
<code>
myvalueabc
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size in bytes
  * **myvalueabc** → value to set "mykey" to

===== replace =====

Store a key/value pair, but only if it already exists.

**syntax:**
<code>
replace <key> <flags> <TTL> <length> [noreply] \r\n <value> \r\n
</code>
**example:** 
<code>
replace mykey 0 120 10
</code>
**output:**
<code>
myvalueabc
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size in bytes
  * **myvalueabc** → value to set "mykey" to

===== append =====
Add data to an existing key after existing data.

**syntax:**
<code>
append <key> <flags> <TTL> <length> [noreply]  \r\n <value> \r\n
</code>
**example:**
<code>
append mykey 0 120 10
</code>
**output:**
<code>
defghijklm
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size to append in bytes
  * In this example, if "mykey" had a value of "myvalueabc", after running **append**, its value would be "myvalueabcdefghijklm".

===== prepend =====
Add data to an existing key before existing data.

**syntax:**
<code>
prepend <key> <flags> <TTL> <length> [noreply] \r\n <value> \r\n
</code>
**example:**
<code>
prepend mykey 0 120 10
</code>
**output:**
<code>
abcdeabcde
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size to prepend in bytes
  * In this example, if "mykey" had a value of "myvalueabc", after running **prepend**, its value would be "abcdeabcdemyvalueabc".

===== cas =====
Check-and-Set an item; store data only if no one else has updated since the last fetch, determined with the **cas token** from the **gets** command.

**syntax:**
<code>
cas <key> <flags> <TTL> <length> <cas unique key> [noreply]
</code>
**example:**
<code>
cas mykey 0 120 10 2
</code>
**output:**
<code>
abcdeabcde
	STORED
</code>
**output notes:**
  * **0** → no flags
  * **120** → TTL in seconds
  * **10** → Size in bytes
  * **2** → unique token number obtained from **gets** command

===== incr =====
Increment numerical key’s value by the given number if the key/value pair exists.

**syntax:** 
<code>
incr <key> <value> [noreply]
</code>
**example:**
<code>
incr mykey 4
</code>
**output:**
<code>
5
</code>
**output notes:**
  * **4** → value to increment by
    * In this example, if "mykey" had a value of "1", after running **incr**, its value would be "5". 

===== decr =====
Decrement numerical key’s value by the given number if the key/value pair exists.

**syntax:** 
<code>
decr <key> <value> [noreply]
</code>
**example:**
<code>
decr mykey 3
</code>
**output:** 
<code>
2
</code>
**output notes:**
  * **3** → value to decrement by.
  * In this example, if "mykey" had a value of "5", after running **decr**, its value would be "2".

===== delete =====
Delete an existing key/value pair.

**syntax:** 
<code>
delete <key> [<time>] [noreply]
</code>
**example:** 
<code>
delete mykey
</code>
**output:** 
<code>
DELETED
</code>

===== touch =====
Update the expiration time for a key/value pair without fetching it.

**syntax:** 
<code>
touch <key> <TTL> [noreply]
</code>
**example:** 
<code>
touch mykey 1200
</code>
**output:** 
<code>
TOUCHED
</code>
**output notes:**
  * **1200** → new TTL in seconds

===== stats =====
Print or reset general statistics

**syntax:** 
<code>
stats [reset]
</code>
**example:** 
<code>
stats
</code>
**output:**
<code>
STAT pid 16825
STAT version 1.0.0
STAT pointer_size 64
STAT rusage_user 0.300000
STAT rusage_system 0.520000
STAT cmd_get 10
STAT cmd_set 11
STAT cmd_flush 2
STAT cmd_touch 2
STAT get_hits 8
STAT get_misses 2
STAT delete_misses 0
STAT delete_hits 1
STAT incr_misses 0
STAT incr_hits 1
STAT decr_misses 1
STAT decr_hits 1
STAT cas_misses 0
STAT cas_hits 1
STAT cas_badval 0
STAT touch_hits 2
STAT touch_misses 0
STAT auth_cmds 0
STAT auth_errors 0
END
</code>
**example:** 
<code>
stats reset
</code>
**output:**
<code>
RESET
</code>

===== flush_all =====
Delete all key/value pairs immediately.

**syntax:** 
<code>
flush_all [<time>] [noreply]
</code>
**example:** 
<code>
flush_all
</code>
**output:**
<code>
OK
</code>

===== version =====
Print server version.

**syntax:** 
<code>
version
</code>
**example:** 
<code>
version
</code>
**output:** 
<code>
VERSION 1.0.0
</code>

===== quit =====
Terminate telnet session.

**syntax:** 
<code>
quit
</code>
**example:**
<code>
quit
</code>
**output:**
<code>
Connection closed by foreign host.
</code>

===== verbosity =====
Increase log version.

**syntax:** 
<code>
verbosity <level> [noreply]
</code>
**example:** 
<code>
verbosity 1
</code>
**output:**
<code>
OK
</code>