stow/oh-my-zsh/.oh-my-zsh/plugins/cp/README.md

   1 # cp plugin
   2
   3 This plugin defines a `cpv` function that uses `rsync` so that you
   4 get the features and security of this command.
   5
   6 To enable, add `cp` to your `plugins` array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... cp)
  10 ```
  11
  12 ## Description
  13
  14 The enabled options for rsync are:
  15
  16 - `-p`: preserves permissions.
  17
  18 - `-o`: preserves owner.
  19
  20 * `-g`: preserves group.
  21
  22 * `-b`: make a backup of the original file instead of overwriting it, if it exists.
  23
  24 * `-r`: recurse directories.
  25
  26 * `-hhh`: outputs numbers in human-readable format, in units of 1024 (K, M, G, T).
  27
  28 * `--backup-dir="/tmp/rsync-$USERNAME"`: move backup copies to "/tmp/rsync-$USERNAME".
  29
  30 * `-e /dev/null`: only work on local files (disable remote shells).
  31
  32 * `--progress`: display progress.