The clhs Reference Manual

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

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 Mon Aug 15 04:13:17 2022 GMT+0.

Table of Contents


1 Introduction

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
).
Redistribution of the HyperSpec is made with permission from LispWorks
per the terms and restrictions set forth at
.
You may further redistribute the HyperSpec subject to the same terms
and restrictions; consult the previous link for all details.

This thin ASDF wrapper was prepared by Jean-Philippe Paradis
(hexstream@gmail.com) for inclusion in Quicklisp and is not endorsed
by LispWorks Ltd. Common Lisp HyperSpec is a registered trademark of
LispWorks Ltd. Jean-Philippe Paradis is not a lawyer, has not
consulted a lawyer, and prepared this thin ASDF wrapper as a community
service on a "good faith, best-effort" basis.

The original download was a .tar.gz file and has been uncompressed for
your convenience. The primary use cases for downloading the HyperSpec
to your hard drive instead of using the online documentation at
 are
to benefit from the increased responsiveness inherent in browsing a
local resource and to ensure reliable, fast access from anywhere while
on the go (ex: laptop, smartphone).

Use (clhs:print-emacs-setup-form) to print the command used to tell
Emacs to use your new local copy of CLHS.

(Note that the default setup involves automatic creation and usage of
a symlink that points to the 'HyperSpec' directory within the "real
top-level" 'HyperSpec-7-0' directory. Don't redistribute the former
without the latter!)

Slime has commands to quickly get at what you want in the HyperSpec.
They are:

slime-documentation-lookup (C-c C-d h)
Lookup a symbol (such as "make-instance").

common-lisp-hyperspec-lookup-reader-macro (C-c C-d #)
Lookup a reader-macro (such as "#'" or "(").

common-lisp-hyperspec-format (C-c C-d ~)
Lookup a FORMAT directive (such as "~A").


If the default browser used is not the one you wanted, here's how
you might tell Emacs to use Firefox instead:

(setq browse-url-firefox-program "firefox")

Or Google Chrome:

(setq browse-url-browser-function 'browse-url-generic)
(setq browse-url-generic-program "google-chrome")

2 Systems

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


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

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

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

3 Modules

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


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

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.


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

4.1 Lisp


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

4.1.1 clhs/clhs.asd

Source

clhs.asd.

Parent Component

clhs (system).

ASDF Systems

clhs.


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

4.1.2 clhs/package.lisp

Dependency

hyperspec-7-0 (module).

Source

clhs.asd.

Parent Component

clhs (system).

Packages

clhs.


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

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.


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

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.


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

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


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

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


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

A.1 Concepts


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

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

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