package reason

  1. Overview
  2. Docs
Reason: Syntax & Toolchain for OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

reason-3.16.0.tbz
sha256=47b0e43a7d348e2a850658ab4bec5a4fbbb9fd4ff3ec8a1c1816511558c5364e
sha512=0d8dbe33ac17b765ea018522910a333831fec278ae4da25ba039ce4d2d8152f9b2fbba5b40c453241bf4323e55e0dc070170b04caa35742c6e33a7f726feafb3

doc/reason.cmdliner/Vendored_cmdliner/Cmd/Env/index.html

Module Cmd.EnvSource

Environment variable and their information.

Environment variables

Sourcetype var = string

The type for environment names.

Environment variable information

The type for environment variable information.

Sourceval 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.
OCaml

Innovation. Community. Security.