package opam-lib

  1. Overview
  2. Docs
package opam-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions to read and write OPAM configuration files in a typed way

module type IO_FILE = sig ... end

All Configuration files satisfies this signature

module Lines : IO_FILE with type t = string list list

Lines of space-separated words.

module Config : sig ... end

Configuration file: $opam/config

module OPAM : sig ... end

OPAM files

module Descr : sig ... end

Package descriptions: $opam/descr/

Compiler aliases: $opam/aliases

Import/export file. This difference with installed is that we are explicit about root packages.

List of installed packages: $opam/$oversion/installed

List of packages explicitly installed by the user: $opam/$switch/installed.user

List of packages to reinstall: $opam/$oversion/reinstall

module Comp : sig ... end

Compiler version $opam/compilers/

Configuration files

module Dot_install : sig ... end

.install files

module Dot_config : sig ... end

.config files

Repository files

Association between package names and repositories

Association between compiler names and repositories

Repository config: $opam/repo/$repo/config

Pinned package files

module Repo : sig ... end

Repository metadata

Substitution files

module URL : sig ... end

List of filenames

module Prefix : IO_FILE with type t = string OpamTypes.name_map

Prefix of package directories

val print_stats : unit -> unit

Display statistics about file access.