Module OpamCoreConfig

Configuration options for the core lib (record, global reference and setter)

module E : sig ... end
type t = private {
  1. auto_answer : (string * OpamStd.Config.answer) list;
    (*

    Controls the answer of specific interactive questions. It maps names to its wanted answer and takes precedence over yes and confirm_level for the questions linked to the specific names listed.

    *)
  2. debug_level : int;
    (*

    Controls debug messages, 0 to disable

    *)
  3. debug_sections : OpamStd.Config.sections;
    (*

    Controls which sections display debugging messages. If empty, all messages are displayed.

    *)
  4. verbose_level : OpamStd.Config.level;
    (*

    Controls printing of external commands and output, 0 to disable, more means print more low-level commands

    *)
  5. color : OpamStd.Config.when_;
    (*

    Console ANSI color control

    *)
  6. utf8 : OpamStd.Config.when_ext;
    (*

    Controls usage of UTF8 in OPAM-generated messages. Extended adds camel emojis

    *)
  7. disp_status_line : OpamStd.Config.when_;
    (*

    Controls on-line display of parallel commands being run, using ANSI escapes

    *)
  8. confirm_level : [ OpamStd.Config.answer | `undefined ];
  9. yes : bool option;
    (*

    Affects interactive questions in OpamConsole: used to compute the automatic ansering level

    *)
  10. safe_mode : bool;
    (*

    Fail on writes or delays, don't ask questions (for quick queries, e.g. for shell completion)

    *)
  11. log_dir : string;
    (*

    Where to store log and temporary files (output from commands...)

    *)
  12. keep_log_dir : bool;
    (*

    Whether to cleanup temporary and log files on exit

    *)
  13. errlog_length : int;
    (*

    The number of log lines displayed on process error. 0 for all

    *)
  14. merged_output : bool;
    (*

    If set, stderr of commands is merged into their stdout

    *)
  15. precise_tracking : bool;
    (*

    If set, will take full md5 of all files when checking diffs (to track installations), rather than rely on just file size and mtime

    *)
  16. cygbin : string option;
    (*

    Windows specific: the path of binary directory (bin/) of currently used Cygwin install: internal or external Cygwin, or MSYS2.

    *)
  17. git_location : string option;
    (*

    Windows specific: the full path of the git binary to use on Windows.

    *)
  18. set : bool;
    (*

    Options have not yet been initialised (i.e. defaults are active)

    *)
  19. in_opam : bool;
    (*

    Indicates that the code is running inside of opam and not as a library

    *)
}
type 'a options_fun = ?auto_answer:(string * OpamStd.Config.answer) list -> ?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 -> ?log_dir:string -> ?keep_log_dir:bool -> ?errlog_length:int -> ?merged_output:bool -> ?precise_tracking:bool -> ?cygbin:string -> ?git_location:string -> 'a
val default : t
val set : t -> (unit -> t) options_fun
val setk : (t -> 'a) -> t -> 'a options_fun
val r : t Stdlib.ref
val update : ?noop:_ -> (unit -> unit) options_fun
val init : ?noop:_ -> (unit -> unit) options_fun

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

val initk : 'a -> 'a options_fun

Like init, but returns the given value. For optional argument stacking

val answer_is : name:string option -> OpamStd.Config.answer -> bool

Automatic answering levels * `ask: prompt and ask user * `all_no: answer no to all opam questions * `all_yes: answer yes to all opam questions * `unsafe_yes: answer yes to all opam question and launch system package command wit non interactive options If confirm-level is set (from cli or environment variable), its value is returned. Otherwise, is takes last yes/no cli flag. For environment variables, if OPAMYES is set to true, it has priority over OPAMNO. As other environment variables, cli flags content is taken if given. answer_is and answer_is_yes computes the answer lazily, use answer in case of config update.

val answer_is_yes : name:string option -> unit -> bool
val answer : name:string option -> unit -> OpamStd.Config.answer
val developer : bool

true if OPAM was compiled in developer mode

val set_in_opam : unit -> unit

Indicates that the code currently runs inside opam, not a library. Internal use only.