| Elektra 0.11.0

Plugin: line

- infos = Information about line plugin is in keys below
- infos/author = Ian Donnelly ian.s.nosp@m..don.nosp@m.nelly.nosp@m.@gma.nosp@m.il.co.nosp@m.m
- infos/provides = storage/line
- infos/licence = BSD
- infos/needs = binary
- infos/placements = getstorage setstorage
- infos/status = maintained unittest nodep libc final limited
- infos/description = storage plugin which stores each line from a file

# Introduction

This plugin is useful if you have a file in a format not supported by any other plugin and want to use the Elektra tools to edit individual lines.

This plugin is designed to save each line from a file as a key. The keys form an array. The key names are determined by the line number such as `#3` or `#_12` for lines 4 and 13. The plugin considers `#0` to be the first line. The plugin will automatically add `_` to the beginning of key names in order to keep them in numerical order (like specified for Elektra arrays).

The value of each key hold the content of the actual file line-by-line.

# Examples

For example, consider the following content of the file `~/.config/line` where the numbers on the left represent the line numbers:

1 setting1 true
2 setting2 false
3 setting3 1000
4 #comment
5
6
7 //some other comment
8
9 setting4 -1

We mount that file by:

sudo kdb mount line user:/line line

This file would result in the following keyset which is being displayed as `key: value`, e.g. with:

kdb export -c "format=%s: %s" user:/line simpleini
#> 0: setting1 true
#> 1: setting2 false
#> 2: setting3 1000
#> 3: #comment
#> 4:
#> 5:
#> 6: //some other comment
#> 7:
#> 8: setting4 -l

## Creating Files

# Backup-and-Restore:/tests/line
sudo kdb mount line /tests/line base64 line
kdb set user:/tests/line/add something
kdb set user:/tests/line/ignored huhu
kdb set user:/tests/line ignored # adding parent key does nothing
kdb set user:/tests/line/add here
cat `kdb file user:/tests/line`
#> something
#> huhu
#> here
kdb ls user:/tests/line
# STDOUT-REGEX: line.+line/#0.+line/#1.+line/#2
kdb set user:/tests/line/#1 huhu
# STDOUT-REGEX: Set string to "huhu"
kdb export user:/tests/line line
#> something
#> huhu
#> here
sudo kdb umount /tests/line

## Other Tests

# Backup-and-Restore:/tests/line
sudo kdb mount line /tests/line base64 line
# create and initialize testfile
echo 'setting1 true' > `kdb file user:/tests/line`
echo 'setting2 false' >> `kdb file user:/tests/line`
echo 'setting3 1000' >> `kdb file user:/tests/line`
echo '#comment' >> `kdb file user:/tests/line`
echo >> `kdb file user:/tests/line`
echo >> `kdb file user:/tests/line`
echo '//some other comment' >> `kdb file user:/tests/line`
echo >> `kdb file user:/tests/line`
echo 'setting4 -1' >> `kdb file user:/tests/line`
# output filecontent and display line numbers
awk '{print NR-1 "-" $0}' < `kdb file user:/tests/line`
#> 0-setting1 true
#> 1-setting2 false
#> 2-setting3 1000
#> 3-#comment
#> 4-
#> 5-
#> 6-//some other comment
#> 7-
#> 8-setting4 -1
# cleanup
kdb rm -r user:/tests/line
sudo kdb umount /tests/line