Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance search #2581

Closed
wants to merge 20 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -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

Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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 <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\.
.
Expand Down
6 changes: 3 additions & 3 deletions 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
Expand Down Expand Up @@ -43,15 +43,15 @@ 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
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"
.
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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:
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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 <editor>\fR
Expand Down
10 changes: 9 additions & 1 deletion 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
Expand Down Expand Up @@ -57,6 +57,14 @@ Omit the \fBsystem/elektra\fR directory\.
\fB\-c\fR, \fB\-\-plugins\-config <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
Expand Down
10 changes: 9 additions & 1 deletion 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
Expand Down Expand Up @@ -54,6 +54,14 @@ Suppress the newline at the end of the output\.
\fB\-N\fR, \fB\-\-namespace <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
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 5 additions & 1 deletion 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
Expand Down Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion 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
Expand Down Expand Up @@ -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:
.
Expand Down
10 changes: 9 additions & 1 deletion 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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions 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
Expand Down Expand Up @@ -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"
.
Expand Down
8 changes: 6 additions & 2 deletions 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
Expand Down Expand Up @@ -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:
Expand Down