The clad Reference Manual

This is the clad Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:34:48 2025 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clad

The CLAD System.

Author

Marco Antoniotti

License

BSD

Source

clad.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 clad/clad.asd

Source

clad.asd.

Parent Component

clad (system).

ASDF Systems

clad.


3.1.2 clad/clad-package.lisp

Source

clad.asd.

Parent Component

clad (system).

Packages

it.unimib.disco.ma.clad.


3.1.3 clad/clad.lisp

Dependency

clad-package.lisp (file).

Source

clad.asd.

Parent Component

clad (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 it.unimib.disco.ma.clad

Source

clad-package.lisp.

Nickname

clad

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: app-or-library-data-folder (app-or-library-name &key version-name impl-dependent-too)

Returns the folder (a pathname) for a given app or library.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: app-or-library-data-folders ()

Returns a list of the folder pathnames present in the CL data folder.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: ensure-app-or-library-data-folder (app-or-library-name &key version-name impl-dependent-too)

Ensures that the folder for an app or library exists.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: known-apps-or-libraries-data ()

Returns a list of known apps or libraries listed in the CL data folder.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: user-cl-data-folder ()

A synonim for USER-COMMON-LISP-DATA-DIRECTORY.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: user-common-lisp-data-directory ()

Return the "user" Common Lisp Data directory.

Two values are returned, the pathname and whether it exists in the file system.

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: +cl-subfolder-name+
Package

it.unimib.disco.ma.clad.

Source

clad.lisp.


5.2.2 Ordinary functions

Function: reset-app-or-data-folder (app-or-library-name &optional abort-if-non-empty)
Package

it.unimib.disco.ma.clad.

Source

clad.lisp.

Function: system-dependent-cl-subfolder-name ()

Return the platform dependent Common Lisp pathname.

This function returns a sensible pathname where Common Lisp code and libraries may reside.

Essentially it follows the XDG specification for Linux and UN*X systems (but not Mac OS), and ’normal’ defaults for MacOS (in "~/Library/Common Lisp") and Windows (in "AppData/Roaming/Common Lisp").

Package

it.unimib.disco.ma.clad.

Source

clad.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+cl-subfolder-name+: Private special variables

S
Special Variable, +cl-subfolder-name+: Private special variables