table of contents
| md_src_plugins_simpleini_README(3elektra) | Elektra | md_src_plugins_simpleini_README(3elektra) |
NAME¶
md_src_plugins_simpleini_README - Plugin: simpleini
- infos = Information about SIMPLEINI plugin is in keys below
- infos/author = Markus Raab elektra@libelektra.org
- infos/licence = BSD
- infos/provides = storage/ini
- infos/needs = code null
- infos/placements = getstorage setstorage
- infos/status = maintained nodep concept obsolete 3000
- infos/description = Very simple storage which writes out in a basic ini format.
This plugin reads and writes files written in a basic line-oriented ini-like format. It is very simplistic without sections, the ini plugin and for specifications the ni plugin should be preferred in most cases. Since the simpleini plugin requires the GNU C library it will not work on operating systems that use another C library such as macOS.
Usage¶
It is quite suitable to export configuration if you want line-by-line key, value pairs without sections or metadata. (Thus +3000 in status)
$ kdb export system/samba simpleini
Configuration¶
The only parameter simpleini supports is format which allows you to change the syntax of individual lines. The format is a string with any characters where only % has special meaning:
- % in an even number N are escaped and represent N/2 %, e.g. %%%% are actually %% in the resulting format.
- The first unescaped % represents the key.
- The second unescaped % represents the value.
The default is % = %.
For example, if you want every key to be marked %:key value you would use:
$ kdb export -c "format=%%:% %" system/samba simpleini %:key value %:key2 value2
Restrictions¶
- Lines in a different format (e.g. comments) are discarded.
- The order per line must be key and then value: the plugin cannot be used if the value is first
- Whitespace before and after keynames are trimmed (but not for value)
- Delimiting symbols cannot be part of the key.
- The last occurrence of the same key wins (others are discarded).
- The parent Key cannot be used.
- This plugin needs the code and null plugins. A code plugin is used for the escape character for some symbols (but does not respect user-defined format) and the null plugin is used to handle null values.
Examples¶
Mount the plugin:
$ kdb mount -d /etc/samba/smb.conf system/samba ccode null simpleini
| Mon Jan 15 2018 | Version 0.8.20 |