diff --git a/users/syncthing.rst b/users/syncthing.rst new file mode 100644 index 000000000..36d8d2c20 --- /dev/null +++ b/users/syncthing.rst @@ -0,0 +1,125 @@ +Syncthing +========= + +Synopsis +-------- + +:: + + syncthing [-audit] [-generate=] [-gui-address=
] + [-gui-apikey=] [-gui-authentication=] + [-home=] [-logflags=] [-no-browser] [-no-restart] + [-reset] [-upgrade] [-upgrade-check] [-upgrade-to=] + [-verbose] [-version] + +Description +----------- + +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. + +Options +------- + +``-audit`` + Write events to audit file. +``-generate=`` + Generate key and config in specified dir, then exit. +``-gui-address=
`` + Override GUI address. +``-gui-apikey=`` + Override GUI API key. +``-gui-authentication=`` + Override GUI authentication; username:password. +``-home=`` + Set configuration directory. The default configuration directory is: + ``$HOME/.config/syncthing``. +``-logflags=`` + Select information in log line prefix, default 2. The ``-logflags`` value is + a sum of the following: + + - 1: Date + - 2: Time + - 4: Microsecond time + - 8: Long filename + - 16: Short filename + + To prefix each log line with date and time, set ``-logflags=3`` (1 + 2 from + above). The value 0 is used to disable all of the above. The default is to + show time only (2). +``-no-browser`` + Do not start a browser. +``-no-restart`` + Do not restart; just exit. +``-reset`` + Reset the database. +``-upgrade`` + Perform upgrade. +``-upgrade-check`` + Check for available upgrade. +``-upgrade-to=`` + Force upgrade directly from specified URL. +``-verbose`` + Print verbose log output. +``-version`` + Show version. + +Development Settings +-------------------- + +The following environment variables modify Syncthing's behavior in ways that +are mostly useful for developers. Use with care. + +STGUIASSETS + Directory to load GUI assets from. Overrides compiled in assets. +STTRACE + A comma separated string of facilities to trace. The valid facility strings + are: + + - ``beacon``: the beacon package + - ``discover``: the discover package + - ``events``: the events package + - ``files``: the files package + - ``http``: the main package; HTTP requests + - ``locks``: the sync package; trace long held locks + - ``net``: the main package; connections & network messages + - ``model``: the model package + - ``scanner``: the scanner package + - ``stats``: the stats package + - ``upnp``: the upnp package + - ``xdr``: the xdr package + - ``all``: all of the above + +STPROFILER + Set to a listen address such as "127.0.0.1:9090" to start the profiler with + HTTP access. +STCPUPROFILE + Write a CPU profile to cpu-$pid.pprof on exit. +STHEAPPROFILE + Write heap profiles to heap-$pid-$timestamp.pprof each time heap usage + increases. +STBLOCKPROFILE + Write block profiles to ``block-$pid-$timestamp.pprof`` every 20 seconds. +STPERFSTATS + Write running performance statistics to perf-$pid.csv. Not supported on + Windows. +STNOUPGRADE + Disable automatic upgrades. +GOMAXPROCS + Set the maximum number of CPU cores to use. Defaults to all available CPU cores. +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 + (ie. performance). + +See also +-------- + +:manpage:`syncthing-config(5)`, :manpage:`syncthing-stignore(5)`, +:manpage:`syncthing-device-ids(7)`, :manpage:`syncthing-security(7)`, +:manpage:`syncthing-networking(7)`, :manpage:`syncthing-versioning(7)`, +:manpage:`syncthing-faq(7)`