diff --git a/doc/INSTALL.md b/doc/INSTALL.md index 7b6a0114433..286ab31a571 100644 --- a/doc/INSTALL.md +++ b/doc/INSTALL.md @@ -53,6 +53,8 @@ The `etc/apt/source.list` entry must look like following: `deb https://debs.libe E.g. `deb https://debs.libelektra.org/focal focal-unstable main` +3. Run `sudo apt-get update`. + > NOTE: for Ubuntu Bionic the yamlcpp plugin is excluded due to missing dependencies and therefore the package `libelektra5-yamlcpp` is not available. ### Fedora diff --git a/doc/news/_preparation_next_release.md b/doc/news/_preparation_next_release.md index 13c0981d793..c2851c16ffb 100644 --- a/doc/news/_preparation_next_release.md +++ b/doc/news/_preparation_next_release.md @@ -203,6 +203,7 @@ _(@tucek)_ - <> - <> +- Document names of different components. _(Markus Raab)_ - Update buildserver documentation _(Robert Sowula)_ - Reworked [METADATA.ini](/doc/METADATA.ini) _(Markus Raab)_ - Minor rewording in INSTALL.md _(@a-kraschitzer)_ diff --git a/src/plugins/augeas/README.md b/src/plugins/augeas/README.md index 117063aed9d..0588d7a176d 100644 --- a/src/plugins/augeas/README.md +++ b/src/plugins/augeas/README.md @@ -23,6 +23,9 @@ can be found at http://augeas.net/ ## Installation +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-augeas`. + If you have installed Augeas manually, it may be necessary to update the ld configuration. This is especially true if an older version of Augeas is installed also. Such a situation may lead to an error similar to this: diff --git a/src/plugins/crypto/README.md b/src/plugins/crypto/README.md index 8d6a1eb9eef..93096ad76da 100644 --- a/src/plugins/crypto/README.md +++ b/src/plugins/crypto/README.md @@ -23,6 +23,11 @@ Also the cryptographic keys must never be exposed to the outside of the crypto m The crypto plugin uses libgcrypt as provider of cryptographic operations. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-crypto`. + ## Dependencies - `libgcrypt20-dev` or `libgcrypt-devel` diff --git a/src/plugins/curlget/README.md b/src/plugins/curlget/README.md index 3f9e74f16bb..a679ff80893 100644 --- a/src/plugins/curlget/README.md +++ b/src/plugins/curlget/README.md @@ -13,6 +13,11 @@ The `curlget` plugin is a resolver using libcurl to upload and download files from/to remote hosts. When mounted with a `URL` as configuration file there will be no changes to the file system. When mounted with a (local) path to a configuration a copy of the remote configuration is kept and used as fallback in `kdbGet()` if fetching the remote file from the server fails. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-curl`. + ## Configuration ### definitions diff --git a/src/plugins/dbus/README.md b/src/plugins/dbus/README.md index 64c26261a02..15167fc7697 100644 --- a/src/plugins/dbus/README.md +++ b/src/plugins/dbus/README.md @@ -13,6 +13,11 @@ This plugin is a notification plugin, which sends a signal to D-Bus when the key database (KDB) has been modified. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-dbus`. + ## Dependencies - `libdbus-1-dev` diff --git a/src/plugins/jni/README.md b/src/plugins/jni/README.md index d514cad0fdf..c02ee586c01 100644 --- a/src/plugins/jni/README.md +++ b/src/plugins/jni/README.md @@ -33,6 +33,9 @@ The Java plugin itself needs to have the following methods: ## Installation +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-java`. + ### Java Prerequisites on Debian 9 openjdk-8 and 9 do not work reliable: jvm crashes without usable backtrace. diff --git a/src/plugins/journald/README.md b/src/plugins/journald/README.md index 72bc05f727e..82a66d84726 100644 --- a/src/plugins/journald/README.md +++ b/src/plugins/journald/README.md @@ -17,6 +17,11 @@ Successful writes are reported with priority 5 (notice priority) and use the mes Configure the plugin with `log/get=1` to enable logging when configuration is loaded. For example, `kdb gmount journald log/get=1`. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-journald`. + ## Dependencies - `libsystemd-dev` (also called `libsystemd-journal-dev`) diff --git a/src/plugins/lua/README.md b/src/plugins/lua/README.md index b1efc599771..dc3f5a970b2 100644 --- a/src/plugins/lua/README.md +++ b/src/plugins/lua/README.md @@ -14,6 +14,11 @@ The plugin uses Lua to do magic things. It basically allows to call plugins writ What a Lua script can do is not really limited by design, so any kind of plugin may be implemented. The lua plugin is especially useful to write filter and logging scripts. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-lua`. + ## Usage The lua plugin accepts only the **script** configuration parameter holding the path to a Lua diff --git a/src/plugins/python/README.md b/src/plugins/python/README.md index 9f4be01b904..55569c7fc24 100644 --- a/src/plugins/python/README.md +++ b/src/plugins/python/README.md @@ -14,6 +14,11 @@ The plugin uses Python to do magic things. It allows plugins to be written in Py What a Python script can do is not really limited by design, so any kind of plugin may be implemented. The python plugin is especially useful to write filter and logging scripts. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-python`. + ## Usage The python plugin requires the configuration parameter **script** holding the file path to a diff --git a/src/plugins/xerces/README.md b/src/plugins/xerces/README.md index 1b84ed48ad4..628a7ab7f99 100644 --- a/src/plugins/xerces/README.md +++ b/src/plugins/xerces/README.md @@ -19,6 +19,13 @@ formatted files. It uses a general format which: = attribute value - Ignores XML comments +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-xerces`. + +To include this plugin in a homebrew installation run `brew tap elektrainitiative/elektra` followed by `brew install elektrainitiative/elektra/elektra --with-xerces` + ## Usage To mount an XML file we use: @@ -68,8 +75,6 @@ the mount point, then it uses the mount point's name instead. - CMake 3.6 or a copy of `FindXercesC.cmake` in `/usr/share/cmake-3.0/Modules/` -To include this plugin in a homebrew installation run `brew tap elektrainitiative/elektra` followed by `brew install elektrainitiative/elektra/elektra --with-xerces` - ## Limitations This plugin is not able to handle key names which contain characters that are not diff --git a/src/plugins/xmltool/README.md b/src/plugins/xmltool/README.md index 65a873be201..aaa88e43a9e 100644 --- a/src/plugins/xmltool/README.md +++ b/src/plugins/xmltool/README.md @@ -15,6 +15,11 @@ formatted files. It uses the legacy Elektra 0.7 XML format. This plugin can be used for migration of Key Databases from 0.7 -> 0.8. It should not be used otherwise. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-xmltool`. + ## Dependencies - `libxml2-dev` diff --git a/src/plugins/yajl/README.md b/src/plugins/yajl/README.md index 5ba56f99b0e..1d36d6c2b79 100644 --- a/src/plugins/yajl/README.md +++ b/src/plugins/yajl/README.md @@ -26,6 +26,11 @@ A validator can be found [here](http://jsonlint.com/). Supports every KeySet except when arrays are intermixed with other keys. Has only limited support for metadata. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-yajl`. + ## Dependencies - `libyajl-dev` (version 1 and 2 should work) diff --git a/src/plugins/yamlcpp/README.md b/src/plugins/yamlcpp/README.md index cc4a0d42bb7..c8ea7aa0787 100644 --- a/src/plugins/yamlcpp/README.md +++ b/src/plugins/yamlcpp/README.md @@ -15,6 +15,11 @@ The YAML CPP plugin reads and writes configuration data via the [yaml-cpp][] library. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-yamlcpp`. + ## Usage You can mount this plugin via `kdb mount`: diff --git a/src/plugins/zeromqsend/README.md b/src/plugins/zeromqsend/README.md index d16872cc918..953ca05f1c0 100644 --- a/src/plugins/zeromqsend/README.md +++ b/src/plugins/zeromqsend/README.md @@ -14,6 +14,11 @@ This plugin is a notification plugin, which sends notifications using ZeroMq publish (`ZMQ_PUB`) sockets when the key database (KDB) has been modified. It is compatible with the sending zeromqrecv plugin. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-zeromq`. + ## Dependencies - `libzmq3-dev` (ZeroMQ C bindings > 3.2)