docs/man/dav.1.man

Fri, 21 Apr 2023 21:25:32 +0200

author
Olaf Wintermann <olaf.wintermann@gmail.com>
date
Fri, 21 Apr 2023 21:25:32 +0200
changeset 747
efbd59642577
parent 704
8b88efcbf56f
permissions
-rw-r--r--

ucx 3 update, basic dav commands work, most stuff is still broken

.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "DAV" "1" "December 15, 2019" "Version 1.3" "DavUtils User Manuals"
.hy
.SH NAME
.PP
\f[B]dav\f[] \- command line WebDAV client
.SH SYNOPSIS
.PP
\f[B]dav\f[] \f[I]command\f[] [\f[I]options\f[]] \f[I]arguments\f[]\&...
.SH DESCRIPTION
.PP
TODO
.SH COMMANDS
.TP
.B list [\f[B]\-altdepcR\f[]] [\f[B]\-u\f[] \f[I]date\f[]] \f[I]url\f[]
Lists the files at \f[I]url\f[].
.RS
.RE
.TP
.B get [\f[B]\-pcRK\f[]] [\f[B]\-o\f[] \f[I]file\f[]] [\f[B]\-u\f[] \f[I]date\f[]] [\f[B]\-V\f[] \f[I]version\f[]] \f[I]url\f[]
Downloads a resource from \f[I]url\f[].
.RS
.RE
.TP
.B put [\f[B]\-pcR\f[]] [\f[B]\-k\f[] \f[I]key\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[] \f[I]file\f[]
Uploads a resource to \f[I]url\f[].
.RS
.RE
.TP
.B mkdir [\f[B]\-pc\f[]] [\f[B]\-k\f[] \f[I]key\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[]
Creates a new collection at \f[I]url\f[].
.RS
.RE
.TP
.B remove [\f[B]\-pc\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[]
Deletes a resource or collection at \f[I]url\f[]
.RS
.RE
.TP
.B copy [\f[B]\-pcO\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]srcurl\f[] \f[I]desturl\f[]
Copies a resource or collection from \f[I]srcurl\f[] to
\f[I]desturl\f[].
.RS
.RE
.TP
.B move [\f[B]\-pcO\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]srcurl\f[] \f[I]desturl\f[]
Moves a resource or collection from \f[I]srcurl\f[] to \f[I]desturl\f[].
.RS
.RE
.TP
.B rename [\f[B]\-pcO\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]srcurl\f[] \f[I]name\f[]
Changes the name of a resource or collection at \f[I]srcurl\f[] to
\f[I]name\f[].
.RS
.RE
.TP
.B export [\f[B]\-pc\f[]] [\f[B]\-o\f[] \f[I]file\f[]] [\f[B]\-u\f[] \f[I]date\f[]] \f[I]url\f[]
Exports a resource or collection to a \f[B]tar(5)\f[] archive.
By default the data is written to \f[I]stdout\f[], but you may specify a
\f[I]file\f[] with the \f[B]\-o\f[] option.
.RS
.RE
.TP
.B import [\f[B]\-pc\f[]] [\f[B]\-k\f[] \f[I]key\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[] \f[I]file\f[]
Uploads and extracts the contents of the \f[B]tar(5)\f[] archive
\f[I]file\f[] to \f[I]url\f[].
.RS
.RE
.TP
.B get\-property [\f[B]\-pcx\f[]] [\f[B]\-n\f[] \f[I]uri\f[]] \f[I]url\f[] \f[I]property\f[]
Gets a specific resource property.
Every WebDAV property has a name and an XML namespace.
A namespace can be specified with the \f[B]\-n\f[] option or with a
prefixed name.
The prefix and property name are separated by a colon \f[I]:\f[] as
usual.
.RS
.PP
If the \f[B]\-x\f[] option is specified, a valid XML document containing
the value is printed on \f[I]stdout\f[].
.PP
If the property contains XML data and the \f[B]\-x\f[] option is not
specified, the value is printed on \f[I]stderr\f[] in an XML\-like
format.
.RE
.TP
.B set\-property [\f[B]\-pcx\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] [\f[B]\-n\f[] \f[I]uri\f[]] \f[I]url\f[] \f[I]property\f[] [\f[I]value\f[]]
Sets a resource property to the specified value.
See \f[B]get\-property\f[] for details.
If no \f[I]value\f[] is specified, it is read from \f[I]stdin\f[].
.RS
.RE
.TP
.B remove\-property [\f[B]\-pc\f[]] [\f[B]\-n\f[] \f[I]uri\f[]] \f[I]url\f[] \f[I]property\f[]
Removes a resource property.
.RS
.RE
.TP
.B lock [\f[B]\-pc\f[]] [\f[B]\-T\f[] \f[I]timeout\f[]] \f[I]url\f[]
Creates a lock on the resource at \f[I]url\f[].
The lock is an exclusive write lock with infinite depth.
If the resource is sucessfully locked, a lock token for this resource is
printed to \f[I]stdout\f[].
This lock token should be saved to unlock the resource eventually.
.RS
.RE
.TP
.B unlock [\f[B]\-pc\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[]
Unlocks the resource at \f[I]url\f[] with a lock token.
If \f[I]lock\f[] is not specified, the token is read from
\f[I]stdin\f[].
.RS
.RE
.TP
.B info [\f[B]\-pc\f[]] \f[I]url\f[]
Prints some information and lists al properties for the resource at
\f[I]url\f[].
.RS
.RE
.TP
.B date [\f[I]url\f[]]
Gets the time from the server providing the resource denoted by
\f[I]url\f[].
If \f[I]url\f[] is not specified, this command prints the local time.
This command is useful, if the server clock and the local clock are not
in sync.
.RS
.RE
.TP
.B versioncontrol [\f[B]\-pc\f[]] \f[I]url\f[]
Puts the resource, specified by url, under version control.
This is required in order to use other versioning commands with this
resource.
.RS
.RE
.TP
.B list\-versions [\f[B]\-pc\f[]] \f[I]url\f[]
Lists all versions of a version\-controlled resource.
.RS
.RE
.TP
.B checkout [\f[B]\-pc\f[]] \f[I]url\f[]
Changes the state of a resource to checked\-out to allow modifications
to the content and properties.
.RS
.RE
.TP
.B checkin [\f[B]\-pc\f[]] \f[I]url\f[]
Changes the state of a resource to checked\-in.
This will create a new version of the resource.
In the checked\-in state the resource cannot be modified.
.RS
.RE
.TP
.B uncheckout [\f[B]\-pc\f[]] \f[I]url\f[]
Cancels all modification of the resource and sets the state to
checked\-in without creating a new version.
.RS
.RE
.SH CONFIGURATION COMMANDS
.TP
.B add\-repository
This command runs an interactive assistant that creates a repository
configuration.
.RS
.RE
.TP
.B remove\-repository \f[I]name\f[]
Removes the repository with the specified \f[I]name\f[] from the
configuration.
.RS
.RE
.TP
.B list\-repositories
Lists all currently configured repositories.
.RS
.RE
.TP
.B check\-config
Validates the \f[B]$HOME/.dav/config.xml\f[] configuration file.
.RS
.RE
.TP
.B repository\-url [\f[B]\-p\f[]] \f[I]repository\f[]
Prints the repository url.
.RS
.RE
.TP
.B add\-user
Adds a user to the secret store.
.RS
.RE
.TP
.B remove\-user
Removes a user from the secret store.
.RS
.RE
.TP
.B edit\-user
Interactive command for modifying users stored in the secret store.
.RS
.RE
.TP
.B list\-users
Lists all users stored in the secret store.
.RS
.RE
.SH GENERAL OPTIONS
.PP
The following options can be used with all commands.
.TP
.B \-i
Disable cert verification.
.RS
.RE
.TP
.B \-N
Disable authentication prompt.
.RS
.RE
.TP
.B \-v
Verbose output.
.RS
.RE
.SH COMMAND OPTIONS
.TP
.B \-a
Show all files.
.RS
.RE
.TP
.B \-c
Enable full encryption.
.RS
.RE
.TP
.B \-d
Order by last modified date.
.RS
.RE
.TP
.B \-e
Show extended flags.
.RS
.RE
.TP
.B \-K
Keep already present files.
.RS
.RE
.TP
.B \-k \f[I]key\f[]
Key to use for encryption.
.RS
.RE
.TP
.B \-l
Print resources in long list format.
.RS
.RE
.TP
.B \-L \f[I]lock\f[]
Specificy lock token.
.RS
.RE
.TP
.B \-n \f[I]uri\f[]
Specify namespace \f[I]uri\f[].
There are two namespaces configured by default.
.RS
.IP "1." 3
\f[I]D\f[] for the \f[I]DAV:\f[] namespace
.IP "2." 3
\f[I]idav\f[] for the \f[I]http://davutils.org/\f[] namespace
.RE
.TP
.B \-o \f[I]file\f[]
Write output to \f[I]file\f[].
Use `\-' for stdout.
.RS
.RE
.TP
.B \-O
Override resources.
.RS
.RE
.TP
.B \-p
Don't encrypt or decrypt files.
.RS
.RE
.TP
.B \-R
Recursively do the operation for all children.
.RS
.RE
.TP
.B \-t
Print content type.
.RS
.RE
.TP
.B \-T \f[I]sec\f[]
Timeout in seconds.
.RS
.RE
.TP
.B \-u \f[I]date\f[]
Get resources which are modified since the specified \f[I]date\f[].
.RS
.RE
.TP
.B \-V \f[I]version\f[]
downloads a specific version of the resource.
Available versions can be listed with the list\-versions command
.RS
.RE
.TP
.B \-x
XML property content.
.RS
.RE
.SH SEE ALSO
.PP
\f[C]dav\-sync\f[] (1).
.PP
DavUtils full documentation: <https://davutils.sourceforge.io/>.
.SH AUTHORS
Olaf Wintermann.

mercurial