docs/src/add-directory.md

Tue, 23 Jul 2024 14:29:33 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Tue, 23 Jul 2024 14:29:33 +0200
changeset 824
76ca3dac6506
parent 283
0e36bb75a732
permissions
-rw-r--r--

fix request_auth not removing the trailing newline from the user name

283
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 276
diff changeset
1 ---
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 276
diff changeset
2 title: 'dav-sync add-directory'
0e36bb75a732 adds dav-sync introduction and sync.xml documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 276
diff changeset
3 ---
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
4
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
5 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
6 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
7
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
8 [1]: ./sync-configuration.html
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
9 [2]: ./add-repository.html
273
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
10
c743721d566f more documentation
Olaf Wintermann <olaf.wintermann@gmail.com>
parents:
diff changeset
11 **Command alias:** add-dir
275
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
12
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
13 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
14 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
15 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
16 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
17 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
18 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
19
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
20 $ dav-sync add-directory
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
21 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
22 name: mysyncdir
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
23 Enter local directory path.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
24 path: $HOME/important_files
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
25 Specify webdav repository.
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
26 0) myfirstrepo
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
27 1) anotherrepo
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
28 repository: 0
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
29 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
30 collection (default: /): /important_files
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
31
276
20a176d5a53e adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 275
diff changeset
32 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
33 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
34
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
35
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
36 [3]: ./list-directories.html
fa48ab29abd2 adds more details to add-directory.md
Mike Becker <universe@uap-core.de>
parents: 273
diff changeset
37

mercurial