dav: comparison docs/html/sync-configuration.html

-:2e3a24b9896a
+:8b88efcbf56f
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
 <head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta charset="utf-8" />
-<meta http-equiv="Content-Style-Type" content="text/css" />
 <meta name="generator" content="pandoc" />
+<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
 <title>Configuration</title>
-<style type="text/css">code{white-space: pre;}</style>
+<style type="text/css">
-<link rel="stylesheet" href="davdoc.css" type="text/css" />
+code{white-space: pre-wrap;}
+span.smallcaps{font-variant: small-caps;}
+span.underline{text-decoration: underline;}
+div.column{display: inline-block; vertical-align: top; width: 50%;}
+</style>
+<link rel="stylesheet" href="davdoc.css" />
+<!--[if lt IE 9]>
+<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+<![endif]-->
 </head>
 <body>
 <div class="header">
 	<a href="./index.html"><span>DavUtils documentation</span></a>
 </div>
 						<li><a href="put.html">put</a></li>
 						<li><a href="mkdir.html">mkdir</a></li>
 						<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="rename.html">rename</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>
 						<li><a href="lock.html">lock</a></li>
 						<li><a href="unlock.html">unlock</a></li>
 						<li><a href="info.html">info</a></li>
 						<li><a href="date.html">date</a></li>
+						<li><a href="versioncontrol.html">versioncontrol</a></li>
+						<li><a href="list-versions.html">list-versions</a></li>
+						<li><a href="checkout.html">checkout</a></li>
+						<li><a href="checkin.html">checkin</a></li>
+						<li><a href="uncheckout.html">uncheckout</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="repository-url.html">repository-url</a></li>
+						<li><a href="add-user.html">add-user</a></li>
+						<li><a href="remove-user.html">remove-user</a></li>
+						<li><a href="edit-user.html">edit-user</a></li>
+						<li><a href="list-users.html">list-users</a></li>
 						<li><a href="check-config.html">check-config</a></li>
 					</ul>
 				<li><a href="configuration.html">Configuration</a></li>
 				<li><a href="encryption.html">Encryption</a></li>
 			</ul>
 				<li><a href="sync-commands.html">Commands</a></li>
 					<ul>
 						<li><a href="pull.html">pull</a></li>
 						<li><a href="push.html">push</a></li>
 						<li><a href="archive.html">archive</a></li>
-<li><a href="list-conflicts.html">list-conflicts</a></li>
+						<li><a href="restore.html">restore</a></li>
+						<li><a href="list-conflicts.html">list-conflicts</a></li>
 						<li><a href="resolve-conflicts.html">resolve-conflicts</a></li>
 						<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="list-versions.html">list-versions</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>
 	</div>
 </div>
 <!-- begin content -->
 <div class="content">
-<div id="header">
+<header>
 <h1 class="title">Configuration</h1>
-</div>
+</header>
 <p>The file <code>$HOME/.dav/sync.xml</code> is used for configuring sync-directories.</p>
 <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;lock-timeout&gt;</code>, <code>&lt;filter&gt;</code></p>
+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>, <code>&lt;metadata&gt;</code>, <code>&lt;versioning&gt;</code>, <code>&lt;splitconfig&gt;</code>, <code>&lt;symlink-intern&gt;</code>, <code>&lt;symlink-extern&gt;</code>, <code>&lt;tagconfig&gt;</code>, <code>&lt;allow-cmd&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>
 <h3 id="repository">repository</h3>
 <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>
+<h3 id="hashing">hashing</h3>
+<p>Enables file hashing. The hash will be used for checking if files are modified and should be synchronized.</p>
+<p>Type: boolean<br />
+Default: false<br />
+Example: <code>&lt;hashing&gt;true&lt;/hashing&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>
+<h3 id="push-strategy">push-strategy</h3>
+<p>Controls the strategy <em>push</em> uses for deciding which files should be pushed. Possible values are: <code>metadata</code> and <code>hash</code>.</p>
+<p>Type: pushstrategy enum<br />
+Default: metadata Example: <code>&lt;push-strategy&gt;hash&lt;/push-strategy&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>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>
 <h3 id="lock-timeout">lock-timeout</h3>
-<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>
+<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>
 <p>Type: integer<br />
 Default: 0<br />
 Example: <code>&lt;lock-timeout&gt;50&lt;/lock-timeout&gt;</code></p>
