Initial revision
[hyperspec-lookup.git] / README
blob0adefd3a4fba815ac79b7e9522f3859c2f4aa840
1 Description:
3   hyperspec: a ANSI Common Lisp library that provides a
4   reliable way of mapping symbols to URLs for both the Common Lisp
5   Hyperspec and the Common Lisp Object System MetaObject Protocol.
7 Usage:
9   Note that there is some overlap between the MOP and the Hyperspec
10   and in those cases `lookup' will always return the Hyperspec result
11   first.  For example:
13     * (lookup "add-method")
14     "http://www.lispworks.com/reference/HyperSpec/Body/f_add_me.htm"
16   but note that:
18     * (mop-lookup "add-method")
19     "http://www.alu.org/mop/dictionary.html#add-method"
21   also succeeds.
23 Customization:
25   You'll probably have to customize the *hyperspec-map-file* and the
26   *mop-map-file* to point to local copies (note that Mop_Sym.txt is
27   distributed with this library).
29 Erik.