Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package opam-client
Functions handling the `opam config` subcommand and configuration actions
`opam config` subcommand and their associated commands
val env :
'a OpamStateTypes.global_state ->
OpamTypes.switch ->
?set_opamroot:bool ->
?set_opamswitch:bool ->
csh:bool ->
sexp:bool ->
fish:bool ->
pwsh:bool ->
cmd:bool ->
inplace_path:bool ->
unitDisplay 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 ensure_env : 'a OpamStateTypes.global_state -> OpamTypes.switch -> unitEnsures that the environment file exists in the given switch, regenerating it, if necessary.
val print_eval_env :
csh:bool ->
sexp:bool ->
fish:bool ->
pwsh:bool ->
cmd:bool ->
OpamTypes.env ->
unitLike env but allows one to specify the precise env to print rather than compute it from a switch state
val list : 'a OpamStateTypes.switch_state -> OpamTypes.name list -> unitDisplay the content of all available packages variables
val subst : 'a OpamStateTypes.global_state -> OpamTypes.basename list -> unitSubstitute files
val expand : 'a OpamStateTypes.global_state -> string -> unitPrints expansion of variables in string
val exec :
[< OpamStateTypes.unlocked ] OpamStateTypes.global_state ->
set_opamroot:bool ->
set_opamswitch:bool ->
inplace_path:bool ->
no_switch:bool ->
string list ->
unitExecute a command in a subshell, after variable expansion
Variables and options display and setting
Functions handling `opam var` and `opam option` command
Given an `opam option` field or field-value argument, detect the scope, switch, global or nonexistent field (cf. OpamCommands.Var_Option_Common.var_option)
Setting variables and options
val parse_update : string -> string * update_opParse an update operation. String is of the form var[(+=|-=|=)[value]]. If 'value' is absent, it is a revert operation. Raise Invalid_argument if the string is malformed
val parse_whole : string -> string * whole_opAs parse_update but parse only overwrites and reverts. String is of the form var=[value]`. Raise Invalid_argument if the string is malformed
val set_opt_global :
OpamStateTypes.rw OpamStateTypes.global_state ->
string ->
update_op ->
OpamStateTypes.rw OpamStateTypes.global_stateset_opt_global gt field value updates global config field with update value in <opamroot>/config file. Modifiable fields are a subset of all defined fields in OpamFile.Config.t. On revert, field is reverted to its initial value as defined in OpamInitDefaults.init_config, to default value otherwise (OpamFile.Config.empty). May raise OpamStd.Sys.Exit 2.
val set_opt_switch :
'a OpamStateTypes.global_state ->
?st:OpamStateTypes.rw OpamStateTypes.switch_state ->
string ->
update_op ->
OpamStateTypes.rw OpamStateTypes.switch_state optionAs set_opt_global, set_opt_switch updates switch config file in <opamroot>/<switch>/.opam-switch/switch-config. If switch state is given, uses its config and returns it with then new config. Otherwise, loads the raw switch state and returns None. Raises OpamStd.Sys.Exit 50 (`Configuration_error) if no switch is set
val set_var_global :
OpamStateTypes.rw OpamStateTypes.global_state ->
string ->
whole_op ->
OpamStateTypes.rw OpamStateTypes.global_stateset_var_global and set_var_switch update respectively `global-variables` field in global config and `variables` field in switch config, by appending the new variables to current set. If switch state is given, uses its config and returns it with then new config. Otherwise, loads the raw switch state and returns None. Raises OpamStd.Sys.Exit 2 (`Bad_argument) if field is not modifiable
val set_var_switch :
'a OpamStateTypes.global_state ->
?st:OpamStateTypes.rw OpamStateTypes.switch_state ->
string ->
whole_op ->
OpamStateTypes.rw OpamStateTypes.switch_state optionRaises OpamStd.Sys.Exit 50 (`Configuration_error) if no switch is set
Display list of variables and options
List switch and/or global fields/sections and their value. If switch state is given, uses its config, otherwise loads the raw switch state.
val options_list :
?st:OpamStateTypes.unlocked OpamStateTypes.switch_state ->
'a OpamStateTypes.global_state ->
unitval options_list_global : 'a OpamStateTypes.global_state -> unitval options_list_switch :
?st:OpamStateTypes.unlocked OpamStateTypes.switch_state ->
'a OpamStateTypes.global_state ->
unitRaises OpamStd.Sys.Exit 50 (`Configuration_error) if no switch is set
List switch and/or global variables and their value. If switch state is given, uses its config, otherwise loads the raw switch state.
val vars_list :
?st:'a OpamStateTypes.switch_state ->
'b OpamStateTypes.global_state ->
unitval vars_list_global : 'a OpamStateTypes.global_state -> unitval vars_list_switch :
?st:'a OpamStateTypes.switch_state ->
'b OpamStateTypes.global_state ->
unitRaises OpamStd.Sys.Exit 50 (`Configuration_error) if no switch is set
Display a variable and option
Display field name and content in the global / switch configuration. If switch state is given, uses its config, otherwise loads the raw switch state.
val option_show_global : 'a OpamStateTypes.global_state -> string -> unitval option_show_switch :
'a OpamStateTypes.global_state ->
?st:OpamStateTypes.unlocked OpamStateTypes.switch_state ->
string ->
unitRaises OpamStd.Sys.Exit 50 (`Configuration_error) if no switch is set
Display var name and content in the global / switch configuration. Look first in the raw switch_state, if not found, uses the given switch state or loads one.
val var_show_global : 'a OpamStateTypes.global_state -> string -> unitval var_show_switch :
'a OpamStateTypes.global_state ->
?st:'b OpamStateTypes.switch_state ->
string ->
unitval var_show : 'a OpamStateTypes.global_state -> string -> unit