Updated documentation for foldertype

This commit is contained in:
Lars K.W. Gohlke
2016-05-08 07:20:16 +02:00
committed by Jakob Borg
parent de1d3792c1
commit bdafe9f5d4
+7 -5
View File
@@ -50,7 +50,7 @@ The following shows the default configuration file:
.. code-block:: xml .. code-block:: xml
<configuration version="12"> <configuration version="12">
<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="default" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
<device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device> <device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device>
<minDiskFreePct>1</minDiskFreePct> <minDiskFreePct>1</minDiskFreePct>
<versioning></versioning> <versioning></versioning>
@@ -122,7 +122,7 @@ Folder Element
.. code-block:: xml .. code-block:: xml
<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="default" path="/Users/jb/Sync/" type="readonly" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
<device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device> <device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device>
<minDiskFreePct>1</minDiskFreePct> <minDiskFreePct>1</minDiskFreePct>
<versioning></versioning> <versioning></versioning>
@@ -148,9 +148,11 @@ path
The path to the directory where the folder is stored on this The path to the directory where the folder is stored on this
device; not sent to other devices. (mandatory) device; not sent to other devices. (mandatory)
ro type
True if the folder is read only (Master mode; will not be modified by - ``readonly`` if the folder is in *master* mode, it will not be modified by
Syncthing) on this device. syncthing on this device.
- ``readwrite`` if the folder is in default mode. Sending local and accepting remote changes.
rescanIntervalS rescanIntervalS
The rescan interval, in seconds. Can be set to zero to disable when external The rescan interval, in seconds. Can be set to zero to disable when external