$darkmode
Elektra 0.11.0
|
kdb plugin-check [<plugin>]
This command is used to perform checks on the key database or an Elektra plugin.
Where the option argument, plugin
is the plugin that a user wants to check. Use -c
to pass options to that plugin. If no plugin
argument is provided a check will be performed on the key database itself. Special values are returned upon exit to represent the outcome of a check.
-H
, --help
: Show the man page.-V
, --version
: Print version info.-p
, --profile <profile>
: Use a different kdb profile.-C
, --color <when>
: Print never/auto(default)/always colored output.-f
, --force
: The user can also use this tool to perform write tests. Please note that this can result in configuration files being changed!-v
, --verbose
: Explain what is happening. Prints additional information in case of errors/warnings.-c
, --plugins-config <plugins-config>
: Add a plugin configuration in addition to /module
.-d
, --debug
: Give debug information. Prints additional debug information in case of errors/warnings.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.
The outcome of a check on the key database is returned as an exit status. This integer represents an 8-bit pattern. Each bit represents a specific outcome as described below:
-f
is used)-f
is used)So if the following number was returned 9
the user could figure out more detail by considering the bits: 00001001
The user would know that there was a warning on open and an error on get.
If a plugin name is given, checks will only be done on the given plugin. The returned values for a check on a plugin are returned as much simpler numbers.
Return values on plugin checking:
Please report any output caused by official plugins to https://git.libelektra.org/issues.
Since the error code is a return value, it is not automatically displayed to the shell. If the user wants to have the value printed, they must do so manually (by running a command such as echo $?
).
To check the Key Database:
kdb plugin-check
To check the Key Database and then print the result:
kdb plugin-check
followed by:
echo $?
To check the Key Database including write checks:
kdb plugin-check -f
Note that this type of check may change configuration files.
To check the line
plugin:
kdb plugin-check line