Module OpamFile.OPAM

module OPAM: sig .. end
OPAM files

include OpamFile.IO_FILE
val create : OpamTypes.package -> t
Create an opam file
val name : t -> OpamTypes.name
Package name
val version : t -> OpamTypes.version
Package version
val ocaml_version : t -> OpamTypes.compiler_constraint option
Compiler constraint
val os : t -> (bool * string) OpamTypes.generic_formula
OS constraint
val maintainer : t -> string
Package maintainer
val substs : t -> OpamTypes.basename list
File substitutions
val build_env : t -> (string * string * string) list
List of environment variables to set-up for the build
val build : t -> OpamTypes.command list
List of command to run for building the package
val remove : t -> OpamTypes.command list
List of command to run for removing the package
val depends : t -> OpamTypes.formula
Package dependencies
val depopts : t -> OpamTypes.formula
Optional dependencies
val depexts : t -> OpamTypes.tags option
External dependencies
val conflicts : t -> OpamTypes.formula
Package conflicts
val libraries : t -> OpamTypes.section list
List of exported libraries
val syntax : t -> OpamTypes.section list
List of exported syntax extensions
val patches : t -> (OpamTypes.basename * OpamTypes.filter option) list
Patches
val homepage : t -> string option
Homepage
val authors : t -> string list
Authors
val license : t -> string option
License
val doc : t -> string option
API documentation
val tags : t -> string list
Classification tags
val build_test : t -> OpamTypes.command list
Commands to build and run the tests
val build_doc : t -> OpamTypes.command list
Commands to build the documentation
val with_depends : t -> OpamTypes.formula -> t
Construct as depends
val with_depopts : t -> OpamTypes.formula -> t
Construct as depopts
val with_build : t -> OpamTypes.command list -> t
Construct as build
val with_remove : t -> OpamTypes.command list -> t
Construct as remove
val with_libraries : t -> OpamTypes.section list -> t
Construct as libraries
val with_substs : t -> OpamTypes.basename list -> t
Construct as substs
val with_ocaml_version : t -> OpamTypes.compiler_constraint option -> t
Construct as compiler_version
val with_maintainer : t -> string -> t
Construct as maintainer
val with_patches : t -> (OpamTypes.basename * OpamTypes.filter option) list -> t
Construct as patches