diff -r b50ade8e7197 -r 1607450065ba docs/html/sync-configuration.html --- a/docs/html/sync-configuration.html Sun Jun 24 11:51:07 2018 +0200 +++ b/docs/html/sync-configuration.html Sun Jun 24 12:18:12 2018 +0200 @@ -26,6 +26,8 @@
  • remove
  • copy
  • move
  • +
  • export
  • +
  • import
  • get-property
  • set-property
  • remove-property
  • @@ -34,6 +36,7 @@
  • info
  • date
  • add-repository
  • +
  • remove-repository
  • list-repositories
  • check-config
  • @@ -54,6 +57,10 @@
  • delete-conflicts
  • trash-info
  • empty-trash
  • +
  • add-tag
  • +
  • remove-tag
  • +
  • set-tags
  • +
  • list-tags
  • add-directory
  • list-directories
  • check-config
  • @@ -127,10 +134,35 @@

    Type: integer
    Default: 0
    Example: <lock-timeout>50</lock-timeout>

    +

    tagconfig

    +

    Configures the local store for resource tags. If this element is specified, resource tags are stored locally.

    +

    Optional elements: local-store, detect-changes, xattr-name, on-conflict

    +

    local-store

    +

    Specifies the tag-store type. Currently the only available type is xattr.

    +

    The element can contain the attribute format with one of the following values: text, csv, xml, macos. The default value is text.

    +

    Type: tagstore type enum
    +Default: xattr
    +Example: <local-store format="csv">xattr</local-store>

    +

    xattr-name

    +

    Specifies the name of the extended attribute for storing tags. The default value is tags, unless you are using the macos format, where the default value is com.apple.metadata:_kMDItemUserTags.

    +

    Type: string
    +Default: tags
    +Example: `file_tags

    +

    detect-changes

    +

    Controls, if tag changes should be detected.

    +

    Type: boolean
    +Default: false
    +Example: <detect-changes>true</detect-changes>

    +

    on-conflict

    +

    Specifies the behavior, when tag conflicts occur. Possible values are: no_conflict, keep_local, keep_remote, merge

    +

    Type: onconflict enum
    +Default: no_conflict
    +Example: <on-conflict>merge</on-conflict>

    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: <include>, <exclude>

    +

    Optional elements: <include>, <exclude>, <tags>

    include

    Controls which files will be included by pull and push. If an include filter is specified, only files matching this filter are included.

    Type: regex string
    @@ -147,6 +179,18 @@ <exclude>^/secretdir</exclude> <exclude>\.DS_Store$</exclude> </filter> +

    tags

    +

    Filters resources by tags. Only resources, that are not a collection, are effected. If tags are not stored locally, the pull command still uses the filter.

    +

    Filter Syntax:

    +
    filter ::= operator? , (tag_list | ("(" , filter , ")")+)
    +tag_list ::= tag , ("," tag)*
    +operator ::= "&" | "|" | "1" | "0"
    +

    Type: tag filter expression
    +Example:

    +
    <filter>
    +    <!-- sync only resources that have one of this tags -->
    +    <tags>| (tag1, tag2, tag3)</tags>
    +</filter>