doc: document plugin package names

a-kraschitzer · Apr 12, 2021 · a59fb35 · a59fb35
1 parent d628e7e
commit a59fb35
Show file tree

Hide file tree

Showing 46 changed files with 230 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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