The clhs Reference Manual

This is the clhs Reference Manual, version 0.6.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:45:51 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 clhs

The HyperSpec-7-0 directory in this thin ASDF wrapper is a complete and unmodified copy of Lispworks’ Common Lisp HyperSpec version 7.0 (referenced from <http://www.lispworks.com/documentation/common-lisp.html>). Redistribution of the HyperSpec is made with permission from LispWorks per the terms and restrictions set forth at <http://www.lispworks.com/documentation/HyperSpec/Front/Help.htm#Legal>. You may further redistribute the HyperSpec subject to the same terms and restrictions; consult the previous link for all details.

License

HyperSpec: Proprietary; Thin ASDF wrapper (excluding HyperSpec): Public Domain

Version

0.6.3

Source

clhs.asd.

Child Components

3 Modules

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


3.1 clhs/HyperSpec-7-0

Source

clhs.asd.

Parent Component

clhs (system).


4 Files

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


4.1 Lisp


4.1.1 clhs/clhs.asd

Source

clhs.asd.

Parent Component

clhs (system).

ASDF Systems

clhs.


4.1.2 clhs/package.lisp

Dependency

hyperspec-7-0 (module).

Source

clhs.asd.

Parent Component

clhs (system).

Packages

clhs.


4.1.3 clhs/main.lisp

Dependency

package.lisp (file).

Source

clhs.asd.

Parent Component

clhs (system).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 clhs

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Special variables

Special Variable: *hyperspec-relative-directory*
Package

clhs.

Source

main.lisp.

Special Variable: *quicklisp-directory*
Package

clhs.

Source

main.lisp.

Special Variable: *system-directory*
Package

clhs.

Source

main.lisp.


6.1.2 Ordinary functions

Function: clhs-use-local-status (&key quicklisp-directory)
Package

clhs.

Source

main.lisp.

Function: emacs-setup-form (&key root indirect-through-quicklisp-p quicklisp-directory)
Package

clhs.

Source

main.lisp.

Function: hyperspec-root (&key system-directory relative-directory)
Package

clhs.

Source

main.lisp.

Function: install-clhs-use-local (&key if-exists verbose destination-directory ensure-directories-exist-p)
Package

clhs.

Source

main.lisp.

Function: print-emacs-setup-form (&key root indirect-through-quicklisp-p quicklisp-directory)
Package

clhs.

Source

main.lisp.


6.2 Internals


6.2.1 Ordinary functions

Function: %clhs-use-local (directory)
Package

clhs.

Source

main.lisp.

Function: %clhs-use-local-version (clhs-use-local)
Package

clhs.

Source

main.lisp.

Function: %copy-file (source destination &key if-source-does-not-exist if-destination-exists)
Package

clhs.

Source

main.lisp.

Function: %maybe-print-clhs-use-local-status-warning (&key stream quicklisp-directory interactive-test-p)
Package

clhs.

Source

main.lisp.

Function: %probe-file (pathname)
Package

clhs.

Source

main.lisp.

Function: %quicklisp-directory-setf-example ()
Package

clhs.

Source

main.lisp.

Function: %try-getting-authoritative-quicklisp-directory ()
Package

clhs.

Source

main.lisp.


6.2.2 Generic functions

Generic Function: %print (kind &key installed bundled installed-version bundled-version emacs-setup-form readme-location)
Package

clhs.

Source

main.lisp.

Methods
Method: %print ((kind (eql :not-installed)) &key)
Method: %print ((kind (eql :version-mismatch)) &key installed bundled installed-version bundled-version)
Method: %print ((kind (eql :installed)) &rest keys)
Method: %print ((kind (eql :step-2)) &key emacs-setup-form readme-location)

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   E   F   G   H   I   M   P  
Index Entry  Section

%
%clhs-use-local: Private ordinary functions
%clhs-use-local-version: Private ordinary functions
%copy-file: Private ordinary functions
%maybe-print-clhs-use-local-status-warning: Private ordinary functions
%print: Private generic functions
%print: Private generic functions
%print: Private generic functions
%print: Private generic functions
%print: Private generic functions
%probe-file: Private ordinary functions
%quicklisp-directory-setf-example: Private ordinary functions
%try-getting-authoritative-quicklisp-directory: Private ordinary functions

C
clhs-use-local-status: Public ordinary functions

E
emacs-setup-form: Public ordinary functions

F
Function, %clhs-use-local: Private ordinary functions
Function, %clhs-use-local-version: Private ordinary functions
Function, %copy-file: Private ordinary functions
Function, %maybe-print-clhs-use-local-status-warning: Private ordinary functions
Function, %probe-file: Private ordinary functions
Function, %quicklisp-directory-setf-example: Private ordinary functions
Function, %try-getting-authoritative-quicklisp-directory: Private ordinary functions
Function, clhs-use-local-status: Public ordinary functions
Function, emacs-setup-form: Public ordinary functions
Function, hyperspec-root: Public ordinary functions
Function, install-clhs-use-local: Public ordinary functions
Function, print-emacs-setup-form: Public ordinary functions

G
Generic Function, %print: Private generic functions

H
hyperspec-root: Public ordinary functions

I
install-clhs-use-local: Public ordinary functions

M
Method, %print: Private generic functions
Method, %print: Private generic functions
Method, %print: Private generic functions
Method, %print: Private generic functions

P
print-emacs-setup-form: Public ordinary functions