docs/html/sync-configuration.html

changeset 429
1607450065ba
parent 320
12ed560c926c
child 563
3dffe58a573f
equal deleted inserted replaced
428:b50ade8e7197 429:1607450065ba
24 <li><a href="put.html">put</a></li> 24 <li><a href="put.html">put</a></li>
25 <li><a href="mkdir.html">mkdir</a></li> 25 <li><a href="mkdir.html">mkdir</a></li>
26 <li><a href="remove.html">remove</a></li> 26 <li><a href="remove.html">remove</a></li>
27 <li><a href="copy.html">copy</a></li> 27 <li><a href="copy.html">copy</a></li>
28 <li><a href="move.html">move</a></li> 28 <li><a href="move.html">move</a></li>
29 <li><a href="export.html">export</a></li>
30 <li><a href="import.html">import</a></li>
29 <li><a href="get-property.html">get-property</a></li> 31 <li><a href="get-property.html">get-property</a></li>
30 <li><a href="set-property.html">set-property</a></li> 32 <li><a href="set-property.html">set-property</a></li>
31 <li><a href="remove-property.html">remove-property</a></li> 33 <li><a href="remove-property.html">remove-property</a></li>
32 <li><a href="lock.html">lock</a></li> 34 <li><a href="lock.html">lock</a></li>
33 <li><a href="unlock.html">unlock</a></li> 35 <li><a href="unlock.html">unlock</a></li>
34 <li><a href="info.html">info</a></li> 36 <li><a href="info.html">info</a></li>
35 <li><a href="date.html">date</a></li> 37 <li><a href="date.html">date</a></li>
36 <li><a href="add-repository.html">add-repository</a></li> 38 <li><a href="add-repository.html">add-repository</a></li>
39 <li><a href="remove-repository.html">remove-repository</a></li>
37 <li><a href="list-repositories.html">list-repositories</a></li> 40 <li><a href="list-repositories.html">list-repositories</a></li>
38 <li><a href="check-config.html">check-config</a></li> 41 <li><a href="check-config.html">check-config</a></li>
39 </ul> 42 </ul>
40 <li><a href="configuration.html">Configuration</a></li> 43 <li><a href="configuration.html">Configuration</a></li>
41 <li><a href="encryption.html">Encryption</a></li> 44 <li><a href="encryption.html">Encryption</a></li>
52 <li><a href="archive.html">archive</a></li> 55 <li><a href="archive.html">archive</a></li>
53 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li> 56 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
54 <li><a href="delete-conflicts.html">delete-conflicts</a></li> 57 <li><a href="delete-conflicts.html">delete-conflicts</a></li>
55 <li><a href="trash-info.html">trash-info</a></li> 58 <li><a href="trash-info.html">trash-info</a></li>
56 <li><a href="empty-trash.html">empty-trash</a></li> 59 <li><a href="empty-trash.html">empty-trash</a></li>
60 <li><a href="add-tag.html">add-tag</a></li>
61 <li><a href="remove-tag.html">remove-tag</a></li>
62 <li><a href="set-tags.html">set-tags</a></li>
63 <li><a href="list-tags.html">list-tags</a></li>
57 <li><a href="add-directory.html">add-directory</a></li> 64 <li><a href="add-directory.html">add-directory</a></li>
58 <li><a href="list-directories.html">list-directories</a></li> 65 <li><a href="list-directories.html">list-directories</a></li>
59 <li><a href="sync-check-config.html">check-config</a></li> 66 <li><a href="sync-check-config.html">check-config</a></li>
60 <li><a href="check-repositories.html">check-repositories</a></li> 67 <li><a href="check-repositories.html">check-repositories</a></li>
61 </ul> 68 </ul>
125 <h3 id="lock-timeout">lock-timeout</h3> 132 <h3 id="lock-timeout">lock-timeout</h3>
126 <p>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.</p> 133 <p>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.</p>
127 <p>Type: integer<br /> 134 <p>Type: integer<br />
128 Default: 0<br /> 135 Default: 0<br />
129 Example: <code>&lt;lock-timeout&gt;50&lt;/lock-timeout&gt;</code></p> 136 Example: <code>&lt;lock-timeout&gt;50&lt;/lock-timeout&gt;</code></p>
137 <h3 id="tagconfig">tagconfig</h3>
138 <p>Configures the local store for resource tags. If this element is specified, resource tags are stored locally.</p>
139 <p>Optional elements: local-store, detect-changes, xattr-name, on-conflict</p>
140 <h3 id="local-store">local-store</h3>
141 <p>Specifies the tag-store type. Currently the only available type is <code>xattr</code>.</p>
142 <p>The element can contain the attribute <code>format</code> with one of the following values: <code>text</code>, <code>csv</code>, <code>xml</code>, <code>macos</code>. The default value is <code>text</code>.</p>
143 <p>Type: tagstore type enum<br />
144 Default: xattr<br />
145 Example: <code>&lt;local-store format=&quot;csv&quot;&gt;xattr&lt;/local-store&gt;</code></p>
146 <h3 id="xattr-name">xattr-name</h3>
147 <p>Specifies the name of the extended attribute for storing tags. The default value is <code>tags</code>, unless you are using the <code>macos</code> format, where the default value is <code>com.apple.metadata:_kMDItemUserTags</code>.</p>
148 <p>Type: string<br />
149 Default: tags<br />
150 Example: `<xattr-name>file_tags</xattr-name></p>
151 <h3 id="detect-changes">detect-changes</h3>
152 <p>Controls, if tag changes should be detected.</p>
153 <p>Type: boolean<br />
154 Default: false<br />
155 Example: <code>&lt;detect-changes&gt;true&lt;/detect-changes&gt;</code></p>
156 <h3 id="on-conflict">on-conflict</h3>
157 <p>Specifies the behavior, when tag conflicts occur. Possible values are: <code>no_conflict</code>, <code>keep_local</code>, <code>keep_remote</code>, <code>merge</code></p>
158 <p>Type: onconflict enum<br />
159 Default: no_conflict<br />
160 Example: <code>&lt;on-conflict&gt;merge&lt;/on-conflict&gt;</code></p>
130 <h3 id="filter">filter</h3> 161 <h3 id="filter">filter</h3>
131 <p>With the filter element, include and exclude filters can be specified, to control which files are synchronized. The <em>pull</em> and <em>push</em> 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.</p> 162 <p>With the filter element, include and exclude filters can be specified, to control which files are synchronized. The <em>pull</em>, <em>push</em> and <em>archive</em> 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.</p>
163 <p>It is also possible to filter resources by tags. Tags can dynamically be applied to individual files. The tag filter elements contains a tag filter expression. Only files that match the filter expression are synchronized.</p>
132 <p>Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.</p> 164 <p>Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.</p>
133 <p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code></p> 165 <p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>, <code>&lt;tags&gt;</code></p>
134 <h3 id="include">include</h3> 166 <h3 id="include">include</h3>
135 <p>Controls which files will be included by <em>pull</em> and <em>push</em>. If an include filter is specified, only files matching this filter are included.</p> 167 <p>Controls which files will be included by <em>pull</em> and <em>push</em>. If an include filter is specified, only files matching this filter are included.</p>
136 <p>Type: regex string<br /> 168 <p>Type: regex string<br />
137 Default: .*<br /> 169 Default: .*<br />
138 Example:</p> 170 Example:</p>
145 Example:</p> 177 Example:</p>
146 <pre><code>&lt;filter&gt; 178 <pre><code>&lt;filter&gt;
147 &lt;exclude&gt;^/secretdir&lt;/exclude&gt; 179 &lt;exclude&gt;^/secretdir&lt;/exclude&gt;
148 &lt;exclude&gt;\.DS_Store$&lt;/exclude&gt; 180 &lt;exclude&gt;\.DS_Store$&lt;/exclude&gt;
149 &lt;/filter&gt;</code></pre> 181 &lt;/filter&gt;</code></pre>
182 <h3 id="tags">tags</h3>
183 <p>Filters resources by tags. Only resources, that are not a collection, are effected. If tags are not stored locally, the pull command still uses the filter.</p>
184 <p>Filter Syntax:</p>
185 <pre><code>filter ::= operator? , (tag_list | (&quot;(&quot; , filter , &quot;)&quot;)+)
186 tag_list ::= tag , (&quot;,&quot; tag)*
187 operator ::= &quot;&amp;&quot; | &quot;|&quot; | &quot;1&quot; | &quot;0&quot;</code></pre>
188 <p>Type: tag filter expression<br />
189 Example:</p>
190 <pre><code>&lt;filter&gt;
191 &lt;!-- sync only resources that have one of this tags --&gt;
192 &lt;tags&gt;| (tag1, tag2, tag3)&lt;/tags&gt;
193 &lt;/filter&gt;</code></pre>
150 </div> 194 </div>
151 <!-- end content --> 195 <!-- end content -->
152 </body> 196 </body>
153 </html> 197 </html>

mercurial