diff options
Diffstat (limited to 'docs/ssync-index.1')
| -rw-r--r-- | docs/ssync-index.1 | 48 |
1 files changed, 48 insertions, 0 deletions
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. |