summaryrefslogtreecommitdiff
path: root/plugins/rsync
diff options
context:
space:
mode:
authorgramps <richmoyer@gmail.com>2018-10-02 14:44:06 -0500
committerMarc Cornellà <marc.cornella@live.com>2018-10-02 21:44:06 +0200
commit2c559a496c7ca95e04b4d5cc0b71334a0f10a2c3 (patch)
tree1dfc1a8bb6fe09c90dc0f8d1dadd4ed6f7d98fc7 /plugins/rsync
parentca3984759afb4d9aa1fb02beb8a3571d3206435c (diff)
downloadzsh-2c559a496c7ca95e04b4d5cc0b71334a0f10a2c3.tar.gz
zsh-2c559a496c7ca95e04b4d5cc0b71334a0f10a2c3.tar.bz2
zsh-2c559a496c7ca95e04b4d5cc0b71334a0f10a2c3.zip
rsync: add README (#7188)
Diffstat (limited to 'plugins/rsync')
-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` |