package opam-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Configuration files
Repository files
Substitution files

package opam-lib

opam-lib
- OpamCompat
- OpamConsole
- OpamCoreConfig
- OpamFilename
  - Attribute
    
    Map
    
    Set
    
    Op
  - Base
    
    Map
    
    Set
    
    Op
  - Dir
    
    Map
    
    Set
    
    Op
  - Map
  - Op
  - Set
    
    Op
- OpamJson
- OpamParallel
  - G
    
    E
    
    Topological
    
    V
    
    Vertex
  - GRAPH
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Make
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - MakeGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - SIG
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - VERTEX
- OpamProcess
  - Job
    
    Op
- OpamStd
  - ABSTRACT
    
    Map
    
    Set
    
    Op
  - AbstractString
    
    Map
    
    Set
    
    Op
  - Config
  - Env
  - Exn
  - Format
  - IntMap
  - IntSet
    
    Op
  - List
  - MAP
  - Map
    
    Make
    
    S
  - Op
  - Option
    
    Op
  - OrderedType
  - SET
    
    Op
  - Set
    
    Make
    
    Op
    
    S
  - String
    
    Map
    
    Set
    
    Op
    
    SetMap
    
    SetSet
    
    Op
  - Sys
- OpamSystem
- OpamVersion
  - Map
  - Set
    
    Op
- OpamVersionCompare
opam-lib.client
- OpamClient
  - API
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
  - SafeAPI
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
- OpamClientConfig
- OpamConfigCommand
- OpamPinCommand
- OpamRepositoryCommand
- OpamSwitchCommand
opam-lib.format
- OpamCompiler
  - Map
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamFile
  - Aliases
  - Comp
  - Compiler_index
  - Config
  - Descr
  - Dot_config
  - Dot_install
  - Export
  - File_attributes
  - Filenames
  - IO_FILE
  - Installed
  - Installed_roots
  - Lines
  - OPAM
  - Package_index
  - Pinned
  - Prefix
  - Reinstall
  - Repo
  - Repo_config
  - URL
- OpamFilter
- OpamFormat
- OpamFormatConfig
- OpamFormula
- OpamLexer
- OpamLineLexer
- OpamPackage
  - Graph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Map
  - Name
    
    Map
    
    Set
    
    Op
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamParser
- OpamRepositoryName
  - Map
  - Set
    
    Op
- OpamSwitch
  - Map
  - Set
    
    Op
- OpamTypesBase
- OpamVariable
  - Full
    
    Map
    
    Set
    
    Op
  - Map
  - Set
    
    Op
opam-lib.repository
- OpamDarcs
  - B
- OpamDownload
- OpamGit
  - B
- OpamHTTP
  - B
- OpamHg
  - B
- OpamLocal
  - B
- OpamRepository
- OpamRepositoryBackend
  - S
- OpamRepositoryConfig
- OpamRepositoryPath
- OpamVCS
  - Make
    
    VCS
  - VCS
opam-lib.solver
- OpamActionGraph
  - ACTION
    
    Pkg
  - Make
    
    A
    
    Pkg
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - MakeAction
    
    P
    
    Pkg
  - SIG
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
- OpamCudf
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Graph
  - Map
  - Set
    
    Op
- OpamHeuristic
- OpamSolver
  - Action
    
    Pkg
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
- OpamSolverConfig
opam-lib.state
- OpamAction
- OpamOCaml
- OpamPath
  - Switch
    
    Default
    
    Overlay
- OpamScript
- OpamSolution
- OpamState
  - Cache
  - Types
- OpamStateConfig

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/

module Aliases : IO_FILE with type t = OpamTypes.compiler OpamTypes.switch_map

Compiler aliases: $opam/aliases

module Export : 
  IO_FILE
    with type t =
           OpamTypes.package_set
           * OpamTypes.package_set
           * OpamTypes.pin_option OpamPackage.Name.Map.t

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

module Installed : IO_FILE with type t = OpamTypes.package_set

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

module Installed_roots : IO_FILE with type t = OpamTypes.package_set

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

module Reinstall : IO_FILE with type t = OpamTypes.package_set

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

module Package_index : 
  IO_FILE
    with type t =
           (OpamTypes.repository_name * string option) OpamTypes.package_map

Association between package names and repositories

module Compiler_index : 
  IO_FILE
    with type t =
           (OpamTypes.repository_name * string option) OpamTypes.compiler_map

Association between compiler names and repositories

module Repo_config : IO_FILE with type t = OpamTypes.repository

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

module Pinned : IO_FILE with type t = OpamTypes.pin_option OpamTypes.name_map

Pinned package files

module Repo : sig ... end

Repository metadata

Substitution files

module URL : sig ... end

module File_attributes : IO_FILE with type t = OpamTypes.file_attribute_set

module Filenames : IO_FILE with type t = OpamTypes.filename_set

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.