(/) [OpamFilename.OP] |
Create a new directory
|
(//) [OpamFilename.OP] |
Create a new filename
|
A | |
acolor [OpamGlobals] | |
acolor_w [OpamGlobals] | |
action_contents [OpamTypesBase] |
Extract a package from a package action.
|
add [OpamJson] | |
add [OpamRepositoryCommand] |
Add a new repository.
|
add [OpamClient.API.REPOSITORY] |
Add a new repository.
|
add_extension [OpamFilename] |
Add a file extension
|
add_pinned_overlay [OpamState] |
Add overlay files for a pinned package.
|
add_pos [OpamFormat] |
Adds a position to a Bad_format exception if it doesn't have one yet
|
add_to_env [OpamState] |
Update an environment.
|
add_to_reinstall [OpamState] |
Add the given packages to the set of package to reinstall.
|
address_of_string [OpamTypesBase] |
Parse an address
|
aliases [OpamPath] |
Compiler aliases
|
all_installed [OpamState] |
Return all the collection of installed packages, for all the
available packages
|
all_parens [OpamGlobals] |
Tells the printer to write parens everywhere
|
ands [OpamFormula] |
Convert a list of formulas to an AND-formula (
Empty formulas are
ignored)
|
ands_to_list [OpamFormula] |
Converts back an AND-formula to a list (flattens top-level ands)
|
ano [Opam_check] | |
apply [OpamSolution] |
Apply a solution returned by the solver.
|
arch [OpamGlobals] | |
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
|
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_packages [OpamSolution] |
Return a list of simple atoms (ie.
|
author [OpamFile.OPAM] |
Author(s)
|
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
|
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 from its downloaded source.
|
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 [OpamGlobals] | |
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_test [OpamGlobals] | |
build_test [OpamFile.OPAM] |
Commands to build and run the tests
|
C | |
chdir [OpamSystem] |
Change the current working directory
|
check [OpamFormula] |
Checks if a package verifies an atom
|
check [OpamState] |
Apply a function while taking the right locks
|
check_availability [OpamSolution] |
Checks that the atoms can possibly be verified (individually) in a package
set.
|
check_base_packages [OpamState] |
Consistency checks: do the base package for the current compiler
are installed ?
|
check_relop [OpamFormula] |
Check a relational operator against an integer from compare
|
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
|
chop_extension [OpamFilename] |
Remove the file extension
|
clean_files [OpamProcess] |
Clean-up process result files
|
cleandir [OpamFilename] |
Clean the contents of a directory.
|
cleanup_package_artefacts [OpamAction] |
Removes auxiliary files related to a package, after checking that
they're not needed (even in other switches)
|
cnf_of_formula [OpamFormula] |
Convert a formula to CNF
|
color [OpamGlobals] | |
color_tri_state [OpamGlobals] | |
colorise [OpamGlobals] |
not nestable
|
command [OpamSystem] | command cmd executes the command cmd in the correct OPAM
environment.
|
command_exists [OpamSystem] |
Test whether 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 [OpamCompiler.Version] |
Compare OCaml versions
|
compat_mode_1_0 [OpamGlobals] | |
compat_preferences [OpamGlobals] | |
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_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 [OpamState] |
Global compiler state
|
compilers [Opam_admin_top] |
All defined compilers in the current repo
|
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/
|
complete [OpamScript] | |
complete_zsh [OpamScript] | |
config [OpamPath.Repository] |
Return the repository config: $opam/repo/$repo/config
|
config [OpamPath.Switch] |
Compile and link flags for a given package: $opam/$switch/lib/$name/opam.config
|
config [OpamPath] |
Main configuration file: $opam/config
|
config_dir [OpamPath.Switch] |
Configuration folder: $opam/$switch/config
|
configure [OpamFile.Comp] |
Options to give to the "./configure" command
|
confirm [OpamGlobals] |
Ask the user to press Y/y/N/n to continue (returns a boolean)
|
conflicts [OpamFile.OPAM] |
Package conflicts
|
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.Full] |
Create a variable local for a given library/syntax extension
|
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 [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_preinstalled [OpamFile.Comp] |
Create a pre-installed compiler description file
|
create_system_compiler_description [OpamState] |
Create $opam/compilers/system.com.
|
criteria [OpamFile.Config] | |
cudf_file [OpamGlobals] | |
curl_command [OpamGlobals] | |
current [OpamVersion] |
The current OPAM version
|
current [OpamCompiler.Version] |
Return the version of the compiler currently installed
|
current_nopatch [OpamVersion] |
The current OPAM version, truncated (only MAJOR.MINOR)
|
cwd [OpamFilename] |
Return the current working directory
|
D | |
debug [OpamGlobals] | |
debug_level [OpamGlobals] | |
default [OpamSwitch] |
Default switch
|
default [OpamRepositoryName] |
Default repository name
|
default_dl_jobs [OpamGlobals] | |
default_external_solver [OpamGlobals] | |
default_jobs [OpamGlobals] | |
default_opam_dir [OpamGlobals] | |
default_preferences [OpamGlobals] | |
default_repository_address [OpamGlobals] | |
default_repository_name [OpamGlobals] | |
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/
|
dev_repo [OpamFile.OPAM] |
The package source repository address
|
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/
|
dir_is_empty [OpamSystem] | |
dir_is_empty [OpamFilename] | |
directories_with_links [OpamSystem] | directories_with_links dir returns the directories in the directory dir .
|
dirname [OpamFilename] |
Return the directory name
|
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.
|
dl_jobs [OpamGlobals] | |
dl_jobs [OpamFile.Config] |
Return the number of download jobs
|
dl_jobs [OpamState] |
Download Jobs
|
dnf_of_formula [OpamFormula] |
Convert a formula to DNF
|
do_not_copy_files [OpamGlobals] | |
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
|
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 [OpamTypesBase] |
Upcast a downloaded directory.
|
download_file [OpamTypesBase] |
Upcast a downloaded file.
|
download_iter [OpamFilename] |
iterate downloads until one is sucessful
|
download_package [OpamAction] |
Downloads the source for a package to the local cache.
|
download_retry [OpamGlobals] | |
download_upstream [OpamState] |
Download the upstream archive, add the eventual additional files
and return the directory..
|
dryrun [OpamGlobals] | |
E | |
edit [OpamPinCommand] |
Let the user edit a pinned package's opam file.
|
edit [OpamClient.API.PIN] | |
editor [OpamGlobals] | |
empty [OpamFormat] |
The empty file
|
empty [OpamFile.IO_FILE] |
Empty file
|
ends_with [OpamFilename] |
Check whether a filename ends with a given suffix
|
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
|
error [OpamGlobals] | |
error_and_exit [OpamGlobals] | |
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.
|
eval_relop [OpamFormula] |
Evaluate a relational operator between versions
|
eval_relop [OpamCompiler.Version] |
Evaluate a relational operator between OCaml versions
|
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 ?
|
exit [OpamGlobals] | |
export [OpamSwitchCommand] |
Export a file which contains the installed packages.
|
export [OpamClient.API.SWITCH] |
Export the packages to a file.
|
external_solver [OpamGlobals] | |
external_tags [OpamGlobals] | |
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)
|
extract_package [OpamAction] |
Extracts and patches the source of a package found in the local cache.
|
F | |
fake [OpamGlobals] | |
fetch [OpamVCS.VCS] |
Fetch changes from upstream.
|
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_compilers [Opam_admin_top] |
Turn a list of glob patterns into a proper filtering function on
compiler names.
|
filter_deps [OpamTypesBase] | |
filter_packages [Opam_admin_top] |
Turn a list of glob patterns into a proper filtering function on
package names.
|
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.
|
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.
|
fixup [OpamClient.API] |
Recovers from an inconsistent universe
|
flags [OpamFile.OPAM] |
The package flags that are present for this package.
|
flock [OpamSystem] |
Acquires a lock on the given file.
|
fold_left [OpamFormula] |
Fold function
|
formula_of_extended [OpamFormula] |
Turns an extended package formula to a normal formula, by filtering out
the packages on the flags of which
filter returns false .
|
full [OpamVersion] |
The full version (current + git)
|
full [OpamFile.Descr] |
Return the full description
|
full_action_contents [OpamTypesBase] |
Extract a packages from a package action.
|
funlock [OpamSystem] |
Releases an acquired locl
|
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_env_var [OpamState] |
Check for user-defined variable overwrite.
|
get_external_solver [OpamGlobals] | |
get_full_env [OpamState] |
Get the current environment with OPAM specific additions.
|
get_opam_env [OpamState] |
Get only environment modified by OPAM.
|
get_section_by_kind [OpamFormat] |
Get one section of a certain kind
|
get_solver_criteria [OpamGlobals] |
Get the currently configured solver criteria as a string
|
git [OpamVersion] |
The 'git' version of OPAM
|
global_config [OpamPath.Switch] |
Global config for the switch: $opam/$switch/config/global-config.config
|
global_config [OpamGlobals] | |
global_lock [OpamClient] |
Call an unsafe function while taking the global lock.
|
global_start_time [OpamGlobals] | |
global_variable_names [OpamState] |
Lists of available variables and their description
|
guess_version_control [OpamTypesBase] |
Scan the given directory for version control
|
H | |
handle_install [Opamlfind] | |
has_empty_opam [OpamState] |
May be used to check if a given package metadata has just been
initialised.
|
header_error [OpamGlobals] | |
header_msg [OpamGlobals] | |
home [OpamGlobals] | |
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
|
indent_left [OpamGlobals] | |
info [OpamClient.API] |
Display a general summary of a collection of packages.
|
init [OpamVCS.VCS] |
Init a repository.
|
init [OpamPath] |
Init scripts
|
init [OpamClient.API] |
Initialize the client a consistent state.
|
install [OpamSystem] | install ?exec src dst copies file src as file dst using install .
|
install [OpamPath.Switch] |
Installed files for a given package: $opam/$switch/install/$name.install
|
install [OpamFilename] |
Installs a file to a destination.
|
install [OpamFile.OPAM] |
List of command to run for installing the package
|
install [OpamSwitchCommand] |
Like
install_cont but runs the continuation already
|
install [OpamClient.API.SWITCH] |
Install the given compiler.
|
install [OpamClient.API] |
Install the given list of packages.
|
install_compiler [OpamState] |
Install the given compiler
|
install_cont [OpamSwitchCommand] |
Install a new switch.
|
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.
|
installed [Opam_check] | |
installed [OpamPath.Switch] |
List of installed packages with their version:
$opam/$switch/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_timestamp [OpamState] |
Returns a timestamp when the given package was last installed
|
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_exec [OpamSystem] |
Checks if a file is an executable (regular file with execution
permission)
|
is_exec [OpamFilename] |
Is an executable ?
|
is_explicit [OpamFile.OPAM] |
Returns true if the given OPAM file contains 'name' or 'version' fields
|
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 [OpamState] |
Is the package name pinned ?
|
is_self_upgrade [OpamGlobals] | |
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 [OpamFormula] |
Iter function
|
iter_compilers [Opam_admin_top] | |
iter_compilers_gen [Opam_admin_top] |
Similarly for compiler descriptions
|
iter_packages [Opam_admin_top] |
Quicker interface when considering a single type of file
|
iter_packages_gen [Opam_admin_top] |
Maps on the files of every package.
|
J | |
jobs [OpamGlobals] | |
jobs [OpamFile.Config] |
Return the number of jobs
|
jobs [OpamState] |
Jobs
|
K | |
keep_build_dir [OpamGlobals] | |
kind [OpamFile.URL] |
Backend kind (could be curl/rsync/git/darcs/hg at the moment)
|
kind [OpamFile.Comp] |
Return the url kind
|
kind_of_pin_option [OpamTypesBase] |
Get the pin kind from a pin option
|
L | |
label [Opam_check] | |
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 [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.
|
load_env_state [OpamState] |
Load state associated to env variables.
|
load_state [OpamState] |
Load the client state.
|
lock [OpamPath.Switch] |
lock file: $opam/lock
|
lock [OpamPath] |
lock file
|
log [OpamPath] |
Log dir $opam/log
|
log [OpamGlobals] | log section ~level fmt args .
|
log_limit [OpamGlobals] | |
log_line_limit [OpamGlobals] | |
logop_of_string [OpamTypesBase] |
Raises Invalid_argument
|
M | |
magic [OpamVersion] |
Magic string
|
main [OpamParser] | |
main [OpamLineLexer] | |
maintainer [OpamFile.OPAM] |
Package maintainer(s)
|
major [OpamVersion] |
Extracts the major version
|
make [OpamFile.Comp] |
Options to give to the "make" command
|
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_ext_formula [OpamFormat] |
Make an AND formula where constraints are extended with leading keywords
|
make_filter [OpamFormat] |
Creation
|
make_flag [OpamFormat] |
Create a package flag
|
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_libraries [OpamFormat] |
Create a list of libraries/syntax
|
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_section [OpamFormat] |
Create a file section
|
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_tags [OpamFormat] |
Make tags
|
make_urls_txt [OpamHTTP] | |
make_variable [OpamFormat] |
Create a variable
|
makecmd [OpamGlobals] | |
man [OpamFile.Dot_install] |
Man pages
|
man_dir [OpamPath.Switch] |
Man pages path: $opam/$switch/man/.
|
map [OpamFormula] |
Map on atoms.
|
map [OpamFormat] |
map a file
|
map_formula [OpamFormula] |
Maps top-down on a formula
|
map_success [OpamTypesBase] |
Map on a solver result
|
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
|
mirrors [OpamFile.URL] | |
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
|
msg [OpamGlobals] | |
N | |
name [OpamFile.Comp] |
Return the compiler name
|
name [OpamFile.OPAM] |
Package name
|
name_opt [OpamFile.OPAM] | |
name_to_string [OpamTypes.GenericPackage] | |
neg [OpamFormula] |
Negates a formula (given the function to negate atoms)
|
neg_relop [OpamFormula] | |
no_base_packages [OpamGlobals] | |
no_checksums [OpamGlobals] | |
no_self_upgrade [OpamGlobals] | |
nopatch [OpamVersion] |
Major+minor version, strips the patch version
|
not_installed [OpamSwitch] |
Display a nice error message when a switch is not installed.
|
note [OpamGlobals] | |
O | |
ocaml_natdynlink_available [OpamSystem] |
Checks if native dynlink is available with the current OCaml compiler
|
ocaml_native_available [OpamSystem] |
Returns true if the "ocamlopt" is available in the current switch
|
ocaml_opt_available [OpamSystem] |
Returns true if the ".opt" version of the current OCaml compiler is
available
|
ocaml_version [OpamSystem] |
Return the version of the current OCaml compiler.
|
ocaml_version [OpamFile.OPAM] |
Compiler constraint
|
ocamlfind_command [Opamlfind] | |
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_disjunction [OpamFormula] |
Return a formula from a disjunction of atoms
|
of_filename [OpamCompiler] |
Convert a filename into a compiler name.
|
of_string [OpamFile.Descr] |
Create an abstract description file from a string
|
of_string_list [OpamFilename.Attribute] | |
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.
|
open_out [OpamFilename] | |
ors [OpamFormula] |
Convert a list of formulas to an OR-formula (
Empty formulas are
ignored)
|
ors_to_list [OpamFormula] |
Converts back an OR-formula to a list (flattens top-level ors)
|
os [OpamGlobals] | |
os [OpamFile.OPAM] |
OS constraint
|
os_string [OpamGlobals] | |
output [OpamJson] | |
P | |
package [OpamVariable.Full] |
Return the package the variable is defined in
|
package [OpamPath.Switch.Overlay] |
Switch metadata overlay (over the global metadata): $opam/$switch/overlay/$name.$version
|
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_partial_state [OpamState] |
Global & partial package state.
|
package_repository_partial_state [OpamState] |
Repository & partial package state.
|
package_repository_state [OpamState] |
Repository state
|
package_state [OpamState] |
Global package state.
|
package_variable_names [OpamState] | |
packages [Opam_check] | |
packages [Opam_admin_top] |
All defined packages in the current repo
|
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/
|
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_ext_formula [OpamFormat] |
Parse an AND formula where constraints are extended with leading keywords
|
parse_filter [OpamFormat] |
Parsing
|
parse_flag [OpamFormat] |
Parse a package flag
|
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_libraries [OpamFormat] |
Parse a list of libraries/syntax
|
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_package_name [OpamFormat] | |
parse_pair [OpamFormat] |
Parse a pair of strings
|
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_tags [OpamFormat] |
Parse tags
|
parse_url [OpamTypesBase] |
Guess an address kind using url suffixes (
.git , etc.) and prefixes
(http:// , etc.).
|
pass_on [Opamlfind] | |
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
|
path_sep [OpamSystem] |
The separator character for the PATH variable
|
perm [OpamFilename.Attribute] |
File permission
|
pfxop_of_string [OpamTypesBase] |
Raises Invalid_argument
|
pin [OpamPinCommand] |
Pin a package.
|
pin [OpamClient.API.PIN] |
Set a package pinning.
|
pin_kind_of_string [OpamTypesBase] |
Pretty-printing of pin kinds.
|
pin_of_url [OpamTypesBase] |
Get a pin_option from address and kind
|
pin_option_of_string [OpamTypesBase] |
Read pin options args
|
pinned [OpamPath.Switch] |
Pinned package file: $opam/$switch/pinned
|
pinned [OpamState] |
Returns the versionned pinned package.
|
pinned_opt [OpamState] |
Returns the versionned pinned package, or
None if not pinned
|
pinned_packages [OpamState] |
The set of pinned packages in the state (warning: costly)
|
pos_null [OpamTypesBase] |
The empty file position
|
post_messages [OpamFile.OPAM] |
Messages to display at end of install
|
prefixes [OpamCompiler] |
List the compiler available in a directory (and their prefix)
|
preinstalled [OpamFile.Comp] |
Is it a pre-installed compiler description file
|
preload_state [OpamHTTP] | |
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.
|
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_stats [OpamSystem] |
Print stats
|
print_stats [OpamGlobals] | |
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_error [OpamSystem] |
raise
Process_error
|
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>)
|
read [OpamSystem] | read filename returns the contents of filename
|
read [OpamGlobals] | |
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] | |
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.
|
relop_of_string [OpamTypesBase] |
Raises Invalid_argument
|
relop_of_string [OpamFormula] |
Parsing relops
|
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 [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 list of packages.
|
remove_all_packages [OpamAction] |
Remove all the packages from a solution.
|
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 [OpamFilename] |
Remove a prefix from a file name
|
remove_state_cache [OpamState] |
Remove the state cache
|
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 [Opam_admin_top] |
The current repo (taken from CWD !)
|
repo [OpamPath.Repository] |
Return the repo file
|
repositories [OpamFile.Config] |
Return the list of 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 [OpamTypesBase] |
Convert a pin kind to a repository kind
|
repository_kind_of_string [OpamTypesBase] |
Parser of repository kinds.
|
repository_of_package [OpamState] |
Get the active repository for a given package
|
req_checksums [OpamGlobals] | |
reset [OpamVCS.VCS] |
Reset the master branch of the repository to match the remote
repository state.
|
resolve [OpamSolution] |
Resolve an user request
|
resolve_and_apply [OpamSolution] |
Call the solver to get a solution and then call
apply .
|
revision [OpamVCS.VCS] |
Return the HEAD revision.
|
rmdir [OpamFilename] |
Remove a directory
|
root [OpamPath.Switch] |
Root dir: $opam/$switch
|
root [OpamPath] |
Default root path
|
root_dir [OpamGlobals] | |
root_dir_tmp [OpamGlobals] |
The initial value of root_dir, set in the tmpdir before initialised
|
run [OpamProcess] | run ~name cmd args synchronously call the command cmd with
arguments args .
|
S | |
safe_mode [OpamGlobals] | |
safe_read [OpamFile.IO_FILE] |
Read file contents.
|
sanitize_atom_list [OpamSolution] |
Takes a "raw" list of atoms (from the user), and match it to existing
packages.
|
sbin [OpamPath.Switch] |
Installed system binaries: $opam/$switch/sbin
|
sbin [OpamFile.Dot_install] |
List of files to install in $sbin/
|
search_files [OpamGlobals] | |
sections [OpamFormat] |
Get all the sections from a list of items
|
self_upgrade_bootstrapping_value [OpamGlobals] | |
set_output [OpamJson] | |
set_url [OpamRepositoryCommand] |
Change the registered address of a repo
|
set_url [OpamClient.API.REPOSITORY] |
Set-up repository url.
|
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.
|
share [OpamPath.Switch] |
Share directory for a given package: $opam/$switch/share/$package
|
share [OpamFile.Dot_install] |
List of architecture-independent files
|
share_dir [OpamPath.Switch] |
Shared directory: $opam/$switch/share
|
share_root [OpamFile.Dot_install] |
List of files under the more general share prefix
|
short_string_of_atom [OpamFormula] |
The compact atom format used in requests, "pkgOPvers", with '.' allowed instead
of '='
|
show [OpamGlobals] | |
show [OpamSwitchCommand] |
Display the current compiler switch.
|
show [OpamClient.API.SWITCH] |
Display the name of the current compiler.
|
skip_version_checks [OpamGlobals] | |
slog [OpamGlobals] |
Helper to pass stringifiers to log (use
log "%a" (slog to_string) x
rather than log "%s" (to_string x) to avoid costly unneeded
stringifications
|
solver [OpamFile.Config] | |
solver_preferences [OpamGlobals] |
Solver preference bindings.
|
solver_timeout [OpamGlobals] | |
sorted_repositories [OpamState] |
Sort repositories by priority.
|
sources_needed [OpamAction] |
Compute the set of packages which will need to be downloaded to apply a
solution
|
spec [Opam_check] | |
src [OpamFile.Comp] |
Return the url of the compiler
|
starts_with [OpamFilename] |
Check whether a filename starts by a given Dir.t
|
state_cache [OpamPath] |
State cache
|
strict [OpamGlobals] | |
string_of_address [OpamTypesBase] |
Print an address
|
string_of_atom [OpamFormula] |
Pretty-printing of atoms
|
string_of_atoms [OpamFormula] |
Prints atoms as a conjunction ("&") using the short format
|
string_of_cause [OpamTypesBase] |
Pretty-prints the cause of an action
|
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 [OpamTypesBase] |
Pretty print
|
string_of_formula [OpamFormula] |
Pretty print a formula
|
string_of_logop [OpamTypesBase] | |
string_of_pfxop [OpamTypesBase] | |
string_of_pin_kind [OpamTypesBase] |
Parsing of pin kinds
|
string_of_pin_option [OpamTypesBase] |
Convert a pin option to a string
|
string_of_pos [OpamTypesBase] |
Prints a file position
|
string_of_relop [OpamTypesBase] | |
string_of_relop [OpamFormula] |
Pretty-printing of relops
|
string_of_repositories [OpamState] |
Pretty print a map of repositories
|
string_of_repository_kind [OpamTypesBase] |
Pretty-print repository kinds.
|
string_of_result [OpamProcess] |
Pretty printing of process.
|
string_of_shell [OpamTypesBase] |
Pretty-print
|
string_of_upload [OpamTypesBase] |
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
|
stublibs [OpamPath.Switch] |
DLL paths
|
stublibs [OpamFile.Dot_install] |
C bindings
|
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
|
sum [OpamSolution] |
Stats
|
switch [OpamGlobals] | |
switch [OpamFile.Config] |
Return the OCaml switch
|
switch [OpamSwitchCommand] |
Like
switch_cont but runs the continuation already.
|
switch [OpamClient.API.SWITCH] |
Switch to the given compiler.
|
switch_cont [OpamSwitchCommand] |
Switch to the given compiler switch.
|
switch_eval [OpamScript] | |
switch_lock [OpamClient] |
Call an unsafe function while taking the current switch lock.
|
switch_reinstall_hook [OpamState] |
Switch reinstall hook.
|
sync_archives [OpamGlobals] | |
synopsis [OpamFile.Descr] |
Return the first line
|
syntax [OpamFile.OPAM] |
List of exported syntax extensions
|
system [OpamGlobals] | |
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
|
template [OpamFile.OPAM] |
Create an OPAM package template filled with common options
|
timer [OpamGlobals] | |
timestamp [OpamGlobals] | |
tmp_opam [OpamPath.Switch.Overlay] |
OPAM temp overlay (for user editing): $opam/$switch/cache/$name.$version/opam_
|
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_list_dir [OpamFilename] |
Turn a full path into a list of directory names
|
to_string [OpamJson] | |
to_string [OpamFormula] |
Pretty print the formula
|
to_string [OpamFilter] |
Pretty-print
|
to_string_list [OpamFilename.Attribute] | |
token [OpamLexer] | |
toplevel [OpamPath.Switch] |
toplevel path: $opam/$switch/lib/toplevel
|
toplevel [OpamFile.Dot_install] |
List of toplevel files
|
touch [OpamFilename] |
Create an empty file
|
U | |
unavailable_reason [OpamState] |
Returns an explanation why a package is not currently available
|
universe [OpamState] |
Create a universe from the current state
|
unknown [OpamCompiler] |
Errors
|
unknown_package [OpamState] |
Returns a message about an atom that doesn't exist
|
unpin [OpamPinCommand] |
Unpin a package.
|
unpin [OpamClient.API.PIN] | |
update [OpamRepositoryCommand] | |
update [OpamClient.API] |
Refresh the available packages.
|
update_cache [OpamPath.Repository] |
Update cache
|
update_cache [OpamPath] |
Update cache
|
update_compiler_index [OpamRepositoryCommand] |
Update the compiler index.
|
update_dev_package [OpamState] |
Updates a dev or pinned package from its upstream; returns true
if changed, false otherwise
|
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, within the given constraints.
|
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.
|
usage [Opam_check] | |
use_external_solver [OpamGlobals] | |
utf8_msgs [OpamGlobals] | |
V | |
validate [OpamFile.OPAM] |
Runs several sanity checks on the opam file; returns a list of
warnings
|
value [OpamParser] | |
value_pos [OpamFormat] |
Get the position out of a value
|
values_pos [OpamFormat] |
Get the position of the first element out of a value list
|
variable [OpamVariable.Full] |
Return the variable name
|
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] |
The list of top-level variables
|
verbose [OpamJson] | |
verbose [OpamGlobals] | |
version [OpamGitVersion] | |
version [OpamFile.Comp] |
Return the compiler version
|
version [OpamFile.OPAM] |
Package version
|
version [OpamCompiler] |
Return the compiler version
|
version_opt [OpamFile.OPAM] | |
version_to_string [OpamTypes.GenericPackage] | |
W | |
wait [OpamProcess] | wait p waits for the processus p to end and returns its results.
|
warning [OpamGlobals] | |
with_bug_reports [OpamFile.OPAM] |
Construct using
bug_reports
|
with_build [OpamFile.OPAM] |
Construct as
build
|
with_checksum [OpamFile.URL] |
Constructor
|
with_conflicts [OpamFile.OPAM] | |
with_contents [OpamFilename] |
Apply a function on the contents of a file
|
with_criteria [OpamFile.Config] | |
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_dev_repo [OpamFile.OPAM] | |
with_flags [OpamFile.OPAM] | |
with_flock [OpamFilename] |
File locks
|
with_install [OpamFile.OPAM] | |
with_libraries [OpamFile.OPAM] |
Construct as
libraries
|
with_maintainer [OpamFile.OPAM] |
Construct as
maintainer
|
with_name [OpamFile.OPAM] |
construct as
name
|
with_name_opt [OpamFile.OPAM] | |
with_ocaml_version [OpamFile.OPAM] |
Construct as
compiler_version
|
with_opam_version [OpamFile.OPAM] |
Sets the opam version
|
with_os [OpamFile.OPAM] | |
with_patches [OpamFile.OPAM] |
Construct as
patches
|
with_remove [OpamFile.OPAM] |
Construct as
remove
|
with_repositories [OpamFile.Config] |
Repository updates
|
with_solver [OpamFile.Config] | |
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_syntax [OpamFile.OPAM] |
Replace the
syntax field of the given OPAM file.
|
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
|
with_version_opt [OpamFile.OPAM] | |
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.
|
Y | |
yes [OpamGlobals] |