package opam-client

  1. Overview
  2. Docs

Functions handling the "opam config" subcommand

val env : 'a OpamStateTypes.switch_state -> csh:bool -> sexp:bool -> fish:bool -> inplace_path:bool -> unit

Display the current environment. Booleans csh, sexp and fish set an alternative output (unspecified if more than one is true, sh-style by default). inplace_path changes how the PATH variable is updated when there is already an opam entry: either at the same rank, or pushed in front.

val print_eval_env : csh:bool -> sexp:bool -> fish:bool -> OpamTypes.env -> unit

Like env but allows to specify the precise env to print rather than compute it from a switch state

val list : 'a OpamStateTypes.global_state -> OpamTypes.name list -> unit

Display the content of all available variables; global summary if the list is empty, package name "-" is understood as global configuration

Display the content of a given variable

val subst : 'a OpamStateTypes.global_state -> OpamTypes.basename list -> unit

Substitute files

val expand : 'a OpamStateTypes.global_state -> string -> unit

Prints expansion of variables in string

val set : OpamTypes.full_variable -> string option -> unit

Sets or unsets switch config variables

val set_global : OpamTypes.full_variable -> string option -> unit

Sets or unsets global config variables

val setup : OpamStateTypes.rw OpamStateTypes.global_state -> ?dot_profile:OpamTypes.filename -> completion:bool -> shell:OpamTypes.shell -> user:bool -> global:bool -> unit

Update the global and user configuration to use OPAM.

val setup_list : OpamTypes.shell -> OpamTypes.filename -> unit

Display the global and user configuration for OPAM.

val exec : [< OpamStateTypes.unlocked ] OpamStateTypes.global_state -> inplace_path:bool -> string list -> unit

Execute a command in a subshell, after variable expansion

OCaml

Innovation. Community. Security.