diff -r e85c93b59d1c -r a62d312d8e53 docs/man/dav-sync.1.man --- a/docs/man/dav-sync.1.man Sun Jul 01 16:45:03 2018 +0200 +++ b/docs/man/dav-sync.1.man Sun Jul 01 17:14:17 2018 +0200 @@ -14,59 +14,147 @@ .PP TODO .SH COMMANDS -.PP -pull [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] -.PP -push [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] -.PP -archive [\f[B]\-cld\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] -.PP -resolve\-conflicts \f[I]directory\f[] -.PP -delete\-conflicts \f[I]directory\f[] -.PP -trash\-info \f[I]directory\f[] -.PP -empty\-trash \f[I]directory\f[] -.PP -add\-tag [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] -.PP -remove\-tag [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] -.PP -set\-tags [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tags\f[] -.PP -list\-tags [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] +.TP +.B pull [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] +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. +.RS +.RE +.TP +.B push [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] +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. +.RS +.RE +.TP +.B archive [\f[B]\-cld\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] +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. +.RS +.RE +.TP +.B resolve\-conflicts \f[I]directory\f[] +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 \f[B]you\f[] +have resolved the conflicts. +.RS +.RE +.TP +.B delete\-conflicts \f[I]directory\f[] +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. +.RS +.RE +.TP +.B trash\-info \f[I]directory\f[] +Shows the trash directory path for a \f[I]directory\f[], the number of +files currently in the trash and the space they consume. +.RS +.RE +.TP +.B empty\-trash \f[I]directory\f[] +Removes all files from the trash of the given \f[I]directory\f[]. +.RS +.RE +.TP +.B add\-tag [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +Adds a \f[I]tag\f[] to a SyncDirectory \f[I]file\f[]. +The \f[I]file\f[] argument must denote a local file path. +.RS +.RE +.TP +.B remove\-tag [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +Removes a \f[I]tag\f[] from a SyncDirectory \f[I]file\f[]. +See \f[B]add\-tag\f[]. +.RS +.RE +.TP +.B set\-tags [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] \f[I]tags\f[] +Sets the list of \f[I]tags\f[] for a SyncDirectory \f[I]file\f[]. +This command behaves, as if you would remove all tags with +\f[B]remove\-tag\f[] and add the \f[I]tags\f[] with \f[B]add\-tag\f[]. +.RS +.RE +.TP +.B list\-tags [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[] +List all tags for the specified \f[I]file\f[]. +.RS +.RE +.SH CONFIGURATION COMMANDS +.TP +.B add\-directory +Runs an interactive assistant to create a SyncDirectory. +.RS +.RE +.TP +.B list\-directories +Lists all available SyncDirectories. +.RS +.RE +.TP +.B check\-config +Validates the \f[B]$HOME/.dav/sync.xml\f[] configuration file. +.RS +.RE +.TP +.B 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. +.RS +.RE .SH GENERAL OPTIONS .PP The following options can be used with all commands. .TP -.B \f[B]\-v\f[] +.B \-v Verbose output. .RS .RE .SH COMMAND OPTIONS .TP -.B \f[B]\-c\f[] +.B \-c Disable conflict detection. .RS .RE .TP -.B \f[B]\-d\f[] +.B \-d Don\[aq]t lock the repository. .RS .RE .TP -.B \f[B]\-l\f[] +.B \-l Lock the repository before access. .RS .RE .TP -.B \f[B]\-t\f[] \f[I]tags\f[] +.B \-s \f[I]syncdir\f[] +If multiple SyncDirectories contain a local file, this option must be +used to resolve the ambiguity. +.RS +.RE +.TP +.B \-t \f[I]tags\f[] Only sync files which have the specified tags. .RS .RE .TP -.B \f[B]\-r\f[] +.B \-r Remove ressources not matching the tag filter. .RS .RE