Mercurial > hg > dav / changeset

--- a/docs/html/add-directory.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/add-directory.html	Sat Aug 05 09:36:03 2017 +0200
@@ -65,8 +65,21 @@
 <!-- begin content -->
 <div class="content">
 <h1 id="dav-sync-add-directory">dav-sync add-directory</h1>
-<p>The command runs an interactive assistant that creates a sync-directory configuration and adds it to the sync.xml file. Before running this command, a repository must be created. See <a href="./add-repository.html">dav add-repository</a>.</p>
+<p>This command runs an interactive assistant that creates a <a href="./sync-configuration.html">sync-directory configuration</a> and adds it to the sync.xml file. Before running this command, a repository must be created. See <a href="./add-repository.html">dav add-repository</a>.</p>
 <p><strong>Command alias:</strong> add-dir</p>
+<p>The assistant firstly asks for a unique sync-directory name. This may not match the physical directory name. If you are not sure, which names are already in use, you can get a list of currently present sync-directories with <a href="./list-directories.html">dav-sync list-directories</a>. Then you specifiy the local path, select the dav repository and specify the collection within that repository. You may use environment variables like <code>$HOME</code> within the path name. A call of <code>add-directory may</code> look like this.</p>
+<pre><code>$ dav-sync add-directory
+Each sync directory must have an unique name.
+name: mysyncdir
+Enter local directory path.
+path: $HOME/important_files
+Specify webdav repository.
+0) myfirstrepo
+1) anotherrepo
+repository: 0
+Enter collection relative to the repository base url.
+collection (default: /): /important_files</code></pre>
+<p>Assume <code>myfirstrepo</code> points to <code>https://mynas.local/</code>. Then <code>dav-sync</code> would synchronize <code>$HOME/important_files/</code> with <code>https://mynas.local/important_files</code>.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/check-repositories.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/check-repositories.html	Sat Aug 05 09:36:03 2017 +0200
@@ -64,7 +64,8 @@
 
 <!-- begin content -->
 <div class="content">
-
+<h1 id="dav-sync-check-repositories">dav-sync check-repositories</h1>
+<p>Checks if every repository used by sync-directories is configured and available.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/davdoc.css	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/davdoc.css	Sat Aug 05 09:36:03 2017 +0200
@@ -2,7 +2,7 @@
     font-family: sans-serif;
 }
 
