Up

module OpamArg

: sig

OPAM command-line arguments

Commands

#
type command = unit Cmdliner.Term.t * Cmdliner.Term.info

Type of commands

#
val run : command -> command list -> unit

run default commdands at_exit build a binary which takes commands as subcommand and default as default argument (ie. which will be executed when no subcommand is given). at_exit is executed before the program exits.

#
val commands : command list

The default list of commands

#
val default : command

opam

#
val init : command

opam init

#
val list : command

opam list

#
val show : command

opam show

#
val search : command

opam search

#
val install : command

opam install

#
val remove : command

opam remove

#
val reinstall : command

opam reinstall

#
val update : command

opam update

#
val upgrade : command

opam upgrade

#
val config : command

opam config

#
val repository : command

opam repository

#
val switch : command

opam switch

#
val pin : ?unpin_only:bool -> unit -> command

opam pin

#
val help : command

opam help

Flags

#
val print_short_flag : bool Cmdliner.Term.t

--short

#
val installed_flag : bool Cmdliner.Term.t

--installed

#
val installed_roots_flag : bool Cmdliner.Term.t

--installed-root

#
val fish_flag : bool Cmdliner.Term.t

--fish

#
val zsh_flag : bool Cmdliner.Term.t

--zsh

#
val csh_flag : bool Cmdliner.Term.t

--csh

#
val sh_flag : bool Cmdliner.Term.t

--sh

#
val dot_profile_flag : OpamTypes.filename option Cmdliner.Term.t

--dot-profile

#
val repo_kind_flag : OpamTypes.repository_kind option Cmdliner.Term.t

--http/ --git/ --local

#
val jobs_flag : int option Cmdliner.Term.t

--jobs

#
val json_flag : string option Cmdliner.Term.t

--json

#
val pattern_list : string list Cmdliner.Term.t

patterns

#
val name_list : OpamTypes.name list Cmdliner.Term.t

package names

#
val param_list : string list Cmdliner.Term.t

parameters

Global options

#
type global_options

Abstract type for global options

#
val global_options : global_options Cmdliner.Term.t

Global options

#
val apply_global_options : global_options -> unit

Apply global options

Build options

#
type build_options

Abstract type for build options

#
val build_options : build_options Cmdliner.Term.t

Build options

#
val apply_build_options : build_options -> unit

Applly build options

Converters

#
val repository_name : OpamTypes.repository_name Cmdliner.Arg.converter

Repository name converter

#
val address : OpamTypes.address Cmdliner.Arg.converter

Repository address converter

#
val filename : OpamTypes.filename Cmdliner.Arg.converter

Filename converter

#
val dirname : OpamTypes.dirname Cmdliner.Arg.converter

Dirnam converter

#
val compiler : OpamTypes.compiler Cmdliner.Arg.converter

Compiler converter

#
val package_name : OpamTypes.name Cmdliner.Arg.converter

Package name converter

Misc

#
val enum_with_default : (string * ([>
| `default of string
] as 'a)) list -> 'a Cmdliner.Arg.converter

Enumeration with a default command

#
val make_command_alias : unit Cmdliner.Term.t * Cmdliner.Term.info -> ?options:string -> string -> unit Cmdliner.Term.t * Cmdliner.Term.info

Create an alias for an existing command. options can be used to add extra options after the original command in the doc.

end