Overview Clamps Packages CM Dictionary Clamps Dictionary Fomus
Next: start-gui , Previous: start , Up: S , Home: Overview

Clamps Dictionary

start-doc-acceptor

Function

(start-doc-acceptor)

Start the doc acceptor for online documentation if the *​clamps-doc-root​* is set to http://localhost:8282/. The startup is done automatically on Clamps Startup to make the Clamps documentation accessible at the URL https://localhost:8282.

The doc's start address is http://localhost:8282/overview/index.html, but documentation can also be accessed using the <C-c C-d c> Emacs keyboard shortcut with the cursor positioned after a Clamps or Common Music symbol in a lisp source file (see Common Music​/​Clamps in Online Help System.

To configure this, copy one the of the following lisp expressions into the file ~/.clampsinit.lisp

  • To use local documentation (make, curl and tar have to be installed):
(set-clamps-doc-root "http://localhost:8282/")
  • To use online documentation in the internet:
(set-clamps-doc-root "https://selma.hfmdk-frankfurt.de/finnendahl/clamps-doc/")

start-doc-acceptor also checks if the local HTML documentation is up-to-date and will download and extract it into ~/.config/common-lisp/clamps-doc/ otherwise.

See also

Author: Orm Finnendahl

Created: 2025-12-12 Fr 21:36

Validate