package opam-client
Install
Dune Dependency
Authors
-
VVincent Bernardoff <vb@luminar.eu.org>
-
RRaja Boujbel <raja.boujbel@ocamlpro.com>
-
RRoberto Di Cosmo <roberto@dicosmo.org>
-
TThomas Gazagnaire <thomas@gazagnaire.org>
-
LLouis Gesbert <louis.gesbert@ocamlpro.com>
-
FFabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
-
AAnil Madhavapeddy <anil@recoil.org>
-
GGuillem Rieu <guillem.rieu@ocamlpro.com>
-
RRalf Treinen <ralf.treinen@pps.jussieu.fr>
-
FFrederic Tuong <tuong@users.gforge.inria.fr>
Maintainers
Sources
sha256=7f812f9b78e9948fb641bc559183721fedea62d3dafb2960bb786b400eae1de5
md5=385612adf8733f6816cfcbc39e3e1b50
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
val 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 ->
OpamTypes.shell ->
OpamStateTypes.rw OpamStateTypes.global_state
* OpamStateTypes.unlocked OpamStateTypes.repos_state
* OpamTypes.formulaInitialize the client to a consistent state.
val reinit :
?init_config:OpamFile.InitConfig.t ->
interactive:bool ->
?dot_profile:OpamTypes.filename ->
?update_config:bool ->
?env_hook:bool ->
?completion:bool ->
OpamFile.Config.t ->
OpamTypes.shell ->
unitRe-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
val install :
OpamStateTypes.rw OpamStateTypes.switch_state ->
?autoupdate:OpamTypes.atom list ->
?add_to_roots:bool ->
?deps_only:bool ->
?assume_built:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_stateInstall 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.
val install_t :
OpamStateTypes.rw OpamStateTypes.switch_state ->
?ask:bool ->
OpamTypes.atom list ->
bool option ->
deps_only:bool ->
assume_built:bool ->
OpamStateTypes.rw OpamStateTypes.switch_stateLow-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control
val reinstall :
OpamStateTypes.rw OpamStateTypes.switch_state ->
?assume_built:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_stateReinstall the given set of packages.
val reinstall_t :
OpamStateTypes.rw OpamStateTypes.switch_state ->
?ask:bool ->
?force:bool ->
assume_built:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_stateLow-level version of reinstall, bypassing the package name sanitization and dev package update, and offering more control
val update :
'a OpamStateTypes.global_state ->
repos_only:bool ->
dev_only:bool ->
?all:bool ->
string list ->
bool * bool * OpamStateTypes.unlocked OpamStateTypes.repos_stateUpdate 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.
val upgrade :
OpamStateTypes.rw OpamStateTypes.switch_state ->
?check:bool ->
all:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_stateUpgrade 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.
val upgrade_t :
?strict_upgrade:bool ->
?auto_install:bool ->
?ask:bool ->
?check:bool ->
all:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_state ->
OpamStateTypes.rw OpamStateTypes.switch_stateLow-level version of upgrade, bypassing the package name sanitization and dev package update, and offering more control
val fixup :
OpamStateTypes.rw OpamStateTypes.switch_state ->
OpamStateTypes.rw OpamStateTypes.switch_stateRecovers from an inconsistent universe
val remove :
OpamStateTypes.rw OpamStateTypes.switch_state ->
autoremove:bool ->
force:bool ->
OpamTypes.atom list ->
OpamStateTypes.rw OpamStateTypes.switch_stateRemove the given list of packages.