docs/html/sync-configuration.html

changeset 320
12ed560c926c
parent 294
dd5c0ebdf54f
child 429
1607450065ba
equal deleted inserted replaced
319:2433b5969d44 320:12ed560c926c
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="get-property.html">get-property</a></li> 29 <li><a href="get-property.html">get-property</a></li>
30 <li><a href="set-property.html">set-property</a></li> 30 <li><a href="set-property.html">set-property</a></li>
31 <li><a href="remove-property.html">remove-property</a></li>
31 <li><a href="lock.html">lock</a></li> 32 <li><a href="lock.html">lock</a></li>
32 <li><a href="unlock.html">unlock</a></li> 33 <li><a href="unlock.html">unlock</a></li>
33 <li><a href="info.html">info</a></li> 34 <li><a href="info.html">info</a></li>
34 <li><a href="date.html">date</a></li> 35 <li><a href="date.html">date</a></li>
35 <li><a href="add-repository.html">add-repository</a></li> 36 <li><a href="add-repository.html">add-repository</a></li>
46 <li><a href="introduction.html">Introduction</a></li> 47 <li><a href="introduction.html">Introduction</a></li>
47 <li><a href="sync-commands.html">Commands</a></li> 48 <li><a href="sync-commands.html">Commands</a></li>
48 <ul> 49 <ul>
49 <li><a href="pull.html">pull</a></li> 50 <li><a href="pull.html">pull</a></li>
50 <li><a href="push.html">push</a></li> 51 <li><a href="push.html">push</a></li>
52 <li><a href="archive.html">archive</a></li>
51 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li> 53 <li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
52 <li><a href="delete-conflicts.html">delete-conflicts</a></li> 54 <li><a href="delete-conflicts.html">delete-conflicts</a></li>
53 <li><a href="trash-info.html">trash-info</a></li> 55 <li><a href="trash-info.html">trash-info</a></li>
54 <li><a href="empty-trash.html">empty-trash</a></li> 56 <li><a href="empty-trash.html">empty-trash</a></li>
55 <li><a href="add-directory.html">add-directory</a></li> 57 <li><a href="add-directory.html">add-directory</a></li>
70 <p>The file <code>$HOME/.dav/sync.xml</code> is used for configuring sync-directories.</p> 72 <p>The file <code>$HOME/.dav/sync.xml</code> is used for configuring sync-directories.</p>
71 <p>The <em>sync.xml</em> file is an XML file with <code>&lt;configuration&gt;</code> as root element. This element can only have <code>&lt;directory&gt;</code> elements as children.</p> 73 <p>The <em>sync.xml</em> file is an XML file with <code>&lt;configuration&gt;</code> as root element. This element can only have <code>&lt;directory&gt;</code> elements as children.</p>
72 <h2 id="directory">directory</h2> 74 <h2 id="directory">directory</h2>
73 <p>This element configures a sync-directory. A sync-directory must have a unique name, a (local) path, repository and a database.</p> 75 <p>This element configures a sync-directory. A sync-directory must have a unique name, a (local) path, repository and a database.</p>
74 <p>Required elements: <code>&lt;name&gt;</code>, <code>&lt;repository&gt;</code>, <code>&lt;path&gt;</code>, <code>&lt;database&gt;</code><br /> 76 <p>Required elements: <code>&lt;name&gt;</code>, <code>&lt;repository&gt;</code>, <code>&lt;path&gt;</code>, <code>&lt;database&gt;</code><br />
75 Optional elements: <code>&lt;collection&gt;</code>, <code>&lt;trash&gt;</code>, <code>&lt;max-retry&gt;</code>, <code>&lt;backup-on-pull&gt;</code>, <code>&lt;lock-pull&gt;</code>, <code>&lt;lock-push&gt;</code>, <code>&lt;filter&gt;</code></p> 77 Optional elements: <code>&lt;collection&gt;</code>, <code>&lt;trash&gt;</code>, <code>&lt;max-retry&gt;</code>, <code>&lt;backup-on-pull&gt;</code>, <code>&lt;lock-pull&gt;</code>, <code>&lt;lock-push&gt;</code>, <code>&lt;lock-timeout&gt;</code>, <code>&lt;filter&gt;</code></p>
76 <h3 id="name">name</h3> 78 <h3 id="name">name</h3>
77 <p>Unique sync-directory identifer. This identifer is used in combination with all <em>dav-sync</em> commands.</p> 79 <p>Unique sync-directory identifer. This identifer is used in combination with all <em>dav-sync</em> commands.</p>
78 <p>Type: string<br /> 80 <p>Type: string<br />
79 Example: <code>&lt;name&gt;mysyncdir&lt;/name&gt;</code></p> 81 Example: <code>&lt;name&gt;mysyncdir&lt;/name&gt;</code></p>
80 <h3 id="repository">repository</h3> 82 <h3 id="repository">repository</h3>
118 <h3 id="lock-push">lock-push</h3> 120 <h3 id="lock-push">lock-push</h3>
119 <p>Enables locking for the <em>push</em> command.</p> 121 <p>Enables locking for the <em>push</em> command.</p>
120 <p>Type: boolean<br /> 122 <p>Type: boolean<br />
121 Default: false<br /> 123 Default: false<br />
122 Example: <code>&lt;lock-push&gt;true&lt;/lock-push&gt;</code></p> 124 Example: <code>&lt;lock-push&gt;true&lt;/lock-push&gt;</code></p>
125 <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>
127 <p>Type: integer<br />
128 Default: 0<br />
129 Example: <code>&lt;lock-timeout&gt;50&lt;/lock-timeout&gt;</code></p>
123 <h3 id="filter">filter</h3> 130 <h3 id="filter">filter</h3>
124 <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> 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>
125 <p>Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.</p> 132 <p>Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator.</p>
126 <p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code></p> 133 <p>Optional elements: <code>&lt;include&gt;</code>, <code>&lt;exclude&gt;</code></p>
127 <h3 id="include">include</h3> 134 <h3 id="include">include</h3>

mercurial