Sun, 01 Jul 2018 16:13:17 +0200
improves formatting of man pages
docs/man/dav-sync.1.man | file | annotate | diff | comparison | revisions | |
docs/man/dav.1.man | file | annotate | diff | comparison | revisions | |
docs/src/dav-sync.1.md | file | annotate | diff | comparison | revisions | |
docs/src/dav.1.md | file | annotate | diff | comparison | revisions |
--- a/docs/man/dav-sync.1.man Thu Jun 28 21:41:05 2018 +0200 +++ b/docs/man/dav-sync.1.man Sun Jul 01 16:13:17 2018 +0200 @@ -1,23 +1,25 @@ .\" Automatically generated by Pandoc 1.16.0.2 .\" -.TH "DAV\-SYNC" "1" "July 1, 2018" "dav\-sync User Manuals" "" +.TH "DAV\-SYNC" "1" "July 1, 2018" "Version 1.2" "DavUtils User Manuals" .hy .SH NAME .PP -dav\-sync \- synchronize a local directory with a WebDAV collection. +\f[B]dav\-sync\f[] \- 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[]... +\f[B]dav\-sync\f[] \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[] +pull [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] .PP -push [\f[I]\-cldr\f[]] [\f[I]\-t tags\f[]] \f[I]directory\f[] +push [\f[B]\-cldr\f[]] [\f[B]\-t\f[] \f[I]tags\f[]] \f[I]directory\f[] .PP -archive [\f[I]\-cld\f[]] [\f[I]\-t tags\f[]] \f[I]directory\f[] +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 @@ -27,44 +29,47 @@ .PP empty\-trash \f[I]directory\f[] .PP -add\-tag [\f[I]\-s syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +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 -remove\-tag [\f[I]\-s syncdir\f[]] \f[I]file\f[] \f[I]tag\f[] +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[] +.SH GENERAL OPTIONS .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 +The following options can be used with all commands. .TP -.B \-c +.B \f[B]\-v\f[] +Verbose output. +.RS +.RE +.SH COMMAND OPTIONS +.TP +.B \f[B]\-c\f[] Disable conflict detection. .RS .RE .TP -.B \-l -Lock the repository before access. -.RS -.RE -.TP -.B \-d +.B \f[B]\-d\f[] Don\[aq]t lock the repository. .RS .RE .TP -.B \-t \f[I]tags\f[] +.B \f[B]\-l\f[] +Lock the repository before access. +.RS +.RE +.TP +.B \f[B]\-t\f[] \f[I]tags\f[] Only sync files which have the specified tags. .RS .RE .TP -.B \-r +.B \f[B]\-r\f[] 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).
--- a/docs/man/dav.1.man Thu Jun 28 21:41:05 2018 +0200 +++ b/docs/man/dav.1.man Sun Jul 01 16:13:17 2018 +0200 @@ -1,157 +1,163 @@ .\" Automatically generated by Pandoc 1.16.0.2 .\" -.TH "DAV" "1" "July 1, 2018" "dav User Manuals" "" +.TH "DAV" "1" "July 1, 2018" "Version 1.2" "DavUtils User Manuals" .hy .SH NAME .PP -dav \- command line WebDAV client +\f[B]dav\f[] \- command line WebDAV client .SH SYNOPSIS .PP -dav \f[I]command\f[] [\f[I]options\f[]] \f[I]arguments\f[]... +\f[B]dav\f[] \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[] +list [\f[B]\-altdepcR\f[]] [\f[B]\-u\f[] \f[I]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[] +get [\f[B]\-pcRK\f[]] [\f[B]\-o\f[] \f[I]file\f[]] [\f[B]\-u\f[] +\f[I]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[] +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[] .PP -mkdir [\f[I]\-pc\f[]] [\f[I]\-k key\f[]] [\f[I]\-L lock\f[]] -\f[I]url\f[] +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[] +.PP +remove [\f[B]\-pc\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[] .PP -remove [\f[I]\-pc\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] +copy [\f[B]\-pcO\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]srcurl\f[] +\f[I]desturl\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[] +move [\f[B]\-pcO\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]srcurl\f[] +\f[I]desturl\f[] .PP -export [\f[I]\-pc\f[]] [\f[I]\-o file\f[]] [\f[I]\-u date\f[]] -\f[I]url\f[] +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[] .PP -import [\f[I]\-pc\f[]] [\f[I]\-k key\f[]] [\f[I]\-L lock\f[]] -\f[I]url\f[] \f[I]file\f[] +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[] .PP -get\-property [\f[I]\-pcx\f[]] [\f[I]\-n uri\f[]] \f[I]url\f[] +get\-property [\f[B]\-pcx\f[]] [\f[B]\-n\f[] \f[I]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[] +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[]] .PP -lock [\f[I]\-pc\f[]] [\f[I]\-T timeout\f[]] \f[I]url\f[] +remove\-property [\f[B]\-pc\f[]] [\f[B]\-n\f[] \f[I]uri\f[]] +\f[I]url\f[] \f[I]property\f[] .PP -unlock [\f[I]\-pc\f[]] [\f[I]\-L lock\f[]] \f[I]url\f[] +lock [\f[B]\-pc\f[]] [\f[B]\-T\f[] \f[I]timeout\f[]] \f[I]url\f[] .PP -info [\f[I]\-pc\f[]] \f[I]url\f[] +unlock [\f[B]\-pc\f[]] [\f[B]\-L\f[] \f[I]lock\f[]] \f[I]url\f[] +.PP +info [\f[B]\-pc\f[]] \f[I]url\f[] .PP date [\f[I]url\f[]] -.SH OPTIONS +.SH GENERAL OPTIONS +.PP +The following options can be used with all commands. +.TP +.B \f[B]\-i\f[] +Disable cert verification. +.RS +.RE +.TP +.B \f[B]\-N\f[] +Disable authentication prompt. +.RS +.RE +.TP +.B \f[B]\-v\f[] +Verbose output. +.RS +.RE +.SH COMMAND OPTIONS .TP -.B \-k \f[I]key\f[] +.B \f[B]\-a\f[] +Show all files. +.RS +.RE +.TP +.B \f[B]\-c\f[] +Enable full encryption. +.RS +.RE +.TP +.B \f[B]\-d\f[] +Order by last modified date. +.RS +.RE +.TP +.B \f[B]\-e\f[] +Show extended flags. +.RS +.RE +.TP +.B \f[B]\-K\f[] +Keep already present files. +.RS +.RE +.TP +.B \f[B]\-k\f[] \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. +.B \f[B]\-l\f[] +Print resources in long list format. .RS .RE .TP -.B \-R -Recursively do the operation for all children. +.B \f[B]\-L\f[] \f[I]lock\f[] +Specificy lock token. .RS .RE .TP -.B \-K -Keep already present files. +.B \f[B]\-n\f[] \f[I]uri\f[] +Specify namespace \f[I]uri\f[]. .RS .RE .TP -.B \-o \f[I]file\f[] +.B \f[B]\-o\f[] \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[]. +.B \f[B]\-O\f[] +Override resources. .RS .RE .TP -.B \-a -Show all files. +.B \f[B]\-p\f[] +Don\[aq]t encrypt or decrypt files. .RS .RE .TP -.B \-l -Print resources in long list format. +.B \f[B]\-R\f[] +Recursively do the operation for all children. .RS .RE .TP -.B \-t +.B \f[B]\-t\f[] 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[] +.B \f[B]\-T\f[] \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. +.B \f[B]\-u\f[] \f[I]date\f[] +Get resources which are modified since the specified \f[I]date\f[]. .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). +.B \f[B]\-x\f[] +XML property content. .RS .RE .SH SEE ALSO
--- a/docs/src/dav-sync.1.md Thu Jun 28 21:41:05 2018 +0200 +++ b/docs/src/dav-sync.1.md Sun Jul 01 16:13:17 2018 +0200 @@ -1,14 +1,14 @@ -% DAV-SYNC(1) dav-sync User Manuals +% DAV-SYNC(1) Version 1.2 | DavUtils User Manuals % Olaf Wintermann % July 1, 2018 # NAME -dav-sync - synchronize a local directory with a WebDAV collection. +**dav-sync** - synchronize a local directory with a WebDAV collection. # SYNOPSIS -dav-sync *command* [*options*] *arguments*... +**dav-sync** *command* [*options*] *arguments*... # DESCRIPTION @@ -16,11 +16,11 @@ # COMMANDS -pull [*-cldr*] [*-t tags*] *directory* +pull [**-cldr**] [**-t** *tags*] *directory* -push [*-cldr*] [*-t tags*] *directory* +push [**-cldr**] [**-t** *tags*] *directory* -archive [*-cld*] [*-t tags*] *directory* +archive [**-cld**] [**-t** *tags*] *directory* resolve-conflicts *directory* @@ -30,35 +30,38 @@ empty-trash *directory* -add-tag [*-s syncdir*] *file* *tag* +add-tag [**-s** *syncdir*] *file* *tag* + +remove-tag [**-s** *syncdir*] *file* *tag* -remove-tag [*-s syncdir*] *file* *tag* +set-tags [**-s** *syncdir*] *file* *tags* -set-tags [*-s syncdir*] *file* *tags* +list-tags [**-s** *syncdir*] *file* -list-tags [*-s syncdir*] *file* +# GENERAL OPTIONS +The following options can be used with all commands. -# OPTIONS +**-v** +: Verbose output. --c +# COMMAND OPTIONS + +**-c** : Disable conflict detection. --l -: Lock the repository before access. - --d +**-d** : Don't lock the repository. --t *tags* +**-l** +: Lock the repository before access. + +**-t** *tags* : Only sync files which have the specified tags. --r +**-r** : Remove ressources not matching the tag filter. --v -: Verbose output (all commands). - # SEE ALSO `dav` (1).
--- a/docs/src/dav.1.md Thu Jun 28 21:41:05 2018 +0200 +++ b/docs/src/dav.1.md Sun Jul 01 16:13:17 2018 +0200 @@ -1,14 +1,14 @@ -% DAV(1) dav User Manuals +% DAV(1) Version 1.2 | DavUtils User Manuals % Olaf Wintermann % July 1, 2018 # NAME -dav - command line WebDAV client +**dav** - command line WebDAV client # SYNOPSIS -dav *command* [*options*] *arguments*... +**dav** *command* [*options*] *arguments*... # DESCRIPTION @@ -16,100 +16,104 @@ # COMMANDS -list [*-altdepcR*] [*-u date*] *url* +list [**-altdepcR**] [**-u** *date*] *url* -get [*-pcRK*] [*-o file*] [*-u date*] *url* +get [**-pcRK**] [**-o** *file*] [**-u** *date*] *url* -put [*-pcR*] [*-k key*] [*-L lock*] *url* *file* +put [**-pcR**] [**-k** *key*] [**-L** *lock*] *url* *file* -mkdir [*-pc*] [*-k key*] [*-L lock*] *url* +mkdir [**-pc**] [**-k** *key*] [**-L** *lock*] *url* -remove [*-pc*] [*-L lock*] *url* +remove [**-pc**] [**-L** *lock*] *url* -copy [*-pcO*] [*-L lock*] *url* *url* +copy [**-pcO**] [**-L** *lock*] *srcurl* *desturl* -move [*-pcO*] [*-L lock*] *url* *url* +move [**-pcO**] [**-L** *lock*] *srcurl* *desturl* -export [*-pc*] [*-o file*] [*-u date*] *url* +export [**-pc**] [**-o** *file*] [**-u** *date*] *url* -import [*-pc*] [*-k key*] [*-L lock*] *url* *file* +import [**-pc**] [**-k** *key*] [**-L** *lock*] *url* *file* -get-property [*-pcx*] [*-n uri*] *url* *property* +get-property [**-pcx**] [**-n** *uri*] *url* *property* -set-property [*-pcx*] [*-L lock*] [*-n uri*] *url* *property* [*value*] +set-property [**-pcx**] [**-L** *lock*] [**-n** *uri*] *url* *property* [*value*] -remove-property [*-pc*] [*-n uri*] *url* *property* +remove-property [**-pc**] [**-n** *uri*] *url* *property* -lock [*-pc*] [*-T timeout*] *url* +lock [**-pc**] [**-T** *timeout*] *url* -unlock [*-pc*] [*-L lock*] *url* +unlock [**-pc**] [**-L** *lock*] *url* -info [*-pc*] *url* +info [**-pc**] *url* date [*url*] +# GENERAL OPTIONS -# OPTIONS +The following options can be used with all commands. + +**-i** +: Disable cert verification. + +**-N** +: Disable authentication prompt. --k *key* -: Key to use for encryption. +**-v** +: Verbose output. + +# COMMAND OPTIONS --p -: Don't encrypt or decrypt files. +**-a** +: Show all files. --c +**-c** : Enable full encryption. --R -: Recursively do the operation for all children. +**-d** +: Order by last modified date. --K +**-e** +: Show extended flags. + +**-K** : Keep already present files. --o *file* -: Write output to *file*. Use '-' for stdout. +**-k** *key* +: Key to use for encryption. --u *date* -: Get resources which are modified since the specified *date*. - --a -: Show all files. - --l +**-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* +**-L** *lock* : Specificy lock token. --T *sec* +**-n** *uri* +: Specify namespace *uri*. + +**-o** *file* +: Write output to *file*. Use '-' for stdout. + +**-O** +: Override resources. + +**-p** +: Don't encrypt or decrypt files. + +**-R** +: Recursively do the operation for all children. + +**-t** +: Print content type. + +**-T** *sec* : Timeout in seconds. --n *uri* -: Specify namespace *uri*. +**-u** *date* +: Get resources which are modified since the specified *date*. --x +**-x** : XML property content. --N -: Disable authentication prompt (all commands). - --i -: Disable cert verification (all commands). - --v -: Verbose output (all commands). # SEE ALSO