Library
Module
Module type
Parameter
Class
Class type
Command-line argument parsers and helpers
val shell_opt : OpamTypes.shell Cmdliner.Term.t
--shell
val dot_profile_flag : OpamTypes.filename option Cmdliner.Term.t
--dot-profile
val repo_kind_flag : OpamUrl.backend option Cmdliner.Term.t
--http/ --git/ --local
val name_list : OpamTypes.name list Cmdliner.Term.t
package names
val atom_list : OpamFormula.atom list Cmdliner.Term.t
package list with optional constraints
val nonempty_atom_list : OpamFormula.atom list Cmdliner.Term.t
package list with optional constraints
Generic argument list builder
Generic argument list builder
type global_options = {
debug_level : int option;
verbose : int;
quiet : bool;
color : [ `Always | `Never | `Auto ] option;
opt_switch : string option;
yes : bool;
strict : bool;
opt_root : OpamTypes.dirname option;
no_base_packages : bool;
git_version : bool;
external_solver : string option;
use_internal_solver : bool;
cudf_file : string option;
solver_preferences : string option;
safe_mode : bool;
json : string option;
}
Type for global options
val global_options : global_options Cmdliner.Term.t
Global options
val create_global_options :
bool ->
bool ->
int option ->
'a list ->
bool ->
[ `Always | `Auto | `Never ] option ->
string option ->
bool ->
bool ->
OpamTypes.dirname option ->
bool ->
string option ->
bool ->
string option ->
string option ->
bool ->
string option ->
global_options
val apply_global_options : global_options -> unit
Apply global options
val build_options : build_options Cmdliner.Term.t
Build options
val apply_build_options : build_options -> unit
Applly build options
val repository_name : OpamTypes.repository_name Cmdliner.Arg.converter
Repository name converter
val url : OpamTypes.url Cmdliner.Arg.converter
URL converter
val filename : OpamTypes.filename Cmdliner.Arg.converter
Filename converter
val existing_filename_or_dash :
OpamTypes.filename option Cmdliner.Arg.converter
Filename converter also accepting "-" for stdin/stdout
val dirname : OpamTypes.dirname Cmdliner.Arg.converter
Dirnam converter
val existing_filename_dirname_or_dash :
OpamFilename.generic_file option Cmdliner.Arg.converter
val package_name : OpamTypes.name Cmdliner.Arg.converter
Package name converter
val package :
(OpamTypes.name * OpamTypes.version option) Cmdliner.Arg.converter
name{.version}
val atom : OpamTypes.atom Cmdliner.Arg.converter
name{(.|=|!=|>|<|>=|<=)version}
converter
val enum_with_default : (string * 'a default) list -> 'a Cmdliner.Arg.converter
Enumeration with a default command
val opamlist_column : OpamListCommand.output_format Cmdliner.Arg.converter
A subcommand cmds, v, args, doc
is the subcommand cmd
, using the documentation doc
and the list of documentation parameters args
. If the subcommand is selected, return v
.
type 'a subcommands = 'a subcommand list
val mk_subcommands :
'a subcommands ->
'a option Cmdliner.Term.t * string list Cmdliner.Term.t
subcommands cmds
are the terms cmd
and params
. cmd
parses which sub-commands in cmds
is selected and params
parses the remaining of the command-line parameters as a list of strings.
val mk_subcommands_with_default :
'a default subcommands ->
'a option Cmdliner.Term.t * string list Cmdliner.Term.t
Same as mk_subcommand
but use the default value if no sub-command is selected.
val bad_subcommand :
'a default subcommands ->
(string * 'a option * string list) ->
'b Cmdliner.Term.ret
bad_subcommand cmds cmd
is a command return value denoting a parsing error of sub-commands.
val mk_subdoc :
?defaults:(string * string) list ->
'a subcommands ->
Cmdliner.Manpage.block list
mk_subdoc cmds
is the documentation block for cmds
.