aboutsummaryrefslogtreecommitdiff
path: root/docs/ssync-fetch.1
diff options
context:
space:
mode:
Diffstat (limited to 'docs/ssync-fetch.1')
-rw-r--r--docs/ssync-fetch.147
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/ssync-fetch.1 b/docs/ssync-fetch.1
new file mode 100644
index 0000000..c7cc7ff
--- /dev/null
+++ b/docs/ssync-fetch.1
@@ -0,0 +1,47 @@
+.TH ssync-fetch 1 "December 2025" "2.0.0"
+.SH NAME
+ssync-fetch \- fetch files from queue and write them to a destination.
+.SH SYNOPSIS
+.BR ssync-fetch
+[option...]
+.I QUEUE_FILE
+.I DEST_DIR
+.YS
+.SH OPTIONS
+.TP
+.BI \-b " sftp / rsync"
+Backend used for fetching remote files. Can be
+.MR sftp 1
+or
+.MR rsync 1
+.TP
+.BI \-k " 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 \-r " 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
+.BR \-v " verbose logging"
+.TP
+.BR \-h " print this message"
+.SH SEE ALSO
+.MR ssync 1
+.MR ssync 5
+.MR ssync-index 1
+.MR ssync-queue 1
+.SH REPOSITORY
+.UR https://git.senders.io/utils/ssync.git
+.UE
+.SH AUTHORS
+Steph Enders
+.MT steph@senders.io
+.ME
+ssync-fetch is open source licensed under the ISC license. See LICENSE.txt for full copyright information.