Sun, 24 Feb 2019 14:49:58 +0100
nicer dav usage info
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
1 | % DAV-SYNC(1) Version 1.2 | DavUtils User Manuals |
436 | 2 | % Olaf Wintermann |
3 | % July 1, 2018 | |
4 | ||
5 | # NAME | |
6 | ||
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
7 | **dav-sync** - synchronize a local directory with a WebDAV collection. |
436 | 8 | |
9 | # SYNOPSIS | |
10 | ||
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
11 | **dav-sync** *command* [*options*] *arguments*... |
436 | 12 | |
13 | # DESCRIPTION | |
14 | ||
15 | TODO | |
16 | ||
17 | # COMMANDS | |
18 | ||
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
19 | pull [**-cldr**] [**-t** *tags*] *directory* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
20 | : Pulls all changes from the server. All new or modified files are downloaded |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
21 | and all files deleted on the server are deleted locally. If a file is also |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
22 | locally modified and conflict detection is not disabled, the local file is |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
23 | renamed and an entry in the conflict database is added. |
436 | 24 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
25 | push [**-cldr**] [**-t** *tags*] *directory* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
26 | : Pushes all local changes to the server. This uploads all locally modified |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
27 | files and deletes all locally deleted files on the server. If conflict |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
28 | detection is not disabled, all files that are also modified on the server |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
29 | will be skipped. |
436 | 30 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
31 | archive [**-cld**] [**-t** *tags*] *directory* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
32 | : Uploads all new and modified files to the server. The command is similar to |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
33 | the push command (with the same conflict behavior), however it does not |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
34 | delete files on the server. |
436 | 35 | |
36 | resolve-conflicts *directory* | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
37 | : Removes conflict entries from the database. This does not merge any files. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
38 | All files which are marked as conflict are normal files after running this |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
39 | command. In other words: by executing this command you assert that **you** |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
40 | have resolved the conflicts. |
436 | 41 | |
42 | delete-conflicts *directory* | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
43 | : Deletes all files that are marked as a conflict. This will always delete |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
44 | the files and does not move them to the trash directory. Use this command |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
45 | with caution. |
436 | 46 | |
47 | trash-info *directory* | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
48 | : Shows the trash directory path for a *directory*, the number of files |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
49 | currently in the trash and the space they consume. |
436 | 50 | |
51 | empty-trash *directory* | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
52 | : Removes all files from the trash of the given *directory*. |
436 | 53 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
54 | add-tag [**-s** *syncdir*] *file* *tag* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
55 | : Adds a *tag* to a SyncDirectory *file*. The *file* argument must denote a |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
56 | local file path. |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
57 | |
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
58 | remove-tag [**-s** *syncdir*] *file* *tag* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
59 | : Removes a *tag* from a SyncDirectory *file*. See **add-tag**. |
436 | 60 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
61 | set-tags [**-s** *syncdir*] *file* *tags* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
62 | : Sets the list of *tags* for a SyncDirectory *file*. This command behaves, |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
63 | as if you would remove all tags with **remove-tag** and add the *tags* with |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
64 | **add-tag**. |
436 | 65 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
66 | list-tags [**-s** *syncdir*] *file* |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
67 | : List all tags for the specified *file*. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
68 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
69 | # CONFIGURATION COMMANDS |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
70 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
71 | add-directory |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
72 | : Runs an interactive assistant to create a SyncDirectory. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
73 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
74 | list-directories |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
75 | : Lists all available SyncDirectories. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
76 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
77 | check-config |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
78 | : Validates the **$HOME/.dav/sync.xml** configuration file. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
79 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
80 | check-repositories |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
81 | : Checks if every repository used by sync-directories is configured and |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
82 | available. This command outputs the status for each repository. It returns |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
83 | zero when all repositories are all available and non-zero otherwise. |
436 | 84 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
85 | # GENERAL OPTIONS |
436 | 86 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
87 | The following options can be used with all commands. |
436 | 88 | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
89 | -v |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
90 | : Verbose output. |
436 | 91 | |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
92 | # COMMAND OPTIONS |
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
93 | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
94 | -c |
436 | 95 | : Disable conflict detection. |
96 | ||
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
97 | -d |
436 | 98 | : Don't lock the repository. |
99 | ||
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
100 | -l |
438
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
101 | : Lock the repository before access. |
329d57cddae8
improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents:
436
diff
changeset
|
102 | |
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
103 | -s *syncdir* |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
104 | : If multiple SyncDirectories contain a local file, this option must be used |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
105 | to resolve the ambiguity. |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
106 | |
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
107 | -t *tags* |
436 | 108 | : Only sync files which have the specified tags. |
109 | ||
439
e85c93b59d1c
command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents:
438
diff
changeset
|
110 | -r |
436 | 111 | : Remove ressources not matching the tag filter. |
112 | ||
113 | # SEE ALSO | |
114 | ||
115 | `dav` (1). | |
116 | ||
117 | DavUtils full documentation: <https://davutils.sourceforge.io/>. | |
118 |