diff options
| author | Steph Enders <steph@senders.io> | 2025-12-13 12:20:22 -0500 |
|---|---|---|
| committer | Steph Enders <steph@senders.io> | 2025-12-13 12:20:22 -0500 |
| commit | 265ef114cba60a814b543ee7e0fb37f518f62f64 (patch) | |
| tree | 547335cac913fd887aee26a47d4efe06394585e3 /ssync.5 | |
| parent | 0f27a01063eb0d08445a82ba5a9380b3c490ffd8 (diff) | |
Add license and move documentation to its own folder
Diffstat (limited to 'ssync.5')
| -rw-r--r-- | ssync.5 | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/ssync.5 b/ssync.5 deleted file mode 100644 index f12319b..0000000 --- a/ssync.5 +++ /dev/null @@ -1,59 +0,0 @@ -.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 - - |