package opam-lib

  1. Overview
  2. Docs
The OPAM library

Install 

dune-project
 Dependency

opam.ocaml.org Edit opam file Versions (1)

Authors

  1. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  2. A
    Anil Madhavapeddy <anil@recoil.org>
  3. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  4. F
    Frederic Tuong <tuong@users.gforge.inria.fr>
  5. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  6. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  7. V
    Vincent Bernardoff <vb@luminar.eu.org>
  8. R
    Roberto Di Cosmo <roberto@dicosmo.org>

Maintainers

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

Sources

1.3.1.tar.gz
sha256=625767c3465219cc8799aad1449c74279b31686db0821300cfdb92fbff17e9fd
md5=e0688c0cf9a55f93ee93f62d07cf6b74

doc/opam-lib.state/OpamPath/Switch/index.html

Module OpamPath.Switch

Switch related paths

Locations of opam internal dirs and files

Root dir: $opam/$switch

lock file: $opam/lock

val backup_dir : t -> OpamTypes.switch -> OpamTypes.dirname

The directory where backups are stored for this switch

Backup file for state export

val installed : t -> OpamTypes.switch -> OpamTypes.filename

List of installed packages with their version: $opam/$switch/installed

val installed_roots : t -> OpamTypes.switch -> OpamTypes.filename

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

Temporary folders used to decompress and compile the corresponding archives: $opam/$switch/build/$packages

val build_ocaml : t -> OpamTypes.switch -> OpamTypes.dirname

Temporary folders used to decompress and compile the OCaml compiler: $opam/$switch/build/ocaml

val build_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Temporary folder: $opam/$switch/build

Temporary location of install files: $opam/$switch/build/$package/$name.install

Temporary location of config files: $opam/$switch/build/$packages/$name.config

Installed files for a given package: $opam/$switch/install/$name.install

val install_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Installed files: $opam/$switch/install/

val reinstall : t -> OpamTypes.switch -> OpamTypes.filename

Packages to reinstall on next upgrade: $opam/$switch/reinstall

val config_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Configuration folder: $opam/$switch/config

val global_config : t -> OpamTypes.switch -> OpamTypes.filename

Global config for the switch: $opam/$switch/config/global-config.config

Pinned package file: $opam/$switch/pinned

val dev_packages_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Build dir for all pinned packages: $opam/$switch/packages.dev/

Build dir for a given pinned package: $opam/$switch/packages.dev/$name.$version/

Locations for the visible part of the installation

module Default : sig ... end

Default config

Actual config handling the global-config.config indirections

Package-independent dirs

Library path: $opam/$switch/lib

DLL paths

toplevel path: $opam/$switch/lib/toplevel

Documentation path: $opam/$switch/doc/

Shared directory: $opam/$switch/share

Etc directory: $opam/$switch/etc

val man_dir : ?num:string -> t -> OpamTypes.switch -> OpamFile.Dot_config.t -> OpamTypes.dirname

Man pages path: $opam/$switch/man/. The optional num argument will add a manN suffix if specified

Installed binaries: $opam/$switch/bin

Installed system binaries: $opam/$switch/sbin

Package dependent dirs

Library path for a given package: $opam/$switch/lib/$name

Documentation path for a given package: $opam/$switch/doc/$name

Share directory for a given package: $opam/$switch/share/$package

Etc directory for a given package: $opam/$switch/etc/$package

Compile and link flags for a given package: $opam/$switch/lib/$name/opam.config

module Overlay : sig ... end