Up

module OpamPath

: sig

The various paths where OPAM configuration files are stored.

Global paths

#
type t = OpamTypes.dirname

Type of path root

#
val root : unit -> t

Default root path

#
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

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

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

Tempory 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

Switch related paths

#
val root : t -> OpamTypes.switch -> OpamTypes.dirname

Root dir: $opam/$switch

#
val lock : t -> OpamTypes.switch -> OpamTypes.filename

lock file: $opam/lock

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

The directory where backups are stored for this switch

#
val backup : t -> OpamTypes.switch -> OpamTypes.filename

Backup file for state export

#
val lib : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

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

#
val lib_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Library path: $opam/$switch/lib

#
val stublibs : t -> OpamTypes.switch -> OpamTypes.dirname

DLL paths

#
val toplevel : t -> OpamTypes.switch -> OpamTypes.dirname

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

#
val doc : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

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

#
val doc_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Documentation path: $opam/$switch/doc/

#
val share_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Shared directory: $opam/$switch/share

#
val share : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

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

#
val etc_dir : t -> OpamTypes.switch -> OpamTypes.dirname

Etc directory: $opam/$switch/etc

#
val etc : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

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

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

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

#
val bin : t -> OpamTypes.switch -> OpamTypes.dirname

Installed binaries: $opam/$switch/bin

#
val sbin : t -> OpamTypes.switch -> OpamTypes.dirname

Installed system binaries: $opam/$switch/sbin

#
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 expliciterly installed by the user: $opam/$switch/installed.roots

#
val build : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.dirname

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

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

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

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

Tempory folder: $opam/$switch/build

#
val build_install : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.filename

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

#
val build_config : t -> OpamTypes.switch -> OpamTypes.package -> OpamTypes.filename

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

#
val install : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

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 : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

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

#
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

#
val pinned : t -> OpamTypes.switch -> OpamTypes.filename

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/

#
val dev_package : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

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

#
module Overlay : sig
#
val dir : t -> OpamTypes.switch -> OpamTypes.dirname

Switch metadata overlay (over the global metadata): $opam/$switch/overlay/

#
val package : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

Switch metadata overlay (over the global metadata): $opam/$switch/overlay/$name.$version

#
val opam : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

OPAM overlay: $opam/$switch/cache/$name.$version/opam

#
val tmp_opam : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

OPAM temp overlay (for user editing): $opam/$switch/cache/$name.$version/opam_

#
val url : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

URL overlay: $opam/$switch/overlay/$name.$version/url

#
val descr : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.filename

Descr orverlay

#
val files : t -> OpamTypes.switch -> OpamTypes.name -> OpamTypes.dirname

Files overlay

end
end
#
module Repository : sig

Repository paths

#
val create : t -> OpamTypes.repository_name -> OpamTypes.dirname

Repository local path: $opam/repo/<name>

#
val update_cache : OpamTypes.repository -> OpamTypes.filename

Update cache

#
val repo : OpamTypes.repository -> OpamTypes.filename

Return the repo file

#
val remote_repo : OpamTypes.repository -> OpamTypes.filename

Remote repo file

#
val raw_config : OpamTypes.dirname -> OpamTypes.repository_name -> OpamTypes.filename

Return the repository config: $opam/repo/$repo/config

#
val config : OpamTypes.repository -> OpamTypes.filename

Return the repository config: $opam/repo/$repo/config

#
val packages_dir : OpamTypes.repository -> OpamTypes.dirname

Packages folder: $opam/repo/$repo/packages

#
val remote_packages_dir : OpamTypes.repository -> OpamTypes.dirname

Remote package files: $remote/packages

#
val packages : OpamTypes.repository -> string option -> OpamTypes.package -> OpamTypes.dirname

Package folder: $opam/repo/$repo/packages/XXX/$NAME.$VERSION

#
val opam : OpamTypes.repository -> string option -> OpamTypes.package -> OpamTypes.filename

Return the OPAM file for a given package: $opam/repo/$repo/packages/XXX/$NAME.$VERSION/opam

#
val descr : OpamTypes.repository -> string option -> OpamTypes.package -> OpamTypes.filename

Return the description file for a given package: $opam/repo/$repo/packages/XXX/$NAME.VERSION/descr

#
val url : OpamTypes.repository -> string option -> OpamTypes.package -> OpamTypes.filename

urls $opma/repo/$repo/package/XXX/$NAME.$VERSION/url

#
val files : OpamTypes.repository -> string option -> OpamTypes.package -> OpamTypes.dirname

files $opam/repo/$repo/packages/XXX/$NAME.$VERSION/files

#
val archive : OpamTypes.repository -> OpamTypes.package -> OpamTypes.filename

Return the archive for a given package: $opam/repo/$repo/archives/$NAME.$VERSION.tar.gz

#
val remote_archive : OpamTypes.repository -> OpamTypes.package -> OpamTypes.filename

Remote archive $remote/archives/$NAME.$VERSION.tar.gz

#
val archives_dir : OpamTypes.repository -> OpamTypes.dirname

Return the archive folder: $opam/repo/$repo/archives/

#
val upload_dir : OpamTypes.repository -> OpamTypes.dirname

Return the upload folder for a given version: $opam/repo/$repo/upload/

#
val compilers_dir : OpamTypes.repository -> OpamTypes.dirname

Compiler files: $opam/repo/$repo/compilers/

#
val compiler_comp : OpamTypes.repository -> string option -> OpamTypes.compiler -> OpamTypes.filename

Compiler files: $opam/repo/$repo/compilers/XXX/$OVERSION.comp

#
val compiler_descr : OpamTypes.repository -> string option -> OpamTypes.compiler -> OpamTypes.filename

Compiler description files: $opam/repo/$repo/compilers/XXX/$OVERSION.descr

#
val remote_compilers_dir : OpamTypes.repository -> OpamTypes.dirname

Remote compiler files: $remote/compilers

end
end