2019-04-23 18:55:23 +00:00
|
|
|
cdist-type__rsync(7)
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2021-08-24 18:42:27 +00:00
|
|
|
cdist-type__rsync - Mirror directories using ``rsync``
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2021-08-24 18:42:27 +00:00
|
|
|
The purpose of this type is to bring power of ``rsync`` into ``cdist``.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
REQUIRED PARAMETERS
|
|
|
|
|
-------------------
|
|
|
|
|
source
|
2021-08-24 18:42:27 +00:00
|
|
|
Source directory in local machine.
|
|
|
|
|
If source is directory, slash (``/``) will be added to source and destination paths.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
OPTIONAL PARAMETERS
|
|
|
|
|
-------------------
|
2021-08-24 18:42:27 +00:00
|
|
|
destination
|
|
|
|
|
Destination directory. Defaults to ``$__object_id``.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
owner
|
2021-08-24 18:42:27 +00:00
|
|
|
Will be passed to ``rsync`` as ``--chown=OWNER``.
|
|
|
|
|
Read ``rsync(1)`` for more details.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
2021-08-24 18:42:27 +00:00
|
|
|
group
|
|
|
|
|
Will be passed to ``rsync`` as ``--chown=:GROUP``.
|
|
|
|
|
Read ``rsync(1)`` for more details.
|
|
|
|
|
|
|
|
|
|
mode
|
|
|
|
|
Will be passed to ``rsync`` as ``--chmod=MODE``.
|
|
|
|
|
Read ``rsync(1)`` for more details.
|
|
|
|
|
|
|
|
|
|
options
|
|
|
|
|
Defaults to ``--recursive --links --perms --times``.
|
|
|
|
|
Due to `bug in Python's argparse<https://bugs.python.org/issue9334>`_, value must be prefixed with ``\``.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
remote-user
|
2021-08-24 18:42:27 +00:00
|
|
|
Defaults to ``root``.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
OPTIONAL MULTIPLE PARAMETERS
|
|
|
|
|
----------------------------
|
2021-08-24 18:42:27 +00:00
|
|
|
option
|
|
|
|
|
Pass additional options to ``rsync``.
|
|
|
|
|
See ``rsync(1)`` for all possible options.
|
|
|
|
|
Due to `bug in Python's argparse<https://bugs.python.org/issue9334>`_, value must be prefixed with ``\``.
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
.. code-block:: sh
|
|
|
|
|
|
2021-08-24 18:42:27 +00:00
|
|
|
__rsync /var/www/example.com \
|
|
|
|
|
--owner root \
|
|
|
|
|
--group www-data \
|
|
|
|
|
--mode 'D750,F640' \
|
|
|
|
|
--source "$__files/example.com/www"
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
AUTHORS
|
|
|
|
|
-------
|
2021-08-24 18:42:27 +00:00
|
|
|
Ander Punnar <ander-at-kvlt-dot-ee>
|
2019-04-23 18:55:23 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
COPYING
|
|
|
|
|
-------
|
2021-08-24 18:42:27 +00:00
|
|
|
Copyright \(C) 2021 Ander Punnar. You can redistribute it and/or modify it
|
|
|
|
|
under the terms of the GNU General Public License as published by the Free
|
|
|
|
|
Software Foundation, either version 3 of the License, or (at your option)
|
|
|
|
|
any later version.
|
