The mutils Reference Manual

This is the mutils Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 14:23:32 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 mutils

A collection of Common Lisp modules.

Author

Mariano Montone <>

Home Page

https://github.com/mmontone/mutils

Version

0.1

Dependencies
  • alexandria (system).
  • cl-ppcre (system).
Source

mutils.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 mutils/mutils.asd

Source

mutils.asd.

Parent Component

mutils (system).

ASDF Systems

mutils.


3.1.2 mutils/directory-module-loader.lisp

Source

mutils.asd.

Parent Component

mutils (system).

Packages

directory-module-loader.

Public Interface
Internals

module-provide-directory (function).


3.1.3 mutils/mutils.lisp

Source

mutils.asd.

Parent Component

mutils (system).

Packages

mutils.

Public Interface

4 Packages

Packages are listed by definition order.


4.1 mutils

Source

mutils.lisp.

Use List

common-lisp.

Public Interface

4.2 directory-module-loader

Source

directory-module-loader.lisp.

Use List

common-lisp.

Public Interface
Internals

module-provide-directory (function).


5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *module-directories*

A list of pathnames (directories) where to look for module files.

Package

directory-module-loader.

Source

directory-module-loader.lisp.


5.1.2 Ordinary functions

Function: describe-module (module-name)

Print a description of module.

Package

mutils.

Source

mutils.lisp.

Function: describe-modules ()

Print a description of available mutils modules.

Package

mutils.

Source

mutils.lisp.

Function: list-all-modules (&optional return)

List all modules available for loading in *MODULE-DIRECTORIES*. Args:
- RETURN: What the function should return. Either :name or :pathname.

Package

directory-module-loader.

Source

directory-module-loader.lisp.

Function: list-modules (&optional return)

List mutils modules.
RETURN can be:
- :name . Just returns the name of the modules, as a keyword. Default. - :details. Parses the modules and returns its details.

Package

mutils.

Source

mutils.lisp.

Function: parse-lisp-module-file (file)

Parse a Lisp module file.

Returns the name of the module, its short description, its properties (author, requirements, keywords, etc.), its long description/comment with instructions of usage, etc.

Package

mutils.

Source

mutils.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: module-provide-directory (module-name)
Package

directory-module-loader.

Source

directory-module-loader.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*module-directories*: Public special variables

S
Special Variable, *module-directories*: Public special variables