fix #131: add build time option: CLIENT_PREFIX
[awesomized/libmemcached] / docs / source / bin / memcp.rst
1 memcp
2 =====
3
4 SYNOPSIS
5 --------
6
7 .. program:: memcp
8
9 |client_prefix|\cp [options] \-\-servers <hostname[:port]...> <file...>
10
11 Copy files to a collection of memcached servers.
12
13 DESCRIPTION
14 -----------
15
16 :program:`memcp` copies one or more files into :manpage:`memcached(1)` servers.
17 It is similar to the standard UNIX :manpage:`cp(1)` command.
18
19 The key names will be the names of the files, without any directory path.
20
21 OPTIONS
22 -------
23
24 .. include:: options/common_set.rst
25 .. include:: /bin/options/flags_reqarg.rst
26 .. include:: options/udp.rst
27
28 .. option:: -S|--set
29
30 Issue *SET* command(s). This is the default mode.
31 See also :option:`-A|--add` and :option:`-R|--replace`.
32
33 .. option:: -A|--add
34
35 Issue *ADD* command(s).
36
37 .. option:: -R|--replace
38
39 Issue *REPLACE* command(s).
40
41 .. option:: -.|--basename
42
43 Use basename of path as key (default).
44
45 .. option:: -+|--relative
46
47 Use relative path (as passed), instead of basename only.
48
49 .. option:: -/|--absolute
50
51 Use absolute path (real path), instead of basename only.
52
53
54 .. include:: common/env.rst
55
56 NOTES
57 -----
58
59 .. include:: common/note_program_prefix.rst
60
61 SEE ALSO
62 --------
63
64 .. only:: man
65
66 :manpage:`memcached(1)`
67 :manpage:`libmemcached(3)`
68 :manpage:`memcached_behavior(3)`
69
70 .. only:: html
71
72 * :doc:`/libmemcached`
73 * :doc:`/libmemcached/configuration`
74 * :doc:`/libmemcached/memcached_behavior`