-div.header {
+.header {
     padding-top: 0.3em;
     padding-bottom: 0.5em;
     margin-bottom: 2em;
@@ -11,31 +11,31 @@
     border-bottom-color: #2E2E2E;
 }
 
-div.header span {
+.header span {
     font-size: 2em;
     font-weight: bold;
     margin-left: 1em;
 }
 
-div.header img {
+.header img {
     float: right;
 }
 
-div.sidebar {
+.sidebar {
     float: left;
     width: 15em;
 }
 
-div.nav {
+.nav {
     color: black;
     background-color: #d2d2d2;
     margin-bottom: 1em;
     padding-bottom: 0.1em;
 }
 
-div.nav h3 {
+.nav h3 {
     color: white;
-    background-color: #1a3300;
+    background-color: #008080;
     font-size: 1.2em;
     padding-top: 0.2em;
     padding-bottom: 0.2em;
@@ -43,13 +43,27 @@
     margin-top: 0;
 }
 
-div.nav ul {
+.nav ul {
     margin-top: 0;
     padding-top: 0;
     font-size: 0.95em;
 }
 
-div.content {
+.nav a:link {
+	text-decoration: none;
+	color: black;
+}
+
+.nav a:visited {
+	text-decoration: none;
+	color: black;
+}
+
+.nav a:hover {
+	color: #e68a00;
+}
+
+.content {
     margin-left: 16em;
     padding: 0;
     font-family: serif;
@@ -57,9 +71,9 @@
     min-width: 16em;
 }
 
-div.content h1 {
+.content h1 {
     color: white;
-    background-color: #1a3300;
+    background-color: #008080;
     font-size: 1.2em;
     padding-top: 0.2em;
     padding-bottom: 0.2em;
@@ -68,11 +82,11 @@
     margin-top: 0;
 }
 
-div.content h2 {
+.content h2 {
     font-size: 1.2em;
 }
 
-div.content h3 {
+.content h3 {
     font-size: 1.05em;
 }
 

--- a/docs/html/delete-conflicts.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/delete-conflicts.html	Sat Aug 05 09:36:03 2017 +0200
@@ -64,7 +64,9 @@
 
 <!-- begin content -->
 <div class="content">
-
+<h1 id="dav-sync-delete-conflicts">dav-sync delete-conflicts</h1>
+<p><strong><code>delete-conflicts &lt;directory&gt;</code></strong></p>
+<p>Deletes all files that are marked as a conflict. This will always delete files and does not move them to the trash directory.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/empty-trash.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/empty-trash.html	Sat Aug 05 09:36:03 2017 +0200
@@ -64,7 +64,9 @@
 
 <!-- begin content -->
 <div class="content">
-
+<h1 id="dav-sync-empty-trash">dav-sync empty-trash</h1>
+<p><strong><code>empty-trash &lt;directory&gt;</code></strong></p>
+<p>Removes all files from the trash directory for a given sync-directory.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/encryption.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/encryption.html	Sat Aug 05 09:36:03 2017 +0200
@@ -67,7 +67,7 @@
 <h1 id="encryption">Encryption</h1>
 <p>The davutils programs have an integrated client-side encryption feature, that allows you to encrypt and decrypt on the fly with AES256 or AES128. To use this feature, the server <strong>must</strong> support WebDAV dead properties.</p>
 <p>The tools support both, encryption of the resource content and encryption of the resource name. Each resource is encrypted separately. With activated name encryption, the actual resource name is random but the name used by the client is stored encrypted in WebDAV properties. This means, an attacker can see the directory structure and the file length, but can't see which files have the same name.</p>
-<p>To enable encryption a key must be configured in <code>$HOME/.dav/config.xml</code>. A key must have an unique name. To access encrypted resources, all clients must configure the same key with the same name. Currently a key can only be loaded from a file and not generated from a password.</p>
+<p>To enable encryption a key must be configured in <code>$HOME/.dav/config.xml</code>. A key must have a unique name. To access encrypted resources, all clients must configure the same key with the same name. Currently a key can only be loaded from a file and not generated from a password.</p>
 <p>A configuration for a key looks like:</p>
 <pre><code>&lt;key&gt;
     &lt;name&gt;mykey1&lt;/name&gt;

--- a/docs/html/resolve-conflicts.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/resolve-conflicts.html	Sat Aug 05 09:36:03 2017 +0200
@@ -64,7 +64,9 @@
 
 <!-- begin content -->
 <div class="content">
-
+<h1 id="dav-sync-resolve-conflicts">dav-sync resolve-conflicts</h1>
+<p><strong><code>resolve-conflicts &lt;directory&gt;</code></strong></p>
+<p>Removes conflict entries from the database. This does not merge any files. All files which are marked as conflict are normal files after running this command.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/trash-info.html	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/html/trash-info.html	Sat Aug 05 09:36:03 2017 +0200
@@ -64,7 +64,9 @@
 
 <!-- begin content -->
 <div class="content">
-
+<h1 id="dav-sync-trash-info">dav-sync trash-info</h1>
+<p><strong><code>trash-info &lt;directory&gt;</code></strong></p>
+<p>Shows the trash directory path for a sync-directory, the number of files in there and the space consumption.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/src/Makefile	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/src/Makefile	Sat Aug 05 09:36:03 2017 +0200
@@ -79,5 +79,8 @@
 build/davdoc.css:
 	cp davdoc.css build
 
+dist: build
+	rm -Rf ../html; cp -R build ../html
+
 clean:
 	rm -Rf build

--- a/docs/src/add-directory.md	Fri Aug 04 20:03:21 2017 +0200
+++ b/docs/src/add-directory.md	Sat Aug 05 09:36:03 2017 +0200
@@ -1,8 +1,36 @@
 dav-sync add-directory
 ======================
 
-The command runs an interactive assistant that creates a sync-directory configuration and adds it to the sync.xml file. Before running this command, a repository must be created. See [dav add-repository][1].
+This command runs an interactive assistant that creates a [sync-directory configuration][1] and adds it to the sync.xml file.
+Before running this command, a repository must be created. See [dav add-repository][2].
 
-[1]: ./add-repository.html
+[1]: ./sync-configuration.html
+[2]: ./add-repository.html
 
 **Command alias:** add-dir
+
+The assistant firstly asks for a unique sync-directory name.
+This may not match the physical directory name.
+If you are not sure, which names are already in use, you can get a list of currently present sync-directories with [dav-sync list-directories][3].
+Then you specifiy the local path, select the dav repository and specify the collection within that repository.
+You may use environment variables like `$HOME` within the path name.
+A call of `add-directory may` look like this.
+
+	$ dav-sync add-directory
+	Each sync directory must have an unique name.
+	name: mysyncdir
+	Enter local directory path.
+	path: $HOME/important_files
+	Specify webdav repository.
+	0) myfirstrepo
+	1) anotherrepo
+	repository: 0
+	Enter collection relative to the repository base url.
+	collection (default: /): /important_files
+
+Assume `myfirstrepo` points to `https://mynas.local/`.
+Then `dav-sync` would synchronize `$HOME/important_files/` with `https://mynas.local/important_files`.
+
+
+[3]: ./list-directories.html 
+