(++) [OpamMisc.OP] |
Function composition
|
(/) [OpamFilename.OP] |
Create a new directory
|
(//) [OpamFilename.OP] |
Create a new filename
|
(|>) [OpamMisc.OP] |
Pipe operator
|
A | |
action_contents [OpamTypes] |
Extract a package from a package action.
|
actions_of_diff [OpamCudf] |
Compute the list of actions to match the difference between two
universe.
|
actions_of_state [OpamHeuristic] |
Convert a state into a series of action (withour the full closure
of reinstallations).
|
add [OpamJson] | |
add [OpamRepositoryCommand] |
Add a new repository.
|
add [OpamClient.API.REPOSITORY] |
Add a new repository.
|
add_descr_overlay [OpamState] |
Cache a descr file
|
add_extension [OpamFilename] |
Add a file extension
|
add_files_overlay [OpamState] |
Cache additional files
|
add_opam_overlay [OpamState] |
Cache an OPAM file
|
add_pinned_overlay [OpamState] |
Add overlay files for a pinned package
|
add_to_env [OpamState] |
Update an environment.
|
add_to_reinstall [OpamState] |
Add the given packages to the set of package to reinstall.
|
add_url_overlay [OpamState] |
Cache an URL file
|
address [OpamArg] |
Repository address converter
|
address_of_string [OpamTypes] |
Parse an address
|
aliases [OpamPath] |
Compiler aliases
|
all [OpamVariable.Section.Full] |
All the sections in a package
|
all_installed [OpamState] |
Return all the collection of installed packages, for all the
available packages
|
ands [OpamFormula] |
Convert a list of formulas to an AND-formula
|
apply [OpamSolution] |
Apply a solution returned by the solver.
|
apply_build_options [OpamArg] |
Applly build options
|
apply_global_options [OpamArg] |
Apply global options
|
archive [OpamPath.Repository] |
Return the archive for a given package:
$opam/repo/$repo/archives/$NAME.$VERSION.tar.gz
|
archive [OpamPath] |
Archive file: $opam/archives/$NAME.$VERSION+opam.tar.gz
|
archives_dir [OpamPath.Repository] |
Return the archive folder: $opam/repo/$repo/archives/
|
archives_dir [OpamPath] |
Archives dir
|
args [Opam_repo_check] | |
args [Opam_mk_repo] | |
asmcomp [OpamFile.Dot_config.SECTION] |
Return the list of native-compiler options
|
asmcomp [OpamFile.Comp] |
Compilation options to give to the native code compiler
|
asmlink [OpamFile.Dot_config.SECTION] |
Return the list of native-code linking options
|
asmlink [OpamFile.Comp] |
Linking options to give to the native code compiler
|
assoc [OpamFormat] |
Get the value of a field
|
assoc_default [OpamFormat] |
Get the value of a field.
|
assoc_list [OpamFormat] |
Get the value associated to a variable.
|
assoc_option [OpamFormat] |
Get the value of a field.
|
assoc_sections [OpamFormat] |
Get sections
|
assoc_string_list [OpamFormat] |
Get the string list associated to a variable.
|
atom_of_package [OpamSolution] |
Return a simple atom, with no version constrain, from a package
|
atoms [OpamFormula] |
Return all the atoms
|
atoms_of_names [OpamSolution] |
Return a list of atoms from a list of names (wich can eventually
be of the form name.version).
|
atoms_of_packages [OpamSolution] |
Return a list of simple atoms (ie.
|
author [OpamFile.OPAM] |
Author(s)
|
available [OpamFile.Dot_config.SECTION] |
List the available sections
|
available [OpamFile.OPAM] |
Availability formula (OS + compiler constraints)
|
B | |
backup [OpamPath.Switch] |
Backup file for state export
|
backup [OpamPath] |
Backup file for state export
|
backup_dir [OpamPath.Switch] |
The directory where backups are stored for this switch
|
backup_dir [OpamPath] |
The directory where global backups are stored
|
bad_format [OpamFormat] |
Raise
Bad_format .
|
base [OpamFilename.Attribute] |
Get remote filename
|
base_packages [OpamState] |
Return the base packages
|
basename [OpamFilename] |
Return the base name
|
basename_dir [OpamFilename] |
Return the deeper directory name
|
bin [OpamPath.Switch] |
Installed binaries: $opam/$switch/bin
|
bin [OpamFile.Dot_install] |
List of files to install in $bin/
|
body [OpamFile.Descr] |
Return the body
|
browse [OpamFile.Repo] |
Base URL for browsing packages on the WWW
|
brute_force [OpamHeuristic] | explore is_constent state_space explore a state space by
implicitely enumerating all the state in a sensitive order.
|
bug_reports [OpamFile.OPAM] |
Where to post bug reports.
|
build [OpamPath.Switch] |
Tempory folders used to decompress and compile
the corresponding archives:
$opam/$switch/build/$packages
|
build [OpamFile.Comp] |
Options to give to build the package.
|
build [OpamFile.OPAM] |
List of command to run for building the package
|
build_and_install_package [OpamAction] |
Build and install a package.
|
build_config [OpamPath.Switch] |
Tempory location of config files: $opam/$switch/build/$packages/$name.config
|
build_dir [OpamPath.Switch] |
Tempory folder: $opam/$switch/build
|
build_doc [OpamFile.OPAM] |
Commands to build the documentation
|
build_env [OpamFile.OPAM] |
List of environment variables to set-up for the build
|
build_install [OpamPath.Switch] |
Tempory location of install files: $opam/$switch/build/$package/$name.install
|
build_ocaml [OpamPath.Switch] |
Tempory folders used to decompress and compile the OCaml
compiler: $opam/$switch/build/ocaml
|
build_options [OpamArg] |
Build options
|
build_test [OpamFile.OPAM] |
Commands to build and run the tests
|
bytecomp [OpamFile.Dot_config.SECTION] |
Return the list of bytecode-compiler options
|
bytecomp [OpamFile.Comp] |
Compilation options to give to the bytecode compiler
|
bytelink [OpamFile.Dot_config.SECTION] |
Return the list of bytecode linking options
|
bytelink [OpamFile.Comp] |
Linking options to give to the bytecode compiler
|
C | |
chdir [OpamSystem] |
Change the current working directory
|
check [OpamState] |
Apply a function while taking the right locks
|
check_availability [OpamSolution] | |
check_base_packages [OpamState] |
Consistency checks: do the base package for the current compiler
are installed ?
|
check_digest [OpamRepository] | check_digest file expected check that the file digest is the
one expected .
|
check_solution [OpamSolution] |
Raise an error if no solution is found or in case of error.
|
check_suffix [OpamFilename] |
Check whether a file has a given suffix
|
checksum [OpamFilename] |
Compute the MD5 digest a file.
|
checksum [OpamFile.URL] |
Archive checksum
|
checksum_dir [OpamFilename] |
Compute the MD5 digest for all files in a directory.
|
chmod [OpamFilename] |
Change file permissions
|
choose_one [OpamMisc.SET] |
Return one element.
|
chop_extension [OpamFilename] |
Remove the file extension
|
clean_files [OpamProcess] |
Clean-up process result files
|
cleandir [OpamFilename] |
Clean the contents of a directory.
|
close_and_linearize [OpamCudf.Graph] |
Return the transitive closure of dependencies of
set ,
sorted in topological order.
|
cnf_of_formula [OpamFormula] |
Convert a formula to CNF
|
command [OpamSystem] | command cmd executes the command cmd in the correct OPAM
environment.
|
command_exists [OpamSystem] |
Test wether a command exists in the environment.
|
commands [OpamSystem] | commands cmds executes the commands cmds in the correct OPAM
environment.
|
commands [OpamFilter] |
Filter a list of commands by: evaluating the substitution strings; and, removing the commands with a filter evaluating to "false"
|
compare [OpamVersion] |
Version comparison
|
compare [OpamRepository] |
Compare repositories
|
compare [OpamPackage.Version] |
Compare two versions using the Debian version scheme
|
compare [OpamPackage] |
Compare two packages
|
compare [OpamCompiler.Version] |
Compare OCaml versions
|
compiler [OpamArg] |
Compiler converter
|
compiler_comp [OpamPath.Repository] |
Compiler files: $opam/repo/$repo/compilers/XXX/$OVERSION.comp
|
compiler_comp [OpamPath] |
Compiler files: $opam/compilers/$VERSION/$COMP.comp
|
compiler_comp [OpamState] |
Return the compiler description
|
compiler_descr [OpamPath.Repository] |
Compiler description files: $opam/repo/$repo/compilers/XXX/$OVERSION.descr
|
compiler_descr [OpamPath] |
Compiler description files: $opam/compilers/$VERSION/$COMP.descr
|
compiler_files [OpamRepository] |
Get all the compiler files
|
compiler_index [OpamRepository] |
Generate a compiler index from a collection of repositories
|
compiler_index [OpamPath] |
Return the repository index: $opam/repo/compiler-index
|
compiler_index [OpamState] |
Build a map which says in which repository the latest metadata for
a given compiler is.
|
compiler_repository_state [OpamState] |
Repository state
|
compiler_state [OpamRepository] |
Compute a compiler state (ie.
|
compiler_state [OpamState] |
Global compiler state
|
compilers [OpamRepository] |
Get the list of all compiler
|
compilers [OpamPath] |
Compiler subdir $opam/compilers/$VERSION/$COMP
|
compilers_dir [OpamPath.Repository] |
Compiler files: $opam/repo/$repo/compilers/
|
compilers_dir [OpamPath] |
Compiler files: $opam/compilers/
|
compilers_with_prefixes [OpamRepository] |
Get the list of compilers (and their eventual prefixes)
|
config [OpamPath.Repository] |
Return the repository config: $opam/repo/$repo/config
|
config [OpamPath.Switch] |
Compile and link flags for a given package: $opam/$switch/config/$name.config
|
config [OpamPath] |
Main configuration file: $opam/config
|
config [OpamConfigCommand] |
Display configuration options
|
config [OpamClient.API.CONFIG] |
Display configuration options.
|
config [OpamArg] |
opam config
|
config_dir [OpamPath.Switch] |
Configuration folder: $opam/$switch/config
|
configure [OpamFile.Comp] |
Options to give to the "./configure" command
|
confirm [OpamState] |
Ask the user to press Y/y/N/n to continue
|
conflicts [OpamFile.OPAM] |
Package conflicts
|
contains [OpamMisc] |
Does a string contains the given chars ?
|
contents_of_variable [OpamFilter] |
Return the contents of a variable.
|
contents_of_variable [OpamState] |
Compute the value of a variable
|
contents_of_variable_exn [OpamFilter] |
Return the contents of a variable.
|
contents_of_variable_exn [OpamState] |
Compute the value of a variable.
|
copy [OpamSystem] | copy src dst copies src to dst .
|
copy [OpamFilename] |
Copy a file
|
copy_dir [OpamFilename] |
Copy a directory
|
copy_files [OpamFilename] | copy_if_check t src dst copies all the files from one directory
to another.
|
copy_files [OpamState] |
Return the files for a given package
|
copy_in [OpamFilename] |
Copy a file in a directory.
|
create [OpamVariable.Section.Full] |
Create a fully qualified section
|
create [OpamProcess] | create cmd args create a new process to execute the command
cmd with arguments args .
|
create [OpamPath.Repository] |
Repository local path: $opam/repo/<name>
|
create [OpamParallel.SIG] |
Build a graph on concurrent tasks from a list of tasks.
|
create [OpamPackage] |
Create a new pair (name x version)
|
create [OpamFilename.Attribute] |
Constructor
|
create [OpamFilename] |
Create a filename from a Dir.t and a basename
|
create [OpamFile.URL] | |
create [OpamFile.Repo] | |
create [OpamFile.Dot_config] |
Create a new .config file (containing only variables)
|
create [OpamFile.OPAM] |
Create an opam file
|
create [OpamFile.Config] |
Creation
|
create_global [OpamVariable.Full] |
Create a global variable for a package
|
create_local [OpamVariable.Full] |
Create a variable local for a given library/syntax extension
|
create_preinstalled [OpamFile.Comp] |
Create a pre-installed compiler description file
|
create_system_compiler_description [OpamState] |
Create $opam/compilers/system.com.
|
csh_flag [OpamArg] |
--csh
|
current [OpamVersion] |
The current OPAM version
|
current [OpamCompiler.Version] |
Return the version of the compiler currently installed
|
cut_at [OpamMisc] |
Cut a string at the first occurence of the given char
|
cwd [OpamFilename] |
Return the current working directory
|
D | |
debug [OpamMisc] | |
decode [OpamJson.Uncut] | |
decode [OpamJson] | decode d is:
`Await if d has a `Manual source and awaits for more input.
The client must use OpamJson.Manual.src to provide it., `Lexeme l if a lexeme l was decoded., `End if the end of input was reached., `Error e if a decoding error occured. If the client is interested
in a best-effort decoding it can still continue to decode
after an error (see Error recovery) although the resulting sequence
of `Lexeme s is undefined and may not be well-formed.
|
decoded_range [OpamJson] | decoded_range d is the range of characters spanning the last
`Lexeme or `Error (or `White or `Comment for an
OpamJson.Uncut.decode ) decoded by d .
|
decoder [OpamJson] | decoder encoding src is a JSON decoder that inputs from src .
|
decoder_encoding [OpamJson] | decoder_encoding d is d 's encoding.
|
decoder_src [OpamJson] | decoder_src d is d 's input source.
|
default [OpamSwitch] |
Default switch
|
default [OpamRepositoryName] |
Default repository name
|
default [OpamRepository] |
Default repository
|
default [OpamArg] |
opam
|
default_address [OpamRepository] |
Default repository address
|
delete_or_update [OpamSolver] |
Does the solution implies deleting or updating a package
|
dependencies [OpamSolver] |
Return the topological sort of the transitive dependency closures
of a collection of packages.
|
dependencies [OpamCudf] |
Return the transitive closure of dependencies of
set ,
sorted in topological order
|
depends [OpamFile.OPAM] |
Package dependencies
|
depexts [OpamFile.OPAM] |
External dependencies
|
depopts [OpamFile.OPAM] |
Optional dependencies
|
descr [OpamPath.Repository] |
Return the description file for a given package:
$opam/repo/$repo/packages/XXX/$NAME.VERSION/descr
|
descr [OpamPath.Switch.Overlay] |
Descr orverlay
|
descr [OpamPath] |
Description file: $opam/packages/$NAME/$NAME.$VERSION/descr
|
descr [OpamState] |
Return the Descr file for the given package
|
descr_opt [OpamState] |
Return the Descr file for the given package
|
dev_package [OpamPath.Switch] |
Build dir for a given pinned package: $opam/$switch/packages.dev/$name.$version/
|
dev_package [OpamPath] |
Tempory folder for dev packages $opam/packages.dev/$NAME.$VERSION/
|
dev_packages [OpamState] |
Get all the development packages.
|
dev_packages_dir [OpamPath.Switch] |
Build dir for all pinned packages: $opam/$switch/packages.dev/
|
dev_packages_dir [OpamPath] |
Tempory folder for dev packages $opam/packages.dev/
|
diff [OpamCudf.Diff] |
Computation of differences between universe
|
diff [OpamVCS.VCS] |
Check whether the staging area is empty.
|
digest [OpamFilename] |
Compute the MD5 digest of a file
|
dir [OpamPath.Switch.Overlay] |
Switch metadata overlay (over the global metadata): $opam/$switch/overlay/
|
directories_with_links [OpamSystem] | directories_with_links dir returns the directories in the directory dir .
|
dirname [OpamFilename] |
Return the directory name
|
dirname [OpamArg] |
Dirnam converter
|
dirname_dir [OpamFilename] |
Return the parent directory
|
dirs [OpamSystem] |
Return the list of directories in the current directory.
|
dirs [OpamFilename] |
List the sub-directory (do not recurse)
|
display_setup [OpamState] |
Display the global and user configuration for OPAM.
|
dnf_of_formula [OpamFormula] |
Convert a formula to DNF
|
doc [OpamPath.Switch] |
Documentation path for a given package:
$opam/$switch/doc/$name
|
doc [OpamFile.Dot_install] |
List of doc files
|
doc [OpamFile.OPAM] |
API documentation
|
doc_dir [OpamPath.Switch] |
Documentation path: $opam/$switch/doc/
|
dot_config [OpamState] |
Return the .config file for the given package
|
dot_profile_flag [OpamArg] |
--dot-profile
|
download [OpamSystem] |
download compiler sources
|
download [OpamFilename] |
download a remote file in a given directory.
|
download_archive [OpamState] |
Download the OPAM-package archive ($name.$version+opam.tar.gz)
|
download_as [OpamFilename] |
same as
download , but with a specified destination filename instead of a
directory
|
download_dir [OpamTypes] |
Upcast a downloaded directory.
|
download_file [OpamTypes] |
Upcast a downloaded file.
|
download_iter [OpamFilename] |
iterate downloads until one is sucessful
|
download_upstream [OpamState] |
Download the upstream archive, add the eventual additional files
and return the directory..
|
dst [OpamJson.Manual] | dst e s j l provides e with l bytes to write, starting
at j in s .
|
dst_rem [OpamJson.Manual] | dst_rem e is the remaining number of non-written, free bytes
in the last buffer provided with OpamJson.Manual.dst .
|
dump_solution [OpamTypes.ACTION_GRAPH] |
Dump a solution graph
|
E | |
empty [OpamFormat] |
The empty file
|
empty [OpamFile.IO_FILE] |
Empty file
|
enable [OpamVariable] |
the variable
enable
|
encode [OpamJson.Uncut] | |
encode [OpamJson] | encode e v is:
`Partial iff e has a `Manual destination and needs more
output storage. The client must use OpamJson.Manual.dst to provide
a new buffer and then call OpamJson.encode with `Await until `Ok
is returned., `Ok when the encoder is ready to encode a new `Lexeme
or `End .
For `Manual destinations, encoding `End always returns `Partial ,
the client should as usual use OpamJson.Manual.dst and continue with `Await
until `Ok is returned at which point OpamJson.Manual.dst_rem e is guaranteed
to be the size of the last provided buffer (i.e.
|
encoder [OpamJson] | encoder minify dst is an encoder that outputs to dst .
|
encoder_dst [OpamJson] | encoder_dst e is e 's output destination.
|
encoder_minify [OpamJson] | encoder_minify e is true if e 's output is minified.
|
ends_with [OpamMisc] |
Does a string ends with the given suffix ?
|
ends_with [OpamFilename] |
Check whether a filename ends with a given suffix
|
enum_with_default [OpamArg] |
Enumeration with a default command
|
env [OpamMisc] |
Lazy environment
|
env [OpamFile.Comp] |
Environment variable to set-up before running commands in the
subtree
|
env [OpamConfigCommand] |
Display the current environment
|
env [OpamClient.API.CONFIG] |
Display environment.
|
eq_atom [OpamSolution] |
Return an atom with a string version constraint
|
eq_atoms_of_packages [OpamSolution] |
Return a list of constrained atoms from a set of packages
|
equal [OpamPackage] |
Are two packages equal ?
|
etc [OpamPath.Switch] |
Etc directory for a given package: $opam/$switch/etc/$package
|
etc [OpamFile.Dot_install] |
List of etc files
|
etc_dir [OpamPath.Switch] |
Etc directory: $opam/$switch/etc
|
eval [OpamFormula] |
Eval a formula
|
eval [OpamFilter] |
Evaluate a filter.
|
eval_filter [OpamState] |
Evaluate a filter
|
eval_opt [OpamFilter] |
Evaluate an optional filter.
|
exact_match [OpamMisc] |
Exact regexp matching
|
exec [OpamFilename] |
Execute a list of commands in a given directory
|
exec [OpamConfigCommand] |
Execute a command in a subshell
|
exec [OpamClient.API.CONFIG] |
Execute a command in a subshell with the right environment variables.
|
exists [OpamVCS.VCS] |
Test whether the given repository is correctly initialized.
|
exists [OpamFilename] |
see
Sys.file_exists
|
exists_dir [OpamFilename] |
Does the directory existsb ?
|
explore [OpamHeuristic] |
Explore the given package state-space using the
brute_force strategy.
|
export [OpamSwitchCommand] |
Export a file which contains the installed packages.
|
export [OpamClient.API.SWITCH] |
Export the packages to a file.
|
external_solver_available [OpamCudf] |
External solver
|
extract [OpamSystem] | extract filename dirname extracts the archive filename into
dirname .
|
extract [OpamFilename] |
Extract an archive in a given directory (it rewrites the root to
match
Dir.t dir if needed)
|
extract_generic_file [OpamFilename] |
Extract a generic file
|
extract_in [OpamSystem] | extract_in filename dirname extracts the archive filename into
dirname .
|
extract_in [OpamFilename] |
Extract an archive in a given directory (which should already exists)
|
F | |
fetch [OpamVCS.VCS] |
Fetch changes from upstream.
|
filename [OpamArg] |
Filename converter
|
files [OpamSystem] |
Return the list of files in the current directory.
|
files [OpamPath.Repository] |
files $opam/repo/$repo/packages/XXX/$NAME.$VERSION/files
|
files [OpamPath.Switch.Overlay] |
Files overlay
|
files [OpamPath] |
Additional files: $opam/packages/$NAME/$NAME.$VERSION/files
|
files [OpamFilename] |
List all the filename.
|
files [OpamState] |
Return the files/ directory overlay for the given package
|
files_with_links [OpamSystem] | files_with_links dir returns the files in the directory dir .
|
filter_commands [OpamState] |
Filter a list of commands by: evaluating the substitution strings; and, removing the commands with a filter evaluating to "false"
|
filter_map [OpamMisc] |
Filter and map
|
finally [OpamMisc.OP] | finally f cleaner call the cleaner function when f is
complete even in the presence of exceptions.
|
find [OpamMisc.SET] |
Find an element in the list
|
find_backend [OpamRepository] |
Find a backend
|
find_installed_package_by_name [OpamState] |
Return the installed package with the right name
|
find_packages_by_name [OpamState] |
Return all the packages with the given name
|
find_repository [OpamState] |
Find a given repostiory.
|
find_repository_opt [OpamState] |
Find a given repostiory.
|
fish_flag [OpamArg] |
--fish
|
fix_compiler_descriptions [OpamRepositoryCommand] |
Fix the compiler descriptions and display the changes if
verbose
is set.
|
fix_descriptions [OpamRepositoryCommand] |
Fix all the package and compiler descriptions.
|
fix_descriptions_hook [OpamState] |
Update hook
|
fix_package_descriptions [OpamRepositoryCommand] |
Fix the the package descriptions and display the changes if
verbose is set.
|
flock [OpamSystem] | flock () takes the global file lock.
|
fold [OpamTypes.ACTION_GRAPH.Topological] | |
fold_left [OpamFormula] |
Fold function
|
full [OpamVersion] |
The full version (current + git)
|
full [OpamFile.Descr] |
Return the full description
|
funlock [OpamSystem] | funlock () unlocks the global file lock.
|
G | |
get_all_section_by_kind [OpamFormat] |
Get all the sections of a certain kind
|
get_compiler_packages [OpamState] |
Get the packages associated with the given compiler
|
get_final_universe [OpamCudf] |
Compute the final universe state.
|
get_full_env [OpamState] |
Get the current environment.
|
get_opam_env [OpamState] |
Get only environment modified by OPAM.
|
get_section_by_kind [OpamFormat] |
Get one section of a certain kind
|
getenv [OpamMisc] |
Lazy environment variable
|
git [OpamVersion] |
The 'git' version of OPAM
|
global_config [OpamPackage.Name] |
global configuration package
|
global_lock [OpamClient] |
Call an unsafe function while taking the global lock.
|
global_options [OpamArg] |
Global options
|
graph_iter [OpamVariable.Section] |
Iteration in topological order
|
guess_dot_profile [OpamMisc] |
Guess the location of .profile
|
guess_repository_kind [OpamTypes] |
Guess the repository kind
|
guess_shell_compat [OpamMisc] |
Guess the shell compat-mode
|
H | |
has_cycle [OpamParallel.G] | |
hash [OpamPackage] |
Hash a package
|
help [OpamArg] |
opam help
|
homepage [OpamFile.OPAM] |
Homepage(s)
|
I | |
import [OpamSwitchCommand] |
Import a file which contains the packages to install.
|
import [OpamClient.API.SWITCH] |
Import the packages from a file.
|
in_dir [OpamSystem] | in_dir dir fn evaluates fn in the directory dir
|
in_dir [OpamFilename] |
Evaluate a function in a given directory
|
includes [OpamConfigCommand] |
Display includes directives
|
includes [OpamClient.API.CONFIG] |
Display includes files.
|
indent_left [OpamMisc] |
left indenting.
|
indent_right [OpamMisc] |
right indenting
|
info [OpamClient.API] |
Display a general summary of a collection of packages.
|
info [OpamArg] |
opam info
|
init [OpamVCS.VCS] |
Init a repository.
|
init [OpamRepository] |
Initialize $opam/repo/$repo
|
init [OpamPath] |
Init scripts
|
init [OpamClient.API] |
Initialize the client a consistent state.
|
init [OpamArg] |
opam init
|
insert [OpamMisc] |
Insert a value in an ordered list
|
install [OpamCudf] |
Install a package in the universe.
|
install [OpamPath.Switch] |
Installed files for a given package: $opam/$switch/install/$name.install
|
install [OpamSwitchCommand] |
Install a new switch.
|
install [OpamClient.API.SWITCH] |
Install the given compiler.
|
install [OpamClient.API] |
Install the given set of packages.
|
install [OpamArg] |
opam install
|
install_compiler [OpamState] |
Install the given compiler
|
install_dir [OpamPath.Switch] |
Installed files: $opam/$switch/install/
|
install_global_config [OpamState] |
(Re-)install the configuration for a given root and switch
|
install_metadata [OpamState] |
Copy the repository metadata into the global state.
|
installable [OpamSolver] |
Keep only the packages that are installable.
|
installed [OpamVariable] |
the variable
installed
|
installed [OpamPath.Switch] |
List of installed packages with their version:
$opam/$switch/installed
|
installed_flag [OpamArg] |
--installed
|
installed_map [OpamState] |
Return a map from package names to package installed version
|
installed_roots [OpamPath.Switch] |
List of packages expliciterly installed by the user: $opam/$switch/installed.roots
|
installed_roots_flag [OpamArg] |
--installed-root
|
installed_versions [OpamState] |
Return a map containing the switch where a given package is installed.
|
internal_error [OpamSystem] |
Raise
Internal_error
|
invalid_fields [OpamFormat] |
Find all the invalid fields
|
is_compiler_installed [OpamState] |
Is a compiler installed ?
|
is_dev_package [OpamState] |
Check whether a package is a development package
|
is_failure [OpamProcess] |
Is the process result a failure ?
|
is_locally_pinned [OpamState] |
Is the package locally pinned ? (ie.
|
is_name_installed [OpamState] |
Check whether a package name is installed
|
is_package_installed [OpamState] |
Return whether a package is installed
|
is_pinned [OpamPackage] |
Check if a package is pinned.
|
is_pinned [OpamState] |
Is the package name pinned ?
|
is_success [OpamProcess] |
Is the process result a success ?
|
is_switch_installed [OpamState] |
Is a switch installed ?
|
is_symlink [OpamFilename] |
Is a symlink ?
|
is_tar_archive [OpamSystem] |
Test whether the file is an archive, by looking as its extension
|
is_valid [OpamFormat] |
Check whether a list of items contains only valid variable definitions
|
iter [OpamTypes.ACTION_GRAPH.Topological] | |
iter [OpamParallel.SIG] | iter n t pre child paren parallel iteration on n
cores.
|
iter [OpamFormula] |
Iter function
|
iter_l [OpamParallel.SIG] |
Parallel iteration on a list.
|
J | |
jobs [OpamFile.Config] |
Return the number of jobs
|
jobs [OpamState] |
Jobs
|
jobs_flag [OpamArg] |
--jobs
|
json_flag [OpamArg] |
--json
|
K | |
keys [OpamMisc.MAP] |
Return the keys in the map.
|
kind [OpamFile.URL] |
Backend kind (could be curl/rsync/git/darcs/hg at the moment)
|
kind [OpamFile.Dot_config.SECTION] |
Return the section kind
|
kind [OpamFile.Comp] |
Return the url kind
|
kind_of_pin_option [OpamTypes] |
Get the pin kind from a pin option
|
L | |
lib [OpamPath.Switch] |
Library path for a given package:
$opam/$switch/lib/$name
|
lib [OpamFile.Dot_install] |
List of files to install in $lib/
|
lib_dir [OpamPath.Switch] |
Library path: $opam/$switch/lib
|
libraries [OpamFile.OPAM] |
List of exported libraries
|
license [OpamFile.OPAM] |
License(s)
|
link [OpamSystem] | link src dst links src to dst .
|
link [OpamFilename] |
Symlink a file.
|
link_dir [OpamFilename] |
Link a directory
|
link_in [OpamFilename] |
Symlink a file in a directory
|
list [OpamPackage] |
Return all the package descriptions in a given directory
|
list [OpamCompiler] |
List the compiler available in the global state.
|
list [OpamSwitchCommand] |
List all the available compiler switches.
|
list [OpamRepositoryCommand] |
List the available repositories.
|
list [OpamPinCommand] |
List the pinned packages.
|
list [OpamConfigCommand] |
Display the content of all available variables
|
list [OpamClient.API.PIN] |
List the current pinned packages.
|
list [OpamClient.API.SWITCH] |
List the available compiler descriptions.
|
list [OpamClient.API.REPOSITORY] |
Display the list of repositories.
|
list [OpamClient.API.CONFIG] |
Display variables and their contents.
|
list [OpamClient.API] |
Display all available packages that matches any of the
regexps.
|
list [OpamArg] |
opam list
|
load_env_state [OpamState] |
Load state associated to env variables.
|
load_state [OpamState] |
Load the client state.
|
local [OpamRepository] |
Create a local repository on a given path
|
lock [OpamPath.Switch] |
lock file: $opam/lock
|
lock [OpamPath] |
lock file
|
log [OpamPath] |
Log dir $opam/log
|
M | |
magic [OpamVersion] |
Magic string
|
maintainer [OpamFile.OPAM] |
Package maintainer(s)
|
make [OpamFile.Comp] |
Options to give to the "make" command
|
make_archive [OpamRepository] | make_archive ?gener_digest repo prefix package builds the
archive for the given package .
|
make_bool [OpamFormat] |
Create a boolean
|
make_command [OpamFormat] |
Create a command
|
make_commands [OpamFormat] |
Create a list of commands
|
make_compiler_constraint [OpamFormat] |
Build a compiler constraint
|
make_env_variable [OpamFormat] |
Making
|
make_filter [OpamFormat] |
Creation
|
make_formula [OpamFormat] |
Build a formula where AND are implicit.
|
make_group [OpamFormat] |
Create a group of 'things'
|
make_ident [OpamFormat] |
Create an ident
|
make_index_tar_gz [OpamHTTP] | |
make_int [OpamFormat] |
Create an integer
|
make_list [OpamFormat] |
Create a list of 'things'
|
make_opt_formula [OpamFormat] |
Build a formula where OR are implicit.
|
make_option [OpamFormat] |
Create a value and its optional arguments
|
make_os_constraint [OpamFormat] |
Build an OS constraint
|
make_pair [OpamFormat] |
Create a pair
|
make_string [OpamFormat] |
Create a string
|
make_string_list [OpamFormat] |
Create a list of strings
|
make_string_pair [OpamFormat] |
Create a pair of strings
|
make_symbol [OpamFormat] |
Create a symbol
|
make_tags [OpamFormat] |
Make tags
|
make_urls_txt [OpamHTTP] | |
man [OpamFile.Dot_install] |
Man pages
|
man_dir [OpamPath.Switch] |
Man pages path: $opam/$switch/man/.
|
map [OpamFormula] |
Map function
|
map [OpamFormat] |
map a file
|
map [OpamMisc.SET] |
auto-map
|
map_reduce [OpamParallel.SIG] |
Map-reduce on a graph
|
map_reduce_l [OpamParallel.SIG] |
Map-reduce on a list.
|
md5 [OpamFilename.Attribute] |
MD5 digest of the remote file
|
mem_repository [OpamState] |
Check whether a repository exists.
|
message [OpamVersion] |
Display the version message
|
messages [OpamFile.OPAM] |
Messages to display before taking action
|
misc [OpamFile.Dot_install] |
List of other files to install
|
mkdir [OpamSystem] |
Create a directory.
|
mkdir [OpamFilename] |
Create a directory
|
move [OpamFilename] |
Move a file
|
move_dir [OpamFilename] |
Move a directory
|
N | |
name [OpamPackage] |
Return the package name
|
name [OpamFile.Comp] |
Return the compiler name
|
name [OpamFile.OPAM] |
Package name
|
name_list [OpamArg] |
package names
|
names_of_packages [OpamPackage] |
Extract the naes from a collection of packages
|
new_packages [OpamSolver] |
Return the new packages in the solution
|
not_installed [OpamSwitch] |
Display a nice error message when a switch is not installed.
|
O | |
ocaml_version [OpamSystem] |
Return the version of the current OCaml compiler.
|
ocaml_version [OpamFile.OPAM] |
Compiler constraint
|
of_archive [OpamPackage] |
Guess the package name from an archive file.
|
of_atom_formula [OpamFormula] |
Convert an atom-formula to a t-formula
|
of_basename [OpamFilename] |
Create a file from a basename and the current working directory
as dirname
|
of_conjunction [OpamFormula] |
Return a formula from a conjunction of atoms
|
of_dirname [OpamPackage] |
Guess the package name from a directory name.
|
of_disjunction [OpamFormula] |
Return a formula from a disjunction of atoms
|
of_filename [OpamPackage] |
Guess the package name from a filename.
|
of_filename [OpamCompiler] |
Convert a filename into a compiler name.
|
of_list [OpamMisc.MAP] |
Convert an assoc list to a map
|
of_list [OpamMisc.SET] |
Make a set from a list
|
of_string [OpamMisc.Base] | |
of_string [OpamMisc.ABSTRACT] |
Create an abstract value from a string
|
of_string [OpamFile.Descr] |
Create an abstract description file from a string
|
of_string_opt [OpamPackage] |
Return None if
nv is not a valid package name
|
of_universe [OpamCudf.Graph] |
Build a graph from a CUDF universe
|
opam [OpamPath.Repository] |
Return the OPAM file for a given package:
$opam/repo/$repo/packages/XXX/$NAME.$VERSION/opam
|
opam [OpamPath.Switch.Overlay] |
OPAM overlay: $opam/$switch/cache/$name.$version/opam
|
opam [OpamPath] |
OPAM files: $opam/packages/$NAME/$NAME.$VERSION/opam
|
opam [OpamState] |
Return the OPAM file for the given package
|
opam_opt [OpamState] |
Return the OPAM file for the given package
|
opam_version [OpamFile.Repo] |
The minimum OPAM version required for this repository
|
opam_version [OpamFile.Comp] |
Get OPAM version
|
opam_version [OpamFile.OPAM] |
Get OPAM version.
|
opam_version [OpamFile.Config] |
Return the OPAM version
|
open_in [OpamFilename] |
Open a channel from a given file.
|
ors [OpamFormula] |
Convert a list of formulas to an OR-formula
|
os [OpamFile.OPAM] |
OS constraint
|
output [OpamJson] | |
overlay_of_name [OpamState] |
Compute the overlay package for a given name.
|
P | |
package [OpamVariable.Full] |
Return the package the variable is defined in
|
package [OpamVariable.Section.Full] |
Return the package name in which the section is
|
package [OpamPath.Switch.Overlay] |
Switch metadata overlay (over the global metadata): $opam/$switch/overlay/$name.$version
|
package_files [OpamRepository] |
Get all the package files
|
package_index [OpamRepository] |
Generate a package index from a collection of repositories
|
package_index [OpamPath] |
Return the repository index: $opam/repo/package-index
|
package_index [OpamState] |
Builds a map which says in which repository the latest metadata
for a given package are.
|
package_name [OpamArg] |
Package name converter
|
package_partial_state [OpamState] |
Global & partial package state.
|
package_repository_partial_state [OpamState] |
Repository & partial package state.
|
package_repository_state [OpamState] |
Repository state
|
package_state [OpamRepository] |
Compute a package state (ie.
|
package_state [OpamState] |
Global package state.
|
packages [OpamRepository] |
Get the list of packages
|
packages [OpamPath.Repository] |
Package folder: $opam/repo/$repo/packages/XXX/$NAME.$VERSION
|
packages [OpamPath] |
Package sub-directory $opam/packages/$NAME/$NAME.$VERSION/
|
packages [OpamFile.Comp] |
Packages to install immediately after the creation of OCaml
|
packages_dir [OpamPath.Repository] |
Packages folder: $opam/repo/$repo/packages
|
packages_dir [OpamPath] |
Package directroy $opam/packages/
|
packages_of_name [OpamPackage] |
Return all the packages with the given name
|
packages_of_names [OpamPackage] |
Return all the packages with one of the given names
|
packages_with_prefixes [OpamRepository] |
Get the list of packages (and their eventual prefixes)
|
param_list [OpamArg] |
parameters
|
parse_bool [OpamFormat] |
Parse a boolean
|
parse_command [OpamFormat] |
Parse a command
|
parse_commands [OpamFormat] |
Parse a list of commands
|
parse_compiler_constraint [OpamFormat] |
Parse compiler constraints
|
parse_env_variable [OpamFormat] |
Parsing
|
parse_filter [OpamFormat] |
Parsing
|
parse_formula [OpamFormat] |
Parse package formula where AND are implicit:
x y -> x & y
|
parse_group [OpamFormat] |
Parse a group of 'things'
|
parse_ident [OpamFormat] |
Parse an ident
|
parse_int [OpamFormat] |
Parse an integer
|
parse_list [OpamFormat] |
Parse a list of 'things'
|
parse_list_list [OpamFormat] |
Parse a list of list of 'things'
|
parse_messages [OpamFormat] |
Parse a list of commands
|
parse_opt_formula [OpamFormat] |
Parse optional package formula where OR are implicit:
x y -> x | y
|
parse_option [OpamFormat] |
Parse a value and its option of 'things'
|
parse_or [OpamFormat] |
Try to parse the value using function from the list.
|
parse_os_constraint [OpamFormat] |
Parse an OS constraint
|
parse_pair [OpamFormat] |
Parse a pair of strings
|
parse_sequence [OpamFormat] |
Parse a sequence of values
|
parse_single_option [OpamFormat] |
Parse a value and a single optional value
|
parse_single_string [OpamFormat] |
Parse a single string
|
parse_string [OpamFormat] |
Parse a string
|
parse_string_list [OpamFormat] |
Parse a list of strings
|
parse_string_option [OpamFormat] |
Parse a string with an optional argument
|
parse_symbol [OpamFormat] |
Parse a symbol
|
parse_tags [OpamFormat] |
Parse tags
|
patch [OpamSystem] |
Apply a patch file in the current directory.
|
patch [OpamFilename] |
Apply a patch to a directory
|
patches [OpamFile.Comp] |
Return the list of patches to apply
|
patches [OpamFile.OPAM] |
Patches
|
pattern_list [OpamArg] |
patterns
|
perm [OpamFilename.Attribute] |
File permission
|
pin [OpamPinCommand] |
Manage pinned packages.
|
pin [OpamClient.API.PIN] |
Pin a package to a specific version.
|
pin [OpamArg] |
opam pin
|
pin_kind_of_string [OpamTypes] |
Pretty-printing of pin kinds.
|
pin_option_of_string [OpamTypes] |
Read pin options args
|
pinned [OpamPath.Switch] |
Pinned package file: $opam/$switch/pinned
|
pinned [OpamPackage.Version] |
A pinned package version
|
pinned [OpamPackage] |
Create a (path)-pinned package.
|
pinning_version [OpamState] |
Returns the versionned package corresponding to the version the package has
been pinned to.
|
post_messages [OpamFile.OPAM] |
Messages to display at end of install
|
pp [OpamFile.Comp] |
Preprocessing options
|
pp_decode [OpamJson.Uncut] | pp_decode ppf v prints an unspecified representation of v
on ppf .
|
pp_error [OpamJson] | pp_error e prints an unspecified UTF-8 representation of e on ppf .
|
pp_lexeme [OpamJson] | pp_lexeme ppf l prints a unspecified non-JSON representation of l
on ppf .
|
prefixes [OpamPackage] |
Return all the package descriptions in the current directory (and
their eventual prefixes).
|
prefixes [OpamCompiler] |
List the compiler available in a directory (and their prefix)
|
preinstalled [OpamFile.Comp] |
Is it a pre-installed compiler description file
|
prettify [OpamFilename] |
Prettify a filename: replace /path/to/opam/foo by <opam>/foo, replace /path/to/home/foo by ~/foo
|
prettify_dir [OpamFilename] |
Prettify a dirname.
|
prettify_path [OpamMisc] |
Prettify a local path (eg.
|
pretty_backtrace [OpamMisc] |
Return a pretty-printed backtrace
|
pretty_list [OpamMisc] |
Display a pretty list:
"x";"y";"z" -> "x, y and z"
|
print_env_warning_at_init [OpamState] |
Print a warning if the environment is not set-up properly on init.
|
print_env_warning_at_switch [OpamState] |
Print a warning if the environment is not set-up properly on switch.
|
print_short_flag [OpamArg] |
--short
|
print_solution [OpamSolver] |
Display a solution
|
print_stats [OpamSystem] |
Print stats
|
print_stats [OpamFile] |
Display statistics about file access.
|
priority [OpamRepositoryCommand] |
Set a repository priority.
|
priority [OpamClient.API.REPOSITORY] |
Set-up repository priority.
|
process [Opam_stats] | |
process [Opam_repo_check] | |
process [Opam_mk_repo] | |
process_error [OpamSystem] |
raise
Process_error
|
pull_archive [OpamRepository.BACKEND] | pull_archive repo archive pull archive in the given
repository.
|
pull_archive [OpamRepository] |
Pull an archive in a repository
|
pull_repo [OpamRepository.BACKEND] | pull_repo pull the contents of a repository.
|
pull_url [OpamRepository.BACKEND] | pull_url package local_dir checksum remote_url pull the contents of
remote_url into local_dir .
|
pull_url [OpamRepository] |
Download an url
|
pull_url_and_fix_digest [OpamRepository] |
Pull and fix the resulting digest
|
R | |
raw [OpamFilename] |
Creation from a raw string (as http://<path>)
|
raw_config [OpamPath.Repository] |
Return the repository config: $opam/repo/$repo/config
|
raw_dir [OpamFilename] |
Creation from a raw string (as http://<path>)
|
rcut_at [OpamMisc] |
Same as
cut_at , but starts from the right
|
read [OpamSystem] | read filename returns the contents of filename
|
read [OpamFilename] |
Retrieves the contents from the hard disk.
|
read [OpamFile.IO_FILE] |
Read file contents.
|
read_command_output [OpamSystem] | read_command_output cmd executes the command cmd in the
correct OPAM environment and return the lines from stdout if the command
exists normally.
|
read_from_channel [OpamFile.IO_FILE] |
Read from channel.
|
read_lines [OpamProcess] |
Misc
|
read_lock [OpamClient] |
Call an unsafe function while checking that no lock is already held.
|
readlink [OpamFilename] |
Read a symlinked file
|
real_path [OpamSystem] | real_path p returns the real path associated to p : .. are
expanded and relative paths become absolute.
|
rebuild_state_cache [OpamState] |
Rebuild the state cache.
|
rec_dirs [OpamSystem] | rec_dirs dir return the list list of all directories recursively
(going through symbolink links).
|
rec_dirs [OpamFilename] |
List the sub-directory recursively
|
rec_files [OpamSystem] | rec_files dir returns the list of all files in dir ,
recursively.
|
rec_files [OpamFilename] |
List all the filenames, recursively
|
redirect [OpamFile.Repo] |
Redirections.
|
redirect [OpamState] |
Check the redirections.
|
register [OpamLocal] | |
register [OpamHg] | |
register [OpamHTTP] | |
register [OpamGit] | |
register [OpamDarcs] | |
register_backend [OpamRepository] |
Register a repository backend
|
reinstall [OpamPath.Switch] |
Packages to reinstall on next upgrade: $opam/$switch/reinstall
|
reinstall [OpamSwitchCommand] |
Reinstall the given compiler switch.
|
reinstall [OpamClient.API.SWITCH] |
Reinstall the given compiler.
|
reinstall [OpamClient.API] |
Reinstall the given set of packages.
|
reinstall [OpamArg] |
opam reinstall
|
relop_of_string [OpamFormula] |
Parsing relops
|
remote [OpamArg] |
opam remote (alias for 'opam repository')
|
remote_archive [OpamPath.Repository] |
Remote archive $remote/archives/$NAME.$VERSION.tar.gz
|
remote_compilers_dir [OpamPath.Repository] |
Remote compiler files: $remote/compilers
|
remote_packages_dir [OpamPath.Repository] |
Remote package files: $remote/packages
|
remote_repo [OpamPath.Repository] |
Remote repo file
|
remove [OpamCudf] | remove universe name constr Remove all the packages called
name satisfying the constraints constr in the universe
universe .
|
remove [OpamSystem] | remove filename removes filename .
|
remove [OpamFilename] |
Removes everything in
filename if existed.
|
remove [OpamFile.OPAM] |
List of command to run for removing the package
|
remove [OpamSwitchCommand] |
Remove the given compiler switch.
|
remove [OpamRepositoryCommand] |
Remove a repository.
|
remove [OpamClient.API.SWITCH] |
Remove the given compiler.
|
remove [OpamClient.API.REPOSITORY] |
Remove a repository.
|
remove [OpamClient.API] |
Remove the given set of packages.
|
remove [OpamArg] |
opam remove
|
remove_all_packages [OpamAction] |
Remove all the packages from a solution.
|
remove_all_uninstalled_versions_but [OpamCudf] |
Remove all the versions of a given package, but the one given as argument.
|
remove_dir [OpamSystem] | remove_dir filename removes filename .
|
remove_file [OpamSystem] | remove_file filename removes filename .
|
remove_metadata [OpamState] |
Remove some metadata from the global state if they are not used
anymore.
|
remove_overlay [OpamState] |
Remove all overlay files
|
remove_package [OpamAction] |
Remove a package.
|
remove_prefix [OpamMisc] |
Remove a prefix
|
remove_prefix [OpamFilename] |
Remove a prefix from a file name
|
remove_state_cache [OpamState] |
Remove the state cache
|
remove_suffix [OpamMisc] |
Remove a suffix
|
remove_suffix [OpamFilename] |
Remove a suffix from a filename
|
replace [OpamFile.Subst] |
Substitute the variables appearing in a file
|
replace_string [OpamFile.Subst] |
Substitute the variables appearing in a string
|
repo [OpamPath.Repository] |
Return the repo file
|
repo_kind_flag [OpamArg] |
--http/ --git/ --local
|
repositories [OpamFile.Config] |
Return the list of repository
|
repository [OpamArg] |
opam repository
|
repository_and_prefix_of_compiler [OpamState] |
Return the active repository for a given compiler
|
repository_and_prefix_of_package [OpamState] |
Get the active repository for a given package
|
repository_kind_of_pin_kind [OpamTypes] |
Convert a pin kind to a repository kind
|
repository_kind_of_string [OpamTypes] |
Parser of repository kinds.
|
repository_list [OpamArg] |
repositories
|
repository_name [OpamArg] |
Repository name converter
|
repository_of_locally_pinned_package [OpamState] |
Return the repository associtated with a locally pinned
package.
|
repository_of_package [OpamState] |
Get the active repository for a given package
|
requires [OpamFile.Dot_config.SECTION] |
Return the build requirements
|
requires [OpamFile.Comp] |
Libraries to link with
|
reset [OpamVCS.VCS] |
Reset the master branch of the repository to match the remote
repository state.
|
reset_env_value [OpamMisc] |
Remove from a ':' separated list of string the one with the given prefix
|
resolve [OpamSolver] |
Given a description of packages, return a solution preserving the
consistency of the initial description.
|
resolve [OpamHeuristic] |
Optimized resolution
|
resolve [OpamCudf] |
Resolve a CUDF request.
|
resolve [OpamSolution] |
Resolve an user request
|
resolve_and_apply [OpamSolution] |
Call the solver to get a solution and then call
apply .
|
reverse_dependencies [OpamSolver] |
Same as
bdependencies but for reverse dependencies
|
reverse_dependencies [OpamCudf] |
Return the transitive closure of dependencies of
set ,
sorted in topological order
|
revision [OpamVCS.VCS] |
Return the HEAD revision.
|
revision [OpamRepository.BACKEND] |
Return the (optional) revision of a given repository.
|
revision [OpamRepository] |
Get the optional revision associated to a backend.
|
rmdir [OpamFilename] |
Remove a directory
|
root [OpamPath.Switch] |
Root dir: $opam/$switch
|
root [OpamPath] |
Default root path
|
rsync_trim [OpamMisc] |
if rsync -arv return 4 lines, this means that no files have changed
|
run [OpamProcess] | run ~name cmd args synchronously call the command cmd with
arguments args .
|
run [OpamArg] | run default commdands at_exit build a binary which takes
commands as subcommand and default as default argument
(ie.
|
S | |
s_installed_root [OpamCudf] |
The "installed-root" string
|
s_reinstall [OpamCudf] |
The "reinstall" string
|
safe_read [OpamFile.IO_FILE] |
Read file contents.
|
sbin [OpamPath.Switch] |
Installed system binaries: $opam/$switch/sbin
|
sbin [OpamFile.Dot_install] |
List of files to install in $sbin/
|
scc_list [OpamParallel.G] | |
search [OpamArg] |
opam search
|
section [OpamVariable.Full] |
Return the section (library or syntax extension) the package is
defined in
|
section [OpamVariable.Section.Full] |
Return the optional section OpamPackage.Name.t:
None means all available
sections.
|
sections [OpamFormat] |
Get all the sections from a list of items
|
sequential_solution [OpamSolver] |
Create a sequential solution from a list of actions
|
set_output [OpamJson] | |
setup [OpamConfigCommand] |
Update the global and user configuration to use OPAM.
|
setup [OpamClient.API.CONFIG] |
Global and user setup of OPAM.
|
setup_list [OpamConfigCommand] |
Display the global and user configuration for OPAM.
|
setup_list [OpamClient.API.CONFIG] |
Display global and user informations about OPAM setup.
|
sh_flag [OpamArg] |
--sh
|
share [OpamPath.Switch] |
Share directory for a given package: $opam/$switch/share/$package
|
share [OpamFile.Dot_install] |
List of shared files
|
share_dir [OpamPath.Switch] |
Shared directory: $opam/$switch/share
|
show [OpamSwitchCommand] |
Display the current compiler switch.
|
show [OpamClient.API.SWITCH] |
Display the name of the current compiler.
|
solution_is_empty [OpamSolver] |
Is the solution empty ?
|
solution_of_actions [OpamCudf] |
Compution the actions to process from a solution
|
sort [OpamRepository] |
Sort a collection of repositories by priority
|
sorted_repositories [OpamState] |
Sort repositories by priority.
|
split [OpamMisc] |
Split a string
|
src [OpamJson.Manual] | src d s j l provides d with l bytes to read, starting
at j in s .
|
src [OpamFile.Comp] |
Return the url of the compiler
|
starts_with [OpamMisc] |
Does a string starts with the given prefix ?
|
starts_with [OpamFilename] |
Check whether a filename starts by a given Dir.t
|
state_cache [OpamPath] |
State cache
|
state_of_request [OpamHeuristic] |
Find a possible good state which satisfies a request.
|
state_space [OpamHeuristic] |
Build a state space from a list of package names.
|
stats [OpamSolver] |
Compute statistics about a solution
|
string_of_action [OpamTypes.PKG] |
Pretty-printing of package actions
|
string_of_address [OpamTypes] |
Print an address
|
string_of_atom [OpamCudf] |
Pretty-print atoms
|
string_of_atom [OpamFormula] |
Pretty-printing of atoms
|
string_of_channel [OpamSystem] |
Return the contents of a channel.
|
string_of_cnf [OpamFormula] |
Pretty print CNF formulas
|
string_of_conjunction [OpamFormula] |
Pretty print AND formulas
|
string_of_disjunction [OpamFormula] |
Pretty print OR formulas
|
string_of_dnf [OpamFormula] |
Pretty print DNF formulas
|
string_of_file [OpamFormat] |
Print a file
|
string_of_filter [OpamTypes] |
Pretty print
|
string_of_formula [OpamFormula] |
Pretty print a formula
|
string_of_item [OpamFormat] |
Print an file_item
|
string_of_items [OpamFormat] |
Print a list of items
|
string_of_list [OpamMisc] |
Display a list of strings
|
string_of_packages [OpamCudf] |
Pretty-print of packages
|
string_of_pin [OpamTypes] |
Pretty-printing of pinned packages
|
string_of_pin_kind [OpamTypes] |
Parsing of pin kinds.
|
string_of_pin_option [OpamTypes] |
Convert a pin option to a string
|
string_of_reason [OpamCudf] |
Convert a reason to something readable by the user
|
string_of_reasons [OpamCudf] |
Convert a list of reasons to something readable by the user
|
string_of_relop [OpamFormula] |
Pretty-printing of relops
|
string_of_repositories [OpamState] |
Pretty print a map of repositories
|
string_of_repository_kind [OpamTypes] |
Pretty-print repository kinds.
|
string_of_request [OpamSolver] |
Convert a request to a string
|
string_of_request [OpamCudf] |
Pretty-print requests
|
string_of_result [OpamProcess] |
Pretty printing of process.
|
string_of_shell [OpamTypes] |
Pretty-print
|
string_of_stats [OpamSolver] |
Pretty-printing of statistics
|
string_of_symbol [OpamTypes] |
Pretty print
|
string_of_universe [OpamCudf] |
Pretty-print the universe
|
string_of_upload [OpamTypes] |
Pretty-print
|
string_of_value [OpamFormat] |
Print a value
|
string_of_values [OpamFormat] |
Print a list of values
|
string_of_variable_contents [OpamVariable] |
Pretty print of variable contents
|
string_of_vertex [OpamParallel.G] | |
string_of_vpkgs [OpamCudf] |
Convert a package constraint to something readable.
|
strip [OpamMisc] |
Strip a string
|
stublibs [OpamPath.Switch] |
DLL paths
|
stublibs [OpamFile.Dot_install] |
C bindings
|
sub_at [OpamMisc] |
Cut a string
|
subst [OpamConfigCommand] |
Substitute files
|
subst [OpamClient.API.CONFIG] |
Substitute files.
|
substitute_file [OpamFilter] |
Substitute a file.
|
substitute_file [OpamState] |
Substitute file
|
substitute_string [OpamFilter] |
Substitute a string.
|
substitute_string [OpamState] |
Substitute a string
|
substs [OpamFile.OPAM] |
File substitutions
|
succ [OpamHeuristic] |
Given a list of bounds and a tuple, return the next tuple which
satisfies the bounds (each component will be stricly lesser than
the bounds).
|
sum [OpamSolution] |
Stats
|
switch [OpamFile.Config] |
Return the OCaml switch
|
switch [OpamSwitchCommand] |
Switch to the given compiler switch.
|
switch [OpamClient.API.SWITCH] |
Switch to the given compiler.
|
switch [OpamArg] |
opam switch
|
switch_lock [OpamClient] |
Call an unsafe function while taking the current switch lock.
|
switch_reinstall_hook [OpamState] |
Switch reinstall hook.
|
synopsis [OpamFile.Descr] |
Return the first line
|
syntax [OpamFile.OPAM] |
List of exported syntax extensions
|
system [OpamCompiler.Version] |
Returm the version of the system compiler
|
system [OpamCompiler] |
System compiler
|
system_ocamlc_version [OpamSystem] |
Return the version of the system compiler
|
system_ocamlc_where [OpamSystem] |
Return the path where the system ocamlc library is installed
|
T | |
tags [OpamFile.OPAM] |
Classification tags
|
temp_file [OpamSystem] |
Create a tempory file in ~/.opam/logs/<name>XXX
|
terminal_columns [OpamMisc] |
When
stdout refers to a terminal, query the number of columns.
|
to_1_0 [OpamFile.Comp] |
Convert to OPAM 1.0
|
to_1_0 [OpamFile.OPAM] |
Convert to OPAM 1.0
|
to_atom_formula [OpamFormula] |
Transform a formula where versions can be expressed using formulas
to a flat atom formula
|
to_attribute [OpamFilename] |
Convert a filename to an attribute, relatively to a root
|
to_cnf [OpamFormula] |
Return an equivalent CNF formula
|
to_conjunction [OpamFormula] |
Return a conjunction.
|
to_disjunction [OpamFormula] |
Return a disjunction.
|
to_dnf [OpamFormula] |
Return an equivalent DNF formula
|
to_json [OpamMisc.OrderedType] | |
to_json [OpamMisc.Base] | |
to_json [OpamMisc.MAP] |
Return a JSON representation of the given map.
|
to_json [OpamMisc.SET] |
Return a JSON representation of the given set
|
to_json [OpamMisc.ABSTRACT] |
Convert an abstract value to a JSON object
|
to_list_dir [OpamFilename] |
Turn a full path into a list of directory names
|
to_map [OpamPackage] |
Convert a set of pairs to a map
name -> versions
|
to_string [OpamTypes.PKG] |
Pretty printing of packages
|
to_string [OpamRepository] |
Pretty-print
|
to_string [OpamMisc.OrderedType] | |
to_string [OpamMisc.Base] | |
to_string [OpamJson] | |
to_string [OpamFormula] |
Pretty print the formula
|
to_string [OpamFilter] |
Pretty-print
|
to_string [OpamMisc.MAP] |
Pretty-printing
|
to_string [OpamMisc.SET] |
Pretty-print a set
|
to_string [OpamMisc.ABSTRACT] |
Convert an abstract value to a string
|
toplevel [OpamPath.Switch] |
toplevel path: $opam/$switch/lib/toplevel
|
toplevel [OpamFile.Dot_install] |
List of toplevel files
|
touch [OpamFilename] |
Create an empty file
|
transitive_closure [OpamCudf.Graph] |
Return the transitive closure of
g
|
U | |
uname_s [OpamMisc] |
Get the output of
uname -s
|
unavailable [OpamPackage] |
Unavailable package: the package exists in the database, but it is
not available due to compiler/OS constraints.
|
unavailable_because_pinned [OpamPackage] |
Unavailable because the package is pinned.
|
uninstall_all [OpamCudf] |
Uninstall all the package in the universe.
|
union [OpamMisc.MAP] |
A key will be in the union of
m1 and m2 if it is appears
either m1 or m2 , with the corresponding value.
|
universe [OpamState] |
Create a universe from the current state
|
unknown [OpamPackage] |
Unknown package: either the name is unknown, or the version does
not exist.
|
unknown [OpamCompiler] |
Errors
|
update [OpamRepository] |
Update $opam/repo/$repo.
|
update [OpamClient.API] |
Refresh the available packages.
|
update [OpamArg] |
opam update
|
update_cache [OpamPath.Repository] |
Update cache
|
update_cache [OpamPath] |
Update cache
|
update_compiler_index [OpamRepositoryCommand] |
Update the compiler index.
|
update_dev_packages [OpamState] | update_dev_packages t checks for upstream changes for packages
first in the switch cache and then in the global cache.
|
update_dev_packages [OpamRepositoryCommand] |
Update the given dev packages.
|
update_metadata [OpamAction] |
Update package metadata
|
update_package_index [OpamRepositoryCommand] |
Update the package index.
|
update_setup [OpamState] |
Update the user configuration.
|
update_setup_interactive [OpamState] |
Update the global and user configuration by asking some questions.
|
update_switch_config [OpamState] |
Write the right compiler switch in ~/.opam/config
|
upgrade [OpamClient.API] |
Find a consistent state where most of the installed packages are
upgraded to their latest version.
|
upgrade [OpamArg] |
opam upgrade
|
upload_dir [OpamPath.Repository] |
Return the upload folder for a given version:
$opam/repo/$repo/upload/
|
upstream [OpamFile.Repo] |
Base URL for browsing OPAM repository source on the WWW
|
url [OpamPath.Repository] |
urls $opma/repo/$repo/package/XXX/$NAME.$VERSION/url
|
url [OpamPath.Switch.Overlay] |
URL overlay: $opam/$switch/overlay/$name.$version/url
|
url [OpamPath] |
URL files: $opam/packages/$NAME/$NAME.$VERSION/url
|
url [OpamFile.URL] |
URL address
|
url [OpamState] |
Return the URL file for the given package
|
url_of_locally_pinned_package [OpamState] |
Return the URL file associated with a locally pinned package.
|
V | |
values [OpamMisc.MAP] |
Return the values in the map.
|
variable [OpamVariable.Full] |
Return the variable name
|
variable [OpamFile.Dot_config.SECTION] |
Return the value of variables
|
variable [OpamFile.Dot_config] |
Top-level variables
|
variable [OpamConfigCommand] |
Display the content of a given variable
|
variable [OpamClient.API.CONFIG] |
Display a given variable content.
|
variables [OpamFormat] |
Get all the variable definitions from a list of items
|
variables [OpamFile.Dot_config.SECTION] |
The list of local variables
|
variables [OpamFile.Dot_config] |
The list of top-level variables
|
verbose [OpamJson] | |
version [OpamPackage] |
Return the version name
|
version [OpamFile.Comp] |
Return the compiler version
|
version [OpamFile.OPAM] |
Package version
|
version [OpamCompiler] |
Return the compiler version
|
versions_of_name [OpamPackage] |
Return the list of versions for a given package
|
versions_of_packages [OpamPackage] |
Extract the versions from a collection of packages
|
W | |
wait [OpamProcess] | wait p waits for the processus p to end and returns its results.
|
with_bug_reports [OpamFile.OPAM] |
Construct using
bug_reports
|
with_build [OpamFile.OPAM] |
Construct as
build
|
with_checksum [OpamFile.URL] |
Constructor
|
with_contents [OpamFilename] |
Apply a function on the contents of a file
|
with_current_opam_version [OpamFile.Config] |
Update opam-version to the current one
|
with_depends [OpamFile.OPAM] |
Construct as
depends
|
with_depexts [OpamFile.OPAM] |
Construct using
depexts
|
with_depopts [OpamFile.OPAM] |
Construct as
depopts
|
with_flock [OpamFilename] |
File locks
|
with_libraries [OpamFile.OPAM] |
Construct as
libraries
|
with_maintainer [OpamFile.OPAM] |
Construct as
maintainer
|
with_name [OpamFile.OPAM] |
construct as
name
|
with_ocaml_version [OpamFile.OPAM] |
Construct as
compiler_version
|
with_patches [OpamFile.OPAM] |
Construct as
patches
|
with_remove [OpamFile.OPAM] |
Construct as
remove
|
with_repositories [OpamFile.Config] |
Repository updates
|
with_substs [OpamFile.OPAM] |
Construct as
substs
|
with_switch [OpamFile.Config] |
OCaml switch updates
|
with_switch_backup [OpamClient] |
Loads state with
command , and calls f on it.
|
with_tmp_dir [OpamSystem] | with_tmp_dir fn executes fn in a tempory directory
|
with_tmp_dir [OpamFilename] |
Execute a function in a temp directory
|
with_version [OpamFile.OPAM] |
construct as
version
|
write [OpamSystem] | write filename contents write contents to filename
|
write [OpamFilename] |
Removes everything in
filename if existed, then write contents instead.
|
write [OpamFile.IO_FILE] |
Write some contents to a file
|
write_to_channel [OpamFile.IO_FILE] |
Write to channel.
|
Z | |
zero [OpamHeuristic] | zero n returns the tuple with n zeros, which is the first
state to explore.
|
zsh_flag [OpamArg] |
--zsh
|