# HG changeset patch # User Olaf Wintermann # Date 1528034749 -7200 # Node ID 90a6d6952d83f38aba01fe445bbe4f70909f9944 # Parent f71eab18ed38e6e262d1bc73894de39d42d92ab9 adds documentation for new dav-sync features diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/add-tag.md --- a/docs/src/add-tag.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/add-tag.md Sun Jun 03 16:05:49 2018 +0200 @@ -0,0 +1,13 @@ +--- +title: 'dav-sync add-tag' +--- + +**`dav-sync add-tag [-s ] `** + +Adds a tag to a SyncDirectory file. The *file* argument must be a normal file path. If multiple SyncDirectories contain this file, the SyncDirectory must be specified with the **`-s`** option. + +Tags must be enabled for the SyncDirectory. See [Configuration][1] for details. + +**`-s `** SyncDirectory for this file + +[1]: ./sync-configuration.html diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/archive.md --- a/docs/src/archive.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/archive.md Sun Jun 03 16:05:49 2018 +0200 @@ -2,7 +2,7 @@ title: 'dav-sync archive' --- -**`dav-sync archive [-cld] `** +**`dav-sync archive [-cld] [-t ] `** Uploads all new and modified files to the server. The command is similar to the push command, however it does not delete files on the server. @@ -14,3 +14,4 @@ **`-d`** Don't lock the repository (default) +**`-t `** Only sync files that match the tag filter expression diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/header.html --- a/docs/src/header.html Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/header.html Sun Jun 03 16:05:49 2018 +0200 @@ -17,6 +17,7 @@
  • move
  • export
  • import
  • +
  • get-property
  • set-property
  • remove-property
  • lock
  • diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/index.html --- a/docs/src/index.html Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/index.html Sun Jun 03 16:05:49 2018 +0200 @@ -28,6 +28,7 @@
  • move
  • export
  • import
  • +
  • get-property
  • set-property
  • remove-property
  • lock
  • diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/list-tags.md --- a/docs/src/list-tags.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/list-tags.md Sun Jun 03 16:05:49 2018 +0200 @@ -0,0 +1,12 @@ +--- +title: 'dav-sync add-tag' +--- + +**`dav-sync list-tags [-s ] `** + +Lists all file tags. + +Tags must be enabled for the SyncDirectory. See [Configuration][1] for details. + +**`-s `** SyncDirectory for this file + diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/pull.md --- a/docs/src/pull.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/pull.md Sun Jun 03 16:05:49 2018 +0200 @@ -2,7 +2,7 @@ title: 'dav-sync pull' --- -**`dav-sync pull [-cld] `** +**`dav-sync pull [-cldr] [-t ] `** 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. @@ -16,4 +16,7 @@ **`-d`** Don't lock the repository (default) +**`-t `** Only sync files that match the tag filter expression +**`-r`** Delete files not matching the tag filter + diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/push.md --- a/docs/src/push.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/push.md Sun Jun 03 16:05:49 2018 +0200 @@ -2,7 +2,7 @@ title: 'dav-sync push' --- -**`dav-sync push [-cld] `** +**`dav-sync push [-cldr] [-t ] `** Pushes all local changes to the server. This uploads all locally modified files and deletes all locally deleted files on the server. @@ -14,3 +14,6 @@ **`-d`** Don't lock the repository (default) +**`-t `** Only sync files that match the tag filter expression + +**`-r`** Remove resources not matching the tag filter diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/remove-tag.md --- a/docs/src/remove-tag.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/remove-tag.md Sun Jun 03 16:05:49 2018 +0200 @@ -0,0 +1,12 @@ +--- +title: 'dav-sync add-tag' +--- + +**`dav-sync remove-tag [-s ] `** + +Removes a tag from a SyncDirectory file. + +Tags must be enabled for the SyncDirectory. See [Configuration][1] for details. + +**`-s `** SyncDirectory for this file + diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/set-tags.md --- a/docs/src/set-tags.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/set-tags.md Sun Jun 03 16:05:49 2018 +0200 @@ -0,0 +1,13 @@ +--- +title: 'dav-sync add-tag' +--- + +**`dav-sync set-tags [-s ] [tags]`** + +Sets all tags for a SyncDirectory file. The *file* argument must be a normal file path. If multiple SyncDirectories contain this file, the SyncDirectory must be specified with the **`-s`** option. + +If no tags are specified, all tags are removed from this file. + +Tags must be enabled for the SyncDirectory. See [Configuration][1] for details. + +**`-s `** SyncDirectory for this file diff -r f71eab18ed38 -r 90a6d6952d83 docs/src/sync-configuration.md --- a/docs/src/sync-configuration.md Sun Jun 03 14:40:07 2018 +0200 +++ b/docs/src/sync-configuration.md Sun Jun 03 16:05:49 2018 +0200 @@ -102,11 +102,13 @@ ### filter -With the filter element, include and exclude filters can be specified, to control which files are synchronized. The *pull* and *push* command apply these filters to file paths. At first it is checked if a file is matching any include filter. If so only files matching not an exclude filter are further processed. +With the filter element, include and exclude filters can be specified, to control which files are synchronized. The *pull*, *push* and *archive* command apply these filters to file paths. At first it is checked if a file is matching any include filter. If so only files matching not an exclude filter are further processed. + +It is also possible to filter resources by tags. Tags can dynamically be applied to individual files. The tag filter elements contains a tag filter expression. Only files that match the filter expression are synchronized. Note: The file path is relative to the directory path (and WebDAV collection) but always starts with an path separator. -Optional elements: ``, `` +Optional elements: ``, ``, `` ### include @@ -132,4 +134,15 @@ \.DS_Store$ +### tags +TODO + +Type: tag filter expression \ +Example: + + + + | (tag1, tag2, tag3) + +