Manpages.

See Cmdliner.Manpage.

Sourcetype block = [
  1. | `S of string
  2. | `P of string
  3. | `Pre of string
  4. | `I of string * string
  5. | `Noblank
  6. | `Blocks of block list
]
Sourceval escape : string -> string

escape s escapes s from the doc language.

Sourcetype title = string * int * string * string * string
Sourcetype t = title * block list
Sourcetype xref = [
  1. | `Main
  2. | `Cmd of string
  3. | `Tool of string
  4. | `Page of string * int
]

Standard section names

Sourceval s_name : string
Sourceval s_synopsis : string
Sourceval s_description : string
Sourceval s_commands : string
Sourceval s_arguments : string
Sourceval s_options : string
Sourceval s_common_options : string
Sourceval s_exit_status : string
Sourceval s_environment : string
Sourceval s_files : string
Sourceval s_bugs : string
Sourceval s_examples : string
Sourceval s_authors : string
Sourceval s_see_also : string
Sourceval s_none : string

Section maps

Used for handling the merging of metadata doc strings.

Sourcetype smap
Sourceval smap_of_blocks : block list -> smap
Sourceval smap_to_blocks : smap -> block list
Sourceval smap_has_section : smap -> sec:string -> bool
Sourceval smap_append_block : smap -> sec:string -> block -> smap

smap_append_block smap sec b appends b at the end of section sec creating it at the right place if needed.

Content boilerplate

Sourceval s_exit_status_intro : block
Sourceval s_environment_intro : block

Output

Sourcetype format = [
  1. | `Auto
  2. | `Pager
  3. | `Plain
  4. | `Groff
]
Sourceval print : ?errs:Stdlib.Format.formatter -> ?subst:(string -> string option) -> format -> Stdlib.Format.formatter -> t -> unit

Printers and escapes used by Cmdliner module

Sourceval subst_vars : errs:Stdlib.Format.formatter -> subst:(string -> string option) -> Stdlib.Buffer.t -> string -> string

subst b ~subst s, using b, substitutes in s variables of the form "$(doc)" by their subst definition. This leaves escapes and markup directives $(markup,…) intact.

  • raises Invalid_argument

    in case of illegal syntax.

Sourceval doc_to_plain : errs:Stdlib.Format.formatter -> subst:(string -> string option) -> Stdlib.Buffer.t -> string -> string

doc_to_plain b ~subst s using b, substitutes in s variables by their subst definition and renders cmdliner directives to plain text.

  • raises Invalid_argument

    in case of illegal syntax.