+<h3 id="metadata">metadata</h3>
+<p>Controls which file metadata should be synchronized. Possible values are: <code>mtime</code>, <code>mode</code>, <code>xattr</code> and <code>all</code>. If this element is not specified, no metadata will be synchronized.</p>
+<p>Type: list of metadata<br />
+Example: <code>&lt;metadata&gt;mtime mode&lt;/metadata&gt;</code></p>
+<h3 id="versioning">versioning</h3>
+<p>Enables resource versioning for the commands <em>push</em> and <em>archive</em>.</p>
+<p>Possible attributes: <code>type</code>, <code>always</code></p>
+<p>The attribute <code>type</code> sets the versioning method type. Possible values are <code>simple</code> and <code>deltav</code>. With <em>simple</em> versioning, resources are moved to a version history collection before the new content is uploaded. With <em>deltav</em>, the DeltaV methods <em>checkout</em> and <em>checkin</em> are used to store versions. The default value of the <code>type</code> attribute is <code>simple</code>.</p>
+<p>The boolean attribute <code>always</code> specifies if new versions should be always created. The default value is <code>false</code>.</p>
+<p>Optional elements: <code>&lt;history&gt;</code> Example: <code>&lt;versioning type=&quot;simple&quot; always=&quot;true&quot; /&gt;</code></p>
+<h3 id="history">history</h3>
+<p>Specifies the history collection path for <em>simple</em> versioning. The path is interpreted relatively to the root of the sync directory.</p>
+<p>Type: string<br />
+Default: <code>/.dav-version-history</code> Example:</p>
+<pre><code>&lt;versioning type=&quot;simple&quot;&gt;
+&lt;history&gt;/.backup/&lt;/history&gt;
+&lt;/versioning&gt;</code></pre>
+<h3 id="symlink-intern">symlink-intern</h3>
+<p>Configures the handling of symlinks, which have a target inside the sync directory. Possible values are: <code>sync</code>, <code>follow</code> and <code>ignore</code>.</p>
+<p>Type: symlink enum<br />
+Default: follow<br />
+Example: <code>&lt;symlink-intern&gt;sync&lt;/symlink-intern&gt;</code></p>
+<h2 id="symlink-extern">symlink-extern</h2>
+<p>Configures the handling of symlinks, which have a target outside the sync directory. Possible values are: <code>follow</code> and <code>ignore</code>. Unlike internal symlinks, external symlinks cannot be synced.</p>
+<p>Type: symlink enum<br />
+Default: follow<br />
+Example: <code>&lt;symlink-extern&gt;ignore&lt;/symlink-extern&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>
 <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="splitconfig">splitconfig</h3>
+<p>Parent element for all <code>&lt;split&gt;</code> elements.</p>
+<h3 id="split">split</h3>
+<p>Configures if and how files should be splitted into multiple parts on <em>push</em>.</p>
+<p>The blocksize element configures the size of each part.</p>
+<p>The elements filter and minsize specify, in which case the files should be splitted.</p>
+<p>Required elements: <code>&lt;blocksize&gt;</code><br />
+Optional elements: <code>&lt;filter&gt;</code>, <code>&lt;minsize&gt;</code></p>
+<p>Example:</p>
+<pre><code>&lt;splitconfig&gt;
+&lt;!-- split all files with .vmdk file extension that are bigger than 100mb --&gt;
+&lt;split&gt;
+&lt;blocksize&gt;10m&lt;/blocksize&gt;
+&lt;filter&gt;
+&lt;include&gt;\.vmdk$&lt;/include&gt;
+&lt;/filter&gt;
+&lt;minsize&gt;100m&lt;/minsize&gt;
+&lt;/split&gt;
+&lt;/splitconfig&gt;</code></pre>
+<h3 id="blocksize">blocksize</h3>
+<p>Specifies the size of each file part.</p>
+<p>Type: size<br />
+Example: <code>&lt;blocksize&gt;100k&lt;/blocksize&gt;</code></p>
+<h3 id="minsize">minsize</h3>
+<p>Specifies the minimal size a file must have for enabling file splitting.</p>
+<p>Type: size<br />
+Default: 0<br />
+Example: <code>&lt;minsize&gt;100m&lt;/minsize&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>, <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>, <code>&lt;tags&gt;</code></p>

Mercurial > hg > dav / file comparison

comparison: docs/html/sync-configuration.html

docs/html/sync-configuration.html