aboutsummaryrefslogtreecommitdiff
path: root/docs/ssync-index.1
blob: cb53fc195f57067175b171c00d27b6af6c0b592c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
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.