package opam-client

  1. Overview
  2. Docs
Client library for opam 2.3

Install 

dune-project
 Dependency

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

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.3.0.tar.gz
md5=3a99d6d8c0394185f168fa0f085f6bb9
sha512=596d7b28f0cf9613dc7637aaeac45cc45f411a13286fea1cc81aeb0630c4f8a6dc2095d50db73229a255a3da3d9a08fe0993355a7fc64d3b16fd712789ff5f6e

doc/opam-client/OpamClientConfig/index.html

Module OpamClientConfigSource

Configuration options for the client lib (record, global reference, setter, initialisation), plus helper for global setup

Sourcemodule E : sig ... end
Sourcetype t = private {
  1. print_stats : bool;
  2. pin_kind_auto : bool;
  3. autoremove : bool;
  4. editor : string;
  5. keep_build_dir : bool;
  6. reuse_build_dir : bool;
  7. inplace_build : bool;
  8. working_dir : bool;
  9. drop_working_dir : bool;
  10. ignore_pin_depends : bool;
  11. show : bool;
  12. fake : bool;
  13. skip_dev_update : bool;
  14. json_out : string option;
  15. root_is_ok : bool;
  16. no_auto_upgrade : bool;
  17. assume_depexts : bool;
  18. cli : OpamCLIVersion.t;
  19. scrubbed_environment_variables : string list;
  20. verbose_on : OpamTypes.name_set;
}
Sourcetype 'a options_fun = ?print_stats:bool -> ?pin_kind_auto:bool -> ?autoremove:bool -> ?editor:string -> ?keep_build_dir:bool -> ?reuse_build_dir:bool -> ?inplace_build:bool -> ?working_dir:bool -> ?drop_working_dir:bool -> ?ignore_pin_depends:bool -> ?show:bool -> ?fake:bool -> ?skip_dev_update:bool -> ?json_out:string option -> ?root_is_ok:bool -> ?no_auto_upgrade:bool -> ?assume_depexts:bool -> ?cli:OpamCLIVersion.t -> ?scrubbed_environment_variables:string list -> ?verbose_on:OpamTypes.name_set -> 'a
include OpamStd.Config.Sig with type t := t and type 'a options_fun := 'a options_fun
Sourceval default : t

The default values of the options to use at startup

Sourceval set : t -> (unit -> t) options_fun

Use to update any option in a t, using the optional arguments of options_fun. E.g. set opts ?option1:1 ?option4:"x" ()

Sourceval setk : (t -> 'a) -> t -> 'a options_fun

Same as set, but passes the result to a continuation, allowing argument stacking

Sourceval r : t ref

The global reference containing the currently set library options. Access using OpamXxxConfig.(!r.field).

Sourceval update : ?noop:_ -> (unit -> unit) options_fun

Updates the currently set options in r according to the optional arguments

Sourceval init : ?noop:_ -> (unit -> unit) options_fun

Sets the options, reading the environment to get default values when unspecified

Sourceval initk : 'a -> 'a options_fun

Sets the options like init, but returns the given value (for arguments stacking)

Sourceval search_files : string list

Extra files included in opam search

Sourceval opam_init : ?root_dir:OpamTypes.dirname -> ?strict:bool -> ?solver:(module OpamCudfSolver.S) Lazy.t -> ?skip_version_checks:bool -> ?all_parens:bool -> ?log_dir:OpamTypes.dirname -> ?print_stats:bool -> ?pin_kind_auto:bool -> ?autoremove:bool -> ?editor:string -> ?keep_build_dir:bool -> ?reuse_build_dir:bool -> ?inplace_build:bool -> ?working_dir:bool -> ?drop_working_dir:bool -> ?ignore_pin_depends:bool -> ?show:bool -> ?fake:bool -> ?skip_dev_update:bool -> ?json_out:string option -> ?root_is_ok:bool -> ?no_auto_upgrade:bool -> ?assume_depexts:bool -> ?cli:OpamCLIVersion.t -> ?scrubbed_environment_variables:string list -> ?verbose_on:OpamTypes.name_set -> ?original_root_dir:OpamTypes.dirname -> ?current_switch:OpamSwitch.t -> ?switch_from:OpamStateTypes.provenance -> ?jobs:int Lazy.t -> ?dl_jobs:int -> ?build_test:bool -> ?build_doc:bool -> ?dev_setup:bool -> ?dryrun:bool -> ?makecmd:string Lazy.t -> ?ignore_constraints_on:OpamPackage.Name.Set.t -> ?unlock_base:bool -> ?no_env_notice:bool -> ?locked:string option -> ?no_depexts:bool -> ?cudf_file:string option -> ?best_effort:bool -> ?solver_preferences_default:string option Lazy.t -> ?solver_preferences_upgrade:string option Lazy.t -> ?solver_preferences_fixup:string option Lazy.t -> ?solver_preferences_best_effort_prefix:string option Lazy.t -> ?solver_timeout:float option -> ?solver_allow_suboptimal:bool -> ?cudf_trim:string option -> ?dig_depth:int -> ?preprocess:bool -> ?version_lag_power:int -> ?download_tool: (OpamTypes.arg list * OpamRepositoryConfig.dl_tool_kind) Lazy.t -> ?validation_hook:OpamTypes.arg list option -> ?retries:int -> ?force_checksums:bool option -> ?repo_tarring:bool -> ?debug_level:int -> ?debug_sections:OpamStd.Config.sections -> ?verbose_level:OpamStd.Config.level -> ?color:OpamStd.Config.when_ -> ?utf8:OpamStd.Config.when_ext -> ?disp_status_line:OpamStd.Config.when_ -> ?confirm_level:OpamStd.Config.answer -> ?yes:bool option -> ?safe_mode:bool -> ?keep_log_dir:bool -> ?errlog_length:int -> ?merged_output:bool -> ?precise_tracking:bool -> ?cygbin:string -> ?git_location:string -> unit -> unit

Load the global configuration file (opamroot/config) and initialise all opam sub-libraries, overriding the given arguments