gui: Update translations and documentation

This commit is contained in:
Jakob Borg
2016-04-01 07:33:42 +00:00
parent a551686d37
commit 8f580b13df
51 changed files with 593 additions and 377 deletions

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-BEP" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-BEP" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.
@@ -56,7 +56,7 @@ level protocols providing encryption and authentication.
.sp
.nf
.ft C
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| Block Exchange Protocol |
|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
| Encryption & Auth (TLS 1.2) |
@@ -241,6 +241,10 @@ Folder Structure:
\e ID (variable length) \e
/ /
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
/ /
\e Label (length + padded data) \e
/ /
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
| Number of Devices |
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
/ /
@@ -354,6 +358,8 @@ options.
.sp
The \fBID\fP field contains the folder ID, as a human readable string.
.sp
The \fBLabel\fP field contains the folder label, as human readable name for the folder.
.sp
The \fBDevices\fP field is list of devices participating in sharing this folder.
.sp
The \fBFlags\fP field contains flags that affect the behavior of the folder. The
@@ -498,14 +504,15 @@ struct ClusterConfigMessage {
string ClientVersion<64>;
Folder Folders<1000000>;
Option Options<64>;
}
};
struct Folder {
string ID<256>;
string Label<256>;
Device Devices<1000000>;
unsigned int Flags;
Option Options<64>;
}
};
struct Device {
opaque ID<32>;
@@ -516,12 +523,12 @@ struct Device {
hyper MaxLocalVersion;
unsigned int Flags;
Option Options<64>;
}
};
struct Option {
string Key<64>;
string Value<1024>;
}
};
.ft P
.fi
.UNINDENT
@@ -750,7 +757,7 @@ struct IndexMessage {
FileInfo Files<1000000>;
unsigned int Flags;
Option Options<64>;
}
};
struct FileInfo {
string Name<8192>;
@@ -758,22 +765,22 @@ struct FileInfo {
hyper Modified;
Vector Version;
hyper LocalVersion;
BlockInfo Blocks<1000000>;
}
BlockInfo Blocks<10000000>;
};
struct Vector {
Counter Counters<>
}
Counter Counters<>;
};
struct Counter {
unsigned hyper ID
unsigned hyper Value
}
unsigned hyper ID;
unsigned hyper Value;
};
struct BlockInfo {
unsigned int Size;
opaque Hash<64>;
}
};
.ft P
.fi
.UNINDENT
@@ -858,7 +865,7 @@ struct RequestMessage {
opaque Hash<64>;
unsigned int Flags;
Option Options<64>;
}
};
.ft P
.fi
.UNINDENT
@@ -1054,7 +1061,7 @@ T{
T} T{
Total length
T} T{
64 MiB
512 MiB
T}
_
T{
@@ -1098,7 +1105,7 @@ T{
T} T{
Number of Blocks
T} T{
1.000.000
10.000.000
T}
_
T{
@@ -1214,6 +1221,10 @@ T} T{
T}
_
.TE
.sp
The currently defined values allow maximum file size of 1220 GiB
(10.000.000 x 128 KiB). The maximum message size covers an Index message
for the maximum file.
.SH EXAMPLE EXCHANGE
.TS
center;

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-CONFIG" "5" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.
@@ -65,7 +65,7 @@ device ID. The key must be kept private.
The certificate and key for HTTPS GUI connections. These may be replaced
with a custom certificate for HTTPS as desired.
.TP
.B \fBindex\-\fI*\fP\&.db\fP
.B \fBindex\-\fP\fI*\fP\fB\&.db\fP
A directory holding the database with metadata and hashes of the files
currently on disk and available from peers.
.TP
@@ -284,6 +284,9 @@ conflict copies altogether.
<device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="syno" compression="metadata" introducer="false">
<address>dynamic</address>
</device>
<device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="false">
<address>tcp://192.0.2.1:22001</address>
</device>
.ft P
.fi
.UNINDENT
@@ -327,25 +330,36 @@ should copy their list of devices per folder when connecting.
.UNINDENT
.sp
In addition, one or more \fBaddress\fP child elements must be present. Each
contains an address to use when attempting to connect to this device and will
be tried in order. Accepted formats are:
contains an address or host name to use when attempting to connect to this device and will
be tried in order. Entries other than \fBdynamic\fP must be prefixed with \fBtcp://\fP (dual\-stack), \fBtcp4://\fP (IPv4 only) or
.nf
\(ga\(ga
.fi
tcp6://\(ga (IPv6 only). Note that IP addresses need not use tcp4/tcp6; these are optional. Accepted formats are:
.INDENT 0.0
.TP
.B IPv4 address (\fB192.0.2.42\fP)
.B IPv4 address (\fBtcp://192.0.2.42\fP)
The default port (22000) is used.
.TP
.B IPv4 address and port (\fB192.0.2.42:12345\fP)
.B IPv4 address and port (\fBtcp://192.0.2.42:12345\fP)
The address and port is used as given.
.TP
.B IPv6 address (\fB2001:db8::23:42\fP)
The default port (22000) is used.
.B IPv6 address (\fBtcp://[2001:db8::23:42]\fP)
The default port (22000) is used. The address must be enclosed in
square brackets.
.TP
.B IPv6 address and port (\fB[2001:db8::23:42]:12345\fP)
.B IPv6 address and port (\fBtcp://[2001:db8::23:42]:12345\fP)
The address and port is used as given. The address must be enclosed in
square brackets.
.TP
.B Host name (\fBtcp6://fileserver\fP)
The host name will be used on the default port (22000) and connections will be attempted only via IPv6.
.TP
.B Host name and port (\fBtcp://fileserver:12345\fP)
The host name will be used on the given port and connections will be attempted via both IPv4 and IPv6, depending on name resolution.
.TP
.B \fBdynamic\fP
The word \fBdynamic\fP means to use local and global discovery to find the
The word \fBdynamic\fP (without \fBtcp://\fP prefix) means to use local and global discovery to find the
device.
.UNINDENT
.SH IGNOREDDEVICE ELEMENT
@@ -401,13 +415,19 @@ Allowed address formats are:
.B IPv4 address and port (\fB127.0.0.1:8384\fP)
The address and port is used as given.
.TP
.B IPv4 wildcard and port (\fBtcp4://0.0.0.0\fP, \fBtcp4://:8384\fP)
These are equivalent and will result in Syncthing listening on all interfaces via IPv4 only.
.TP
.B IPv6 address and port (\fB[::1]:8384\fP)
The address and port is used as given. The address must be enclosed in
square brackets.
.TP
.B IPv6 wildcard and port (\fBtcp6://[::]:8384\fP, \fBtcp6://:8384\fP)
These are equivalent and will result in Syncthing listening on all interfaces via IPv6 only.
.TP
.B Wildcard and port (\fB0.0.0.0:12345\fP, \fB[::]:12345\fP, \fB:12345\fP)
These are equivalent and will result in Syncthing listening on all
interfaces and both IPv4 and IPv6.
interfaces via both IPv4 and IPv6.
.UNINDENT
.TP
.B username
@@ -504,10 +524,10 @@ Alternatively, a relay list can be loaded over https by using an URL like
from the relay pool server, \fBrelays.syncthing.net\fP\&.
.TP
.B maxSendKbps
Outgoing data rate limit, in kibibits per second.
Outgoing data rate limit, in kibibytes per second.
.TP
.B maxRecvKbps
Incoming data rate limits, in kibibits per second.
Incoming data rate limits, in kibibytes per second.
.TP
.B reconnectionIntervalS
The number of seconds to wait between each attempt to connect to currently

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-DEVICE-IDS" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-EVENT-API" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-FAQ" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.
@@ -156,6 +156,9 @@ causes a conflict on change you\(aqll end up with \fBsync\-conflict\-...sync\-co
.sp
Each user should run their own Syncthing instance. Be aware that you might need
to configure ports such that they do not overlap (see the config.xml).
.SS Does Syncthing support syncing between folders on the same system?
.sp
Syncthing is not designed to sync locally and the overhead involved in doing so will waste resources. There are better programs to achieve this such as rsync or Unison.
.SS Is Syncthing my ideal backup application?
.sp
No, Syncthing is not a backup application because all changes to your files

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-GLOBALDISCO" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-LOCALDISCO" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v3
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-NETWORKING" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-RELAY" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.
@@ -262,7 +262,7 @@ _
T{
1
T} T{
SessionInvitation(A)\->
JoinSessionRequest(A)\->
T} T{
T} T{
T}
@@ -298,7 +298,7 @@ T{
T} T{
T} T{
T} T{
<\-SessionInvitation(B)
<\-JoinSessionRequest(B)
T}
_
T{

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-REST-API" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-SECURITY" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING-STIGNORE" "5" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.
@@ -71,6 +71,8 @@ Question mark matches a single character that is not the directory
separator. \fBte??st\fP matches \fBtebest\fP but not \fBteb/st\fP or
\fBtest\fP\&.
.IP \(bu 2
Characters enclosed in square brackets \fB[]\fP are interpreted as a character range \fB[a\-z]\fP\&. Before using this syntax you should have a basic understanding of regular expression character classes.
.IP \(bu 2
A pattern beginning with \fB/\fP matches in the current directory only.
\fB/foo\fP matches \fBfoo\fP but not \fBsubdir/foo\fP\&.
.IP \(bu 2
@@ -97,6 +99,8 @@ be synchronized. Note that case\-insensitive patterns must start with
patterns are always case\-insensitive.
.IP \(bu 2
A line beginning with \fB//\fP is a comment and has no effect.
.IP \(bu 2
Windows does not support escaping \fB\e[foo \- bar\e]\fP\&.
.UNINDENT
.SH EXAMPLE
.sp

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "TODO" "7" "January 30, 2016" "v0.12" "Syncthing"
.TH "TODO" "7" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
Todo \- Keep automatic backups of deleted files by other nodes
.
@@ -156,6 +156,41 @@ $ /Users/jb/bin/onlylatest.sh /Users/jb/Sync docs/letter.txt
The script will then move the file in question to
\fB~/.trashcan/docs/letter.txt\fP, replacing any previous version of that letter
that may already have been there.
.SS Example for Windows
.sp
On Windows we can use a batch script to perform the same "trash can"\-like
behavior as mentioned above. I created the following script and saved it as
\fBC:\eUsers\emfrnd\eScripts\eonlylatest.bat\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
@echo off
:: We need command extensions for mkdir to create intermediate folders in one go
setlocal EnableExtensions
:: Where I want my versions stored
set VERSIONS_PATH=%USERPROFILE%\e.trashcan
:: The parameters we get from Syncthing, \(aq~\(aq removes quotes if any
set FOLDER_PATH=%~1
set FILE_PATH=%~2
:: First ensure the dir where we need to store the file exists
for %%F in ("%VERSIONS_PATH%\e%FILE_PATH%") do set OUTPUT_PATH=%%~dpF
if not exist "%OUTPUT_PATH%" mkdir "%OUTPUT_PATH%" || exit /B
:: Finally move the file, overwrite existing file if any
move /Y "%FOLDER_PATH%\e%FILE_PATH%" "%VERSIONS_PATH%\e%FILE_PATH%"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Finally, I set \fBC:\eUsers\emfrnd\eScripts\eonlylatest.bat\fP as command name in
Syncthing.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT

View File

@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
.TH "SYNCTHING" "1" "January 30, 2016" "v0.12" "Syncthing"
.TH "SYNCTHING" "1" "March 30, 2016" "v0.12" "Syncthing"
.SH NAME
syncthing \- Syncthing
.
@@ -36,9 +36,9 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.sp
.nf
.ft C
syncthing [\-audit] [\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
syncthing [\-audit] [\-browser\-only] [\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
[\-home=<dir>] [\-logfile=<filename>] [\-logflags=<flags>] [\-no\-browser]
[\-no\-console] [\-no\-restart] [\-reset] [\-upgrade] [\-upgrade\-check]
[\-no\-console] [\-no\-restart] [\-paths] [\-paused] [\-reset] [\-upgrade] [\-upgrade\-check]
[\-upgrade\-to=<url>] [\-verbose] [\-version]
.ft P
.fi
@@ -123,6 +123,11 @@ Do not restart; just exit.
.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
Reset the database.
.UNINDENT
@@ -179,8 +184,14 @@ exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
.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