docs/src/sync-configuration.md

changeset 320
12ed560c926c
parent 283
0e36bb75a732
child 409
90a6d6952d83
equal deleted inserted replaced
319:2433b5969d44 320:12ed560c926c
9 ## directory 9 ## directory
10 10
11 This element configures a sync-directory. A sync-directory must have a unique name, a (local) path, repository and a database. 11 This element configures a sync-directory. A sync-directory must have a unique name, a (local) path, repository and a database.
12 12
13 Required elements: `<name>`, `<repository>`, `<path>`, `<database>` \ 13 Required elements: `<name>`, `<repository>`, `<path>`, `<database>` \
14 Optional elements: `<collection>`, `<trash>`, `<max-retry>`, `<backup-on-pull>`, `<lock-pull>`, `<lock-push>`, `<filter>` 14 Optional elements: `<collection>`, `<trash>`, `<max-retry>`, `<backup-on-pull>`, `<lock-pull>`, `<lock-push>`, `<lock-timeout>`, `<filter>`
15 15
16 ### name 16 ### name
17 17
18 Unique sync-directory identifer. This identifer is used in combination with all *dav-sync* commands. 18 Unique sync-directory identifer. This identifer is used in combination with all *dav-sync* commands.
19 19
90 90
91 Type: boolean \ 91 Type: boolean \
92 Default: false \ 92 Default: false \
93 Example: `<lock-push>true</lock-push>` 93 Example: `<lock-push>true</lock-push>`
94 94
95 ### lock-timeout
96
97 Specifies the lock timeout in seconds. If the lock-timeout is 0, the client doesn't request a specific timeout and the server's default value is used. If the lock-timeout is -1, a infinite timeout is requested.
98
99 Type: integer \
100 Default: 0 \
101 Example: `<lock-timeout>50</lock-timeout>`
102
95 ### filter 103 ### filter
96 104
97 With the filter element, include and exclude filters can be specified, to control which files are synchronized. The *pull* and *push* command apply these filters to file paths. At first it is checked if a file is matching any include filter. If so only files matching not an exclude filter are further processed. 105 With the filter element, include and exclude filters can be specified, to control which files are synchronized. The *pull* and *push* command apply these filters to file paths. At first it is checked if a file is matching any include filter. If so only files matching not an exclude filter are further processed.
98 106
99 Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator. 107 Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.

mercurial