package batteries

  1. Overview
  2. Docs
package batteries
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module BatteriesHelpSource

Tools for reading the documentation from the toplevel

All these tools are invoked automatically by the Batteries Toplevel. They are provided here if you wish to integrate them into your own toplevel.

  • author David Teller
Sourcetype kinds =
  1. | Values
  2. | Types
  3. | Topics
  4. | Modules
  5. | Exns
  6. | Modtypes
  7. | Classes
  8. | Methods
  9. | Attributes
  10. | Objtypes
Sourceval init : unit -> unit

Proceed to initialization.

This function loads the primary help files and registers the toplevel directives.

If you integrate the on-line help system into your toplevel, you must call this function before any of the other functions of this module.

Sourceval help : unit -> unit

help () opens the tutorial.

Sourceval man : string -> unit

man "something" opens the help about subject "something".

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct