428 lines
10 KiB
Groff
428 lines
10 KiB
Groff
.\" Man page generated from reStructuredText.
|
||
.
|
||
.TH "SYNCTHING" "1" "Mar 01, 2021" "v1" "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] [device\-id]
|
||
[\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
|
||
[\-home=<dir> | \-config=<dir> \-data=<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]
|
||
.ft P
|
||
.fi
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.SH DESCRIPTION
|
||
.sp
|
||
Syncthing lets you synchronize your files bidirectionally 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 \-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
|
||
.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. Set this to an address (\fB0.0.0.0:8384\fP)
|
||
or file path (\fB/var/run/st.sock\fP, for UNIX sockets).
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-home=<dir>
|
||
Set common configuration and data 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 \-config=<dir>
|
||
Set configuration directory. Alternative to \fB\-home\fP and must be used
|
||
together with \fB\-data\fP\&.
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-data=<dir>
|
||
Set data (e.g. database) directory. Alternative to \fB\-home\fP and must be used
|
||
together with \fB\-config\fP\&.
|
||
.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. 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
|
||
Do not restart Syncthing when it exits. The monitor process will still run
|
||
to handle crashes and writing to logfiles (if configured to).
|
||
.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 \-paused
|
||
Start with all devices and folders paused.
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-reset\-database
|
||
Reset the database, forcing a full rescan and resync. Create \fI\&.stfolder\fP
|
||
folders in each sync folder if they do not already exist. \fBCaution\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.
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-reset\-deltas
|
||
Reset delta index IDs, forcing a full index exchange.
|
||
.UNINDENT
|
||
.INDENT 0.0
|
||
.TP
|
||
.B \-unpaused
|
||
Start with all devices and folders unpaused.
|
||
.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 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
|
||
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 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 \fBall_proxy\fP\&. Somewhat unusually, this
|
||
variable must be named in lower case \- it is not “ALL_PROXY”. For
|
||
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
|
||
.SH DEVELOPMENT SETTINGS
|
||
.sp
|
||
The following environment variables modify Syncthing’s 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 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 config
|
||
Configuration loading and saving.
|
||
.TP
|
||
.B db
|
||
The database layer.
|
||
.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 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 UDP discovery packets: Selected interfaces
|
||
and addresses.
|
||
.TP
|
||
.B connections
|
||
Connection handling.
|
||
.TP
|
||
.B dialer
|
||
Dialing connections.
|
||
.TP
|
||
.B discover
|
||
Remote device discovery requests, replies and registration of
|
||
devices.
|
||
.TP
|
||
.B nat
|
||
NAT discovery and port mapping.
|
||
.TP
|
||
.B pmp
|
||
NAT\-PMP discovery and port mapping.
|
||
.TP
|
||
.B protocol
|
||
The BEP protocol.
|
||
.TP
|
||
.B relay
|
||
Relay interaction (\fBstrelaysrv\fP).
|
||
.TP
|
||
.B upnp
|
||
UPnP discovery and port mapping.
|
||
.UNINDENT
|
||
.TP
|
||
.B Other facilities:
|
||
.INDENT 7.0
|
||
.TP
|
||
.B fs
|
||
Filesystem access.
|
||
.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 walkfs
|
||
Filesystem access while walking.
|
||
.TP
|
||
.B all
|
||
All of the above.
|
||
.UNINDENT
|
||
.UNINDENT
|
||
.TP
|
||
.B STBLOCKPROFILE
|
||
Write block profiles to \fBblock\-$pid\-$timestamp.pprof\fP every 20 seconds.
|
||
.TP
|
||
.B STCPUPROFILE
|
||
Write a CPU profile to \fBcpu\-$pid.pprof\fP on exit.
|
||
.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 STGUIASSETS
|
||
Directory to load GUI assets from. Overrides compiled in assets. Useful for
|
||
developing webgui, commonly use \fBSTGUIASSETS=gui bin/syncthing\fP\&.
|
||
.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 STHEAPPROFILE
|
||
Write heap profiles to \fBheap\-$pid\-$timestamp.pprof\fP each time heap usage
|
||
increases.
|
||
.TP
|
||
.B STNODEFAULTFOLDER
|
||
Don’t create a default folder when starting for the first time. This
|
||
variable will be ignored anytime after the first run.
|
||
.TP
|
||
.B STNORESTART
|
||
Equivalent to the \fB\-no\-restart\fP flag
|
||
.TP
|
||
.B STNOUPGRADE
|
||
Disable automatic upgrades.
|
||
.TP
|
||
.B STPROFILER
|
||
Set to a listen address such as “127.0.0.1:9090” to start the profiler with
|
||
HTTP access, which then can be reached at
|
||
\fI\%http://localhost:9090/debug/pprof\fP\&. See \fBgo tool pprof\fP for more
|
||
information.
|
||
.TP
|
||
.B STPERFSTATS
|
||
Write running performance statistics to \fBperf\-$pid.csv\fP\&. Not supported on
|
||
Windows.
|
||
.TP
|
||
.B STRECHECKDBEVERY
|
||
Time before folder statistics (file, dir, … counts) are recalculated from
|
||
scratch. The given duration must be parseable by Go’s time.ParseDuration. If
|
||
missing or not parseable, the default value of 1 month is used. To force
|
||
recalculation on every startup, set it to \fB1s\fP\&.
|
||
.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
|
||
\fBsyncthing\-config(5)\fP, \fBsyncthing\-stignore(5)\fP,
|
||
\fBsyncthing\-device\-ids(7)\fP, \fBsyncthing\-security(7)\fP,
|
||
\fBsyncthing\-networking(7)\fP, \fBsyncthing\-versioning(7)\fP,
|
||
\fBsyncthing\-faq(7)\fP
|
||
.SH AUTHOR
|
||
The Syncthing Authors
|
||
.SH COPYRIGHT
|
||
2014-2019, The Syncthing Authors
|
||
.\" Generated by docutils manpage writer.
|
||
.
|