From a59fb35ce7653e47125efecab313a74d409a9731 Mon Sep 17 00:00:00 2001 From: Robert Sowula Date: Wed, 31 Mar 2021 15:30:36 +0200 Subject: [PATCH] doc: document plugin package names --- src/plugins/blockresolver/README.md | 5 +++++ src/plugins/ccode/README.md | 5 +++++ src/plugins/conditionals/README.md | 5 +++++ src/plugins/counter/README.md | 5 +++++ src/plugins/cpptemplate/README.md | 5 +++++ src/plugins/date/README.md | 5 +++++ src/plugins/dbusrecv/README.md | 5 +++++ src/plugins/desktop/README.md | 5 +++++ src/plugins/doc/README.md | 5 +++++ src/plugins/dpkg/README.md | 5 +++++ src/plugins/error/README.md | 5 +++++ src/plugins/fcrypt/README.md | 5 +++++ src/plugins/file/README.md | 5 +++++ src/plugins/filecheck/README.md | 5 +++++ src/plugins/fstab/README.md | 5 +++++ src/plugins/gitresolver/README.md | 5 +++++ src/plugins/gopts/README.md | 5 +++++ src/plugins/gpgme/README.md | 5 +++++ src/plugins/hexcode/README.md | 5 +++++ src/plugins/hexnumber/README.md | 5 +++++ src/plugins/iconv/README.md | 5 +++++ src/plugins/ipaddr/README.md | 5 +++++ src/plugins/iterate/README.md | 5 +++++ src/plugins/keytometa/README.md | 5 +++++ src/plugins/lineendings/README.md | 5 +++++ src/plugins/logchange/README.md | 5 +++++ src/plugins/macaddr/README.md | 5 +++++ src/plugins/mathcheck/README.md | 5 +++++ src/plugins/mmapstorage/README.md | 5 +++++ src/plugins/mozprefs/README.md | 5 +++++ src/plugins/passwd/README.md | 5 +++++ src/plugins/path/README.md | 5 +++++ src/plugins/process/README.md | 5 +++++ src/plugins/profile/README.md | 5 +++++ src/plugins/range/README.md | 5 +++++ src/plugins/reference/README.md | 5 +++++ src/plugins/resolver/README.md | 5 +++++ src/plugins/rgbcolor/README.md | 5 +++++ src/plugins/ruby/README.md | 5 +++++ src/plugins/syslog/README.md | 5 +++++ src/plugins/template/README.md | 5 +++++ src/plugins/timeofday/README.md | 5 +++++ src/plugins/tracer/README.md | 5 +++++ src/plugins/uname/README.md | 5 +++++ src/plugins/unit/README.md | 5 +++++ src/plugins/zeromqrecv/README.md | 5 +++++ 46 files changed, 230 insertions(+) diff --git a/src/plugins/blockresolver/README.md b/src/plugins/blockresolver/README.md index 0cef1fb86a3..28f259326fa 100644 --- a/src/plugins/blockresolver/README.md +++ b/src/plugins/blockresolver/README.md @@ -13,6 +13,11 @@ The `blockresolver` can be used to only resolve a tagged block inside a configuration file. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ### Implementation Details `blockresolver` extracts the requested block from the configurations file and writes it into a temporary file. Afterwards Elektra will only work on the temporary file until kdbSet is called. On kdbSet the contents of the temporary file will be merged with parts outside of the requested block from the original file. diff --git a/src/plugins/ccode/README.md b/src/plugins/ccode/README.md index fcc26200847..139c7a76681 100644 --- a/src/plugins/ccode/README.md +++ b/src/plugins/ccode/README.md @@ -23,6 +23,11 @@ CCode provides a reasonable default configuration, using the usual escape sequen for C strings (e.g. `\n` for newline, `\t` for tab). You can also configure the escape character (`/escape`) and the mapping for special characters (`chars`). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Restrictions This method of encoding characters is not as powerful as the hexcode plugin in terms of reduction. diff --git a/src/plugins/conditionals/README.md b/src/plugins/conditionals/README.md index 83100762352..a2a581207fc 100644 --- a/src/plugins/conditionals/README.md +++ b/src/plugins/conditionals/README.md @@ -13,6 +13,11 @@ This plugin uses if-then-else like conditions. It also works as global plugin. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Check Syntax Stored in the metakey `check/condition` to validate data is: diff --git a/src/plugins/counter/README.md b/src/plugins/counter/README.md index e880bb2ed34..bdc0ce97b9a 100644 --- a/src/plugins/counter/README.md +++ b/src/plugins/counter/README.md @@ -14,6 +14,11 @@ Counts and prints usage statistics. Only useful for debugging the plugin framework. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Module Loading Will not log when loaded as module (config `/module` present), unless `/logmodule` is set: diff --git a/src/plugins/cpptemplate/README.md b/src/plugins/cpptemplate/README.md index 504abdab9f0..4285e551820 100644 --- a/src/plugins/cpptemplate/README.md +++ b/src/plugins/cpptemplate/README.md @@ -21,6 +21,11 @@ scripts/dev/copy-template -p pluginname . For more information please take a look [here](../template/README.md) +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Example ```sh diff --git a/src/plugins/date/README.md b/src/plugins/date/README.md index 3547f5d68ea..4c5acce6ed5 100644 --- a/src/plugins/date/README.md +++ b/src/plugins/date/README.md @@ -9,6 +9,11 @@ - infos/metadata = check/date check/date/format - infos/description = validates date and time strings +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Validation options The following representation standards of dates and times are currently supported and can be use by setting `check/date` to: diff --git a/src/plugins/dbusrecv/README.md b/src/plugins/dbusrecv/README.md index 2c9878a6138..1be75df4b1c 100644 --- a/src/plugins/dbusrecv/README.md +++ b/src/plugins/dbusrecv/README.md @@ -14,6 +14,11 @@ This plugin is a notification plugin, which receives a signal from D-Bus when the key database (KDB) has been modified. It is compatible with the sending D-Bus plugin. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-dbus`. + ## Dependencies - `libdbus-1-dev` diff --git a/src/plugins/desktop/README.md b/src/plugins/desktop/README.md index ebef3abc52c..a971f81f332 100644 --- a/src/plugins/desktop/README.md +++ b/src/plugins/desktop/README.md @@ -14,6 +14,11 @@ The plugin is informational and mainly be used to provide context for other configuration. See [elektrify-getenv](/src/libs/getenv/README.md). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage To mount the plugin please use: diff --git a/src/plugins/doc/README.md b/src/plugins/doc/README.md index f3494d52aad..79f4f3fd3d0 100644 --- a/src/plugins/doc/README.md +++ b/src/plugins/doc/README.md @@ -12,3 +12,8 @@ ## Introduction This plugin has no functionality. It contains documentation explaining the basic makeup of a function. [The latest version of this documentation can be found on our documentation site.](https://doc.libelektra.org/api/master/html/group__plugin.html) + +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. diff --git a/src/plugins/dpkg/README.md b/src/plugins/dpkg/README.md index 5fc6e17ae08..b4c62facef1 100644 --- a/src/plugins/dpkg/README.md +++ b/src/plugins/dpkg/README.md @@ -7,6 +7,11 @@ - infos/status = nodep limited nodoc unfinished - infos/description = can be used to mount dpkg files +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Example ```sh diff --git a/src/plugins/error/README.md b/src/plugins/error/README.md index f620a7d5d35..5f86accb5cb 100644 --- a/src/plugins/error/README.md +++ b/src/plugins/error/README.md @@ -17,6 +17,11 @@ behavior is difficult to produce for tests. This plugin tackles this issue by yielding error/warnings on request. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage ### By metadata diff --git a/src/plugins/fcrypt/README.md b/src/plugins/fcrypt/README.md index 9a856f09502..f5636584590 100644 --- a/src/plugins/fcrypt/README.md +++ b/src/plugins/fcrypt/README.md @@ -21,6 +21,11 @@ This plugin encrypts backend files before the commit is executed (thus `precommi The plugin decrypts the backend files before the getstorage opens it (thus `pregetstorage`). After the getstorage plugin has read the backend file, the plugin decrypts the backend file again (thus `postgetstorage`). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Security Considerations There are two things to consider when using the `fcrypt` plugin: diff --git a/src/plugins/file/README.md b/src/plugins/file/README.md index d097598037d..3d0ecaf5a4f 100644 --- a/src/plugins/file/README.md +++ b/src/plugins/file/README.md @@ -13,6 +13,11 @@ The file plugin reads the content of a file and stores it into the parent key. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Configuration - `binary` diff --git a/src/plugins/filecheck/README.md b/src/plugins/filecheck/README.md index 1940aadbecf..7744c480e51 100644 --- a/src/plugins/filecheck/README.md +++ b/src/plugins/filecheck/README.md @@ -13,6 +13,11 @@ The filecheck plugin validates files. It tests: encoding, lineendings, BOM, printable characters and null bytes. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Configuration `check/lineending` diff --git a/src/plugins/fstab/README.md b/src/plugins/fstab/README.md index a91319ba648..595bd3082a6 100644 --- a/src/plugins/fstab/README.md +++ b/src/plugins/fstab/README.md @@ -12,6 +12,11 @@ This plugin is an implementation of a parser and generator of the /etc/fstab file. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Old fstab Entries (Deprecated, remove this section after it is reimplemented in the new way) diff --git a/src/plugins/gitresolver/README.md b/src/plugins/gitresolver/README.md index 38ae3a7b879..299916535a1 100644 --- a/src/plugins/gitresolver/README.md +++ b/src/plugins/gitresolver/README.md @@ -14,6 +14,11 @@ gitresolver is a resolver that fetches from a local git repository during the get-phase and commits them back at the end of the set-phase. It operates on a temporary copy of the latest version of your file fetched from the repository. If the temporary copy modified, a new commit with the modified version will be created. Local files won't be touched. +## Installation + +See [installation](/doc/INSTALL.md). +This plugin is currently **not** part of a package. + ## Options `branch` defines the branch to work on. Default: master diff --git a/src/plugins/gopts/README.md b/src/plugins/gopts/README.md index 25c810b23e3..831d54f4e71 100644 --- a/src/plugins/gopts/README.md +++ b/src/plugins/gopts/README.md @@ -23,6 +23,11 @@ Which operating system's functions the plugin uses is determined at compile-time > **Note:** One of the system-specific implementations of this plugin relies on procfs. > Therefore, if you compile the plugin on a system with procfs, the plugin may not work on other machine with the same OS or even on the same machine, if procfs is not mounted. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Basic Usage The preferred way of using this plugin is via a `kdbOpen` contract: diff --git a/src/plugins/gpgme/README.md b/src/plugins/gpgme/README.md index 5ed19471a45..bffe0a221c5 100644 --- a/src/plugins/gpgme/README.md +++ b/src/plugins/gpgme/README.md @@ -17,6 +17,11 @@ The encryption and decryption is designed to work transparently. The cryptographic operations are performed by GnuPG via the `libgpgme` library. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Dependencies - `libgpgme11` version 1.10 or later diff --git a/src/plugins/hexcode/README.md b/src/plugins/hexcode/README.md index 7244f4d1f7d..a93973f752c 100644 --- a/src/plugins/hexcode/README.md +++ b/src/plugins/hexcode/README.md @@ -15,6 +15,11 @@ hexadecimal character. The escape character itself always needs to be encoded, otherwise the plugin would try to interpret the following two characters in the text as a hexadecimal sequence. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Restrictions - The escape character itself always needs to be encoded, otherwise diff --git a/src/plugins/hexnumber/README.md b/src/plugins/hexnumber/README.md index 64da19bfd9b..0de6498331e 100644 --- a/src/plugins/hexnumber/README.md +++ b/src/plugins/hexnumber/README.md @@ -16,6 +16,11 @@ This plugin is used to read configuration files that use hexadecimal values. All converted into decimal when Elektra reads values from the mounted file. When Elektra writes back to the file the converted values will be converted back and stored as before (`0X` will be replaced with `0x`). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ### What are "hex-values"? There are multiple ways you can signal to the hexnumber plugin, that a value should be converted: diff --git a/src/plugins/iconv/README.md b/src/plugins/iconv/README.md index b65bd62d2da..68144140218 100644 --- a/src/plugins/iconv/README.md +++ b/src/plugins/iconv/README.md @@ -11,6 +11,11 @@ This plugin is a filter plugin that converts between different character encodings. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Purpose Consider a user insisting on a `latin1` character encoding because diff --git a/src/plugins/ipaddr/README.md b/src/plugins/ipaddr/README.md index b7db84d83d9..e1fbda0e4fe 100644 --- a/src/plugins/ipaddr/README.md +++ b/src/plugins/ipaddr/README.md @@ -15,6 +15,11 @@ This plugin validates IP addresses using regular expressions. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Usage ```sh diff --git a/src/plugins/iterate/README.md b/src/plugins/iterate/README.md index 004f0bc7a84..0585e45c4c9 100644 --- a/src/plugins/iterate/README.md +++ b/src/plugins/iterate/README.md @@ -7,6 +7,11 @@ - infos/status = unittest nodep libc experimental unfinished nodoc concept - infos/description = conditionally calls exported functions +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Usage Suppose you have a plugin bar that exports the function `foo(Key *k)`. diff --git a/src/plugins/keytometa/README.md b/src/plugins/keytometa/README.md index a584f070722..78288285acf 100644 --- a/src/plugins/keytometa/README.md +++ b/src/plugins/keytometa/README.md @@ -36,6 +36,11 @@ to the corresponding key (see merging for more details). The keys are ordered by the "order" metadata. If two keys are equal according to the order metadata, they are ordered by name instead. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Append Strategies The append strategy specifies which key will receive the resulting metadata. diff --git a/src/plugins/lineendings/README.md b/src/plugins/lineendings/README.md index 4f63b233ddc..7bb0c9508b3 100644 --- a/src/plugins/lineendings/README.md +++ b/src/plugins/lineendings/README.md @@ -12,6 +12,11 @@ The Lineendings Plugin verifies the line endings of a file. If inconsistent line endings or line endings that don't match `valid` are detected the plugin yields an error. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Configuration `valid` diff --git a/src/plugins/logchange/README.md b/src/plugins/logchange/README.md index c40f2261d87..a08839e1c09 100644 --- a/src/plugins/logchange/README.md +++ b/src/plugins/logchange/README.md @@ -12,6 +12,11 @@ The purpose of this plugin is to demonstrate how one can be notified of every removed, added or changed key easily. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage Prints every added, changed or deleted key on the console. diff --git a/src/plugins/macaddr/README.md b/src/plugins/macaddr/README.md index 47cf01a736d..38244aa51d9 100644 --- a/src/plugins/macaddr/README.md +++ b/src/plugins/macaddr/README.md @@ -20,6 +20,11 @@ This plugin validates MAC-addresses. The following MAC-address-formats are suppo `kdbGet` returns an integer-representation of these values. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage ```sh diff --git a/src/plugins/mathcheck/README.md b/src/plugins/mathcheck/README.md index 4c6438350f2..a930f05902a 100644 --- a/src/plugins/mathcheck/README.md +++ b/src/plugins/mathcheck/README.md @@ -16,6 +16,11 @@ How the values are compared is specified at the beginning of the metakey using t `:=` is used to set key values. All values are interpreted as `double` floating point values. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ### Keynames Keynames are all either relative to to-be-tested key (starting with `./` or `../`), relative to the parentkey (starting with `@/`) or absolute (e.g. `system:/key`). diff --git a/src/plugins/mmapstorage/README.md b/src/plugins/mmapstorage/README.md index 2c24e9e9155..12a51809877 100644 --- a/src/plugins/mmapstorage/README.md +++ b/src/plugins/mmapstorage/README.md @@ -44,6 +44,11 @@ The `mmapstorage` will always be compiled on a supported system (see [Dependenci we will additionally compile the `mmapstorage_crc` variant. The first variant does not do a CRC32 checksum of the critical data, while the second variant always checks the CRC32 checksum for additional security. +## Installation + +See [installation](/doc/INSTALL.md). +The `mmapstorage` variant is part of the `libelektra5` package and the `mmapstorage_crc` is part of the `libelektra5-extra` package. + ## Dependencies POSIX compliant system (including XSI extensions). diff --git a/src/plugins/mozprefs/README.md b/src/plugins/mozprefs/README.md index cda9acb7d0b..2c28c95f832 100644 --- a/src/plugins/mozprefs/README.md +++ b/src/plugins/mozprefs/README.md @@ -14,6 +14,11 @@ This plugin works on [Mozilla preference files](https://developer.mozilla.org/en-US/docs/Mozilla/Preferences/A_brief_guide_to_Mozilla_preferences) and is used in Elektra’s [Firefox autoconfig script](autoconfig/README.md). +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ### Preference Types - Default preferences: `pref(....`, keys below `mountpoint/pref/`. diff --git a/src/plugins/passwd/README.md b/src/plugins/passwd/README.md index 3ed6449b5af..695d2f67b9c 100644 --- a/src/plugins/passwd/README.md +++ b/src/plugins/passwd/README.md @@ -13,6 +13,11 @@ This plugin parses `passwd` files, e.g. `/etc/passwd`. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Implementation Details The non-POSIX function `fgetpwent` (GNU_SOURCE) will be used to diff --git a/src/plugins/path/README.md b/src/plugins/path/README.md index 95429b9feb2..1641f8d0bba 100644 --- a/src/plugins/path/README.md +++ b/src/plugins/path/README.md @@ -14,6 +14,11 @@ This plugin checks whether the value of a key is a valid file system path and optionally if correct permissions are set for a certain user. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Purpose The motivation to write this plugin is given by the two paths that exist diff --git a/src/plugins/process/README.md b/src/plugins/process/README.md index d21721d4b8c..f0a3a036f62 100644 --- a/src/plugins/process/README.md +++ b/src/plugins/process/README.md @@ -17,6 +17,11 @@ This is useful for runtimes or libraries that cannot be reinitialized in the sam after they have been used. It is also useful for plugins which cause memory leaks to be isolated in an own process. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Usage Mount this plugin and specify the plugin configuration parameter `plugin` to a plugin that exists on diff --git a/src/plugins/profile/README.md b/src/plugins/profile/README.md index 392dc4eea1d..f548b00f22b 100644 --- a/src/plugins/profile/README.md +++ b/src/plugins/profile/README.md @@ -25,6 +25,11 @@ preferences (next to the namespace preferences): 2. Usage of key in the profile set with `profile` 3. Usage of key in the `%` fallback profile +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Example Suppose we have the configuration file `profile.ini` in `~/.config`: diff --git a/src/plugins/range/README.md b/src/plugins/range/README.md index 0454f1e89f0..bc5531aa1de 100644 --- a/src/plugins/range/README.md +++ b/src/plugins/range/README.md @@ -13,6 +13,11 @@ The range plugin checks if a `Key`'s value is within a given range. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Usage The plugin checks every `Key` in the `KeySet` for the metakey `check/range` which contains either a single range with the syntax `[-]min-[-]max`, or a list of ranges or values separated by `,` and tests if the `Key`'s value is within the range(s). diff --git a/src/plugins/reference/README.md b/src/plugins/reference/README.md index 4a2ea749c72..3632aff89e8 100644 --- a/src/plugins/reference/README.md +++ b/src/plugins/reference/README.md @@ -27,6 +27,11 @@ In this reference graph each node corresponds to a key in the KDB, while each ed represents a reference between to keys. The plugin will produce an error, if this graph is not a directed acyclic graph or contains any invalid references. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ### Resolution of References The plugin will try to resolve all keys marked with the metakey `check/reference` as references. diff --git a/src/plugins/resolver/README.md b/src/plugins/resolver/README.md index a12c756c554..96d73acf0dd 100644 --- a/src/plugins/resolver/README.md +++ b/src/plugins/resolver/README.md @@ -78,6 +78,11 @@ non-root to modify keys in `system`. See [COMPILE.md](/doc/COMPILE.md) for a documentation of possible variants. +## Installation + +See [installation](/doc/INSTALL.md). +The default variant of this plugin `resolver_fm_hpu_b` is part of the `libelektra5` package. All other variants are part of the `libelektra5-extra` package. + ### XDG Compatibility The resolver is fully [XDG compatible](http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html) diff --git a/src/plugins/rgbcolor/README.md b/src/plugins/rgbcolor/README.md index 3e72ec09c7c..14ffe364f0d 100644 --- a/src/plugins/rgbcolor/README.md +++ b/src/plugins/rgbcolor/README.md @@ -18,6 +18,11 @@ This plugin validates hex-formatted rgb color strings and normalizes them to dec Add the metakey `check/rgbcolor` with an arbitrary value (e.g. `""`) to the key that you want to check and normalize. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Examples ```sh diff --git a/src/plugins/ruby/README.md b/src/plugins/ruby/README.md index 574f13cd627..175dfca2843 100644 --- a/src/plugins/ruby/README.md +++ b/src/plugins/ruby/README.md @@ -13,6 +13,11 @@ This plugin is an Elektra to Ruby bridge and makes is possible to implement Elektra plugins with Ruby. This plugin requires the `ruby` binding. +## Installation + +See [installation](/doc/INSTALL.md). +This plugin is currently **not** part of a package. + ## Configuration Options The plugin has the following configuration options: diff --git a/src/plugins/syslog/README.md b/src/plugins/syslog/README.md index a5d4eea2b44..26e974ccd58 100644 --- a/src/plugins/syslog/README.md +++ b/src/plugins/syslog/README.md @@ -14,3 +14,8 @@ commit and rollback of the configuration. Configure the plugin with `log/get=1` to enable logging when configuration is loaded. For example, `kdb gmount syslog log/get=1`. + +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. diff --git a/src/plugins/template/README.md b/src/plugins/template/README.md index a9b4fe76ae3..2563065c0be 100644 --- a/src/plugins/template/README.md +++ b/src/plugins/template/README.md @@ -14,6 +14,11 @@ Copy this template if you want to start a new plugin written in C. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-experimental`. + ## Usage You can use `scripts/copy-template` diff --git a/src/plugins/timeofday/README.md b/src/plugins/timeofday/README.md index 24d01ffa8e8..93dbb175b83 100644 --- a/src/plugins/timeofday/README.md +++ b/src/plugins/timeofday/README.md @@ -12,6 +12,11 @@ This plugin is a logging plugin which prints a timestamp during all placements of backend. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage If you want to measure how long your storage plugin needs to do the read diff --git a/src/plugins/tracer/README.md b/src/plugins/tracer/README.md index f143f2a0dcf..9a0601e84cd 100644 --- a/src/plugins/tracer/README.md +++ b/src/plugins/tracer/README.md @@ -12,6 +12,11 @@ This plugin is added on every possible position within a backend. It allows you to trace when the backend is executed. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Usage If you want to trace how and if the backend is called: diff --git a/src/plugins/uname/README.md b/src/plugins/uname/README.md index cf9b9e0cbbe..58b2e7884f3 100644 --- a/src/plugins/uname/README.md +++ b/src/plugins/uname/README.md @@ -12,6 +12,11 @@ This plugin is a storage plugin that will use the syscall `uname (2)`. No resolver is needed for that plugin to work. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Special Values This plugin defines following keynames below its mount point: diff --git a/src/plugins/unit/README.md b/src/plugins/unit/README.md index f936e747953..8bc1390639c 100644 --- a/src/plugins/unit/README.md +++ b/src/plugins/unit/README.md @@ -9,6 +9,11 @@ - infos/metadata = check/unit - infos/description = validates units of memory and normalizes to bytes +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-extra`. + ## Validation options The following representation standards of units are currently supported and can be used by setting `check/unit`: diff --git a/src/plugins/zeromqrecv/README.md b/src/plugins/zeromqrecv/README.md index 3bb383d968c..ed01f5cd302 100644 --- a/src/plugins/zeromqrecv/README.md +++ b/src/plugins/zeromqrecv/README.md @@ -13,6 +13,11 @@ This plugin is a notification plugin, which receives notifications using ZeroMq subscribe (`ZMQ_SUB`) sockets from the compatible zeromqsend plugin. +## Installation + +See [installation](/doc/INSTALL.md). +The package is called `libelektra5-zeromq`. + ## Dependencies - `libzmq3-dev` (ZeroMQ C bindings > 3.2)