docs: improve README.md explanations of tar flags

- Update the `README.md` file with more details about tar flags
- Replace `use --overwrite` with `overwrite existing files when extracting` in the `README.md` file
- Replace `use --dereference` with `follow symlinks; archive and dump the files they point to` in the `README.md` file

Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi.Wu 2023-04-09 15:54:48 +08:00
parent dcb457bb6f
commit 7cc0f645c7

View File

@ -49,10 +49,10 @@ See the [action.yml](./action.yml) file for more detail information.
* source - scp file list
* rm - remove target folder before upload data, default is `false`
* strip_components - remove the specified number of leading path elements.
* overwrite - use `--overwrite` flag with tar
* overwrite - use `--overwrite` flag with tar, overwrite existing files when extracting
* tar_tmp_path - temporary path for tar file on the dest host
* tar_exec - path to tar executable on the dest host. default is `tar`
* tar_dereference - use `--dereference` flag with tar
* tar_dereference - use `--dereference` flag with tar, follow symlinks; archive and dump the files they point to
* use_insecure_cipher - include more ciphers with use_insecure_cipher (see [#15](https://github.com/appleboy/scp-action/issues/15))
SSH Proxy Setting: