package opam-core

  1. Overview
  2. Docs
Core library for opam 2.5

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (33)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.5.0.tar.gz
md5=79d057547b7114e31334bc4f556bc541
sha512=707b652997bae086003c4164029ed40a68e9c465b4ce1731d0f8ccc0a496c5b6d9011e45bc2b6f73e56d316e54bce7c82becb83bd7de4fa53b0795ad7ae7032a

doc/opam-core.cmdliner/OpamCmdliner/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.