package opam-format

  1. Overview
  2. Docs

doc/opam-format/OpamPath/index.html

Module OpamPathSource

Defines the file hierarchy in ~/.opam

Global paths

Type of path root

Sourceval state_cache : t -> OpamTypes.filename

State cache

Sourceval state_cache_dir : t -> OpamTypes.dirname

Directory containing state cache

Global lock file for the whole opamroot. Opam should generally read-lock this (e.g. initialisation and format upgrades require a write lock)

Main configuration file: $opam/config

Sourceval redirected : t -> OpamFilename.t

Redirection file for opam root: $opam/redirected-opamroot

Sourceval init_config_files : unit -> OpamFile.InitConfig.t OpamFile.t list

The list of configuration files location used by default (/etc/opamrc and ~/.opamrc). More general (lower priority) first.

Sourceval config_lock : t -> OpamTypes.filename

Lock for updates on the main config file (write lock when changes to switches, repositories lists are expected. No lock needed otherwise)

Sourceval repos_lock : t -> OpamTypes.filename

Global lock file for the repositories mirrors: $opam/repo/lock

Global config file for the repositories mirrors: $opam/repo/repos-config

Init scripts location: $opam/opam-init

Sourceval hooks_dir : t -> OpamTypes.dirname

Installation dir for configured hooks: $$opam/opam-init/hooks

Log dir $opam/log

Sourceval backup_dir : t -> OpamTypes.dirname

The directory where global backups are stored

Backup file for state export

Sourceval plugin_prefix : string

The prefix for plugin commands ("opam-")

Sourceval plugins : t -> OpamTypes.dirname

The directory for plugins data $opam/plugins

Sourceval plugins_bin : t -> OpamTypes.dirname

The directory for shared plugin binaries $opam/plugins/bin

The globally installed binary of the given plugin $opam/plugins/bin/opam-foo

The directory for a given plugin's data $opam/plugins/$name. "bin" is forbidden.

Sourceval last_env : t -> OpamTypes.dirname

The last environment used regardless the switch

Sourcemodule type LAYOUT = sig ... end
Sourcemodule Switch : sig ... end

Switch related paths

Sourcemodule Builddir : sig ... end

Location of package-specific files relative to their build directory

OCaml

Innovation. Community. Security.

On This Page
  1. Global paths