aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteph Enders <steph@senders.io>2025-12-13 13:10:12 -0500
committerSteph Enders <steph@senders.io>2025-12-13 13:25:37 -0500
commit599a9a05228a2c61055b52ba08288cfc7421c2af (patch)
treebd51e36bd60a811015ce8590b9f3a507184f821f /docs
parent265ef114cba60a814b543ee7e0fb37f518f62f64 (diff)
Document additional commands
Diffstat (limited to 'docs')
-rw-r--r--docs/ssync-fetch.147
-rw-r--r--docs/ssync-index.148
-rw-r--r--docs/ssync-queue.139
-rw-r--r--docs/ssync.17
4 files changed, 136 insertions, 5 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.
diff --git a/docs/ssync-index.1 b/docs/ssync-index.1
new file mode 100644
index 0000000..cb53fc1
--- /dev/null
+++ b/docs/ssync-index.1
@@ -0,0 +1,48 @@
+.TH ssync-index 1 "December 2025" "2.0.0"
+.SH NAME
+ssync-index \- index files locally or remotely
+.SH SYNOPSIS
+.B ssync-index
+.RB [option...]
+.IR ROOT_DIR
+.YS
+.SH OPTIONS
+.TP
+.BR \-b " index basename only"
+.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 \-o " file"
+File to output to.
+.TP
+.BI \-r " hostname"
+Remote Hostname to connect to when indexing 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
+.BI \-w " 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
+.BR \-h " print this message"
+.SH SEE ALSO
+.MR ssync 1
+.MR ssync 5
+.MR ssync-queue 1
+.MR ssync-fetch 1
+.SH REPOSITORY
+.UR https://git.senders.io/utils/ssync.git
+.UE
+.SH AUTHORS
+Steph Enders
+.MT steph@senders.io
+.ME
+ssync-index is open source licensed under the ISC license. See LICENSE.txt for full copyright information.
diff --git a/docs/ssync-queue.1 b/docs/ssync-queue.1
new file mode 100644
index 0000000..1af4275
--- /dev/null
+++ b/docs/ssync-queue.1
@@ -0,0 +1,39 @@
+.TH ssync-queue 1 "December 2025" "2.0.0"
+.SH NAME
+ssync-queue \- generate ssync queue from local and remote indicies
+.SH SYNOPSIS
+.B ssync-queue
+[option...]
+.BI \-l " local_index"
+.BI \-r " remote_index"
+.BI \-o " queue_output"
+.YS
+.SH OPTIONS
+.TP
+.BI \-l " file"
+Local index file generated by
+.MR ssync-index 1
+.TP
+.BI \-r " file"
+Remote index file generated by
+.MR ssync-index 1
+.TP
+.BI \-o " file"
+Queue output file.
+.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-fetch 1
+.SH REPOSITORY
+.UR https://git.senders.io/utils/ssync.git
+.UE
+.SH AUTHORS
+Steph Enders
+.MT steph@senders.io
+.ME
+ssync-queue is open source licensed under the ISC license. See LICENSE.txt for full copyright information.
diff --git a/docs/ssync.1 b/docs/ssync.1
index c6571c8..ab3d82d 100644
--- a/docs/ssync.1
+++ b/docs/ssync.1
@@ -1,14 +1,11 @@
.TH ssync 1 "December 2025" "2.0.0"
.SH NAME
-ssync
+ssync \- simple suite of syncing scripts
.SH SYNOPSIS
.B ssync
-.RB [OPTION]...
+[option...]
.IR CONFIG_FILE
.YS
-.SH DESCRIPTION
-.B ssync
-\- simple suite of syncing scripts
.SH OPTIONS
.TP
.BI \-b " backend"