xref: /aosp_15_r20/external/libconfig/contrib/ls-config/doc/bin.api.txt (revision 2e9d491483b805f09ea864149eadd5680efcc72a)
1Instalation:
2------------
3
4First place somewhere ls-config binary, or make it from source
5
6Then if You woud like use it with national translation, then You muas build
7it form source and then copy *.mo files according to You system
8
9Usage:
10------
11
12Remember to call ls-config always with -f parameter,
13wich give ls-config inormation wich config file use.
14
15Then this program operate in three based modes:
16-g (get) for reading values (default)
17-s (set) for store values
18-h (help) for display help message
19both parameter (-g and -s) nedd to give it variable path
20(internal configuration variable path)
21
22for exapmle read info value from config file:
23ls-config -f config -g info
24
25Then You can set this value to another
26ls-config -f config -s info -d "Somethint to write"
27
28But when You wand to addn new configutation variable you must
29specify his type:
30ls-config -f config -s someint -d 10 -p int
31
32You can remove (unset) variable too. This is subfunstion of setting:
33ls-config -f config -s someint -u
34
35When reading You cent use following flag:
36-v - read only variable valut
37-t - read only variable type
38-c - read only variable element count (sense only in types: array, list, group)
39-i - read only variable index (sense only in type: array, list)
40-n - read only variable name
41
42and sometimes usable
43-q  - to wori in quiet mode usable in scripts.
44
45For example to read variable somevar type, where variable in group foo:
46ls-config -f config -g "foo.somevar" -t
47
48For detailed list of parametera (long options available too) run ls-config
49in help mode:
50ls-config -h
51
52Configuraiton files:
53--------------------
54
55Detailed configuration file shema are publicated on:
56http://www.hyperrealm.com/libconfig/
57And his gramar on:
58http://www.hyperrealm.com/libconfig/libconfig_manual.html#Configuration-Files
59
60there are only short describe:
61configuration = setting-list | empty
62setting-list = setting | setting-list setting
63setting = name (":" | "=") value (";" | "," | empty)
64value = scalar-value | array | list | group
65value-list = value | value-list "," value
66scalar-value = boolean | integer | integer64 | hex | hex64 | float | string
67scalar-value-list = scalar-value | scalar-value-list "," scalar-value
68array = "[" (scalar-value-list | empty) "]"
69list = "(" (value-list | empty) ")"
70group = "{" (setting-list | empty) "}"
71empty =
72
73smaple configuration file and script are available on sample/ directory
74config - samble configuration file
75script - sample script, then read info variable from config file
76