Mercurial > hg > dav / changeset

--- a/docs/html/date.html	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/html/date.html	Sat Aug 05 11:33:17 2017 +0200
@@ -66,7 +66,7 @@
 <div class="content">
 <h1 id="dav-date">dav date</h1>
 <p><strong><code>date [url]</code></strong></p>
-<p>The purpose of this command is to get the current date from a server and print it on stdout (http date format). This in useful in combination with the <code>-U</code> option for the <code>list</code> and <code>get</code> command.</p>
+<p>The purpose of this command is to get the current date from a server and print it to stdout (HTTP date format). This in useful in combination with the <code>-U</code> option for the <code>list</code> and <code>get</code> command.</p>
 <p>The <em>url</em> can be any http url. If no <em>url</em> is specified, the local time is used.</p>
 <h3 id="example-incremental-dav-get">Example: incremental dav get</h3>
 <p>It is possible to download only resources, which are modified since a specified date. The <em>date</em> command allows you to easily store the date of the last <em>get</em>.</p>

--- a/docs/html/delete-conflicts.html	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/html/delete-conflicts.html	Sat Aug 05 11:33:17 2017 +0200
@@ -66,7 +66,7 @@
 <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>
+<p>Deletes all files that are marked as a conflict. This will always delete the files and does not move them to the trash directory.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/empty-trash.html	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/html/empty-trash.html	Sat Aug 05 11:33:17 2017 +0200
@@ -66,7 +66,7 @@
 <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>
+<p>Removes all files from the trash directory of the given sync-directory.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/encryption.html	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/html/encryption.html	Sat Aug 05 11:33:17 2017 +0200
@@ -66,7 +66,7 @@
 <div class="content">
 <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>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 disguised by a random name but the name used by the client is stored encrypted as a WebDAV property. This means, an attacker can see the directory structure and the file length, but can't guess the file names and in particular 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 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;
@@ -74,9 +74,9 @@
     &lt;file&gt;keys/mykey1&lt;/file&gt;
 &lt;/key&gt; </code></pre>
 <p>The file path must be relative to <code>$HOME/.dav/</code>. In this example the file <code>$HOME/.dav/keys/mykey1</code> is loaded.</p>
-<p>To generate a key use <strong><code>dd</code></strong> on unix like systems.</p>
+<p>To generate a key use <strong><code>dd</code></strong> on unix like systems. The following command generates a 256 bit (32 bytes) key for AES256 encryption.</p>
 <pre><code>dd if=/dev/random of=mykey1 bs=32 count=1</code></pre>
-<p>After a key is configured, you can enable encryption/decryption in two ways. You can use the dav option <strong><code>-c</code></strong> to enable encryption and specify your key with the <strong><code>-k</code></strong> option. The alternative is to enable encryption by default for a repository in the config.xml file.</p>
+<p>After a key is configured, you can enable encryption/decryption in two ways. You can use the dav option <strong><code>-c</code></strong> to enable encryption and specify your key with the <strong><code>-k</code></strong> option. The alternative is to enable encryption by default for a repository in the config.xml file. You may also choose to specify the default key only and use <strong><code>-c</code></strong> where you like to use encryption.</p>
 <pre><code>&lt;repository&gt;
     &lt;name&gt;myrepo&lt;/name&gt;
     &lt;url&gt;http://example.com/webdav/&lt;/url&gt;
@@ -89,7 +89,7 @@
 <p>When a resource is encrypted, some crypto properties (namespace: http://davutils.org/) are set for the resource.</p>
 <ul>
 <li>crypto-key: Contains the name of the key used for encryption. The presence of this property indicates that the resource is encrypted</li>
-<li>crypto-hash: A Hash of the cleartext, encrypted and base64 encoded</li>
+<li>crypto-hash: A hash of the cleartext, encrypted and base64 encoded</li>
 <li>crypto-name: The name of the resource, encrypted and base64 encoded. This property is not used if name encryption is disabled.</li>
 </ul>
 </div>

--- a/docs/src/date.md	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/src/date.md	Sat Aug 05 11:33:17 2017 +0200
@@ -3,7 +3,7 @@
 
 **`date [url]`**
 
-The purpose of this command is to get the current date from a server and print it on stdout (http date format). This in useful in combination with the `-U` option for the `list` and `get` command.
+The purpose of this command is to get the current date from a server and print it to stdout (HTTP date format). This in useful in combination with the `-U` option for the `list` and `get` command.
 
 The *url* can be any http url. If no *url* is specified, the local time is used.
 

--- a/docs/src/delete-conflicts.md	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/src/delete-conflicts.md	Sat Aug 05 11:33:17 2017 +0200
@@ -3,4 +3,5 @@
 
 **`delete-conflicts <directory>`**
 
-Deletes all files that are marked as a conflict. This will always delete files and does not move them to the trash directory.
+Deletes all files that are marked as a conflict. This will always delete the files and does not move them to the trash directory.
+

--- a/docs/src/empty-trash.md	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/src/empty-trash.md	Sat Aug 05 11:33:17 2017 +0200
@@ -3,4 +3,5 @@
 
 **`empty-trash <directory>`**
 
-Removes all files from the trash directory for a given sync-directory.
+Removes all files from the trash directory of the given sync-directory.
+

--- a/docs/src/encryption.md	Sat Aug 05 11:08:34 2017 +0200
+++ b/docs/src/encryption.md	Sat Aug 05 11:33:17 2017 +0200
@@ -3,7 +3,7 @@
 
 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 **must** support WebDAV dead properties.
 
-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.
+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 disguised by a random name but the name used by the client is stored encrypted as a WebDAV property. This means, an attacker can see the directory structure and the file length, but can't guess the file names and in particular which files have the same name.
 
 To enable encryption a key must be configured in `$HOME/.dav/config.xml`. 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.
 
@@ -16,11 +16,12 @@
 
 The file path must be relative to `$HOME/.dav/`. In this example the file `$HOME/.dav/keys/mykey1` is loaded.
 
-To generate a key use **`dd`** on unix like systems.
+To generate a key use **`dd`** on unix like systems. The following command generates a 256 bit (32 bytes) key for AES256 encryption.
 
 	dd if=/dev/random of=mykey1 bs=32 count=1
 
 After a key is configured, you can enable encryption/decryption in two ways. You can use the dav option **`-c`** to enable encryption and specify your key with the **`-k`** option. The alternative is to enable encryption by default for a repository in the config.xml file.
+You may also choose to specify the default key only and use **`-c`** where you like to use encryption.
 
 	<repository>
 		<name>myrepo</name>
@@ -40,7 +41,7 @@
 When a resource is encrypted, some crypto properties (namespace: http://davutils.org/) are set for the resource.
 
  - crypto-key: Contains the name of the key used for encryption. The presence of this property indicates that the resource is encrypted
- - crypto-hash: A Hash of the cleartext, encrypted and base64 encoded
+ - crypto-hash: A hash of the cleartext, encrypted and base64 encoded
  - crypto-name: The name of the resource, encrypted and base64 encoded. This property is not used if name encryption is disabled.