docs/src/add-directory.md

Sun, 06 Aug 2017 14:41:20 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Sun, 06 Aug 2017 14:41:20 +0200
changeset 283
0e36bb75a732
parent 276
20a176d5a53e
permissions
-rw-r--r--

adds dav-sync introduction and sync.xml documentation

---
title: 'dav-sync add-directory'
---

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]: ./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/webdav`.
Then `dav-sync` would synchronize `$HOME/important_files/` with `https://mynas.local/webdav/important_files`.


[3]: ./list-directories.html 

mercurial