package reason

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Man pages

package reason

reason
reason.cmdliner
- Vendored_cmdliner
  - Arg
  - Manpage
  - Term
reason.easy_format
- Vendored_easy_format
  - Compact
  - Pretty
reason.ocaml-migrate-parsetree
- Reason_omp
  - Ast_402
    
    Asttypes
    
    Outcometree
  - Ast_403
    
    Asttypes
    
    Outcometree
  - Ast_404
    
    Asttypes
    
    Outcometree
  - Ast_405
    
    Asttypes
    
    Outcometree
  - Ast_406
    
    Asttypes
    
    Outcometree
  - Ast_407
    
    Asttypes
    
    Outcometree
  - Ast_408
    
    Asttypes
    
    Outcometree
  - Ast_409
    
    Asttypes
    
    Outcometree
  - Ast_410
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_411
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_412
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_413
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_414
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_500
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_51
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Ast_52
    
    Asttypes
    
    Outcometree
    
    Type_immediacy
  - Compiler_libs
  - Def
  - Migrate_402_403
  - Migrate_403_402
  - Migrate_403_404
  - Migrate_404_403
  - Migrate_404_405
  - Migrate_405_404
  - Migrate_405_406
  - Migrate_406_405
  - Migrate_406_407
  - Migrate_407_406
  - Migrate_407_408
  - Migrate_408_407
    
    Def
  - Migrate_408_409
  - Migrate_409_408
  - Migrate_409_410
  - Migrate_410_409
    
    Def
  - Migrate_410_411
  - Migrate_411_410
  - Migrate_411_412
  - Migrate_412_411
  - Migrate_412_413
  - Migrate_413_412
  - Migrate_413_414
  - Migrate_414_413
  - Migrate_414_500
  - Migrate_500_414
  - Migrate_500_51
  - Migrate_51_500
  - Migrate_51_52
  - Migrate_52_51
  - Versions
    
    Ast
    
    Outcometree
    
    Convert
    
    A
    
    Ast
    
    Outcometree
    
    B
    
    Ast
    
    Outcometree
    
    OCaml_402
    
    OCaml_403
    
    OCaml_404
    
    OCaml_405
    
    OCaml_406
    
    OCaml_407
    
    OCaml_408
    
    OCaml_409
    
    OCaml_410
    
    OCaml_411
    
    OCaml_412
    
    OCaml_413
    
    OCaml_414
    
    OCaml_500
    
    OCaml_51
    
    OCaml_52
    
    OCaml_version
    
    Ast
    
    Outcometree

Legend:
Library
Module
Module type
Parameter
Class
Class type

Man page specification.

Man page generation is automatically handled by Cmdliner. The block type is used to define a man page's content.

The print function can be useful if the client wants to define other man pages (e.g. to implement a help command).

Man pages

type block = [

| `S of string
| `P of string
| `Pre of string
| `I of string * string
| `Noblank

]

The type for a block of man page text.

`S s introduces a new section s.
`P t is a new paragraph with text t.
`Pre t is a new preformatted paragraph with text t.
`I (l,t) is an indented paragraph with label l and text t.
`Noblank suppresses the blank line introduced between two blocks.

Except in `Pre, whitespace and newlines are not significant and are all collapsed to a single space. In labels l and text strings t, the syntax "$(i,italic text)" and "$(b,bold text)" can be used to respectively produce italic and bold text.

type title = string * int * string * string * string

The type for man page titles. Describes the man page title, section, center_footer, left_footer, center_header.

type t = title * block list

The type for a man page. A title and the page text as a list of blocks.

val print : 
  ?subst:(string -> string) ->
  [ `Pager | `Plain | `Groff ] ->
  Stdlib.Format.formatter ->
  t ->
  unit

print ~subst fmt ppf page prints page on ppf in the format fmt. If fmt is `Pager the function tries to write the formatted result in a pager, if that fails the format `Plain is written on ppf. subst can be used to perform variable substitution, see Buffer.add_substitute (defaults to the identity).