# HG changeset patch # User Mike Becker # Date 1530209513 -7200 # Node ID daea53362170dcaf147f2c943c7bf86d0b451518 # Parent def0359fb48f282c8a9894af6f45f7ea44895335 adds draft man pages diff -r def0359fb48f -r daea53362170 docs/man/dav-sync.1.man --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/dav-sync.1.man Thu Jun 28 20:11:53 2018 +0200 @@ -0,0 +1,74 @@ +.\" Automatically generated by Pandoc 1.16.0.2 +.\" +.TH "DAV\-SYNC" "1" "July 1, 2018" "dav\-sync User Manuals" "" +.hy +.SH NAME +.PP +dav\-sync \- synchronize a local directory with a WebDAV collection. +.SH SYNOPSIS +.PP +dav\-sync \f[I]command\f[] [\f[I]options\f[]] \f[I]arguments\f[]... +.SH DESCRIPTION +.PP +TODO +.SH COMMANDS +.PP +pull [\f[I]\-cldr\f[]] [\f[I]\-t tags\f[]] \f[I]directory\f[] +.PP +push [\f[I]\-cldr\f[]] [\f[I]\-t tags\f[]] \f[I]directory\f[] +.PP +archive [\f[I]\-cld\f[]] [\f[I]\-t 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[I]\-s syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +.PP +remove\-tag [\f[I]\-s syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +.PP +set\-tags [\f[I]\-s syncdir\f[]] \f[I]file\f[] \f[I]tags\f[] +.PP +list\-tags [\f[I]\-s syncdir\f[]] \f[I]file\f[] +.SH OPTIONS +.TP +.B \-c +Disable conflict detection. +.RS +.RE +.TP +.B \-l +Lock the repository before access. +.RS +.RE +.TP +.B \-d +Don\[aq]t lock the repository. +.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 +.TP +.B \-v +Verbose output (all commands). +.RS +.RE +.SH SEE ALSO +.PP +\f[C]dav\f[] (1). +.PP +DavUtils full documentation: . +.SH AUTHORS +Olaf Wintermann. diff -r def0359fb48f -r daea53362170 docs/man/dav.1.man --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/dav.1.man Thu Jun 28 20:11:53 2018 +0200 @@ -0,0 +1,163 @@ +.\" Automatically generated by Pandoc 1.16.0.2 +.\" +.TH "DAV" "1" "July 1, 2018" "dav User Manuals" "" +.hy +.SH NAME +.PP +dav \- command line WebDAV client +.SH SYNOPSIS +.PP +dav \f[I]command\f[] [\f[I]options\f[]] \f[I]arguments\f[]... +.SH DESCRIPTION +.PP +TODO +.SH COMMANDS +.PP +list [\f[I]\-altdepcR\f[]] [\f[I]\-u date\f[]] \f[I]url\f[] +.PP +get [\f[I]\-pcRK\f[]] [\f[I]\-o file\f[]] [\f[I]\-u date\f[]] +\f[I]url\f[] +.PP +put [\f[I]\-pcR\f[]] [\f[I]\-k key\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] +\f[I]file\f[] +.PP +mkdir [\f[I]\-pc\f[]] [\f[I]\-k key\f[]] [\f[I]\-L lock\f[]] +\f[I]url\f[] +.PP +remove [\f[I]\-pc\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] +.PP +copy [\f[I]\-pcO\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] \f[I]url\f[] +.PP +move [\f[I]\-pcO\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] \f[I]url\f[] +.PP +export [\f[I]\-pc\f[]] [\f[I]\-o file\f[]] [\f[I]\-u date\f[]] +\f[I]url\f[] +.PP +import [\f[I]\-pc\f[]] [\f[I]\-k key\f[]] [\f[I]\-L lock\f[]] +\f[I]url\f[] \f[I]file\f[] +.PP +get\-property [\f[I]\-pcx\f[]] [\f[I]\-n uri\f[]] \f[I]url\f[] +\f[I]property\f[] +.PP +set\-property [\f[I]\-pcx\f[]] [\f[I]\-L lock\f[]] [\f[I]\-n uri\f[]] +\f[I]url\f[] \f[I]property\f[] [\f[I]value\f[]] +.PP +remove\-property [\f[I]\-pc\f[]] [\f[I]\-n uri\f[]] \f[I]url\f[] +\f[I]property\f[] +.PP +lock [\f[I]\-pc\f[]] [\f[I]\-T timeout\f[]] \f[I]url\f[] +.PP +unlock [\f[I]\-pc\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] +.PP +info [\f[I]\-pc\f[]] \f[I]url\f[] +.PP +date [\f[I]url\f[]] +.SH OPTIONS +.TP +.B \-k \f[I]key\f[] +Key to use for encryption. +.RS +.RE +.TP +.B \-p +Don\[aq]t encrypt or decrypt files. +.RS +.RE +.TP +.B \-c +Enable full encryption. +.RS +.RE +.TP +.B \-R +Recursively do the operation for all children. +.RS +.RE +.TP +.B \-K +Keep already present files. +.RS +.RE +.TP +.B \-o \f[I]file\f[] +Write output to \f[I]file\f[]. +Use \[aq]\-\[aq] for stdout. +.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 \-a +Show all files. +.RS +.RE +.TP +.B \-l +Print resources in long list format. +.RS +.RE +.TP +.B \-t +Print content type. +.RS +.RE +.TP +.B \-d +Order by last modified date. +.RS +.RE +.TP +.B \-e +Show extended flags. +.RS +.RE +.TP +.B \-O +Override resources. +.RS +.RE +.TP +.B \-L \f[I]lock\f[] +Specificy lock token. +.RS +.RE +.TP +.B \-T \f[I]sec\f[] +Timeout in seconds. +.RS +.RE +.TP +.B \-n \f[I]uri\f[] +Specify namespace \f[I]uri\f[]. +.RS +.RE +.TP +.B \-x +XML property content. +.RS +.RE +.TP +.B \-N +Disable authentication prompt (all commands). +.RS +.RE +.TP +.B \-i +Disable cert verification (all commands). +.RS +.RE +.TP +.B \-v +Verbose output (all commands). +.RS +.RE +.SH SEE ALSO +.PP +\f[C]dav\-sync\f[] (1). +.PP +DavUtils full documentation: . +.SH AUTHORS +Olaf Wintermann. diff -r def0359fb48f -r daea53362170 docs/src/Makefile --- a/docs/src/Makefile Thu Jun 28 19:22:22 2018 +0200 +++ b/docs/src/Makefile Thu Jun 28 20:11:53 2018 +0200 @@ -28,6 +28,7 @@ PANDOC=pandoc PFLAGS = -c davdoc.css -B header.html -A footer.html +PFLAGSMAN=-s -t man SRC = getting-started.md SRC += commands.md @@ -72,15 +73,22 @@ SRC += check-repositories.md SRC += sync-configuration.md +SRCMAN = dav.1.md +SRCMAN += dav-sync.1.md HTML = $(SRC:%.md=build/%.html) +MAN = $(SRCMAN:%.md=build/%.man) + +DISTHTML = ../html +DISTMAN = ../man FILES = build/davdoc.css build/index.html -all: doc +all: doc manual doc: build $(HTML) $(FILES) - + +manual: build $(MAN) build: mkdir -p build @@ -88,14 +96,21 @@ build/%.html: %.md $(PANDOC) $(PFLAGS) $< -o $@ +build/%.man: %.md + $(PANDOC) $(PFLAGSMAN) $< -o $@ + build/davdoc.css: cp davdoc.css build build/index.html: cp index.html build -dist: doc - rm -Rf ../html; cp -R build ../html +dist: doc manual + rm -Rf $(DISTHTML) $(DISTMAN) + mkdir -p $(DISTHTML) $(DISTMAN) + cp build/*.html $(DISTHTML)/ + cp build/*.css $(DISTHTML)/ + cp build/*.man $(DISTMAN)/ clean: rm -Rf build diff -r def0359fb48f -r daea53362170 docs/src/dav-sync.1.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/dav-sync.1.md Thu Jun 28 20:11:53 2018 +0200 @@ -0,0 +1,67 @@ +% DAV-SYNC(1) dav-sync User Manuals +% Olaf Wintermann +% July 1, 2018 + +# NAME + +dav-sync - synchronize a local directory with a WebDAV collection. + +# SYNOPSIS + +dav-sync *command* [*options*] *arguments*... + +# DESCRIPTION + +TODO + +# COMMANDS + +pull [*-cldr*] [*-t tags*] *directory* + +push [*-cldr*] [*-t tags*] *directory* + +archive [*-cld*] [*-t tags*] *directory* + +resolve-conflicts *directory* + +delete-conflicts *directory* + +trash-info *directory* + +empty-trash *directory* + +add-tag [*-s syncdir*] *file* *tag* + +remove-tag [*-s syncdir*] *file* *tag* + +set-tags [*-s syncdir*] *file* *tags* + +list-tags [*-s syncdir*] *file* + + +# OPTIONS + +-c +: Disable conflict detection. + +-l +: Lock the repository before access. + +-d +: Don't lock the repository. + +-t *tags* +: Only sync files which have the specified tags. + +-r +: Remove ressources not matching the tag filter. + +-v +: Verbose output (all commands). + +# SEE ALSO + +`dav` (1). + +DavUtils full documentation: . + diff -r def0359fb48f -r daea53362170 docs/src/dav.1.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/src/dav.1.md Thu Jun 28 20:11:53 2018 +0200 @@ -0,0 +1,119 @@ +% DAV(1) dav User Manuals +% Olaf Wintermann +% July 1, 2018 + +# NAME + +dav - command line WebDAV client + +# SYNOPSIS + +dav *command* [*options*] *arguments*... + +# DESCRIPTION + +TODO + +# COMMANDS + +list [*-altdepcR*] [*-u date*] *url* + +get [*-pcRK*] [*-o file*] [*-u date*] *url* + +put [*-pcR*] [*-k key*] [*-L lock*] *url* *file* + +mkdir [*-pc*] [*-k key*] [*-L lock*] *url* + +remove [*-pc*] [*-L lock*] *url* + +copy [*-pcO*] [*-L lock*] *url* *url* + +move [*-pcO*] [*-L lock*] *url* *url* + +export [*-pc*] [*-o file*] [*-u date*] *url* + +import [*-pc*] [*-k key*] [*-L lock*] *url* *file* + +get-property [*-pcx*] [*-n uri*] *url* *property* + +set-property [*-pcx*] [*-L lock*] [*-n uri*] *url* *property* [*value*] + +remove-property [*-pc*] [*-n uri*] *url* *property* + +lock [*-pc*] [*-T timeout*] *url* + +unlock [*-pc*] [*-L lock*] *url* + +info [*-pc*] *url* + +date [*url*] + + +# OPTIONS + +-k *key* +: Key to use for encryption. + +-p +: Don't encrypt or decrypt files. + +-c +: Enable full encryption. + +-R +: Recursively do the operation for all children. + +-K +: Keep already present files. + +-o *file* +: Write output to *file*. Use '-' for stdout. + +-u *date* +: Get resources which are modified since the specified *date*. + +-a +: Show all files. + +-l +: Print resources in long list format. + +-t +: Print content type. + +-d +: Order by last modified date. + +-e +: Show extended flags. + +-O +: Override resources. + +-L *lock* +: Specificy lock token. + +-T *sec* +: Timeout in seconds. + +-n *uri* +: Specify namespace *uri*. + +-x +: XML property content. + +-N +: Disable authentication prompt (all commands). + +-i +: Disable cert verification (all commands). + +-v +: Verbose output (all commands). + +# SEE ALSO + +`dav-sync` (1). + +DavUtils full documentation: . +