home *** CD-ROM | disk | FTP | other *** search
/ Peanuts NeXT Software Archives / Peanuts-1.iso / Documents / developer / lisp / clman.README next >
Encoding:
Text File  |  1989-10-27  |  2.3 KB  |  65 lines
  1. The following files, which implement and document CLMAN (Franz Inc's
  2. CL Manual), on the NeXT machine, are now available by anonymous FTP
  3. (file ~ftp/pub/franzinc/next/clman.tar.Z on hosts uunet.uu.net and
  4. ucbvax.berkeley.edu).
  5.     
  6.     clman.el    (generic CLMAN code)
  7.     next-clman.el    (next-specific CLMAN code)
  8.     next-cook-data.el (code for generating tables used by CLMAN)
  9.     README         (this document)
  10.     spec.next.n    (the user guide to CLMAN)
  11.  
  12. This message tells you how to install CLMAN (Franz Inc's CL Manual) on
  13. your NeXT machine.  This is essentially the same CLMAN that is
  14. available on most platforms that support Franz's Allegro CL.
  15.  
  16. The first time you start up emacs with this code, the system takes
  17. about 5 minutes to build the table that it will use for all future use
  18. of CLMAN.  This will only happen once.
  19.  
  20. If you set the value of next:save-clman-pages to T, then manual pages
  21. will automatically be written out to a file in a subdirectory of
  22. next-clman-code-directory.  (Thus, you should have write-permission in
  23. the directory that is the value of next-clman-code-directory.)
  24. Subsequent lookups will run much faster, because the system does not
  25. have to perform the extra step of nroffing the manual page.  If you do
  26. not want this feature, set the value of next:save-clman-pages to NIL.
  27.  
  28.  
  29. ;;  
  30. ;;  STEP 1: Place the following three files in some directory.
  31. ;;    
  32.  
  33. ;; clman.el
  34. ;; next-clman.el
  35. ;; next-cook-data.el
  36.  
  37. ;;  STEP 2: Place the following code in your .emacs file.
  38.  
  39. ;; If the following  variable is T, then CLMAN pages will be saved 
  40. ;;  (in subdirectories under the code directory).  Thus, CLMAN
  41. ;;  will get faster through use.
  42.  
  43. (setq next:save-clman-pages t)
  44.  
  45. ;;    Lets assume you put the CLMAN CODE FILES files in a directory called 
  46. ;;    /usr/local/clman.
  47.  
  48. (setq next-clman-code-directory "/usr/local/clman/")
  49.  
  50. ;; bind the key ESC-m to the top-level CLMAN lookup function
  51.  
  52. (global-set-key "\em" 'fi:clman)
  53.  
  54. ;; bind the key ESC-a to the top-level manual CLMAN apropos function
  55. (global-set-key "\ea" 'fi:clman-apropos)
  56.  
  57. ;;  We load the two files that implement the lookup facility of 
  58. ;;  CLMAN.
  59.  
  60. (load-file (concat next-clman-code-directory "clman.el"))
  61. (load-file (concat next-clman-code-directory "next-clman.el"))
  62.  
  63. ;;  Now type ESC-a for fi:clman-apropos or ESC-m for fi:clman
  64. ;;  Refer to the user guide for further instructions on using CLMAN.
  65.