aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/ssync-reapr.137
-rw-r--r--docs/ssync.59
2 files changed, 46 insertions, 0 deletions
diff --git a/docs/ssync-reapr.1 b/docs/ssync-reapr.1
new file mode 100644
index 0000000..99f36ab
--- /dev/null
+++ b/docs/ssync-reapr.1
@@ -0,0 +1,37 @@
+.TH ssync-reapr 1 {RELEASE}
+.SH NAME
+ssync-reapr \- reap temporary and run files created by other ssync commands
+.SH SYNOPSIS
+.B ssync-reapr
+.RB [option...]
+.IR DIRS...
+.YS
+.SH OPTIONS
+.TP
+.BR \-a " seconds"
+Reap files created more than the configured seconds ago. This will help clear out temporary files created by the
+.MR ssync-index 1
+and
+.MR ssync-queue 1
+commands.
+.TP
+.BR \-n " dry-run"
+Dry run the reaping process - only prints the files; doesn't delete.
+.TP
+.BR \-v " verbose logging"
+Use -vv to increase the verbose level. 2+ will print the files being reaped.
+.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
+.UE
+.SH AUTHORS
+Steph Enders
+.MT steph@senders.io
+.ME
+ssync-reapr is open source licensed under the ISC license. See LICENSE for full copyright information.
diff --git a/docs/ssync.5 b/docs/ssync.5
index c0e3caf..e729df5 100644
--- a/docs/ssync.5
+++ b/docs/ssync.5
@@ -36,6 +36,13 @@ which will retain the outputs of each run in a subdirectory. This directory must
.MR ssync-queue 1
running.
.TP
+.BI reap_age_s " seconds"
+Reap files created more than the configured seconds ago. This will help clear out temporary files created by the
+.MR ssync-index 1
+and
+.MR ssync-queue 1
+commands.
+.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
@@ -50,6 +57,7 @@ Directory containing the
.MR ssync-index 1
.MR ssync-queue 1
.MR ssync-fetch 1
+.MR ssync-reapr 1
commands.
.SH AUTHOR
Written by Steph Enders
@@ -58,5 +66,6 @@ Written by Steph Enders
.MR ssync-index 1
.MR ssync-queue 1
.MR ssync-fetch 1
+.MR ssync-reapr 1