The clhs Reference Manual

Table of Contents

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 2.3 "Robert April" on Tue Jan 09 14:12:14 2018 GMT+0.


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

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")

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 clhs

Author

Common Lisp Specification: X3J13 Committee HyperSpec: Kent Pitman <kmp@lispworks.com>

License

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

Description

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.

Version

0.6.3

Source

clhs.asd (file)

Components

Next: , Previous: , Up: Top   [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

Parent

clhs (system)

Location

HyperSpec-7-0/


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

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 files   [Contents][Index]

4.1.1 clhs.asd

Location

clhs.asd

Systems

clhs (system)


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

4.1.2 clhs/package.lisp

Dependency

hyperspec-7-0 (module)

Parent

clhs (system)

Location

package.lisp

Packages

clhs


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

4.1.3 clhs/main.lisp

Dependency

package.lisp (file)

Parent

clhs (system)

Location

main.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 clhs

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *hyperspec-relative-directory*
Package

clhs

Source

main.lisp (file)

Special Variable: *quicklisp-directory*
Package

clhs

Source

main.lisp (file)

Special Variable: *system-directory*
Package

clhs

Source

main.lisp (file)


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

6.1.2 Functions

Function: clhs-use-local-status &key QUICKLISP-DIRECTORY
Package

clhs

Source

main.lisp (file)

Function: emacs-setup-form &key ROOT INDIRECT-THROUGH-QUICKLISP-P QUICKLISP-DIRECTORY
Package

clhs

Source

main.lisp (file)

Function: hyperspec-root &key SYSTEM-DIRECTORY RELATIVE-DIRECTORY
Package

clhs

Source

main.lisp (file)

Function: install-clhs-use-local &key IF-EXISTS VERBOSE DESTINATION-DIRECTORY ENSURE-DIRECTORIES-EXIST-P
Package

clhs

Source

main.lisp (file)

Function: print-emacs-setup-form &key ROOT (INDIRECT-THROUGH-QUICKLISP-P INDIRECTP) QUICKLISP-DIRECTORY
Package

clhs

Source

main.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Functions

Function: %clhs-use-local DIRECTORY
Package

clhs

Source

main.lisp (file)

Function: %clhs-use-local-version CLHS-USE-LOCAL
Package

clhs

Source

main.lisp (file)

Function: %copy-file SOURCE DESTINATION &key IF-SOURCE-DOES-NOT-EXIST IF-DESTINATION-EXISTS
Package

clhs

Source

main.lisp (file)

Function: %maybe-print-clhs-use-local-status-warning &key STREAM QUICKLISP-DIRECTORY INTERACTIVE-TEST-P
Package

clhs

Source

main.lisp (file)

Function: %probe-file PATHNAME
Package

clhs

Source

main.lisp (file)

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

clhs

Source

main.lisp (file)

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

clhs

Source

main.lisp (file)


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

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

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

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
clhs.asd: The clhs<dot>asd file
clhs/HyperSpec-7-0: The clhs/hyperspec-7-0 module
clhs/main.lisp: The clhs/main<dot>lisp file
clhs/package.lisp: The clhs/package<dot>lisp file

F
File, Lisp, clhs.asd: The clhs<dot>asd file
File, Lisp, clhs/main.lisp: The clhs/main<dot>lisp file
File, Lisp, clhs/package.lisp: The clhs/package<dot>lisp file

L
Lisp File, clhs.asd: The clhs<dot>asd file
Lisp File, clhs/main.lisp: The clhs/main<dot>lisp file
Lisp File, clhs/package.lisp: The clhs/package<dot>lisp file

M
Module, clhs/HyperSpec-7-0: The clhs/hyperspec-7-0 module

Jump to:   C   F   L   M  

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: Internal functions
%clhs-use-local-version: Internal functions
%copy-file: Internal functions
%maybe-print-clhs-use-local-status-warning: Internal functions
%print: Internal generic functions
%print: Internal generic functions
%print: Internal generic functions
%print: Internal generic functions
%print: Internal generic functions
%probe-file: Internal functions
%quicklisp-directory-setf-example: Internal functions
%try-getting-authoritative-quicklisp-directory: Internal functions

C
clhs-use-local-status: Exported functions

E
emacs-setup-form: Exported functions

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

G
Generic Function, %print: Internal generic functions

H
hyperspec-root: Exported functions

I
install-clhs-use-local: Exported functions

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

P
print-emacs-setup-form: Exported functions

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

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*hyperspec-relative-directory*: Exported special variables
*quicklisp-directory*: Exported special variables
*system-directory*: Exported special variables

S
Special Variable, *hyperspec-relative-directory*: Exported special variables
Special Variable, *quicklisp-directory*: Exported special variables
Special Variable, *system-directory*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
clhs: The clhs system
clhs: The clhs package

P
Package, clhs: The clhs package

S
System, clhs: The clhs system

Jump to:   C   P   S