355 lines
8.7 KiB
Groff
355 lines
8.7 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SYNCTHING" "1" "February 22, 2017" "v0.14" "Syncthing"
|
|
.SH NAME
|
|
syncthing \- Syncthing
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.SH SYNOPSIS
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
syncthing [\-audit] [\-auditfile=<file|\-|\-\->] [\-browser\-only] [\-generate=<dir>]
|
|
[\-gui\-address=<address>] [\-gui\-apikey=<key>] [\-home=<dir>] [\-logfile=<filename>]
|
|
[\-logflags=<flags>] [\-no\-browser] [\-no\-console] [\-no\-restart] [\-paths] [\-paused]
|
|
[\-reset\-database] [\-reset\-deltas] [\-upgrade] [\-upgrade\-check] [\-upgrade\-to=<url>]
|
|
[\-verbose] [\-version]
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Syncthing is an application that lets you synchronize your files across multiple
|
|
devices. This means the creation, modification or deletion of files on one
|
|
machine will automatically be replicated to your other devices. We believe your
|
|
data is your data alone and you deserve to choose where it is stored. Therefore
|
|
Syncthing does not upload your data to the cloud but exchanges your data across
|
|
your machines as soon as they are online at the same time.
|
|
.SH OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-audit
|
|
Write events to timestamped file \fBaudit\-YYYYMMDD\-HHMMSS.log\fP\&.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-auditfile=<file|\-|\-\->
|
|
Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) for audit events, rather than the timestamped default file name.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-generate=<dir>
|
|
Generate key and config in specified dir, then exit.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-gui\-address=<address>
|
|
Override GUI listen address.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-home=<dir>
|
|
Set configuration directory. The default configuration directory is
|
|
\fB$HOME/.config/syncthing\fP (Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac) and \fB%LOCALAPPDATA%\eSyncthing\fP (Windows).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-logfile=<filename>
|
|
Set destination filename for logging (use \fB"\-"\fP for stdout, which is the default option).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-logflags=<flags>
|
|
Select information in log line prefix, default 2. The \fB\-logflags\fP value is
|
|
a sum of the following:
|
|
.INDENT 7.0
|
|
.IP \(bu 2
|
|
1: Date
|
|
.IP \(bu 2
|
|
2: Time
|
|
.IP \(bu 2
|
|
4: Microsecond time
|
|
.IP \(bu 2
|
|
8: Long filename
|
|
.IP \(bu 2
|
|
16: Short filename
|
|
.UNINDENT
|
|
.sp
|
|
To prefix each log line with date and time, set \fB\-logflags=3\fP (1 + 2 from
|
|
above). The value 0 is used to disable all of the above. The default is to
|
|
show time only (2).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-no\-browser
|
|
Do not start a browser.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-no\-console
|
|
Hide the console window. (On Windows only)
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-no\-restart
|
|
Disable the Syncthing monitor process which handles restarts for some configuration changes, upgrades, crashes and also log file writing (stdout is still written).
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-paths
|
|
Print the paths used for configuration, keys, database, GUI overrides, default sync folder and the log file.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-reset\-database
|
|
Reset the database, forcing a full rescan and resync.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-reset\-deltas
|
|
Reset delta index IDs, forcing a full index exchange.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-upgrade
|
|
Perform upgrade.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-upgrade\-check
|
|
Check for available upgrade.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-upgrade\-to=<url>
|
|
Force upgrade directly from specified URL.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-verbose
|
|
Print verbose log output.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-version
|
|
Show version.
|
|
.UNINDENT
|
|
.SH DEPRECATED OPTIONS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B \-gui\-apikey=<key>
|
|
Override GUI API key (deprecated as of v0.13, to be removed in the future \- do not use).
|
|
.UNINDENT
|
|
.SH EXIT CODES
|
|
.INDENT 0.0
|
|
.TP
|
|
.B 0
|
|
Success / Shutdown
|
|
.TP
|
|
.B 1
|
|
Error
|
|
.TP
|
|
.B 2
|
|
Upgrade not available
|
|
.TP
|
|
.B 3
|
|
Restarting
|
|
.TP
|
|
.B 4
|
|
Upgrading
|
|
.UNINDENT
|
|
.sp
|
|
Some of these exit codes are only returned when running without a monitor
|
|
process (with environment variable \fBSTNORESTART\fP set). Exit codes over 125 are
|
|
usually returned by the shell/binary loader/default signal handler. Exit codes
|
|
over 128+N on Unix usually represent the signal which caused the process to
|
|
exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
|
|
.SH DEVELOPMENT SETTINGS
|
|
.sp
|
|
The following environment variables modify Syncthing\(aqs behavior in ways that
|
|
are mostly useful for developers. Use with care.
|
|
If you start Syncthing from within service managers like systemd or supervisor,
|
|
path expansion may not be supported.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B STNODEFAULTFOLDER
|
|
Don\(aqt create a default folder when starting for the first time. This
|
|
variable will be ignored anytime after the first run.
|
|
.TP
|
|
.B STGUIASSETS
|
|
Directory to load GUI assets from. Overrides compiled in assets.
|
|
.TP
|
|
.B STTRACE
|
|
Used to increase the debugging verbosity in specific or all facilities, generally mapping to a Go package. Enabling any of these also enables microsecond timestamps, file names plus line numbers. Enter a comma\-separated string of facilities to trace. \fBsyncthing \-help\fP always outputs an up\-to\-date list. The valid facility strings
|
|
are:
|
|
.INDENT 7.0
|
|
.TP
|
|
.B Main and operational facilities:
|
|
.INDENT 7.0
|
|
.TP
|
|
.B main
|
|
Main package.
|
|
.TP
|
|
.B model
|
|
The root hub; the largest chunk of the system. File pulling, index transmission and requests for chunks.
|
|
.TP
|
|
.B config
|
|
Configuration loading and saving.
|
|
.TP
|
|
.B db
|
|
The database layer.
|
|
.TP
|
|
.B scanner
|
|
File change detection and hashing.
|
|
.TP
|
|
.B versioner
|
|
File versioning.
|
|
.UNINDENT
|
|
.TP
|
|
.B Networking facilities:
|
|
.INDENT 7.0
|
|
.TP
|
|
.B beacon
|
|
Multicast and broadcast discovery packets.
|
|
.TP
|
|
.B connections
|
|
Connection handling.
|
|
.TP
|
|
.B dialer
|
|
Dialing connections.
|
|
.TP
|
|
.B discover
|
|
Remote device discovery requests, replies and registration of devices.
|
|
.TP
|
|
.B relay
|
|
Relay interaction.
|
|
.TP
|
|
.B protocol
|
|
The BEP protocol.
|
|
.TP
|
|
.B nat
|
|
NAT discovery and port mapping.
|
|
.TP
|
|
.B pmp
|
|
NAT\-PMP discovery and port mapping.
|
|
.TP
|
|
.B upnp
|
|
UPnP discovery and port mapping.
|
|
.UNINDENT
|
|
.TP
|
|
.B Other facilities:
|
|
.INDENT 7.0
|
|
.TP
|
|
.B events
|
|
Event generation and logging.
|
|
.TP
|
|
.B http
|
|
REST API.
|
|
.TP
|
|
.B sha256
|
|
SHA256 hashing package (this facility currently unused).
|
|
.TP
|
|
.B stats
|
|
Persistent device and folder statistics.
|
|
.TP
|
|
.B sync
|
|
Mutexes. Used for debugging race conditions and deadlocks.
|
|
.TP
|
|
.B upgrade
|
|
Binary upgrades.
|
|
.TP
|
|
.B all
|
|
All of the above.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.TP
|
|
.B STPROFILER
|
|
Set to a listen address such as "127.0.0.1:9090" to start the profiler with
|
|
HTTP access.
|
|
.TP
|
|
.B STCPUPROFILE
|
|
Write a CPU profile to cpu\-$pid.pprof on exit.
|
|
.TP
|
|
.B STHEAPPROFILE
|
|
Write heap profiles to \fBheap\-$pid\-$timestamp.pprof\fP each time heap usage
|
|
increases.
|
|
.TP
|
|
.B STBLOCKPROFILE
|
|
Write block profiles to \fBblock\-$pid\-$timestamp.pprof\fP every 20 seconds.
|
|
.TP
|
|
.B STPERFSTATS
|
|
Write running performance statistics to \fBperf\-$pid.csv\fP\&. Not supported on
|
|
Windows.
|
|
.TP
|
|
.B STDEADLOCK
|
|
Used for debugging internal deadlocks. Use only under direction of a
|
|
developer.
|
|
.TP
|
|
.B STDEADLOCKTIMEOUT
|
|
Used for debugging internal deadlocks; sets debug sensitivity. Use only
|
|
under direction of a developer.
|
|
.TP
|
|
.B STDEADLOCKTHRESHOLD
|
|
Used for debugging internal deadlocks; sets debug sensitivity. Use only
|
|
under direction of a developer.
|
|
.TP
|
|
.B STNORESTART
|
|
Equivalent to the \-no\-restart argument. Disable the Syncthing monitor process which handles restarts for some configuration changes, upgrades, crashes and also log file writing (stdout is still written).
|
|
.TP
|
|
.B STNOUPGRADE
|
|
Disable automatic upgrades.
|
|
.TP
|
|
.B STHASHING
|
|
Specify which hashing package to use. Defaults to automatic based on
|
|
performance. Specify "minio" (compatibility) or "standard" for the default Go implementation.
|
|
.TP
|
|
.B GOMAXPROCS
|
|
Set the maximum number of CPU cores to use. Defaults to all available CPU
|
|
cores.
|
|
.TP
|
|
.B GOGC
|
|
Percentage of heap growth at which to trigger GC. Default is 100. Lower
|
|
numbers keep peak memory usage down, at the price of CPU usage
|
|
(i.e. performance).
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
\fIsyncthing\-config(5)\fP, \fIsyncthing\-stignore(5)\fP,
|
|
\fIsyncthing\-device\-ids(7)\fP, \fIsyncthing\-security(7)\fP,
|
|
\fIsyncthing\-networking(7)\fP, \fIsyncthing\-versioning(7)\fP,
|
|
\fIsyncthing\-faq(7)\fP
|
|
.SH AUTHOR
|
|
The Syncthing Authors
|
|
.SH COPYRIGHT
|
|
2015, The Syncthing Authors
|
|
.\" Generated by docutils manpage writer.
|
|
.
|