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