# HG changeset patch # User Mike Becker # Date 1530456303 -7200 # Node ID e85c93b59d1c28c9f0b59a66faf0a3ad11dddde1 # Parent 329d57cddae8077fa7cb565d2d751900356ce60e command documentation for dav-sync man page diff -r 329d57cddae8 -r e85c93b59d1c docs/src/dav-sync.1.md --- a/docs/src/dav-sync.1.md Sun Jul 01 16:13:17 2018 +0200 +++ b/docs/src/dav-sync.1.md Sun Jul 01 16:45:03 2018 +0200 @@ -17,49 +17,97 @@ # COMMANDS pull [**-cldr**] [**-t** *tags*] *directory* +: Pulls all changes from the server. All new or modified files are downloaded + and all files deleted on the server are deleted locally. If a file is also + locally modified and conflict detection is not disabled, the local file is + renamed and an entry in the conflict database is added. push [**-cldr**] [**-t** *tags*] *directory* +: Pushes all local changes to the server. This uploads all locally modified + files and deletes all locally deleted files on the server. If conflict + detection is not disabled, all files that are also modified on the server + will be skipped. archive [**-cld**] [**-t** *tags*] *directory* +: Uploads all new and modified files to the server. The command is similar to + the push command (with the same conflict behavior), however it does not + delete files on the server. resolve-conflicts *directory* +: Removes conflict entries from the database. This does not merge any files. + All files which are marked as conflict are normal files after running this + command. In other words: by executing this command you assert that **you** + have resolved the conflicts. delete-conflicts *directory* +: Deletes all files that are marked as a conflict. This will always delete + the files and does not move them to the trash directory. Use this command + with caution. trash-info *directory* +: Shows the trash directory path for a *directory*, the number of files + currently in the trash and the space they consume. empty-trash *directory* +: Removes all files from the trash of the given *directory*. add-tag [**-s** *syncdir*] *file* *tag* +: Adds a *tag* to a SyncDirectory *file*. The *file* argument must denote a + local file path. remove-tag [**-s** *syncdir*] *file* *tag* +: Removes a *tag* from a SyncDirectory *file*. See **add-tag**. set-tags [**-s** *syncdir*] *file* *tags* +: Sets the list of *tags* for a SyncDirectory *file*. This command behaves, + as if you would remove all tags with **remove-tag** and add the *tags* with + **add-tag**. list-tags [**-s** *syncdir*] *file* +: List all tags for the specified *file*. + +# CONFIGURATION COMMANDS + +add-directory +: Runs an interactive assistant to create a SyncDirectory. + +list-directories +: Lists all available SyncDirectories. + +check-config +: Validates the **$HOME/.dav/sync.xml** configuration file. + +check-repositories +: Checks if every repository used by sync-directories is configured and + available. This command outputs the status for each repository. It returns + zero when all repositories are all available and non-zero otherwise. # GENERAL OPTIONS The following options can be used with all commands. -**-v** +-v : Verbose output. # COMMAND OPTIONS -**-c** +-c : Disable conflict detection. -**-d** +-d : Don't lock the repository. -**-l** +-l : Lock the repository before access. -**-t** *tags* +-s *syncdir* +: If multiple SyncDirectories contain a local file, this option must be used + to resolve the ambiguity. + +-t *tags* : Only sync files which have the specified tags. -**-r** +-r : Remove ressources not matching the tag filter. # SEE ALSO