package opam-client

  1. Overview
  2. Docs
Client library for opam 2.5

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (30)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

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

Sources

2.5.0-beta1.tar.gz
md5=8f0995bb3cb626efa1af74bc6d888c54
sha512=607ff235cf43e73cbcbf67202682a1bd7b0e3fa35bc6b4748a54db9b57b7a0a25e656ec0f8d81d0369b3a1b05fd5c4148571f5dc217ffdbcd2c32592e0b682b6

doc/opam-client/OpamClient/index.html

Module OpamClientSource

High-level execution of user-facing functions like install and upgrade, and wrappers around the pinning commands

Sourceval init : init_config:OpamFile.InitConfig.t -> interactive:bool -> ?repo:OpamTypes.repository -> ?bypass_checks:bool -> ?dot_profile:OpamTypes.filename -> ?update_config:bool -> ?env_hook:bool -> ?completion:bool -> ?check_sandbox:bool -> ?cygwin_setup: [ `internal of OpamSysPkg.t list | `default_location | `location of OpamTypes.dirname | `no ] -> ?git_location:(OpamTypes.dirname, unit) OpamTypes.either -> OpamTypes.shell -> OpamStateTypes.rw OpamStateTypes.global_state * OpamStateTypes.unlocked OpamStateTypes.repos_state * OpamTypes.atom list

Initialize the client to a consistent state. Returns the initial state and, in case a switch is to be created, its initial set of packages

Sourceval reinit : ?init_config:OpamFile.InitConfig.t -> interactive:bool -> ?dot_profile:OpamTypes.filename -> ?update_config:bool -> ?env_hook:bool -> ?completion:bool -> ?inplace:bool -> ?check_sandbox:bool -> ?bypass_checks:bool -> ?cygwin_setup: [ `internal of OpamSysPkg.t list | `default_location | `location of OpamTypes.dirname | `no ] -> ?git_location:(OpamTypes.dirname, unit) OpamTypes.either -> OpamFile.Config.t -> OpamTypes.shell -> unit

Re-runs the extra tools checks, updates the configuration from init_config (defaults to OpamInitDefaults.init_config) for the settings that are unset, and updates all repositories

Sourceval install : OpamStateTypes.rw OpamStateTypes.switch_state -> ?formula:OpamTypes.formula -> ?autoupdate:OpamTypes.atom list -> ?add_to_roots:bool -> ?deps_only:bool -> ?ignore_conflicts:bool -> ?assume_built:bool -> ?download_only:bool -> ?depext_only:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Install the given list of packages. add_to_roots, if given, specifies that given packages should be added or removed from the roots. autoupdate defaults to the list of atoms, and can be used to restrict the atoms which are updated if pinned.

Sourceval install_t : OpamStateTypes.rw OpamStateTypes.switch_state -> ?ask:bool -> ?ignore_conflicts:bool -> ?depext_only:bool -> ?download_only:bool -> OpamTypes.atom list -> ?formula:OpamTypes.formula -> bool option -> deps_only:bool -> assume_built:bool -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control

Sourceval check_installed : build:bool -> post:bool -> recursive:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> OpamTypes.atom list -> OpamPackage.Name.Set.t OpamPackage.Name.Map.t

Check that the given list of packages atoms have their dependencies satisfied, without calling the solver. Returns a map of package names to their set of missing dependencies.

  • parameter recursive

    if true will check every installed dependencies recursively. For example, this is useful if a package currently installed has been modified and a dependencies has been added but that package has not yet been upgraded. Note: if true, the keys of the resulting map might contain packages further down the dependency tree and is no longer guaranteed to contain only packages from atoms.

Reinstall the given set of packages.

Sourceval reinstall_t : OpamStateTypes.rw OpamStateTypes.switch_state -> ?ask:bool -> ?force:bool -> assume_built:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control

Sourceval update : 'a OpamStateTypes.global_state -> repos_only:bool -> dev_only:bool -> ?all:bool -> string list -> bool * bool * OpamStateTypes.unlocked OpamStateTypes.repos_state

Update the local mirrors for the repositories and/or development packages. Returns (success, changes, rt), where success is true only if all updates were successful, changes is true if any upstream had updates, and rt is the updated repository state.

Sourceval upgrade : OpamStateTypes.rw OpamStateTypes.switch_state -> ?formula:OpamTypes.formula -> ?check:bool -> ?only_installed:bool -> all:bool -> OpamTypes.atom list -> OpamStateTypes.rw OpamStateTypes.switch_state

Upgrade the switch, that is, move packages to their more recent available versions. The specified atoms are kept installed (or newly installed after a confirmation). The upgrade concerns them only unless all is specified.

Sourceval upgrade_t : ?strict_upgrade:bool -> ?auto_install:bool -> ?ask:bool -> ?check:bool -> ?terse:bool -> ?only_installed:bool -> all:bool -> OpamTypes.atom list -> ?formula:OpamTypes.formula -> OpamStateTypes.rw OpamStateTypes.switch_state -> OpamStateTypes.rw OpamStateTypes.switch_state

Low-level version of upgrade, bypassing the package name sanitization and dev package update, and offering more control. terse avoids the verbose message when we are at a local maximum, but there are possible upgrades

Recovers from an inconsistent universe

Remove the given list of packages.

Sourcemodule PIN : sig ... end