users/config: Document folder labels

GitHub-Pull-Request: https://github.com/syncthing/docs/pull/162
This commit is contained in:
Lars K.W. Gohlke
2016-05-11 10:48:38 +00:00
committed by Jakob Borg
parent c5796b993f
commit 0231d12897
+5 -2
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/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="xsdasdSasd" label="default-sync" 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/" type="readonly" rescanIntervalS="60" ignorePerms="false" autoNormalize="true"> <folder id="sdafa-aASD" label="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>
@@ -144,6 +144,9 @@ element:
id id
The folder ID, must be unique. (mandatory) The folder ID, must be unique. (mandatory)
label
The label of a folder is a human readable and a descriptive local name. Can be different on each device. (optional)
path 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)