This is the cl-inix Reference Manual, version 0.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri May 15 11:51:38 2026 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-inixcl-inix is a flexible library for .INI/.conf file parsing
Artyom Bologov
(GIT https://codeberg.org/aartaka/cl-inix.git)
BSD-2 Clause
0.0.0
package.lisp (file).
cl-inix.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-inix/cl-inix.lisppackage.lisp (file).
cl-inix (system).
get (generic function).
get-array (function).
get-boolean (function).
get-integer (function).
get-read (function).
get-string (function).
read (generic function).
write (generic function).
%read (function).
-> (macro).
convert-key (function).
dlambda (macro).
no-break-space (special variable).
section (function).
slurp-key/value (function).
whitespace (special variable).
Packages are listed by definition order.
cl-inix‘cl-inix’ is a package with functions useful for .INI file handling:
- ‘cl-inix:read’ reads sections, keys, and values from file or string. Key
format, the overall output shape, delimiter char, and comment char
are all configurable.
- ‘cl-inix:get’ gets a value under section+key from any shape of data.
- ‘cl-inix:get-string’ gets a string value
- ‘cl-inix:get-integer’ gets an integer
- ‘cl-inix:get-boolean’ gets a boolean (with configurable keywords)
- ‘cl-inix:get-array’ gets an array (parsed with delimiter)
- ‘cl-inix:get-read’ gets a ‘cl:read’ value, whatever the type
- ‘cl-inix:write’ saves the data (of any shape) to a file.
common-lisp.
get (generic function).
get-array (function).
get-boolean (function).
get-integer (function).
get-read (function).
get-string (function).
read (generic function).
write (generic function).
%read (function).
-> (macro).
convert-key (function).
dlambda (macro).
no-break-space (special variable).
section (function).
slurp-key/value (function).
whitespace (special variable).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Get a value under KEY from SECTIONS.
Gets values from default (T) section or SECTION, when provided.
Read the configuration sections from IN.
IN can be either pathname or string.
KEY is the key-processing function:
- :STRING (default),
- :KEYWORD for keywords converted from uppercased key,
- :PRESERVE-KEYWORD for literal keys,
- :SYMBOL for symbols from uppercased keys,
- :PRESERVE-SYMBOL for literal keys,
- or a function taking a strings as an argument and returning something.
FORMAT is the output format:
- :ALIST (default) for dotted list of sections to key-value alists,
- :HASH-TABLE from section names to key-value hash tables.
PACKAGE is the package to intern :SYMBOL/:PRESERVE-SYMBOL keys into.
DELIMITER is a char separating key from value.
COMMENT-CHAR is the comment-initiating character.
Write SECTIONS to FILE.
Delimits key/values with DELIMITER (character or string, defaults to #\=).
KEY-CASE is the way keys are printed: either :DOWNCASE, :UPCASE, or :CAPITALIZE.
Example for pretty DWIM output:
(write sections #p"/path/to/output.conf" :delimiter " = " :key-case :downcase)
Or DOS vibes
(write sections #p"/PATH/TO/OUTPUT.INI" :delimiter "=" :key-case :UPCASE)
Whitespace characters.
Shorter ftype declaration for NAME.
| Jump to: | %
-
C D F G M R S W |
|---|
| Jump to: | %
-
C D F G M R S W |
|---|
| Jump to: | N S W |
|---|
| Jump to: | N S W |
|---|
| Jump to: | C F P S |
|---|
| Jump to: | C F P S |
|---|