diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 93 |
1 files changed, 62 insertions, 31 deletions
@@ -44,42 +44,73 @@ In a previous implementation of this - not starting from scratch each run led to ## Configuration -ssync.conf - -```config -remote_host=HOST -remote_root_dir=/path/to/sync/root/ -keyfile=/path/to/key -local_root_dir=/path/to/local/sync/root/ - -index_window_s=86400 # 24 hours -index_dir=/path/to/index/dir # optional -queue_dir=/path/to/queue/dir # optional -lock_file=/path/to/desired/file.lock # optional +See `man 5 ssync` for configuration details. + +## Usage + +There are man pages for each sub-process with details and `-h` flags for each printing the options and configs. + +### ssync + +``` +ssync [options] CONFIG_FILE + OPTIONS + -b BACKEND + -v verbose logging + -h print this message ``` -## commands +### ssync-index ``` -ssync [options] - OPTIONS - -c [CONFIG_FILE] optional config file to use - default: ~/.config/ssync/ssync.conf - -l [LOCK_FILE] optional lock file - default: from config) - -q [QUEUE_DIR] optional queue dir - default: from config) - -k [KEY_FILE] optional key file - default: from config) +ssync-index [options] ROOT_DIR + OPTIONS + -b index basename only + -k KEY_FILE (optional: if indexing local) + ssh-key file to use (needs to be non-interactive) + optional: will use default session key + or key set in ssh_config for HOST + -o OUTPUT_FILE + -r REMOTE_HOST (optional) + remote host to index from such as user@hostname + username can be omitted if identical to $USER + or if set in ssh_config + -v verbose logging + -w NUM_SECONDS + index all files newer than NOW - NUM_SECONDS + -h print this message ``` +### ssync-queue + +``` +ssync-queue [options] -l LOCAL_INDEX_FILE -r REMOTE_INDEX_FILE -o QUEUE_OUTPUT_FILE + OPTIONS + -l LOCAL_INDEX_FILE + target local index file + -r REMOTE_INDEX_FILE + target remote index file + -o QUEUE_OUTPUT_FILE + queue output file + -v verbose logging + -h print this message +``` + +### ssync-fetch + ``` -ssync-index [options] -c [FILE] - REQUIRED - -c [CONFIG_FILE] config file to use - OPTIONS - -l local only (cannot be used in conjunction with -r) - -r remote only (cannot be used in conjunction with -l) - -o [OUTPUT_FILE] output file override - -k [KEY_FILE] key file override +ssync-fetch [options] QUEUE_FILE DEST_DIR + OPTIONS + -r REMOTE_HOST + remote host to download from such as user@hostname + username can be omitted if identical to $USER + or if set in ssh_config + -k KEY_FILE + ssh-key file to use (needs to be non-interactive) + optional: will use default session key + or key set in ssh_config for REMOTE_HOST + -b BACKEND + sftp (default) | rsync + -v verbose logging + -h print this message ``` |