fix #134: docs: update client options

[awesomized/libmemcached] / docs / source / bin / memcp.rst

diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst
index a60008be9a6b48b668cebdd9d4e36a57cc948cd5..7d82a59090c3c0126502ca18e90506fed81f6835 100644 (file)
--- a/docs/source/bin/memcp.rst
+++ b/docs/source/bin/memcp.rst
@@ -1,58 +1,74 @@
-=============================
-memcp - Copy data to a server
-=============================
+memcp
+=====
 
-
-Copies files to a collection of memcached servers
-
-
---------
 SYNOPSIS
 --------
 
-memcp [options] [file] [server]
-
 .. program:: memcp
 
+memcp [options] \-\-servers <hostname[:port]...> <file...>
+
+Copy files to a collection of memcached servers.
 
------------
 DESCRIPTION
 -----------
 
+:program:`memcp` copies one or more files into :manpage:`memcached(1)` servers.
+It is similar to the standard UNIX :manpage:`cp(1)` command.
 
-:program:`memcp` copies one or more files into memcached(1) servers.
-It is similar to the standard UNIX cp(1) command.
-
-The key names will be the names of the files,
-without any directory path.
+The key names will be the names of the files, without any directory path.
 
-
--------
 OPTIONS
 -------
 
+.. include:: options/common_set.rst
+.. include:: /bin/options/flags_reqarg.rst
+.. include:: options/udp.rst
 
-You can specify servers via the option:
+.. option:: -S|--set
 
-.. option:: --servers
+    Issue *SET* command(s). This is the default mode.
+    See also :option:`-A|--add` and :option:`-R|--replace`.
 
-or via the environment variable:
+.. option:: -A|--add
 
-.. envvar:: `MEMCACHED_SERVERS`
+    Issue *ADD* command(s).
 
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+.. option:: -R|--replace
 
-For a full list of operations run the tool with the option:
+    Issue *REPLACE* command(s).
 
-.. option:: --help
+.. option:: -.|--basename
 
+    Use basename of path as key (default).
+    
+.. option:: -+|--relative
 
+    Use relative path (as passed), instead of basename only.
+    
+.. option:: -/|--absolute
+
+    Use absolute path (real path), instead of basename only.
+    
+    
+ENVIRONMENT
+-----------
+
+.. envvar:: MEMCACHED_SERVERS
+
+    Specify the list of servers.
 
---------
 SEE ALSO
 --------
 
 .. only:: man
 
-  :manpage:`memcached(1)` :manpage:`libmemcached(3)`
+    :manpage:`memcached(1)`
+    :manpage:`libmemcached(3)`
+    :manpage:`memcached_behavior(3)`
+
+.. only:: html
 
+    * :doc:`/libmemcached`
+    * :doc:`/libmemcached/configuration`
+    * :doc:`/libmemcached/memcached_behavior`