Sturgeon implements various tools for manipulating Emacs from OCaml:
Sturgeon_sexpimplements the Emacs dialect of S-expressions
Sturgeon_sessionimplements an "session protocol" to make RPC to Emacs from OCaml and vice versa
Sturgeon_stuiis a session implementing an Inuit backend: one can now runs text user-interface on an Emacs buffer
Sturgeon_recipes_*offers different "rendez-vous" points to connect to Emacs
Sturgeon is distributed under the ISC license.
Contact: Frédéric Bour
sturgeon can be installed with
opam install sturgeon
If you don't use
opam consult the
opam file for build
The documentation and API reference is automatically generated by
ocamldoc from the interfaces. It can be consulted online
and there is a generated version in the
doc directory of the
If you installed sturgeon with
opam sample programs are located in
opam config var sturgeon:doc.
In the distribution sample programs and tests are located in the
test directory of the distribution. They can be built with:
ocamlbuild -use-ocamlfind test/tests.otarget
The resulting binaries are in
test.nativetests the library, nothing should fail.