diff -r 2e3a24b9896a -r 8b88efcbf56f docs/html/introduction.html --- a/docs/html/introduction.html Sun Dec 15 16:54:05 2019 +0100 +++ b/docs/html/introduction.html Sun Dec 15 17:00:46 2019 +0100 @@ -1,12 +1,20 @@ - - + + - - + + Introduction to dav-sync - - + + +
@@ -26,6 +34,7 @@
  • remove
  • copy
  • move
    • +
  • rename
  • export
  • import
  • get-property
    • @@ -35,9 +44,19 @@
  • unlock
  • info
  • date
    • +
  • versioncontrol
    • +
  • list-versions
    • +
  • checkout
    • +
  • checkin
    • +
  • uncheckout
  • add-repository
  • remove-repository
  • list-repositories
    • +
  • repository-url
    • +
  • add-user
    • +
  • remove-user
    • +
  • edit-user
    • +
  • list-users
  • check-config
  • Configuration
    • @@ -53,11 +72,13 @@
  • pull
  • push
  • archive
    • -
  • list-conflicts
    • +
  • restore
    • +
  • list-conflicts
  • resolve-conflicts
  • delete-conflicts
  • trash-info
  • empty-trash
    • +
  • list-versions
  • add-tag
  • remove-tag
  • set-tags
    • @@ -74,9 +95,9 @@
    - +

    The dav-sync program can synchronize a local directory with a WebDAV collection.

    First Steps

    To use dav-sync it is required to configure a repository in config.xml and the directory in sync.xml.

    @@ -114,7 +135,7 @@

    Every sync-directory has a database xml file that contains the etag and last modified date of each file. The etag is used to detect changes on the server and the last modified date is used to detect local changes. The database file is usually located in $HOME/.dav/ and if you want to reset a sync-directory, you can delete the database. After that, pull/push (with disabled conflict detection) will download/upload all files.

    Conflict detection

    The pull and push commands detect if a file has changed remotely and locally. This is a conflict that must be resolved manually.

    -

    When pull detects a conflict it renames the local file to orig-$number.$name where $number is an integer, usually 0 if no other conflict file with the name exists and $name is the file's name. After the file is renamed the new file from the server is downloadet. The user should merge the files manually then or just delete one or keep both. After that run resolve-conflicts to remove all conflict entries from the database otherwise push will ignore any file in a conflict state. There is also the delete-conflicts command that deletes all conflict files.

    +

    When pull detects a conflict it renames the local file to orig-$number.$name where $number is an integer, usually 0 if no other conflict file with the name exists and $name is the file’s name. After the file is renamed the new file from the server is downloadet. The user should merge the files manually then or just delete one or keep both. After that run resolve-conflicts to remove all conflict entries from the database otherwise push will ignore any file in a conflict state. There is also the delete-conflicts command that deletes all conflict files.

    When push detects that a file is modified locally and on the server, it just skips this file. Run the pull command to get the new file from the server and resolve the conflict like described above.

    Trash

    For high data safety, a trash directory can be configured. If this is done, dav-sync will not delete files, but move them to the trash directory. Also the pull command can move files to the trash directory before overwriting them.