Browse Source

Updated README

remotes/github/master
Mike 1 year ago
parent
commit
2d2f27178e
1 changed files with 46 additions and 3 deletions
  1. +46
    -3
      README.md

+ 46
- 3
README.md View File

@ -10,7 +10,13 @@ This can be very useful to detect files which may have been *accidentally delete
* Python library *humanfriendly*
``` sudo pip3 install humanfriendly ```
* ``` sudo pip3 install humanfriendly ```
* rsync
* ```sudo apt install rsync```
* ```sudo yum install rsync```
* etc
## How to Execute
@ -30,18 +36,55 @@ You must at minimum specify the source and the backup directories. Following is
Specifies the path to your source directory
### --source-remote-host < hostname or ip >
Specifies the remote host where your source directory resides
### --source-remote-user < username >
Specifies the user to connect as, when connecting to a remote host with *--source-remote-host*
### --backup-path < path >
Specifies the path to your backup directory
### --backup-remote-host < hostname or ip >
Specifies the remote host where your backup directory resides
### --backup-remote-user < username >
Specifies the user to connect as, when connecting to a remote host with *--backup-remote-host*
### --ssh-key < key path >
Specifies the SSH key to use, when connecting to remote hosts.
When omitted, and also connecting to a remote host, the default key for the current user will be used (probably).
### --use-rsync
Force this tool to use rsync for comparison. If not specified, directories and files will just be compared normally. In the future, the non-rsync mode might be removed.
### --rsync
Same as *--use-rsync*
### --no-clean
Don't make any attempt to clean the generated report of redundant entries. This might be useful if you think the report isn't accurate.
#### Example Call With Arguments
Here's an example of how you might invoke the script:
Here's an example of how you might invoke the script with two local directories:
```
python3 /path/to/backup-diff.py --source-path "/my/source/directory/path" --backup-path "/my/backups/main-backup"
```
```python3 /path/to/backup-diff.py --source-path "/my/source/directory/path" --backup-path "/my/backups/main-backup" ```
Here's an example of how you might compare a local directory with a remote backup:
```
python3 /path/to/backup-diff.py --source-path "/my/local/source/directory/path" --backup-path "/path/on/remote/server/backups/main-backup" --backup-remote-host "example.com" --backup-remote-user "me123" --ssh-key "/path/to/my/ssh/key"
```

Loading…
Cancel
Save