package opam-lib

  1. Overview
  2. No Docs
The OPAM library

Install 

dune-project
 Dependency

opam.ocaml.org Edit opam file Versions (1)

Authors

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

Maintainers

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

Sources

1.3.1.tar.gz
sha256=625767c3465219cc8799aad1449c74279b31686db0821300cfdb92fbff17e9fd
md5=e0688c0cf9a55f93ee93f62d07cf6b74

doc/opam-lib.format/OpamFile/Config/index.html

Module OpamFile.Config

Configuration file: $opam/config

include IO_FILE
type t

File contents

val empty : t

Empty file

val write : OpamTypes.filename -> t -> unit

Write some contents to a file

val read : OpamTypes.filename -> t

Read file contents. Raise an error if the file does not exist.

val safe_read : OpamTypes.filename -> t

Read file contents. Return empty if the file does not exist.

val read_from_channel : ?filename:OpamTypes.filename -> in_channel -> t

Read from channel.

val read_from_string : ?filename:OpamTypes.filename -> string -> t
val write_to_channel : out_channel -> t -> unit

Write to channel.

val create : OpamTypes.switch -> OpamTypes.repository_name list -> ?criteria:(OpamTypes.solver_criteria * string) list -> ?solver:OpamTypes.arg list -> int -> ?download_tool:OpamTypes.arg list -> int -> t

Creation

val with_switch : t -> OpamTypes.switch -> t

OCaml switch updates

val with_repositories : t -> OpamTypes.repository_name list -> t

Repository updates

val with_opam_version : t -> OpamVersion.t -> t

Update opam-version

val with_criteria : t -> (OpamTypes.solver_criteria * string) list -> t
val with_solver : t -> OpamTypes.arg list option -> t
val opam_version : t -> OpamTypes.opam_version

Return the OPAM version

val repositories : t -> OpamTypes.repository_name list

Return the list of repository

val switch : t -> OpamTypes.switch

Return the OCaml switch

val jobs : t -> int

Return the number of jobs

val dl_tool : t -> OpamTypes.arg list option
val dl_jobs : t -> int

Return the number of download jobs

val criteria : t -> (OpamTypes.solver_criteria * string) list
val solver : t -> OpamTypes.arg list option