Mercurial > hg > dav / changeset

--- a/docs/html/add-directory.html	Sat Aug 05 09:36:03 2017 +0200
+++ b/docs/html/add-directory.html	Sat Aug 05 09:56:51 2017 +0200
@@ -67,7 +67,7 @@
 <h1 id="dav-sync-add-directory">dav-sync add-directory</h1>
 <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>
+<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</code> may look like this.</p>
 <pre><code>$ dav-sync add-directory
 Each sync directory must have an unique name.
 name: mysyncdir
@@ -79,7 +79,7 @@
 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>
+<p>Assume <code>myfirstrepo</code> points to <code>https://mynas.local/webdav</code>. Then <code>dav-sync</code> would synchronize <code>$HOME/important_files/</code> with <code>https://mynas.local/webdav/important_files</code>.</p>
 </div>
 <!-- end content -->
 </body>

--- a/docs/html/add-repository.html	Sat Aug 05 09:36:03 2017 +0200
+++ b/docs/html/add-repository.html	Sat Aug 05 09:56:51 2017 +0200
@@ -65,8 +65,19 @@
 <!-- begin content -->
 <div class="content">
 <h1 id="dav-add-repository">dav add-repository</h1>
-<p>The command runs an interactive assistant that creates a repository configuration and adds it to the config.xml file.</p>
+<p>This command runs an interactive assistant that creates a repository <a href="./configuration.html">configuration</a> and adds it to the config.xml file.</p>
 <p><strong>Command alias:</strong> add-repo</p>
+<p>The assistant firstly asks for a unique repository name. If you are not sure, which names are already in use, you can get a list of currently present repositories with <a href="./list-repositories.html">dav list-repositories</a>. Then you specifiy the base URL and optional authentication information. Please keep in mind, that the password is stored base64 encoded in your configuration. If you do not want this to happen, leave the password blank. <code>dav</code> will ask you for the password when accessing the repository. Beware that you don't use password prompt in background jobs, though. A call of <code>add-repository</code> may look like this.</p>
+<pre><code>$ dav add-repository
+Each repository must have an unique name.
+name: myfirstrepo
+
+Specify the repository base url.
+url: https://mynas.local/webdav
+
+User for HTTP authentication.
+user (optional): mywebuser
+password (optional): </code></pre>
 </div>
 <!-- end content -->
 </body>

--- a/docs/src/Makefile	Sat Aug 05 09:36:03 2017 +0200
+++ b/docs/src/Makefile	Sat Aug 05 09:56:51 2017 +0200
@@ -68,7 +68,10 @@
 
 FILES = build/davdoc.css
 
-all: build $(HTML) $(FILES)
+all: doc
+
+doc: build $(HTML) $(FILES)
+
 
 build:
 	mkdir -p build
@@ -79,8 +82,9 @@
 build/davdoc.css:
 	cp davdoc.css build
 
-dist: build
+dist: doc
 	rm -Rf ../html; cp -R build ../html
 
-clean:
+clean: 
 	rm -Rf build
+

--- a/docs/src/add-directory.md	Sat Aug 05 09:36:03 2017 +0200
+++ b/docs/src/add-directory.md	Sat Aug 05 09:56:51 2017 +0200
@@ -14,7 +14,7 @@
 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.
+A call of `add-directory` may look like this.
 
 	$ dav-sync add-directory
 	Each sync directory must have an unique name.
@@ -28,8 +28,8 @@
 	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`.
+Assume `myfirstrepo` points to `https://mynas.local/webdav`.
+Then `dav-sync` would synchronize `$HOME/important_files/` with `https://mynas.local/webdav/important_files`.
 
 
 [3]: ./list-directories.html 

--- a/docs/src/add-repository.md	Sat Aug 05 09:36:03 2017 +0200
+++ b/docs/src/add-repository.md	Sat Aug 05 09:56:51 2017 +0200
@@ -1,6 +1,31 @@
 dav add-repository
 ==================
 
-The command runs an interactive assistant that creates a repository configuration and adds it to the config.xml file.
+This command runs an interactive assistant that creates a repository [configuration][1] and adds it to the config.xml file.
+
+[1]: ./configuration.html
 
 **Command alias:** add-repo
+
+The assistant firstly asks for a unique repository name.
+If you are not sure, which names are already in use, you can get a list of currently present repositories with [dav list-repositories][2].
+Then you specifiy the base URL and optional authentication information.
+Please keep in mind, that the password is stored base64 encoded in your configuration.
+If you do not want this to happen, leave the password blank.
+`dav` will ask you for the password when accessing the repository.
+Beware that you don't use password prompt in background jobs, though.
+A call of `add-repository` may look like this.
+
+	$ dav add-repository
+	Each repository must have an unique name.
+	name: myfirstrepo
+
+	Specify the repository base url.
+	url: https://mynas.local/webdav
+
+	User for HTTP authentication.
+	user (optional): mywebuser
+	password (optional): 
+
+[2]: ./list-repositories.html
+