docs/man/dav-sync.1.man

Wed, 02 Nov 2022 11:45:56 +0100

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Wed, 02 Nov 2022 11:45:56 +0100
changeset 741
e9a5dd08258d
parent 704
8b88efcbf56f
permissions
-rw-r--r--

fix return value in util_exec_command on windows

.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "DAV\-SYNC" "1" "December 15, 2019" "Version 1.3" "DavUtils User Manuals"
.hy
.SH NAME
.PP
\f[B]dav\-sync\f[] \- synchronize a local directory with a WebDAV
collection.
.SH SYNOPSIS
.PP
\f[B]dav\-sync\f[] \f[I]command\f[] [\f[I]options\f[]]
\f[I]arguments\f[]\&...
.SH DESCRIPTION
.PP
TODO
.SH COMMANDS
.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]\-cldrSRM\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]\-cldSRM\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 restore [\f[B]\-ldRM\f[]] [\f[B]\-V\f[] *version] [\f[B]\-s\f[] \f[I]directory\f[]] [\f[I]file\&...\f[]]
Restores local files by downloading them from the server.
The \f[I]file\f[] argument can be a local absolute or relative file
path.
.RS
.RE
.TP
.B list\-conflicts [\f[B]\-v\f[]] \f[I]directory\f[]
Lists all conflicting files.
If verbose output is enabled, the output also shows the number of
entries for the same conflicting file.
.RS
.RE
.TP
.B resolve\-conflicts \f[I]directory\f[]
Forcefully clears the conflict 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.
Usually you will never need this command.
.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 list\-versions [\f[B]\-s\f[] \f[I]syncdir\f[]] \f[I]file\f[]
Lists all available file versions.
.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 \-v
Verbose output.
.RS
.RE
.SH COMMAND OPTIONS
.TP
.B \-c
Disable conflict detection.
.RS
.RE
.TP
.B \-d
Don't lock the repository.
.RS
.RE
.TP
.B \-l
Lock the repository before access.
.RS
.RE
.TP
.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 \-r
Remove ressources not matching the tag filter.
.RS
.RE
.SH SEE ALSO
.PP
\f[C]dav\f[] (1).
.PP
DavUtils full documentation: <https://davutils.sourceforge.io/>.
.SH AUTHORS
Olaf Wintermann.

mercurial