felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

chore: update man pages for 2.0

Browse Source
This commit is contained in:
Jakob Borg
2025-08-11 19:33:32 +02:00
parent 3da84804b6
commit c74d2a9872
16 changed files with 300 additions and 459 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/syncthing-bep.7
+30 -26
View File
@@ -28,7 +28,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-BEP" "7" "Aug 01, 2025" "v1.29.7" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Aug 11, 2025" "v2.0.0" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
@@ -267,13 +267,11 @@ message ClusterConfig {
}
message Folder {
string id = 1;
string label = 2;
bool read_only = 3;
bool ignore_permissions = 4;
bool ignore_delete = 5;
bool disable_temp_indexes = 6;
bool paused = 7;
string id = 1;
string label = 2;
FolderType type = 3;
FolderStopReason stop_reason = 7;
reserved 4 to 6;
repeated Device devices = 16;
}
@@ -296,6 +294,18 @@ enum Compression {
NEVER = 1;
ALWAYS = 2;
}
enum FolderType {
FOLDER_TYPE_SEND_RECEIVE = 0;
FOLDER_TYPE_SEND_ONLY = 1;
FOLDER_TYPE_RECEIVE_ONLY = 2;
FOLDER_TYPE_RECEIVE_ENCRYPTED = 3;
}
enum FolderStopReason {
FOLDER_STOP_REASON_RUNNING = 0;
FOLDER_STOP_REASON_PAUSED = 1;
}
.EE
.UNINDENT
.UNINDENT
@@ -311,20 +321,12 @@ the folder.
The \fBlabel\fP field contains the folder label, the human readable name of
the folder.
.sp
The \fBread_only\fP field is set for folders that the device will accept no
updates from the network for.
The \fBfolder_type\fP field contains the type of the folder as defined by the
FolderType enumeration.
.sp
The \fBignore_permissions\fP field is set for folders that the device will not
accept or announce file permissions for.
.sp
The \fBignore_delete\fP field is set for folders that the device will ignore
deletes for.
.sp
The \fBdisable_temp_indexes\fP field is set for folders that will not dispatch
and do not wish to receive progress updates about partially downloaded files
via Download Progress messages.
.sp
The \fBpaused\fP field is set for folders that are currently paused.
The \fBstop_reason\fP field is set for folders that are currently stopped for
any reason. The zero means that the folder is not stopped; further reasons
are defined by the FolderStopReason enumeration.
.sp
The \fBdevices\fP field is a list of devices participating in sharing this
folder.
@@ -430,10 +432,10 @@ enum FileInfoType {
}
message BlockInfo {
int64 offset = 1;
int32 size = 2;
bytes hash = 3;
uint32 weak_hash = 4;
int64 offset = 1;
int32 size = 2;
bytes hash = 3;
reserved 4;
}
message Vector {
@@ -536,6 +538,8 @@ message Request {
int32 size = 5;
bytes hash = 6;
bool from_temporary = 7;
int32 block_no = 9;
reserved 8;
}
.EE
.UNINDENT
@@ -1053,6 +1057,6 @@ process occurs for device A at 15.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
2014-2019, The Syncthing Authors
2014-2025, The Syncthing Authors
.\" Generated by docutils manpage writer.
.