docs/src/add-directory.md

changeset 275
fa48ab29abd2
parent 273
c743721d566f
child 276
20a176d5a53e
--- 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 
+

mercurial