[comp.lang.clu] CLU manual help on-line

boaz@CONCERTO.LCS.MIT.EDU (Boaz Ben-Zvi) (03/08/91)

  A hassle in writing CLU code is the frequent need to search through the
CLU manual (appendix A in the CLU book) for the exact specifications of
some operations. Also when writing a large project in CLU, one has often
to search through one's code to find the exact parameters needed by some
procedure, or the specifications of some abstraction, etc.

  A solution to the above problems is now available: You can have the CLU
manual on-line as part of the help facility in Emacs. You can also augment
the manual with the specifications of your user defined abstractions.

  The package is available via anonymous ftp on  pion.lcs.mit.edu
(same machine that keeps the CLU source distribution) in the file
  pub/clu-manual/clu-manual.tar.Z  . A README file in the same directory
(also inside the package) describes all the features.

 In short, here is one example of using the online CLU manual (once installed
and loaded into Emacs):

  You type  		 C-h d
  Emacs prompts with	 Describe CLU symbol: 
  You type		 oneof$make_  <RETURN>
  Emacs splits your screen and gives the following help:
----------------------------------------------------------------
Operation on type class: ONEOF

 make_n_[i] = proc (e: t_[i]) returns (ot) 
   effects  Returns a oneof object with tag n_[i] and value e.
	There is a make_ operation for each selector.
 
  (  ot = oneof[n_1 : t_1, ..., n_k: t_k]  )
----------------------------------------------------------------

 Other features include help on general topics (e.g., input/output, syntax),
all the Emacs' tricks (completion, defaults, apropos, etc.), and ways to 
add (the specifications of) your CLU files into the CLU on-line manual.

Enjoy it ....

-- Boaz.

========================================================
*   Boaz Ben-Zvi   (boaz@neutron.lcs.mit.edu)          *
*   MIT: NE43-526   Tel: (617) 253-6212                *
========================================================