docs/html/sync-configuration.html

changeset 429
1607450065ba
parent 320
12ed560c926c
child 563
3dffe58a573f
--- a/docs/html/sync-configuration.html	Sun Jun 24 11:51:07 2018 +0200
+++ b/docs/html/sync-configuration.html	Sun Jun 24 12:18:12 2018 +0200
@@ -26,6 +26,8 @@
 						<li><a href="remove.html">remove</a></li>
 						<li><a href="copy.html">copy</a></li>
 						<li><a href="move.html">move</a></li>
+						<li><a href="export.html">export</a></li>
+						<li><a href="import.html">import</a></li>
 						<li><a href="get-property.html">get-property</a></li>
 						<li><a href="set-property.html">set-property</a></li>
 						<li><a href="remove-property.html">remove-property</a></li>
@@ -34,6 +36,7 @@
 						<li><a href="info.html">info</a></li>
 						<li><a href="date.html">date</a></li>
 						<li><a href="add-repository.html">add-repository</a></li>
+						<li><a href="remove-repository.html">remove-repository</a></li>
 						<li><a href="list-repositories.html">list-repositories</a></li>
 						<li><a href="check-config.html">check-config</a></li>
 					</ul>
@@ -54,6 +57,10 @@
 						<li><a href="delete-conflicts.html">delete-conflicts</a></li>
 						<li><a href="trash-info.html">trash-info</a></li>
 						<li><a href="empty-trash.html">empty-trash</a></li>
+						<li><a href="add-tag.html">add-tag</a></li>
+						<li><a href="remove-tag.html">remove-tag</a></li>
+						<li><a href="set-tags.html">set-tags</a></li>
+						<li><a href="list-tags.html">list-tags</a></li>
 						<li><a href="add-directory.html">add-directory</a></li>
 						<li><a href="list-directories.html">list-directories</a></li>
 						<li><a href="sync-check-config.html">check-config</a></li>
@@ -127,10 +134,35 @@
 <p>Type: integer<br />
 Default: 0<br />
 Example: <code>&lt;lock-timeout&gt;50&lt;/lock-timeout&gt;</code></p>
+<h3 id="tagconfig">tagconfig</h3>
+<p>Configures the local store for resource tags. If this element is specified, resource tags are stored locally.</p>
+<p>Optional elements: local-store, detect-changes, xattr-name, on-conflict</p>
+<h3 id="local-store">local-store</h3>
+<p>Specifies the tag-store type. Currently the only available type is <code>xattr</code>.</p>
+<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>
+<p>Type: tagstore type enum<br />
+Default: xattr<br />
+Example: <code>&lt;local-store format=&quot;csv&quot;&gt;xattr&lt;/local-store&gt;</code></p>
+<h3 id="xattr-name">xattr-name</h3>
+<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>
+<p>Type: string<br />
+Default: tags<br />
+Example: `<xattr-name>file_tags</xattr-name></p>
+<h3 id="detect-changes">detect-changes</h3>
+<p>Controls, if tag changes should be detected.</p>
+<p>Type: boolean<br />
+Default: false<br />
+Example: <code>&lt;detect-changes&gt;true&lt;/detect-changes&gt;</code></p>
+<h3 id="on-conflict">on-conflict</h3>
+<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>
+<p>Type: onconflict enum<br />
+Default: no_conflict<br />
+Example: <code>&lt;on-conflict&gt;merge&lt;/on-conflict&gt;</code></p>
 <h3 id="filter">filter</h3>
-<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>
+<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>
+<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>
 <p>Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.</p>
-<p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code></p>
+<p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code>, <code>&lt;tags&gt;</code></p>
 <h3 id="include">include</h3>
 <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>
 <p>Type: regex string<br />
@@ -147,6 +179,18 @@
     &lt;exclude&gt;^/secretdir&lt;/exclude&gt;
     &lt;exclude&gt;\.DS_Store$&lt;/exclude&gt;
 &lt;/filter&gt;</code></pre>
+<h3 id="tags">tags</h3>
+<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>
+<p>Filter Syntax:</p>
+<pre><code>filter ::= operator? , (tag_list | (&quot;(&quot; , filter , &quot;)&quot;)+)
+tag_list ::= tag , (&quot;,&quot; tag)*
+operator ::= &quot;&amp;&quot; | &quot;|&quot; | &quot;1&quot; | &quot;0&quot;</code></pre>
+<p>Type: tag filter expression<br />
+Example:</p>
+<pre><code>&lt;filter&gt;
+    &lt;!-- sync only resources that have one of this tags --&gt;
+    &lt;tags&gt;| (tag1, tag2, tag3)&lt;/tags&gt;
+&lt;/filter&gt;</code></pre>
 </div>
 <!-- end content -->
 </body>

mercurial