GARBAGE_COLLECTION Help Definitions for Help

29.4: DOCUMENTATION

The function DESCRIBE(item) will offer a list of topics which include the substring item. The documentation will then be printed on the screen. It may also be put into a buffer by using the command MACSYMA DESCRIBE in the zmacs editor.

The variable ALL_MACSYMA_DOCUMENTATION is a list of file names which contain documentation in a format suitable to be read by DESCRIBE. You may of course add to any of these files, or add another file to the list. Each separate item should begin with "&" on a new line separated by a blank line. The key which will be used for searching, is the string up to the first blank space.

The function set-up-index will then be called to make an index and add it to *DESCRIBE-INDICES*, so that future calls to DESCRIBE will also see the additional documentation.

(set-up-index "MAXIMA-source:maxima;foo.bar" :make-new-one t)

would cause a new index to be made even if foo-index.bin already existed containing the appropriate index.

GARBAGE_COLLECTION

Help

Definitions for Help