Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The conf Reference Manual

This is the conf Reference Manual, version 1.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:49:48 2024 GMT+0.

Next: Systems, Previous: The conf Reference Manual, Up: The conf Reference Manual [Contents][Index]

1 Introduction

Next: Modules, Previous: Introduction, Up: The conf Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

conf

Previous: Systems, Up: Systems [Contents][Index]

2.1 `conf`

Simple configuration file manipulator for projects.

Maintainer: noloop <noloop@zoho.com>
Author: noloop <noloop@zoho.com>
Home Page: https://github.com/noloop/conf
Source Control: (GIT git@github.com:noloop/conf.git)
Bug Tracker: https://github.com/noloop/conf/issues
License: GPLv3
Version: 1.0.1
Dependency: cl-fad (system).
Source: conf.asd.
Child Component: src (module).

Next: Files, Previous: Systems, Up: The conf Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

conf/src

Previous: Modules, Up: Modules [Contents][Index]

3.1 `conf/src`

Source

conf.asd.

Parent Component

conf (system).

Child Components

package.lisp (file).
conf.lisp (file).

Next: Packages, Previous: Modules, Up: The conf Reference Manual [Contents][Index]

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

Next: conf/src/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `conf/conf.asd`

Source: conf.asd.
Parent Component: conf (system).
ASDF Systems: conf.

Next: conf/src/conf.lisp, Previous: conf/conf.asd, Up: Lisp [Contents][Index]

4.1.2 `conf/src/package.lisp`

Source: conf.asd.
Parent Component: src (module).
Packages: noloop.conf.

Previous: conf/src/package.lisp, Up: Lisp [Contents][Index]

4.1.3 `conf/src/conf.lisp`

Dependency

package.lisp (file).

Source

conf.asd.

Parent Component

src (module).

Public Interface

get-conf-directory (function).
get-conf-file (function).
get-conf-full-path (function).
get-conf-hash (function).
init-conf (function).
replace-conf (function).
set-conf-directory (function).
set-conf-file (function).

Internals

hash-table-for-string (function).
list-for-hash-table (function).
load-conf-file-for-hash-table (function).
load-file (function).
read-field (function).
replace-conf-fields (function).
save-conf-file (function).
save-file (function).

Next: Definitions, Previous: Files, Up: The conf Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

noloop.conf

Previous: Packages, Up: Packages [Contents][Index]

5.1 `noloop.conf`

Source

package.lisp.

Nickname

conf

Use List

common-lisp.

Public Interface

get-conf-directory (function).
get-conf-file (function).
get-conf-full-path (function).
get-conf-hash (function).
init-conf (function).
replace-conf (function).
set-conf-directory (function).
set-conf-file (function).

Internals

hash-table-for-string (function).
list-for-hash-table (function).
load-conf-file-for-hash-table (function).
load-file (function).
read-field (function).
replace-conf-fields (function).
save-conf-file (function).
save-file (function).

Next: Indexes, Previous: Packages, Up: The conf Reference Manual [Contents][Index]

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

6.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Ordinary functions

Function: get-conf-directory (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: get-conf-file (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: get-conf-full-path (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: get-conf-hash (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: init-conf (directory file-name) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: replace-conf (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: set-conf-directory (conf new-directory) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: set-conf-file (conf new-file-name) ¶

Package: noloop.conf.
Source: conf.lisp.

Previous: Public Interface, Up: Definitions [Contents][Index]

6.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: hash-table-for-string (your-hash) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: list-for-hash-table (your-list) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: load-conf-file-for-hash-table (conf) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: load-file (file-name) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: read-field (field-name actual-value) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: replace-conf-fields (your-hash) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: save-conf-file (conf conf-hash) ¶

Package: noloop.conf.
Source: conf.lisp.

Function: save-file (file-name stg) ¶

Package: noloop.conf.
Source: conf.lisp.

Previous: Definitions, Up: The conf Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	F G H I L R S

	Index Entry	Section

F
	`Function, get-conf-directory`:	Public ordinary functions
	`Function, get-conf-file`:	Public ordinary functions
	`Function, get-conf-full-path`:	Public ordinary functions
	`Function, get-conf-hash`:	Public ordinary functions
	`Function, hash-table-for-string`:	Private ordinary functions
	`Function, init-conf`:	Public ordinary functions
	`Function, list-for-hash-table`:	Private ordinary functions
	`Function, load-conf-file-for-hash-table`:	Private ordinary functions
	`Function, load-file`:	Private ordinary functions
	`Function, read-field`:	Private ordinary functions
	`Function, replace-conf`:	Public ordinary functions
	`Function, replace-conf-fields`:	Private ordinary functions
	`Function, save-conf-file`:	Private ordinary functions
	`Function, save-file`:	Private ordinary functions
	`Function, set-conf-directory`:	Public ordinary functions
	`Function, set-conf-file`:	Public ordinary functions

G
	`get-conf-directory`:	Public ordinary functions
	`get-conf-file`:	Public ordinary functions
	`get-conf-full-path`:	Public ordinary functions
	`get-conf-hash`:	Public ordinary functions

H
	`hash-table-for-string`:	Private ordinary functions

I
	`init-conf`:	Public ordinary functions

L
	`list-for-hash-table`:	Private ordinary functions
	`load-conf-file-for-hash-table`:	Private ordinary functions
	`load-file`:	Private ordinary functions

R
	`read-field`:	Private ordinary functions
	`replace-conf`:	Public ordinary functions
	`replace-conf-fields`:	Private ordinary functions

S
	`save-conf-file`:	Private ordinary functions
	`save-file`:	Private ordinary functions
	`set-conf-directory`:	Public ordinary functions
	`set-conf-file`:	Public ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F M N P S

	Index Entry	Section

C
	`conf`:	The conf system
	`conf.asd`:	The conf/conf․asd file
	`conf.lisp`:	The conf/src/conf․lisp file

F
	`File, conf.asd`:	The conf/conf․asd file
	`File, conf.lisp`:	The conf/src/conf․lisp file
	`File, package.lisp`:	The conf/src/package․lisp file

M
	`Module, src`:	The conf/src module

N
	`noloop.conf`:	The noloop․conf package

P
	`Package, noloop.conf`:	The noloop․conf package
	`package.lisp`:	The conf/src/package․lisp file

S
	`src`:	The conf/src module
	`System, conf`:	The conf system

The conf Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 conf

3 Modules

3.1 conf/src

4 Files

4.1 Lisp

4.1.1 conf/conf.asd

4.1.2 conf/src/package.lisp

4.1.3 conf/src/conf.lisp

5 Packages

5.1 noloop.conf

6 Definitions

6.1 Public Interface

6.1.1 Ordinary functions

6.2 Internals

6.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `conf`

3.1 `conf/src`

4.1.1 `conf/conf.asd`

4.1.2 `conf/src/package.lisp`

4.1.3 `conf/src/conf.lisp`

5.1 `noloop.conf`