package opam-client

  1. Overview
  2. Docs
Client library for opam 2.1

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

2.1.1.tar.gz
md5=e1202a21d669d460b9fa852e39f0502e
sha512=fb46bc8f12e49c2da95c5f8669f55fb93710ee826827538852c3091ec2c714c082137373fa9e1ad3f53f107b1fae6c2abd0b6e5f84f7756bd3b38e57978f080e

doc/opam-client/OpamSwitchCommand/index.html

Module OpamSwitchCommandSource

Functions handling the "opam switch" subcommand

Sourceval create : OpamStateTypes.rw OpamStateTypes.global_state -> rt:'a OpamStateTypes.repos_state -> ?synopsis:string -> ?repos:OpamTypes.repository_name list -> update_config:bool -> invariant:OpamTypes.formula -> OpamTypes.switch -> (OpamStateTypes.rw OpamStateTypes.switch_state -> 'ret * OpamStateTypes.rw OpamStateTypes.switch_state) -> 'ret * OpamStateTypes.rw OpamStateTypes.switch_state

Creates and configures a new switch. The given global_state is unlocked once done. update_config sets the switch as current globally, unless it is external.

post can be used to run guarded operations after the switch creation (cleanup will be proposed to the user if they fail). You probably want to call install_compiler there.

Sourceval install_compiler : ?additional_installs:OpamTypes.atom list -> ?deps_only:bool -> ?ask:bool -> OpamStateTypes.rw OpamStateTypes.switch_state -> OpamStateTypes.rw OpamStateTypes.switch_state

Used to initially install a compiler's base packages, according to its invariant. ask triggers prompting the user as for normal installs; defaults to false.

Sourceval import : OpamStateTypes.rw OpamStateTypes.switch_state -> OpamFile.SwitchExport.t OpamFile.t option -> OpamStateTypes.rw OpamStateTypes.switch_state

Import a file which contains the packages to install.

Sourceval export : 'a OpamStateTypes.repos_state -> ?freeze:bool -> ?full:bool -> ?switch:OpamTypes.switch -> OpamFile.SwitchExport.t OpamFile.t option -> unit

Export a file which contains the installed packages. If full is specified and true, export metadata of all installed packages (excluding overlay files) as part of the export. The export will be extended with a map of all extra-files. If freeze is specified and true, VCS urls will be frozen to the specific commit ID. If None is provided as file argument, the export is done to stdout.

Remove the given compiler switch, and returns the updated state (unchanged in case confirm is true and the user didn't confirm)

Sourceval switch : 'a OpamStateTypes.lock -> OpamStateTypes.rw OpamStateTypes.global_state -> OpamTypes.switch -> unit

Changes the currently active switch

Reinstall the given compiler switch.

Updates the switch invariant and the associated config files, and writes the config file unless show or dry_run are activated globally. Low-level function, see set_invariant for the user-facing function.

Sets the packages configured as the current switch compiler base, after some checks and messages.

Sourceval show : unit -> unit

Display the current compiler switch.

Sourceval list : 'a OpamStateTypes.global_state -> print_short:bool -> unit

List all the available compiler switches.

Sourceval get_compiler_packages : ?repos:OpamTypes.repository_name list -> 'a OpamStateTypes.repos_state -> OpamTypes.package_set

Returns all available compiler packages from a repo state

Sourceval guess_compiler_invariant : ?repos:OpamTypes.repository_name list -> 'a OpamStateTypes.repos_state -> string list -> OpamFormula.t

Guess a real compiler spec from a list of strings, which may refer to packages with optional version constraints, or just versions. This uses some heuristics.