The clad Reference Manual

Table of Contents

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

The clad Reference Manual

This is the clad Reference Manual, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 13:42:44 2019 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CLAD

Copyright (c) 2018-2019 Marco Antoniotti See file COPYING for licensing information

DESCRIPTION

The Common Lisp Application Directories (CLAD) library is a simple API collection that provides access to a set of "standard" Common Lisp folders on a "per-application" or "per-library" basis.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 clad

Author

Marco Antoniotti

License

BSD

Description

The CLAD System.

Source

clad.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 clad.asd

Location

clad.asd

Systems

clad (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 clad/clad-package.lisp

Parent

clad (system)

Location

clad-package.lisp

Packages

it.unimib.disco.ma.clad


Previous: , Up: Lisp files   [Contents][Index]

3.1.3 clad/clad.lisp

Dependency

clad-package.lisp (file)

Parent

clad (system)

Location

clad.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 it.unimib.disco.ma.clad

Source

clad-package.lisp (file)

Nickname

clad

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Functions

Function: app-or-library-data-folder APP-OR-LIBRARY-NAME &key VERSION-NAME IMPL-DEPENDENT-TOO &aux ADDL
Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

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 (file)

Function: ensure-app-or-library-data-folder APP-OR-LIBRARY-NAME &key VERSION-NAME IMPL-DEPENDENT-TOO
Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

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 (file)

Function: user-cl-data-folder ()
Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

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

it.unimib.disco.ma.clad

Source

clad.lisp (file)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: +cl-subfolder-name+
Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 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 (file)

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

it.unimib.disco.ma.clad

Source

clad.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
clad.asd: The clad<dot>asd file
clad/clad-package.lisp: The clad/clad-package<dot>lisp file
clad/clad.lisp: The clad/clad<dot>lisp file

F
File, Lisp, clad.asd: The clad<dot>asd file
File, Lisp, clad/clad-package.lisp: The clad/clad-package<dot>lisp file
File, Lisp, clad/clad.lisp: The clad/clad<dot>lisp file

L
Lisp File, clad.asd: The clad<dot>asd file
Lisp File, clad/clad-package.lisp: The clad/clad-package<dot>lisp file
Lisp File, clad/clad.lisp: The clad/clad<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   E   F   K   R   S   U  
Index Entry  Section

A
app-or-library-data-folder: Exported functions
app-or-library-data-folders: Exported functions

E
ensure-app-or-library-data-folder: Exported functions

F
Function, app-or-library-data-folder: Exported functions
Function, app-or-library-data-folders: Exported functions
Function, ensure-app-or-library-data-folder: Exported functions
Function, known-apps-or-libraries-data: Exported functions
Function, reset-app-or-data-folder: Internal functions
Function, system-dependent-cl-subfolder-name: Internal functions
Function, user-cl-data-folder: Exported functions
Function, user-common-lisp-data-directory: Exported functions

K
known-apps-or-libraries-data: Exported functions

R
reset-app-or-data-folder: Internal functions

S
system-dependent-cl-subfolder-name: Internal functions

U
user-cl-data-folder: Exported functions
user-common-lisp-data-directory: Exported functions

Jump to:   A   E   F   K   R   S   U  

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

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

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

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

Jump to:   +  
S  

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

A.4 Data types

Jump to:   C   I   P   S  
Index Entry  Section

C
clad: The clad system

I
it.unimib.disco.ma.clad: The it<dot>unimib<dot>disco<dot>ma<dot>clad package

P
Package, it.unimib.disco.ma.clad: The it<dot>unimib<dot>disco<dot>ma<dot>clad package

S
System, clad: The clad system

Jump to:   C   I   P   S