diff --git a/README.md b/README.md index 26c7bdffb1f..2a2ed9146a3 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ applications' configurations, leveraging easy application integration. - [Build server](https://build.libelektra.org/) - [Website](https://www.libelektra.org) -- [API docu](https://doc.libelektra.org/api/latest/html/) +- [API documentation](https://doc.libelektra.org/api/latest/html/) ## Overview diff --git a/doc/man/man1/kdb-check.1 b/doc/man/man1/kdb-check.1 index a98a187e450..0fefe267e46 100644 --- a/doc/man/man1/kdb-check.1 +++ b/doc/man/man1/kdb-check.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-CHECK" "1" "August 2018" "" "" +.TH "KDB\-CHECK" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-check\fR \- Perform internal checks @@ -39,12 +39,16 @@ The user can also use this tool to perform write tests\. Please note that this c . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. . .TP \fB\-c\fR, \fB\-\-plugins\-config \fR Add a plugin configuration in addition to \fB/module\fR\. . +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "RETURN VALUES" There are two different types of checks, a check on a plugin (by specifying the name of a plugin as an argument) or a check on the key database itself\. . diff --git a/doc/man/man1/kdb-complete.1 b/doc/man/man1/kdb-complete.1 index 2d7f54c1280..c3d76e677e0 100644 --- a/doc/man/man1/kdb-complete.1 +++ b/doc/man/man1/kdb-complete.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-COMPLETE" "1" "January 2019" "" "" +.TH "KDB\-COMPLETE" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-complete\fR \- Show suggestions how to complete a given path @@ -43,7 +43,7 @@ Specify the maximum depth of completion suggestions (unlimited by default, 1 to . .TP \fB\-v\fR, \fB\-\-verbose\fR -Give a more detailed output, showing the number of child nodes and the depth level\. +Give a more detailed output, showing the number of child nodes and the depth level\. Prints additional information in case of errors/warnings\. . .TP \fB\-0\fR, \fB\-\-null\fR @@ -51,7 +51,7 @@ Use binary 0 termination\. . .TP \fB\-d\fR, \fB\-\-debug\fR -Give debug information\. +Give debug information\. Prints additional debug information in case of errors/warnings\. . .SH "EXAMPLES" . diff --git a/doc/man/man1/kdb-convert.1 b/doc/man/man1/kdb-convert.1 index e8a4c3b6552..dd6e6b2e8bd 100644 --- a/doc/man/man1/kdb-convert.1 +++ b/doc/man/man1/kdb-convert.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-CONVERT" "1" "August 2018" "" "" +.TH "KDB\-CONVERT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-convert\fR \- Convert configuration files using elektra @@ -44,7 +44,11 @@ Print never/auto(default)/always colored output\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .SH "EXAMPLES" To convert an Elektra dump file to xml: diff --git a/doc/man/man1/kdb-cp.1 b/doc/man/man1/kdb-cp.1 index 02d9ae0a5df..f55c6329edb 100644 --- a/doc/man/man1/kdb-cp.1 +++ b/doc/man/man1/kdb-cp.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-CP" "1" "April 2019" "" "" +.TH "KDB\-CP" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-cp\fR \- Copy keys within the key database @@ -57,7 +57,11 @@ Recursively copy keys\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-f\fR, \fB\-\-force\fR diff --git a/doc/man/man1/kdb-editor.1 b/doc/man/man1/kdb-editor.1 index 82a1edc8d22..107d11958e7 100644 --- a/doc/man/man1/kdb-editor.1 +++ b/doc/man/man1/kdb-editor.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-EDITOR" "1" "August 2018" "" "" +.TH "KDB\-EDITOR" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-editor\fR \- Use your editor for editing KDB @@ -65,7 +65,11 @@ Specify which strategy should be used to resolve conflicts\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-e\fR, \fB\-\-editor \fR diff --git a/doc/man/man1/kdb-export.1 b/doc/man/man1/kdb-export.1 index 7f2e9704ea5..87109a07260 100644 --- a/doc/man/man1/kdb-export.1 +++ b/doc/man/man1/kdb-export.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-EXPORT" "1" "December 2017" "" "" +.TH "KDB\-EXPORT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-export\fR \- Export keys from the key database @@ -57,6 +57,14 @@ Omit the \fBsystem/elektra\fR directory\. \fB\-c\fR, \fB\-\-plugins\-config \fR Add a configuration to the format plugin\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "KDB" . .IP "\(bu" 4 diff --git a/doc/man/man1/kdb-file.1 b/doc/man/man1/kdb-file.1 index ce916ea9440..ef29f3d82b1 100644 --- a/doc/man/man1/kdb-file.1 +++ b/doc/man/man1/kdb-file.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-FILE" "1" "December 2017" "" "" +.TH "KDB\-FILE" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-file\fR \- Displays which file a key is stored in @@ -54,6 +54,14 @@ Suppress the newline at the end of the output\. \fB\-N\fR, \fB\-\-namespace \fR Specify the namespace to use when writing cascading keys\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "KDB" . .TP diff --git a/doc/man/man1/kdb-find.1 b/doc/man/man1/kdb-find.1 index 4e6b1c15ab0..0450e8c1bee 100644 --- a/doc/man/man1/kdb-find.1 +++ b/doc/man/man1/kdb-find.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-FIND" "1" "January 2019" "" "" +.TH "KDB\-FIND" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-find\fR \- Find keys in the key database @@ -35,7 +35,11 @@ Print never/auto(default)/always colored output\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-0\fR, \fB\-\-null\fR diff --git a/doc/man/man1/kdb-fstab.1 b/doc/man/man1/kdb-fstab.1 index fd278234a35..c9dc1206478 100644 --- a/doc/man/man1/kdb-fstab.1 +++ b/doc/man/man1/kdb-fstab.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-FSTAB" "1" "December 2017" "" "" +.TH "KDB\-FSTAB" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-fstab\fR \- Create a new fstab entry @@ -46,7 +46,11 @@ Print never/auto(default)/always colored output\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .SH "EXAMPLES" To create an fstab entry to mount \fBdev/sdb1\fR to \fB/media/external\fR stored in the key \fBsystem/fstab/sdb1\fR: diff --git a/doc/man/man1/kdb-get.1 b/doc/man/man1/kdb-get.1 index 2203059d4f3..5ae7a66a0f6 100644 --- a/doc/man/man1/kdb-get.1 +++ b/doc/man/man1/kdb-get.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-GET" "1" "May 2019" "" "" +.TH "KDB\-GET" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-get\fR \- Get the value of a key stored in the key database @@ -66,6 +66,10 @@ Suppress the newline at the end of the output\. \fB\-v\fR, \fB\-\-verbose\fR Explain what is happening\. Gives a complete trace of all tried keys\. Very useful to debug fallback and overrides\. . +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "EXAMPLES" . .nf diff --git a/doc/man/man1/kdb-getmeta.1 b/doc/man/man1/kdb-getmeta.1 index 426f5b6b0c3..7aee237f0ad 100644 --- a/doc/man/man1/kdb-getmeta.1 +++ b/doc/man/man1/kdb-getmeta.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-GETMETA" "1" "February 2019" "" "" +.TH "KDB\-GETMETA" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-getmeta\fR \- Get the value of a metakey stored in the key database @@ -59,6 +59,14 @@ Print never/auto(default)/always colored output\. \fB\-n\fR, \fB\-\-no\-newline\fR Suppress the newline at the end of the output\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "EXAMPLES" To get the value of a metakey called \fBdescription\fR stored in the key \fBspec/example/key\fR: . diff --git a/doc/man/man1/kdb-global-mount.1 b/doc/man/man1/kdb-global-mount.1 index 9711df69e43..e0dbd4ebeb0 100644 --- a/doc/man/man1/kdb-global-mount.1 +++ b/doc/man/man1/kdb-global-mount.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-GLOBAL\-MOUNT" "1" "August 2018" "" "" +.TH "KDB\-GLOBAL\-MOUNT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-global\-mount\fR \- Globally mount plugins @@ -48,6 +48,14 @@ Print never/auto(default)/always colored output\. \fB\-W\fR, \fB\-\-with\-recommends\fR Also add recommended plugins and warn if they are not available\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "KDB" . .TP diff --git a/doc/man/man1/kdb-import.1 b/doc/man/man1/kdb-import.1 index d0097cf0d66..551b76759f1 100644 --- a/doc/man/man1/kdb-import.1 +++ b/doc/man/man1/kdb-import.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-IMPORT" "1" "August 2018" "" "" +.TH "KDB\-IMPORT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-import\fR \- Import an existing configuration into the key database @@ -55,7 +55,11 @@ Specify which strategy should be used to resolve conflicts\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-c\fR, \fB\-\-plugins\-config\fR diff --git a/doc/man/man1/kdb-list.1 b/doc/man/man1/kdb-list.1 index c1368501d9d..114e3cde61f 100644 --- a/doc/man/man1/kdb-list.1 +++ b/doc/man/man1/kdb-list.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-LIST" "1" "December 2017" "" "" +.TH "KDB\-LIST" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-list\fR \- List plugins available to Elektra @@ -35,7 +35,11 @@ Print never/auto(default)/always colored output\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Also output the number calculated by their \fBinfos/status\fR clause in the contract\. +Also output the number calculated by their \fBinfos/status\fR clause in the contract\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-0\fR, \fB\-\-null\fR diff --git a/doc/man/man1/kdb-ls.1 b/doc/man/man1/kdb-ls.1 index 3ee4736bb04..468aaa189d5 100644 --- a/doc/man/man1/kdb-ls.1 +++ b/doc/man/man1/kdb-ls.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-LS" "1" "January 2019" "" "" +.TH "KDB\-LS" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-ls\fR \- List keys in the key database @@ -43,15 +43,15 @@ Specify the maximum path depth of the output (unlimited by default, 1 to show on . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. . .TP -\fB\-0\fR, \fB\-\-null\fR -Use binary 0 termination\. +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP -\fB\-d\fR, \fB\-\-debug\fR -Give debug information\. +\fB\-0\fR, \fB\-\-null\fR +Use binary 0 termination\. . .SH "EXAMPLES" . diff --git a/doc/man/man1/kdb-lsmeta.1 b/doc/man/man1/kdb-lsmeta.1 index ab1ae7c32f0..5f33b741f40 100644 --- a/doc/man/man1/kdb-lsmeta.1 +++ b/doc/man/man1/kdb-lsmeta.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-LSMETA" "1" "December 2017" "" "" +.TH "KDB\-LSMETA" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-lsmeta\fR \- Print metakeys associated with a key @@ -44,7 +44,11 @@ Use binary 0 termination\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Show which key will be used\. +Explain what is happening\. Prints additional information in case of errors/warnings\. Show which key will be used\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .SH "EXAMPLE" To see which metakeys are associated with a key: diff --git a/doc/man/man1/kdb-merge.1 b/doc/man/man1/kdb-merge.1 index f5576f5b135..0d8c73f61bf 100644 --- a/doc/man/man1/kdb-merge.1 +++ b/doc/man/man1/kdb-merge.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-MERGE" "1" "December 2017" "" "" +.TH "KDB\-MERGE" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-merge\fR \- Three\-way merge of KeySets @@ -120,7 +120,10 @@ Conflicts in a merge can be resolved using a \fIstrategy\fR with the \fB\-s\fR o \fB\-s\fR, \fB\-\-strategy \fR: Specify which strategy should be used to resolve conflicts\. . .IP "\(bu" 4 -\fB\-v\fR, \fB\-\-verbose\fR: Explain what is happening\. +\fB\-v\fR, \fB\-\-verbose\fR: Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.IP "\(bu" 4 +\fB\-d\fR, \fB\-\-debug\fR: Give debug information\. Prints additional debug information in case of errors/warnings\. . .IP "\(bu" 4 \fB\-i\fR, \fB\-\-interactive\fR Interactively resolve the conflicts\. diff --git a/doc/man/man1/kdb-mount.1 b/doc/man/man1/kdb-mount.1 index 0c9e71e761b..2001a1bec2f 100644 --- a/doc/man/man1/kdb-mount.1 +++ b/doc/man/man1/kdb-mount.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-MOUNT" "1" "February 2019" "" "" +.TH "KDB\-MOUNT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-mount\fR \- Mount a file to the key database @@ -61,7 +61,10 @@ For cascading mount points (starting with \fB/\fR) a mount point for the namespa \fB\-C\fR, \fB\-\-color \fR: Print never/auto(default)/always colored output\. . .IP "\(bu" 4 -\fB\-d\fR, \fB\-\-debug\fR: Give debug information or ask debug questions (in interactive mode)\. +\fB\-v\fR, \fB\-\-verbose\fR: Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.IP "\(bu" 4 +\fB\-d\fR, \fB\-\-debug\fR: Give debug information or ask debug questions (in interactive mode)\. Prints additional information in case of errors/warnings\. . .IP "\(bu" 4 \fB\-q\fR, \fB\-\-quiet\fR: Suppress non\-error messages\. diff --git a/doc/man/man1/kdb-mv.1 b/doc/man/man1/kdb-mv.1 index c10dc4974b2..6f834bba745 100644 --- a/doc/man/man1/kdb-mv.1 +++ b/doc/man/man1/kdb-mv.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-MV" "1" "May 2018" "" "" +.TH "KDB\-MV" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-mv\fR \- Move keys within the key database @@ -57,7 +57,11 @@ Work in a recursive mode\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .SH "EXAMPLES" To move multiple keys: diff --git a/doc/man/man1/kdb-remount.1 b/doc/man/man1/kdb-remount.1 index 443f781929e..8201721cbef 100644 --- a/doc/man/man1/kdb-remount.1 +++ b/doc/man/man1/kdb-remount.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-REMOUNT" "1" "August 2018" "" "" +.TH "KDB\-REMOUNT" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-remount\fR \- Use an existing backend to mount a new file @@ -44,8 +44,12 @@ Use a different kdb profile\. Print never/auto(default)/always colored output\. . .TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP \fB\-d\fR, \fB\-\-debug\fR -Give debug information or ask debug questions (in interactive mode)\. +Give debug information or ask debug questions (in interactive mode)\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-i\fR, \fB\-\-interactive\fR diff --git a/doc/man/man1/kdb-rm.1 b/doc/man/man1/kdb-rm.1 index 27bdc31a9a2..05c56215ef8 100644 --- a/doc/man/man1/kdb-rm.1 +++ b/doc/man/man1/kdb-rm.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-RM" "1" "December 2017" "" "" +.TH "KDB\-RM" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-rm\fR \- Remove key(s) from the key database @@ -41,6 +41,14 @@ Work in a recursive mode\. \fB\-f\fR, \fB\-\-force\fR Do not fail on missing key\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "EXAMPLES" To remove multiple keys: . diff --git a/doc/man/man1/kdb-rmmeta.1 b/doc/man/man1/kdb-rmmeta.1 index 03f43f85422..d498ebe99e4 100644 --- a/doc/man/man1/kdb-rmmeta.1 +++ b/doc/man/man1/kdb-rmmeta.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-RMMETA" "1" "August 2018" "" "" +.TH "KDB\-RMMETA" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-rmmeta\fR \- Remove metakey of a key from the key database @@ -33,6 +33,14 @@ Use a different kdb profile\. \fB\-C\fR, \fB\-\-color \fR Print never/auto(default)/always colored output\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "EXAMPLES" To remove metakey \fBmetakey\fR of a key: . diff --git a/doc/man/man1/kdb-set.1 b/doc/man/man1/kdb-set.1 index 4344328c1d3..18d7c30ae51 100644 --- a/doc/man/man1/kdb-set.1 +++ b/doc/man/man1/kdb-set.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-SET" "1" "August 2018" "" "" +.TH "KDB\-SET" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-set\fR \- Set the value of a key @@ -40,10 +40,6 @@ Use a different kdb profile\. Print never/auto(default)/always colored output\. . .TP -\fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. -. -.TP \fB\-q\fR, \fB\-\-quiet\fR Suppress non\-error messages\. . @@ -55,6 +51,14 @@ Specify the namespace to use when writing cascading keys\. See \fIbelow in KDB\f \fB\-\-\fR Do not process any following arguments starting with \fB\-\fR as options\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "KDB" . .TP diff --git a/doc/man/man1/kdb-setmeta.1 b/doc/man/man1/kdb-setmeta.1 index 4e208bbc183..af635e8f1e8 100644 --- a/doc/man/man1/kdb-setmeta.1 +++ b/doc/man/man1/kdb-setmeta.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-SETMETA" "1" "August 2018" "" "" +.TH "KDB\-SETMETA" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-setmeta\fR \- Set the value of a metakey @@ -38,7 +38,11 @@ Print never/auto(default)/always colored output\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Explain what is happening\. +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. . .TP \fB\-q\fR, \fB\-\-quiet\fR diff --git a/doc/man/man1/kdb-vset.1 b/doc/man/man1/kdb-vset.1 index ecf6548d5dd..f833a79eec6 100644 --- a/doc/man/man1/kdb-vset.1 +++ b/doc/man/man1/kdb-vset.1 @@ -1,7 +1,7 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "KDB\-VSET" "1" "December 2017" "" "" +.TH "KDB\-VSET" "1" "June 2019" "" "" . .SH "NAME" \fBkdb\-vset\fR \- Set the value of a key with a validation regular expression @@ -36,6 +36,14 @@ Use a different kdb profile\. \fB\-C\fR, \fB\-\-color \fR Print never/auto(default)/always colored output\. . +.TP +\fB\-v\fR, \fB\-\-verbose\fR +Explain what is happening\. Prints additional information in case of errors/warnings\. +. +.TP +\fB\-d\fR, \fB\-\-debug\fR +Give debug information\. Prints additional debug information in case of errors/warnings\. +. .SH "EXAMPLES" To mount the necessary validation plugin use: . diff --git a/doc/man/man7/elektra-plugins.7 b/doc/man/man7/elektra-plugins.7 index 51fc985b253..282d3472379 100644 --- a/doc/man/man7/elektra-plugins.7 +++ b/doc/man/man7/elektra-plugins.7 @@ -420,6 +420,9 @@ rgbcolor \fIrgbcolor/\fR validates and normalizes hexcolors .IP "\(bu" 4 macaddr \fImacaddr/\fR checks if MAC addresses are valid and normalizes them . +.IP "\(bu" 4 +unit \fIunit/\fR validates and normalizes units of memory (e\.g\. 20KB to 20000 Bytes) +. .IP "" 0 . .P diff --git a/doc/news/_preparation_next_release.md b/doc/news/_preparation_next_release.md index e4274f24ec8..92bee5bec21 100644 --- a/doc/news/_preparation_next_release.md +++ b/doc/news/_preparation_next_release.md @@ -718,7 +718,9 @@ The website is generated from the repository, so all information about plugins, bindings and tools are always up to date. Furthermore, we changed: - Added github build status badges to website _(hesirui)_ +- Added Docsearch to Website _(hesirui)_ - We updated part of a test for the [snippet converter](https://www.libelektra.org/conversion). _(René Schwaiger)_ + - <> ## Outlook diff --git a/src/tools/rest-frontend/Gruntfile.js b/src/tools/rest-frontend/Gruntfile.js index a12b3280315..bd7dd1af071 100755 --- a/src/tools/rest-frontend/Gruntfile.js +++ b/src/tools/rest-frontend/Gruntfile.js @@ -147,10 +147,19 @@ module.exports = function (grunt) { 'node_modules/angular-ui-notification/dist/angular-ui-notification.min.css', 'node_modules/ng-tags-input/build/ng-tags-input.min.css', 'node_modules/ng-tags-input/build/ng-tags-input.bootstrap.min.css', - 'node_modules/angular-typewriter/npm-dist/angular-typewrite.css' + 'node_modules/angular-typewriter/npm-dist/angular-typewrite.css', + 'node_modules/docsearch.js/dist/cdn/docsearch.min.css', ], dest: 'public/assets/skin/vendor.css', }, + docsearchcss: { + src: ['node_modules/docsearch.js/dist/cdn/docsearch.min.css'], + dest: 'public/vendor/docsearch.min.css' + }, + docsearchjs: { + src: ['node_modules/docsearch.js/dist/cdn/docsearch.min.js'], + dest: 'public/vendor/docsearch.min.js' + }, pacejs: { src: ['node_modules/pace-progress/pace.min.js'], dest: 'public/vendor/pace.min.js' diff --git a/src/tools/rest-frontend/package.json b/src/tools/rest-frontend/package.json index ada190e6f5e..81248c2a81f 100644 --- a/src/tools/rest-frontend/package.json +++ b/src/tools/rest-frontend/package.json @@ -59,7 +59,8 @@ "slugify": "^1.0.2", "sync-request": "^3.0.1", "underscore": "^1.8.3", - "xmlbuilder": "^8.2.2" + "xmlbuilder": "^8.2.2", + "docsearch.js": "latest" }, "scripts": { "postinstall": "./node_modules/grunt-cli/bin/grunt install" diff --git a/src/tools/rest-frontend/public/assets/translations/en.json b/src/tools/rest-frontend/public/assets/translations/en.json index fdcdff62b08..72a96da7e42 100755 --- a/src/tools/rest-frontend/public/assets/translations/en.json +++ b/src/tools/rest-frontend/public/assets/translations/en.json @@ -267,7 +267,7 @@ "APP.ENTRIES.SEARCH.ADVANCED.SORTBY.SLUG": "Slug", "APP.ENTRIES.SEARCH.SEARCHBOX.BUTTON.ADVANCEDOPTIONS": "Advanced options", "APP.ENTRIES.SEARCH.SEARCHBOX.BUTTON.SUBMIT": "Go!", - "APP.ENTRIES.SEARCH.SEARCHBOX.PLACEHOLDER": "Search for configuration snippet... (or keep empty to list all)", + "APP.ENTRIES.SEARCH.SEARCHBOX.PLACEHOLDER": "Search for documentation", "APP.ENTRIES.SEARCH.TABLE.ACTION.BUTTON.DETAILS": "Details", "APP.ENTRIES.SEARCH.TABLE.ACTION.BUTTON.RAWDETAILS": "Raw", "APP.ENTRIES.SEARCH.TABLE.HEADER.ACTIONS": "Actions", @@ -325,7 +325,7 @@ "APP.HOME.LABEL.ORIENTATION.2.HEADLINE": "Use Elektra outside C/C++", "APP.HOME.LABEL.ORIENTATION.3.DETAILS": "Of course we can! An initiative like Elektra asks periodically for decisions! We welcome everyone to join the discussions!", "APP.HOME.LABEL.ORIENTATION.3.HEADLINE": "Can you Elaborate on the Why?", - "APP.HOME.LABEL.ORIENTATION.4.DETAILS": "This website does not only contain the news and documentation around Elektra. It does also comprise a service that allows for sharing, searching, converting and downloading of configuration snippets in various formats. To search for a snippet, use the search bar at the top of the page. Uploading new snippets requires an account, which you can register here. All snippets have the BSD license and are available in different formats in a git repository.", + "APP.HOME.LABEL.ORIENTATION.4.DETAILS": "This website does not only contain the news and documentation around Elektra. It does also comprise a service that allows for sharing, searching, converting and downloading of configuration snippets in various formats. To search for a snippet, navigate to snippet search. Uploading new snippets requires an account, which you can register here. All snippets have the BSD license and are available in different formats in a git repository.", "APP.HOME.LABEL.ORIENTATION.4.HEADLINE": "Sharing of Configuration Snippets", "APP.HOME.LABEL.ORIENTATION.5.DETAILS": "Utilize Elektra’s code generator to generate type-safe configuration access code based on the same specification as used for validation.", "APP.HOME.LABEL.ORIENTATION.5.HEADLINE": "Code Generation", diff --git a/src/tools/rest-frontend/public/pages/main/template.html b/src/tools/rest-frontend/public/pages/main/template.html index 6c6ed841295..f0be7f199eb 100755 --- a/src/tools/rest-frontend/public/pages/main/template.html +++ b/src/tools/rest-frontend/public/pages/main/template.html @@ -1,3 +1,5 @@ + +