help

(help name [examples-bool] [path])


Description:

Help prints out help for the givem name (help is a macro). examples-bool is an optional boolean allowing examples to be printed as well.  path is a directory path which is provided saves an html copy of the help entry with the name of sym as the filename.html


Arguments:

           path -- optional path to a directory where a copy of the help entry will be saved as an html file.

           name -- name to show help on (help is a macro so name does not need to be quoted)

  examples-bool -- optional bool #t if you want to display examples


Returns: boolean


Related: impromptu-help 


Examples:

(help osc-send)

(help osc-send #f)

(help osc-send "/tmp/output/")



Back to index