docs/src/dav-sync.1.md

Sun, 17 Dec 2023 14:25:34 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 17 Dec 2023 14:25:34 +0100
changeset 797
edbb20b1438d
parent 703
2e3a24b9896a
permissions
-rw-r--r--

[Makefile] fix missing rules preventing dry-runs

We have to support dry-runs, because many IDEs are using
dry-runs to collect build information.

Some rules have dependencies that expect certain files or
directories to be just present. We added respective build
rules which invoke the test program. This way, the behavior
when running make normally is exactly the same, but dry-runs
are also not failing now.

703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
1 % DAV-SYNC(1) Version 1.3 | DavUtils User Manuals
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
2 % Olaf Wintermann
703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
3 % December 15, 2019
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
4
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
5 # NAME
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
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
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
8
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
9 # SYNOPSIS
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
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
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
12
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
13 # DESCRIPTION
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
14
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
15 TODO
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
16
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
17 # COMMANDS
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
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
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
24
703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
25 push [**-cldrSRM**] [**-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
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
30
703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
31 archive [**-cldSRM**] [**-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
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
35
703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
36 restore [**-ldRM**] [**-V** *version] [**-s** *directory*] [*file...*]
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
37 : Restores local files by downloading them from the server. The *file* argument
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
38 can be a local absolute or relative file path.
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
39
563
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
40 list-conflicts [**-v**] *directory*
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
41 : Lists all conflicting files. If verbose output is enabled, the output also
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
42 shows the number of entries for the same conflicting file.
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
43
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
44 resolve-conflicts *directory*
563
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
45 : Forcefully clears the conflict database. This does not merge any files.
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
46 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
47 command. In other words: by executing this command you assert that **you**
563
3dffe58a573f adds list-conflicts command to dav-sync
Mike Becker <universe@uap-core.de>
parents: 439
diff changeset
48 have resolved the conflicts. Usually you will never need this command.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
49
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
50 delete-conflicts *directory*
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
51 : 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
52 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
53 with caution.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
54
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
55 trash-info *directory*
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
56 : 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
57 currently in the trash and the space they consume.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
58
703
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
59 list-versions [**-s** *syncdir*] *file*
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
60 : Lists all available file versions.
2e3a24b9896a update man pages
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 563
diff changeset
61
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
62 empty-trash *directory*
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
63 : Removes all files from the trash of the given *directory*.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
64
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
65 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
66 : 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
67 local file path.
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
68
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
69 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
70 : Removes a *tag* from a SyncDirectory *file*. See **add-tag**.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
71
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
72 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
73 : 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
74 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
75 **add-tag**.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
76
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
77 list-tags [**-s** *syncdir*] *file*
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
78 : 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
79
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
80 # CONFIGURATION COMMANDS
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
81
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
82 add-directory
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
83 : 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
84
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
85 list-directories
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
86 : Lists all available SyncDirectories.
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
87
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
88 check-config
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
89 : 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
90
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
91 check-repositories
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
92 : 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
93 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
94 zero when all repositories are all available and non-zero otherwise.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
95
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
96 # GENERAL OPTIONS
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
97
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
98 The following options can be used with all commands.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
99
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
100 -v
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
101 : Verbose output.
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
102
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
103 # COMMAND OPTIONS
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
104
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
105 -c
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
106 : Disable conflict detection.
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
107
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
108 -d
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
109 : Don't lock the repository.
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
110
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
111 -l
438
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
112 : Lock the repository before access.
329d57cddae8 improves formatting of man pages
Mike Becker <universe@uap-core.de>
parents: 436
diff changeset
113
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
114 -s *syncdir*
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
115 : 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
116 to resolve the ambiguity.
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
117
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
118 -t *tags*
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
119 : Only sync files which have the specified tags.
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
120
439
e85c93b59d1c command documentation for dav-sync man page
Mike Becker <universe@uap-core.de>
parents: 438
diff changeset
121 -r
436
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
122 : Remove ressources not matching the tag filter.
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
123
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
124 # SEE ALSO
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
125
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
126 `dav` (1).
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
127
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
128 DavUtils full documentation: <https://davutils.sourceforge.io/>.
daea53362170 adds draft man pages
Mike Becker <universe@uap-core.de>
parents:
diff changeset
129

mercurial