summaryrefslogtreecommitdiff
path: root/plugins/rsync/README.md
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-24 17:57:01 +0200
committerGitHub <noreply@github.com>2019-10-24 17:57:01 +0200
commitcad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9 (patch)
tree2b07ec259bbd2b1a4919245669900a87fa87a03b /plugins/rsync/README.md
parent225425fe091ca052997833279ccc08643818c24a (diff)
parent40df67bc3b9b51caa24df5d220487043040d1f9a (diff)
downloadzsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.gz
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.tar.bz2
zsh-cad48e38bfbfa6e3e0096caddf330d6fc8f1ffb9.zip
Merge branch 'master' into fabric_task_description
Diffstat (limited to 'plugins/rsync/README.md')
-rw-r--r--plugins/rsync/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/rsync/README.md b/plugins/rsync/README.md
new file mode 100644
index 000000000..032ee7f3b
--- /dev/null
+++ b/plugins/rsync/README.md
@@ -0,0 +1,16 @@
+# rsync
+
+This plugin adds aliases for frequent [rsync](https://rsync.samba.org/) commands.
+
+To use it add `rsync` to the plugins array in you zshrc file.
+
+```zsh
+plugins=(... rsync)
+```
+
+| Alias | Command |
+| ------------------- | ------------------------------------------------ |
+| *rsync-copy* | `rsync -avz --progress -h` |
+| *rsync-move* | `rsync -avz --progress -h --remove-source-files` |
+| *rsync-update* | `rsync -avzu --progress -h` |
+| *rsync-synchronize* | `rsync -avzu --delete --progress -h` |