package opam-lib

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Global paths

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

The various paths where OPAM configuration files are stored.

Global paths

type t = OpamTypes.dirname

Type of path root

val state_cache : t -> OpamTypes.filename

State cache

val update_cache : t -> OpamTypes.filename

Update cache

val lock : t -> OpamTypes.filename

lock file

val config : t -> OpamTypes.filename

Main configuration file: $opam/config

val aliases : t -> OpamTypes.filename

Compiler aliases

val packages_dir : t -> OpamTypes.dirname

Package directroy $opam/packages/

val packages : t -> OpamTypes.package -> OpamTypes.dirname

Package sub-directory $opam/packages/$NAME/$NAME.$VERSION/

val opam : t -> OpamTypes.package -> OpamTypes.filename

OPAM files: $opam/packages/$NAME/$NAME.$VERSION/opam

val url : t -> OpamTypes.package -> OpamTypes.filename

URL files: $opam/packages/$NAME/$NAME.$VERSION/url

val files : t -> OpamTypes.package -> OpamTypes.dirname

Additional files: $opam/packages/$NAME/$NAME.$VERSION/files

val dev_packages_dir : t -> OpamTypes.dirname

Temporary folder for dev packages $opam/packages.dev/

val dev_package : t -> OpamTypes.package -> OpamTypes.dirname

Temporary folder for dev packages $opam/packages.dev/$NAME.$VERSION/

val descr : t -> OpamTypes.package -> OpamTypes.filename

Description file: $opam/packages/$NAME/$NAME.$VERSION/descr

val archives_dir : t -> OpamTypes.dirname

Archives dir

val archive : t -> OpamTypes.package -> OpamTypes.filename

Archive file: $opam/archives/$NAME.$VERSION+opam.tar.gz

val compiler_comp : t -> OpamTypes.compiler -> OpamTypes.filename

Compiler files: $opam/compilers/$VERSION/$COMP.comp

val compiler_descr : t -> OpamTypes.compiler -> OpamTypes.filename

Compiler description files: $opam/compilers/$VERSION/$COMP.descr

val compilers_dir : t -> OpamTypes.dirname

Compiler files: $opam/compilers/

val compilers : t -> OpamTypes.compiler -> OpamTypes.dirname

Compiler subdir $opam/compilers/$VERSION/$COMP

val package_index : t -> OpamTypes.filename

Return the repository index: $opam/repo/package-index

val compiler_index : t -> OpamTypes.filename

Return the repository index: $opam/repo/compiler-index

val init : t -> OpamTypes.dirname

Init scripts

val log : t -> OpamTypes.dirname

Log dir $opam/log

val backup_dir : t -> OpamTypes.dirname

The directory where global backups are stored

val backup : t -> OpamTypes.filename

Backup file for state export

module Switch : sig ... end

Switch related paths