(/) [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.
|
add [OpamRepositoryCommand] |
Add a new repository.
|
add [OpamClient.API.REPOSITORY] |
Add a new repository.
|
add_extension [OpamFilename] |
Add a file extension
|
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 [OpamFilename] |
Create an local of remote address from a string,
depending whether the string exits in the filesystem.
|
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.
|
archive [OpamPath.Repository] |
Return the archive for a given package:
$opam/repo/$repo/archives/$NAME.$VERSION.tar.gz
|
archive [OpamPath] |
Archives files: $opam/archives/$NAME.$VERSION.tar.gz
|
archives_dir [OpamPath.Repository] |
Return the archive folder: $opam/repo/$repo/archives/
|
archives_dir [OpamPath] |
Archives files folder: $opam/archives/
|
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.
|
authors [OpamFile.OPAM] |
Authors
|
available [OpamFile.Dot_config.SECTION] |
List the available sections
|
B | |
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/$OVERSION/bin
|
bin [OpamFile.Dot_install] |
List of files to install in $bin/
|
build [OpamPath.Switch] |
Tempory folders used to decompress and compile
the corresponding archives:
$opam/$OVERSION/build/$NAME-$VERSION
|
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/$OVERSION/build/$NAME.$VERSION/$NAME.config
|
build_dir [OpamPath.Switch] |
Tempory folder: $opam/$OVERSION/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/$OVERSION/build/$NAME.$VERSION/$NAME.install
|
build_ocaml [OpamPath.Switch] |
Tempory folders used to decompress and compile
the OCaml compiler:
$opam/$OVERSION/build/_
|
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_base_packages [OpamState] |
Consistency checks: do the base package for the current compiler
are installed ?
|
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 [OpamFile.URL] |
Archive checksum
|
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
|
closure [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 environement.
|
commands [OpamSystem] | commands cmds executes the commands cmds in the correct
OPAM environment.
|
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 [OpamPath.Repository] |
Compiler files: $opam/repo/$repo/compilers/$OVERSION.comp
|
compiler [OpamPath] |
Compiler files: $opam/compilers/$OVERSION.comp
|
compiler [OpamState] |
Return the compiler descritpion file for the given compiler name
|
compiler_descr [OpamPath.Repository] |
Compiler description files: $opam/repo/$repo/compilers/$OVERSION.descr
|
compiler_descr [OpamPath] |
Compiler description files: $opam/compilers/$OVERSION.descr
|
compiler_repository_map [OpamState] |
Build a map which says in which repository the latest metadata for
a given compiler is.
|
compilers [OpamRepository] |
Get the list of compilers (and their eventual description file)
|
compilers [OpamState] |
Return the list of available compilers
|
compilers_dir [OpamPath.Repository] |
Compiler files: $opam/repo/$repo/compilers/
|
compilers_dir [OpamPath] |
Compiler files: $opam/compilers/
|
config [OpamPath.Repository] |
Return the repository config: $opam/repo/$repo/config
|
config [OpamPath.Switch] |
Compile and link flags for a given package:
$opam/$OVERSION/config/$NAME.config
|
config [OpamPath] |
Main configuration file: $opam/config
|
config [OpamConfigCommand] |
Display configuration options
|
config [OpamClient.API.CONFIG] |
Display configuration options.
|
config_dir [OpamPath.Switch] |
Configuration folder: $opam/$OVERSION/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 [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 [OpamRepository] |
Copy the additional package files in the current dir
|
copy_in [OpamFilename] |
Copy a file in a directory
|
copy_unique_dir [OpamFilename] |
Copy the unique directory in
src to dst
|
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] |
Return the repository folder: $opam/repo/$repo
|
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.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.
|
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 | |
default [OpamSwitch] |
Default switch
|
default [OpamRepositoryName] |
Default repository name
|
default [OpamRepository] |
Default repository
|
default [OpamPath] |
Default root path
|
default [OpamPackage.Name] |
default package
|
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] |
Description file: $opam/descr/$NAME.$VERSION
|
descr_dir [OpamPath] |
Description files folder: $opam/descr/
|
diff [OpamCudf.Diff] |
Computation of differences between universe
|
digest [OpamFilename] |
Compute the MD5 digest of a file
|
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
|
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/$OVERSION/doc/NAME
|
doc [OpamFile.Dot_install] |
List of doc files
|
doc [OpamFile.OPAM] |
API documentation
|
doc_dir [OpamPath.Switch] |
Documentation path: $opam/$OVERSION/doc/
|
dot_config [OpamState] |
Return the .config file for the given package
|
download [OpamSystem] |
download compiler sources
|
download [OpamRepository] |
Download $opam/repo/$repo/archive/$nv.tar.gz
|
download [OpamFilename] |
download a remote file in a given directory.
|
download_archive [OpamRepository.BACKEND] |
Download a (remote) archive file, stored on the (remote) OPAM
repository, in the current repository.
|
download_dir [OpamRepository.BACKEND] |
Download a (remote) directory and return the local path to the
downloaded directory: $repo/tmp/$package/$dirname.
|
download_file [OpamRepository.BACKEND] |
Download a (remote) file and return the local path to the
downloaded file: $repo/tmp/$package/$filename.
|
download_iter [OpamFilename] |
iterate downloads until one is sucessful
|
E | |
empty [OpamFormat] |
The empty file
|
empty [OpamFile.IO_FILE] |
Empty file
|
enable [OpamVariable] |
the variable
enable
|
ends_with [OpamMisc] |
Does a string ends with the given suffix ?
|
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 ?
|
eval [OpamFormula] |
Eval a formula
|
eval_filter [OpamState] |
Evaluate a 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 [OpamFilename] |
see
Sys.file_exists
|
exists_dir [OpamFilename] |
Does the directory existsb ?
|
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_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 | |
files [OpamRepository] |
Get the external files associated to a package
|
files [OpamPath.Repository] |
files $opam/repo/$repo/packages/XXX/$NAME.$VERSION/files
|
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_installed_package_by_name_aux [OpamState] |
Return the installed package with the right name, but this time
using the collection of installed packages as argument
|
find_packages_by_name [OpamState] |
Return all the packages with the given name
|
find_prefix [OpamRepository] |
Find an eventual prefix in a map
|
find_repository_name [OpamState] |
Find a repository state, given its name
|
flock [OpamSystem] | flock () takes the global file lock.
|
fold [OpamTypes.ACTION_GRAPH.Topological] | |
fold_left [OpamFormula] |
Fold function
|
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
|
git_of_string [OpamMisc] |
Cut a git string of the form /git/address
#SHA into (address * commit)
|
global_lock [OpamClient] |
Call an unsafe function while taking the global lock.
|
graph_iter [OpamVariable.Section] |
Iteration in topological order
|
guess_shell_compat [OpamMisc] |
Guess the shell compat-mode
|
H | |
has_cycle [OpamParallel.G] | |
hash [OpamPackage] |
Hash a package
|
homepage [OpamFile.OPAM] |
Homepage
|
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.
|
init [OpamRepository.BACKEND] |
Initialize an OPAM repository in the current directory.
|
init [OpamRepository] |
Initialize $opam/repo/$repo
|
init [OpamPath] |
Init scripts
|
init [OpamClient.API] |
Initialize the client a consistent state.
|
insert [OpamMisc] |
Insert a value in an ordered list
|
install [OpamPath.Switch] |
Installed files for a given package:
$opam/$OVERSION/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_compiler [OpamState] |
Install the given compiler
|
install_dir [OpamPath.Switch] |
Installed files: $opam/$OVERSION/install/
|
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/$OVERSION/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
|
internal_error [OpamSystem] |
Raise
Internal_error
|
invalid_checksum [OpamRepository] |
Raise an error when a checksum is invalid.
|
invalid_fields [OpamFormat] |
Find all the invalid fields
|
is_failure [OpamProcess] |
Is the process result a failure ?
|
is_pinned [OpamState] |
Is a package pinned ?
|
is_success [OpamProcess] |
Is the process result a success ?
|
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 [OpamFormula] |
Iter function
|
J | |
jobs [OpamFile.Config] |
Return the number of jobs
|
K | |
keys [OpamMisc.MAP] |
Return the keys in the map.
|
kind [OpamFile.URL] |
Backend kind (could be curl/rsync/git/darcs at the moment)
|
kind [OpamFile.Dot_config.SECTION] |
Return the section kind
|
kind_of_pin_option [OpamTypes] | |
L | |
lib [OpamPath.Switch] |
Library path for a given package:
$opam/$OVERSION/lib/NAME
|
lib [OpamFile.Dot_install] |
List of files to install in $lib/
|
lib_dir [OpamPath.Switch] |
Library path: $opam/$OVERSION/lib/
|
libraries [OpamFile.OPAM] |
List of exported libraries
|
license [OpamFile.OPAM] |
License
|
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] |
List all the .opam files and the package directories in a given
path
|
list [OpamCompiler] |
List the compiler available in a directory (and their eventual
descrition file)
|
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_repository_state [OpamState] |
Load repository related states only.
|
load_state [OpamState] |
Load the client state.
|
local_repo [OpamRepository] |
Create a dummy local repository
|
lock [OpamPath.Switch] |
lock file
|
lock [OpamPath] |
lock file
|
M | |
maintainer [OpamFile.OPAM] |
Package maintainer
|
make [OpamFile.Comp] |
Options to give to the "make" command
|
make_archive [OpamRepository] | make_archive repo_kind nv build ./$nv.tar.gz, assuming the
repository kind is repo_kind .
|
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_dir [OpamPath.Switch] |
Man pages path: $opam/$OVERSION/man/.
|
map [OpamFormula] |
Map function
|
map [OpamMisc.SET] |
auto-map
|
md5 [OpamFilename.Attribute] |
MD5 digest of the remote file
|
mem_installed_package_by_name [OpamState] |
Check whether a package name is installed
|
mem_installed_package_by_name_aux [OpamState] |
Check whether a package name is installed, but this time
using the collection of installed packages as argument
|
mem_repository [OpamState] |
Check if a package belongs to a repository
|
mem_repository_name [OpamState] |
Check whether a repository name is valid
|
message [OpamVersion] |
Display the version message
|
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
|
names_of_packages [OpamPackage] |
Extract the naes from a collection of packages
|
new_packages [OpamSolver] |
Return the new packages in the solution
|
O | |
ocaml_version [OpamSystem] |
Return the version of the current OCaml compiler.
|
ocaml_version [OpamFile.OPAM] |
Compiler constraint
|
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] |
Create a new pair from a directory name.
|
of_disjunction [OpamFormula] |
Return a formula from a disjunction of atoms
|
of_filename [OpamPackage] |
Create a new pair 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_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] |
OPAM files: $opam/opam/$NAME.$VERSION.opam
|
opam [OpamState] |
Return the OPAM file for the given package
|
opam_dir [OpamPath] |
OPAM files folder: $opam/opam/
|
opam_version [OpamFile.Config] |
Return the OPAM version
|
ors [OpamFormula] |
Convert a list of formulas to an OR-formula
|
os [OpamFile.OPAM] |
OS constraint
|
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.Repository] |
Package folder: $opam/repo/$repo/packages/XXX/$NAME.$VERSION
|
package_repository_map [OpamState] |
Build a map which says in which repository the latest metadata for
a given package is.
|
packages [OpamRepository] |
Get the list of packages
|
packages [OpamFile.Comp] |
Packages to install immediately after the creation of OCaml
|
packages_dir [OpamPath.Repository] |
Packages folder: $opam/repo/$repo/packages
|
packages_of_name [OpamPackage] |
Return all the packages with the given names
|
parallel_iter [OpamParallel.SIG] | iter n t pre child paren parallel iteration on n
cores.
|
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_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
|
path_of_pin_option [OpamTypes] | |
perm [OpamFilename.Attribute] |
File permission
|
pin [OpamPinCommand] |
Manage pinned packages.
|
pin [OpamClient.API.PIN] |
Pin a package to a specific version.
|
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
|
pinned_cache [OpamPath.Switch] |
Build dir for all pinned packages
|
pinned_dir [OpamPath.Switch] |
Build dir for a given pinned package
|
pinned_package [OpamState] |
Get the corresponding pinned package.
|
pinned_path [OpamState] |
Get the path associated to the given pinned package.
|
pp [OpamFile.Comp] |
Preprocessing options
|
prefix [OpamRepository] |
Check if a package has a given prefix in the repository
|
prefix [OpamPath.Repository] |
Prefix file $opam/repo/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.
|
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 [OpamState] |
Print a warning if the environment is not set-up properly.
|
print_solution [OpamSolver] |
Display a solution
|
print_stats [OpamFile] |
Display statistics about file access.
|
print_stats [OpamState] |
Display stats
|
priority [OpamRepositoryCommand] |
Set a repository priority.
|
priority [OpamClient.API.REPOSITORY] |
Set-up repository priority.
|
process_error [OpamSystem] |
raise
Process_error
|
R | |
raw_dir [OpamFilename] |
Creation from a raw string (as http://<path>)
|
raw_file [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
|
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.
|
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
|
register [OpamLocal] | |
register [OpamHTTP] | |
register [OpamGit] | |
register [OpamDarcs] | |
register_backend [OpamRepository] |
Register a repository backend
|
reinstall [OpamPath.Switch] |
Packages to reinstall on next upgrade:
$opam/$OVERSION/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 [OpamFormula] |
Parsing relops
|
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_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_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_index [OpamPath] |
Return the repository index: $opam/repo/index
|
repositories [OpamFile.Config] |
Return the list of repository
|
repository_address [OpamRepository] |
Constructor
|
repository_kind_of_string [OpamTypes] |
Parser of repository kinds.
|
requires [OpamFile.Dot_config.SECTION] |
Return the build requirements
|
requires [OpamFile.Comp] |
Libraries to link with
|
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
|
rmdir [OpamFilename] |
Remove a directory
|
root [OpamPath.Repository] |
Get the directory root
|
root [OpamPath.Switch] |
Root dir: $opam/$OVERSION
|
root [OpamPath] |
Root dir: $opam/
|
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 .
|
S | |
s_installed_root [OpamCudf] |
The "installed-root" string
|
s_reinstall [OpamCudf] |
The "reinstall" string
|
safe_read [OpamFile.IO_FILE] |
Read file contents.
|
scc_list [OpamParallel.G] | |
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
|
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/$OVERSION/share/$package
|
share [OpamFile.Dot_install] |
List of shared files
|
share_dir [OpamPath.Switch] |
Shared directory: $opam/$OVERSION/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
|
sorted_repositories [OpamState] |
Sort repositories by priority
|
split [OpamMisc] |
Split a string
|
src [OpamFile.Comp] |
Return the url of the compiler
|
starts_with [OpamMisc] |
Does a string starts with the given prefix ?
|
starts_with [OpamFilename] |
Check wether a filename starts by a given Dir.t
|
state_cache [OpamPath] |
State cache
|
stats [OpamSolver] |
Compute statistics about a solution
|
string_of_action [OpamTypes.PKG] |
Pretty-printing of package actions
|
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_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_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_stats [OpamSolver] |
Pretty-printing of statistics
|
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
|
strip [OpamMisc] |
Strip a string
|
stublibs [OpamPath.Switch] |
DLL paths
|
sub_at [OpamMisc] |
Cut a string
|
sub_dirs [OpamFilename] |
List the sub-directory
|
subst [OpamConfigCommand] |
Substitute files
|
subst [OpamClient.API.CONFIG] |
Substitute files.
|
substitute_file [OpamState] |
Substitute file
|
substitute_string [OpamState] |
Substitute a string
|
substs [OpamFile.OPAM] |
File substitutions
|
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_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.
|
tmp [OpamPath.Repository] |
Tempory folder $opam/repo/$repo/tmp
|
tmp_dir [OpamPath.Repository] |
Tempory folder $opam/repo/$repo/tmp/$NAME.$VERSION/
|
to_atom_formula [OpamFormula] |
Transform a formula where versions can be expressed using formulas
to a flat atom formula
|
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_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 [OpamFormula] |
Pretty print the formula
|
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/$OVERSION/lib/toplevel
|
toplevel [OpamFile.Dot_install] |
List of toplevel files
|
touch [OpamFilename] |
Create an empty file
|
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 [OpamCudf] |
Remove a package from an 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.BACKEND] |
Update the OPAM repository in the current directory.
|
update [OpamRepository] |
Update $opam/repo/$repo
|
update [OpamClient.API] |
Refresh the available packages.
|
update_env_variables [OpamState] |
Update the global environment variables.
|
update_hook [OpamState] |
Update hook.
|
update_index [OpamRepositoryCommand] |
Update the repository index.
|
update_metadata [OpamAction] |
Update package metadata
|
update_pinned_package [OpamState] |
Update pinned package
|
update_setup [OpamState] |
Update the user configuration.
|
update_setup_interactive [OpamState] |
Update the global and user configuration by asking some questions.
|
updated [OpamPath.Repository] |
Return the list of updated packages:
$opam/repo/$repo/updated
|
upgrade [OpamClient.API] |
Find a consistent state where most of the installed packages are
upgraded to their latest version.
|
upload [OpamRepository] |
Upload the content of $opam/repo/$repo/upload to the remote
repository.
|
upload [OpamClient.API] |
Upload a package to a remote repository.
|
upload_dir [OpamRepository.BACKEND] |
Upload the content of the current directory to the directory
given as argument.
|
upload_dir [OpamPath.Repository] |
Return the upload folder for a given version:
$opam/repo/$repo/upload/
|
url [OpamPath.Repository] |
urls $opma/repo/$repo/package/XXX/$NAME.$VERSION/url
|
url [OpamFile.URL] |
URL address
|
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
|
version [OpamPath.Repository] |
Return the version file
|
version [OpamPackage] |
Return the version name
|
version [OpamFile.Comp] |
Return the compiler version
|
version [OpamFile.OPAM] |
Package 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_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_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_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_repository [OpamState] |
Apply a function on the repository which contains a given package
|
with_substs [OpamFile.OPAM] |
Construct as
substs
|
with_switch [OpamFile.Config] |
OCaml switch updates
|
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
|
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.
|