2015-05-30 13:05:37 +02:00
. \" Man page generated from reStructuredText.
.
2019-04-10 07:45:25 +02:00
.TH "SYNCTHING" "1" "Apr 04, 2019" "v1" "Syncthing"
2015-05-30 13:05:37 +02:00
.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
2017-11-22 07:45:21 +01:00
syncthing [\- audit] [\- auditfile=<file|\- |\- \- >] [\- browser\- only] [device\- id]
[\- 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] [\- unpaused] [\- upgrade]
[\- upgrade\- check] [\- upgrade\- to=<url>] [\- verbose] [\- version]
2015-05-30 13:05:37 +02:00
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
2018-03-07 07:45:16 +01:00
Syncthing lets you synchronize your files bidirectionally across multiple
2015-05-30 13:05:37 +02:00
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
2015-06-14 13:52:00 +02:00
.B \- audit
2017-01-23 21:58:53 +01:00
Write events to timestamped file \fB audit\- 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.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2017-11-22 07:45:21 +01:00
.B \- browser\-only
Open the web UI in a browser for an already running Syncthing instance.
.UNINDENT
.INDENT 0 .0
.TP
.B \- device\-id
Print device ID to command line.
.UNINDENT
.INDENT 0 .0
.TP
2015-06-14 13:52:00 +02:00
.B \- generate=<dir>
2015-05-30 13:05:37 +02:00
Generate key and config in specified dir, then exit.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- gui\-address=<address>
2018-11-07 07:45:25 +01:00
Override GUI listen address. Set this to an address (\fB 0.0.0.0:8384\fP )
or file path (\fB /var/run/st.sock\fP , for UNIX sockets).
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- home=<dir>
2017-01-23 21:58:53 +01:00
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%\e Syncthing\fP (Windows).
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-09-27 22:31:19 +02:00
.B \- logfile=<filename>
Set destination filename for logging (use \fB "\- "\fP for stdout, which is the default option).
.UNINDENT
.INDENT 0 .0
.TP
2015-06-14 13:52:00 +02:00
.B \- logflags=<flags>
2018-03-07 07:45:16 +01:00
Select information in log line prefix. The \fB \- logflags\fP value is a sum of
the following:
2015-05-30 13:05:37 +02:00
.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).
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- no\-browser
2015-05-30 13:05:37 +02:00
Do not start a browser.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-08-09 11:56:22 +02:00
.B \- no\-console
Hide the console window. (On Windows only)
.UNINDENT
.INDENT 0 .0
.TP
2015-06-14 13:52:00 +02:00
.B \- no\-restart
2017-01-23 21:58:53 +01:00
Disable the Syncthing monitor process which handles restarts for some configuration changes, upgrades, crashes and also log file writing (stdout is still written).
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2016-04-01 09:33:42 +02:00
.B \- paths
Print the paths used for configuration, keys, database, GUI overrides, default sync folder and the log file.
.UNINDENT
.INDENT 0 .0
.TP
2017-11-22 07:45:21 +01:00
.B \- paused
Start with all devices and folders paused.
.UNINDENT
.INDENT 0 .0
.TP
2017-01-10 08:41:14 +01:00
.B \- reset\-database
2018-03-07 07:45:16 +01:00
Reset the database, forcing a full rescan and resync. Create \fI \& .stfolder\fP
folders in each sync folder if they do not already exist. \fB Caution\fP :
Ensure that all sync folders which are mountpoints are already mounted.
Inconsistent versions may result if the mountpoint is later mounted and
contains older versions.
2017-01-10 08:41:14 +01:00
.UNINDENT
.INDENT 0 .0
.TP
.B \- reset\-deltas
Reset delta index IDs, forcing a full index exchange.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2017-11-22 07:45:21 +01:00
.B \- unpaused
Start with all devices and folders unpaused.
.UNINDENT
.INDENT 0 .0
.TP
2015-06-14 13:52:00 +02:00
.B \- upgrade
2015-05-30 13:05:37 +02:00
Perform upgrade.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- upgrade\-check
2015-05-30 13:05:37 +02:00
Check for available upgrade.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- upgrade\-to=<url>
2015-05-30 13:05:37 +02:00
Force upgrade directly from specified URL.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- verbose
2015-05-30 13:05:37 +02:00
Print verbose log output.
2015-06-14 13:52:00 +02:00
.UNINDENT
.INDENT 0 .0
2015-05-30 13:05:37 +02:00
.TP
2015-06-14 13:52:00 +02:00
.B \- version
2015-05-30 13:05:37 +02:00
Show version.
.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
2015-06-28 21:10:57 +02:00
.B 4
2015-05-30 13:05:37 +02:00
Upgrading
.UNINDENT
.sp
Some of these exit codes are only returned when running without a monitor
process (with environment variable \fB STNORESTART\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, \fB 128 + 9 (SIGKILL) = 137\fP \& .
2018-02-07 07:45:17 +01:00
.SH PROXIES
.sp
Syncthing can use a SOCKS, HTTP, or HTTPS proxy to talk to the outside
world. The proxy is used for outgoing connections only \- it is not possible
to accept incoming connections through the proxy. The proxy is configured
through the environment variable \fB all_proxy\fP \& . Somewhat unusually, this
2019-03-27 07:45:25 +01:00
variable must be named in lower case \- it is not “ALL_PROXY”. For
2018-02-07 07:45:17 +01:00
example:
.INDENT 0 .0
.INDENT 3 .5
.sp
.nf
.ft C
$ export all_proxy=socks://192.0.2.42:8081
.ft P
.fi
.UNINDENT
.UNINDENT
2015-05-30 13:05:37 +02:00
.SH DEVELOPMENT SETTINGS
.sp
2019-03-27 07:45:25 +01:00
The following environment variables modify Syncthing’ s behavior in ways that
2015-05-30 13:05:37 +02:00
are mostly useful for developers. Use with care.
2017-01-10 08:41:14 +01:00
If you start Syncthing from within service managers like systemd or supervisor,
2016-04-01 09:33:42 +02:00
path expansion may not be supported.
2015-05-30 13:05:37 +02:00
.INDENT 0 .0
.TP
.B STTRACE
2018-02-28 07:45:16 +01:00
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. \fB syncthing \- help\fP always
outputs an up\- to\- date list. The valid facility strings are:
2015-05-30 13:05:37 +02:00
.INDENT 7 .0
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B Main and operational facilities:
.INDENT 7 .0
.TP
.B config
Configuration loading and saving.
.TP
.B db
The database layer.
.TP
2018-02-28 07:45:16 +01:00
.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
2017-01-10 08:41:14 +01:00
.B scanner
File change detection and hashing.
.TP
.B versioner
File versioning.
.UNINDENT
.TP
.B Networking facilities:
.INDENT 7 .0
.TP
2015-06-14 13:52:00 +02:00
.B beacon
2018-02-28 07:45:16 +01:00
Multicast and broadcast UDP discovery packets: Selected interfaces
and addresses.
2017-01-10 08:41:14 +01:00
.TP
.B connections
Connection handling.
.TP
.B dialer
Dialing connections.
2015-06-14 13:52:00 +02:00
.TP
.B discover
2018-02-28 07:45:16 +01:00
Remote device discovery requests, replies and registration of
devices.
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B nat
NAT discovery and port mapping.
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B pmp
NAT\- PMP discovery and port mapping.
2015-06-14 13:52:00 +02:00
.TP
2018-02-28 07:45:16 +01:00
.B protocol
The BEP protocol.
.TP
.B relay
Relay interaction (\fB strelaysrv\fP ).
.TP
2017-01-10 08:41:14 +01:00
.B upnp
UPnP discovery and port mapping.
.UNINDENT
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B Other facilities:
.INDENT 7 .0
2015-06-14 13:52:00 +02:00
.TP
2018-02-28 07:45:16 +01:00
.B fs
Filesystem access.
.TP
2017-01-10 08:41:14 +01:00
.B events
Event generation and logging.
.TP
.B http
REST API.
.TP
.B sha256
SHA256 hashing package (this facility currently unused).
2015-06-14 13:52:00 +02:00
.TP
.B stats
2017-01-10 08:41:14 +01:00
Persistent device and folder statistics.
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B sync
Mutexes. Used for debugging race conditions and deadlocks.
2015-06-14 13:52:00 +02:00
.TP
2017-01-10 08:41:14 +01:00
.B upgrade
Binary upgrades.
2015-06-14 13:52:00 +02:00
.TP
2018-02-28 07:45:16 +01:00
.B walkfs
Filesystem access while walking.
.TP
2015-06-14 13:52:00 +02:00
.B all
2017-01-10 08:41:14 +01:00
All of the above.
.UNINDENT
2015-05-30 13:05:37 +02:00
.UNINDENT
.TP
.B STBLOCKPROFILE
Write block profiles to \fB block\- $pid\- $timestamp.pprof\fP every 20 seconds.
.TP
2018-02-28 07:45:16 +01:00
.B STCPUPROFILE
2018-03-07 07:45:16 +01:00
Write a CPU profile to \fB cpu\- $pid.pprof\fP on exit.
2017-01-10 08:41:14 +01:00
.TP
.B STDEADLOCKTIMEOUT
2017-01-23 21:58:53 +01:00
Used for debugging internal deadlocks; sets debug sensitivity. Use only
under direction of a developer.
2017-01-10 08:41:14 +01:00
.TP
.B STDEADLOCKTHRESHOLD
2017-01-23 21:58:53 +01:00
Used for debugging internal deadlocks; sets debug sensitivity. Use only
under direction of a developer.
.TP
2018-02-28 07:45:16 +01:00
.B STGUIASSETS
Directory to load GUI assets from. Overrides compiled in assets. Useful for
developing webgui, commonly use \fB STGUIASSETS=gui bin/syncthing\fP \& .
.TP
.B STHASHING
Specify which hashing package to use. Defaults to automatic based on
2019-03-27 07:45:25 +01:00
performance. Specify “minio” (compatibility) or “standard” for the default
2018-02-28 07:45:16 +01:00
Go implementation.
.TP
.B STHEAPPROFILE
Write heap profiles to \fB heap\- $pid\- $timestamp.pprof\fP each time heap usage
increases.
.TP
.B STNODEFAULTFOLDER
2019-03-27 07:45:25 +01:00
Don’ t create a default folder when starting for the first time. This
2018-02-28 07:45:16 +01:00
variable will be ignored anytime after the first run.
.TP
2017-01-23 21:58:53 +01:00
.B STNORESTART
2018-03-07 07:45:16 +01:00
Equivalent to the \fB \- no\- restart\fP flag. Disable the Syncthing monitor
2018-02-28 07:45:16 +01:00
process which handles restarts for some configuration changes, upgrades,
crashes and also log file writing (stdout is still written).
2017-01-10 08:41:14 +01:00
.TP
2015-05-30 13:05:37 +02:00
.B STNOUPGRADE
Disable automatic upgrades.
.TP
2018-02-28 07:45:16 +01:00
.B STPROFILER
2019-03-27 07:45:25 +01:00
Set to a listen address such as “127.0.0.1:9090” to start the profiler with
2018-02-28 07:45:16 +01:00
HTTP access, which then can be reached at
\fI \% http://localhost:9090/debug/pprof\fP \& . See \fB go tool pprof\fP for more
information.
.TP
.B STPERFSTATS
Write running performance statistics to \fB perf\- $pid.csv\fP \& . Not supported on
Windows.
.TP
.B STRECHECKDBEVERY
2019-03-27 07:45:25 +01:00
Time before folder statistics (file, dir, … counts) are recalculated from
scratch. The given duration must be parseable by GO’ s time.ParseDuration. If
2018-02-28 07:45:16 +01:00
missing or not parseable, the default value of 1 month is used. To force
recalculation on every startup, set it to \fB 0\fP \& .
2017-01-10 08:41:14 +01:00
.TP
2015-05-30 13:05:37 +02:00
.B GOMAXPROCS
2015-07-05 11:24:21 +02:00
Set the maximum number of CPU cores to use. Defaults to all available CPU
cores.
2015-05-30 13:05:37 +02:00
.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
2017-01-10 08:41:14 +01:00
(i.e. performance).
2015-05-30 13:05:37 +02:00
.UNINDENT
.SH SEE ALSO
.sp
2017-11-29 07:45:17 +01:00
\fB syncthing\- config(5)\fP , \fB syncthing\- stignore(5)\fP ,
\fB syncthing\- device\- ids(7)\fP , \fB syncthing\- security(7)\fP ,
\fB syncthing\- networking(7)\fP , \fB syncthing\- versioning(7)\fP ,
\fB syncthing\- faq(7)\fP
2015-05-30 13:05:37 +02:00
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
2019-02-13 07:45:23 +01:00
2014-2019, The Syncthing Authors
2015-05-30 13:05:37 +02:00
. \" Generated by docutils manpage writer.
.