docs: bin/

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

diff --git a/docs/source/bin/memcp.rst b/docs/source/bin/memcp.rst
index e67cd28e42cf2d1b87c81045aad3022692b3b3a6..deea12a77d1cd3af9e866570325f6c23e8e43762 100644 (file)
--- a/docs/source/bin/memcp.rst
+++ b/docs/source/bin/memcp.rst
@@ -1,46 +1,69 @@
-=============================
-memcp - Copy data to a server
-=============================
-
-Copies files to a collection of memcached servers
+memcp
+=====
 
 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 memcached(1) servers.
-It is similar to the standard UNIX cp(1) command.
+:program:`memcp` copies one or more files into :manpage:`memcached(1)` servers.
+It is similar to the standard UNIX :manpage:`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
 -------
 
-You can specify servers via the option:
+.. include:: options/all.rst
+.. include:: options/common.rst
+.. include:: options/expire.rst
+.. include:: options/flag.rst
+.. include:: options/hash.rst
+.. include:: options/sasl.rst
+.. include:: options/udp.rst
+
+.. option:: --buffer
+
+    Enable internal buffering of commands.
 
-.. option:: --servers
+.. option:: --set
 
-or via the environment variable:
+    Issue *SET* command(s). This is the default mode.
+    See also :option:`--add` and :option:`--replace`.
 
-.. envvar:: `MEMCACHED_SERVERS`
+.. option:: --add
 
-If you do not specify either these, the final value in the command line list is the name of a server(s).
+    Issue *ADD* command(s).
 
-For a full list of operations run the tool with the option:
+.. option:: --replace
 
-.. option:: --help
+    Issue *REPLACE* command(s).
+
+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`