diff options
Diffstat (limited to 'docs/ssync.5')
| -rw-r--r-- | docs/ssync.5 | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/ssync.5 b/docs/ssync.5 new file mode 100644 index 0000000..f12319b --- /dev/null +++ b/docs/ssync.5 @@ -0,0 +1,59 @@ +.TH ssync 5 +.SH NAME +ssync - configuration file +.SH DESCRIPTION +.MR ssync 1 +takes a configuration file as its parameter to read in the primary valus for executing an ssync process +.TP +.BI backend " sftp / rsync" +Backend used for fetching remote files. Can be +.MR sftp 1 +or +.MR rsync 1 +.TP +.BI fetch_output_dir " directory" +The directory to write the fetched files to. +.TP +.BI index_window_s " seconds" +Window in seconds to look back for new files while indexing. This option will limit indexing to only files newer than N seconds ago. This can help speed up indexing. Typical recommened default is 86400 (1 Day). +.TP +.BI key_file " identity_file" +The +.BR optional +identity file used when connecting to remote hosts. See +.MR ssh 1 +.MR ssh_config 5 +for more information on identity files and configurations. +.TP +.BI output_files_dir " directory" +Directory the index and queue outputs will be written to. The recommended value is +.IR $XDG_SHARE_DIR/ssync/runs/ +which will retain the outputs of each run in a subdirectory. This directory must exist prior to +.MR ssync-index 1 +.MR ssync-queue 1 +running. +.TP +.BI remote_host " hostname" +Remote Hostname to connect to when indexing and fetching remote files. This should be in the format +.IR user@hostname +unless a host alias is set in the users +.MR ssh_config 5 +.TP +.BI remote_root_dir " directory" +The root directory on the remote host to be indexed. +.TP +.BI ssync_dir " directory" +Directory containing the +.MR ssync-index 1 +.MR ssync-queue 1 +.MR ssync-fetch 1 +commands. +.SH AUTHOR +Written by Steph Enders +.SH SEE ALSO +.MR ssync 1 +.MR ssync-index 1 +.MR ssync-queue 1 +.MR ssync-fetch 1 + + |