docs/src/add-directory.md

Sat, 05 Aug 2017 10:12:12 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 05 Aug 2017 10:12:12 +0200
changeset 277
ccef3f2bfe8e
parent 276
20a176d5a53e
child 283
0e36bb75a732
permissions
-rw-r--r--

adds more documentation details the three check commands

273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
1 dav-sync add-directory
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
2 ======================
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
3
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
4 This command runs an interactive assistant that creates a [sync-directory configuration][1] and adds it to the sync.xml file.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
5 Before running this command, a repository must be created. See [dav add-repository][2].
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
6
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
7 [1]: ./sync-configuration.html
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
8 [2]: ./add-repository.html
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
9
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10 **Command alias:** add-dir
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
11
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
12 The assistant firstly asks for a unique sync-directory name.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
13 This may not match the physical directory name.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
14 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].
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
15 Then you specifiy the local path, select the dav repository and specify the collection within that repository.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
16 You may use environment variables like `$HOME` within the path name.
276
20a176d5a53e adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 275
diff changeset
17 A call of `add-directory` may look like this.
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
18
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
19 $ dav-sync add-directory
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
20 Each sync directory must have an unique name.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
21 name: mysyncdir
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
22 Enter local directory path.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
23 path: $HOME/important_files
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
24 Specify webdav repository.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
25 0) myfirstrepo
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
26 1) anotherrepo
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
27 repository: 0
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
28 Enter collection relative to the repository base url.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
29 collection (default: /): /important_files
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
30
276
20a176d5a53e adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 275
diff changeset
31 Assume `myfirstrepo` points to `https://mynas.local/webdav`.
20a176d5a53e adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 275
diff changeset
32 Then `dav-sync` would synchronize `$HOME/important_files/` with `https://mynas.local/webdav/important_files`.
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
33
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
34
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
35 [3]: ./list-directories.html
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
36

mercurial