package reason

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Environment variables
Environment variable information

package reason

reason
reason.cmdliner
- Vendored_cmdliner
  - Arg
  - Cmd
    
    Env
    
    Exit
  - 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

Environment variable and their information.

Environment variables

type var = string

The type for environment names.

Environment variable information

type info = Term.env_info

The type for environment variable information.

val info : ?deprecated:string -> ?docs:string -> ?doc:string -> var -> info

info ~docs ~doc var describes an environment variable var such that:

doc is the man page information of the environment variable, defaults to "undocumented".
docs is the title of the man page section in which the environment variable will be listed, it defaults to Cmdliner.Manpage.s_environment.
deprecated, if specified the environment is deprecated and the string is a message output on standard error when the environment variable gets used to lookup the default value of an argument.

In doc the documentation markup language can be used with following variables:

$(env), the value of var.
The variables mentioned in info.