docs/html/sync-configuration.html

changeset 285
02d3e4b1245f
parent 283
0e36bb75a732
child 294
dd5c0ebdf54f
--- a/docs/html/sync-configuration.html	Sun Aug 06 17:02:25 2017 +0200
+++ b/docs/html/sync-configuration.html	Sun Aug 06 18:18:00 2017 +0200
@@ -10,7 +10,7 @@
 </head>
 <body>
 <div class="header">
-	<span>davutils documentation</span>
+	<a href="./index.html"><span>DavUtils documentation</span></a>
 </div>
 <div class="sidebar">
 	<div class="nav">
@@ -71,71 +71,52 @@
 <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>
 <h2 id="directory">directory</h2>
 <p>This element configures a sync-directory. A sync-directory must have a unique name, a (local) path, repository and a database.</p>
-<p>Required elements: <code>&lt;name&gt;</code>, <code>&lt;repository&gt;</code>, <code>&lt;path&gt;</code>, <code>&lt;database&gt;</code><br />
-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>
+<p>Required elements: <code>&lt;name&gt;</code>, <code>&lt;repository&gt;</code>, <code>&lt;path&gt;</code>, <code>&lt;database&gt;</code><br />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>
 <h3 id="name">name</h3>
 <p>Unique sync-directory identifer. This identifer is used in combination with all <em>dav-sync</em> commands.</p>
-<p>Type: string<br />
-Example: <code>&lt;name&gt;mysyncdir&lt;/name&gt;</code></p>
+<p>Type: string<br />Example: <code>&lt;name&gt;mysyncdir&lt;/name&gt;</code></p>
 <h3 id="repository">repository</h3>
 <p>Name of the WebDAV-repository. A repository with the same name must be configured in [config.xml][1].</p>
-<p>Type: string<br />
-Example: <code>&lt;name&gt;myrepo&lt;/name&gt;</code></p>
+<p>Type: string<br />Example: <code>&lt;name&gt;myrepo&lt;/name&gt;</code></p>
 <h3 id="path">path</h3>
 <p>The path of the local directory that should be synchronized. The path must be an absolute path or start with an environment variable. A path with an environment variable must start with an <code>$</code> followed by the variable name optionally followed by a path. For example:</p>
 <pre><code>`&lt;path&gt;$HOME/Documents&lt;/path&gt;`</code></pre>
 <p>The part between <code>$</code> and <code>/</code> is the environment variable name.</p>
-<p>Type: string<br />
-Example: <code>&lt;path&gt;/absolute/path&lt;/path&gt;</code></p>
+<p>Type: string<br />Example: <code>&lt;path&gt;/absolute/path&lt;/path&gt;</code></p>
 <h3 id="database">database</h3>
 <p>Path to the database file used for this sync-directory. The path must be relative to the <em>$HOME/.dav/</em> directory.</p>
-<p>Type: string<br />
-Example: <code>&lt;database&gt;myrepo-db.xml&lt;/database&gt;</code></p>
+<p>Type: string<br />Example: <code>&lt;database&gt;myrepo-db.xml&lt;/database&gt;</code></p>
 <h3 id="collection">collection</h3>
 <p>Path of the collection relative to the repository root collection. For example if the repository url is <em>http://example.com/webdav/</em> and the collection value is <em>/myfiles/</em>, the directory is synchronized with <em>http://example.com/webdav/myfiles/</em></p>
-<p>Type: string<br />
-Default: /<br />
-Example: <code>&lt;collection&gt;/myfiles&lt;/collection&gt;</code></p>
+<p>Type: string<br />Default: /<br />Example: <code>&lt;collection&gt;/myfiles&lt;/collection&gt;</code></p>
 <h3 id="trash">trash</h3>
 <p>Path to the trash directory for this sync-directory. Files that should be deleted will be moved to this directory. The value must be an absolute path or relative to the sync-directory path.</p>
-<p>Type: string<br />
-Example: <code>&lt;trash&gt;.trash&lt;/trash&gt;</code></p>
+<p>Type: string<br />Example: <code>&lt;trash&gt;.trash&lt;/trash&gt;</code></p>
 <h3 id="max-retry">max-retry</h3>
 <p>This integer value controls how many attempts of downloading/uploading a file in case of an error are made.</p>
-<p>Type: integer<br />
-Default: 0<br />
-Example: <code>&lt;max-retry&gt;3&lt;/max-retry&gt;</code></p>
+<p>Type: integer<br />Default: 0<br />Example: <code>&lt;max-retry&gt;3&lt;/max-retry&gt;</code></p>
 <h3 id="backup-on-pull">backup-on-pull</h3>
 <p>If this element has the value of true, the <em>pull</em> command will move old local files to the trash directory before downloading the new version from the server.</p>
-<p>Type: boolean<br />
-Default: false<br />
-Example: <code>&lt;backup-on-pull&gt;true&lt;/backup-on-pull&gt;</code></p>
+<p>Type: boolean<br />Default: false<br />Example: <code>&lt;backup-on-pull&gt;true&lt;/backup-on-pull&gt;</code></p>
 <h3 id="lock-pull">lock-pull</h3>
 <p>Enables locking for the <em>pull</em> command.</p>
-<p>Type: boolean<br />
-Default: false<br />
-Example: <code>&lt;lock-pull&gt;true&lt;/lock-pull&gt;</code></p>
+<p>Type: boolean<br />Default: false<br />Example: <code>&lt;lock-pull&gt;true&lt;/lock-pull&gt;</code></p>
 <h3 id="lock-push">lock-push</h3>
 <p>Enables locking for the <em>push</em> command.</p>
-<p>Type: boolean<br />
-Default: false<br />
-Example: <code>&lt;lock-push&gt;true&lt;/lock-push&gt;</code></p>
+<p>Type: boolean<br />Default: false<br />Example: <code>&lt;lock-push&gt;true&lt;/lock-push&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>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>
 <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 />
-Default: .*<br />
-Example:</p>
+<p>Type: regex string<br />Default: .*<br />Example:</p>
 <pre><code>&lt;filter&gt;
     &lt;include&gt;\.pdf$&lt;/include&gt;
 &lt;/filter&gt;</code></pre>
 <h3 id="exclude">exclude</h3>
 <p>Controls which files will be excluded by <em>pull</em> and <em>push</em>.</p>
-<p>Type: regex string<br />
-Example:</p>
+<p>Type: regex string<br />Example:</p>
 <pre><code>&lt;filter&gt;
     &lt;exclude&gt;^/secretdir&lt;/exclude&gt;
     &lt;exclude&gt;\.DS_Store$&lt;/exclude&gt;

mercurial