Index of values


(%%) [Topkg.Cmd]
l %% frag appends the line fragment frag to l.
(%) [Topkg.Cmd]
l % arg adds arg to the command line l.
(//) [Topkg.Fpath]
p // q is append p q.
(>>=) [Topkg]
r >>= f is f v if r = Ok v and r if r = Error _.
(>>|) [Topkg]
r >>| f is Ok (f v) if r = Ok v and r if r = Error _.

A
add_arg [Topkg.Cmd]
add_arg l arg is l % arg.
add_args [Topkg.Cmd]
add_args l frag is l %% frag.
alt [Topkg.Private.Codec]
alt tag cs codecs values by tagging them with tag and using the corresponding codec in cs.
answer [Topkg.Private.Ipc]
answer ipc is the file path from which the value can be decoded from.
api [Topkg.Exts]
api is interface @ cmx.
app [Topkg.Log]
app is msg App.
append [Topkg.Fpath]
append p q appends q to p as follows: If q is absolute then q is returned, Otherwise appends q's segments to p using a "/" if needed.

B
base_packages [Topkg_care.OCamlfind]
base_packages are the OCamlfind packages that are distributed with OCaml.
basename [Topkg.Fpath]
basename p is p's basename, the last non empty segment of p.
bin [Topkg.Pkg]
bin is a field that installs to a common bin/ directory.
bool [Topkg.Private.Codec]
bool codecs booleans.
bool [Topkg.Conf]
bool is a converter for booleans.
build [Topkg_care.Pkg]
build [Topkg.Pkg]
build ~prepare_on_pin ~dir ~cmd ~pre ~post describes the package build procedure.
build_cmd [Topkg.Pkg]
build_cmd c os is the default build command to which files to build are given.
build_context [Topkg.Conf]
build_context c is the build context of c.
build_dir [Topkg_care.Pkg]
build_dir p is p's build directory.
build_dir [Topkg.Private.Pkg]
build_dir p is p's build directory.
build_dir [Topkg.Conf]
build_dir c is either the value of build directory as given to Topkg.Pkg.describe via Topkg.Pkg.build or the value of a predefined key --build-dir which overrides the package definition.
build_tests [Topkg.Conf]
build_tests c is the value of a predefined key --tests that indicates if the tests should be built.
bzip2 [Topkg_care.Archive]
bzip2 s dst compresses s to dst using bzip2.

C
c_dll_library [Topkg.Exts]
c_dll_library is the extension for C dynamic libraries (archives).
c_library [Topkg.Exts]
c_library is the extension for C libraries (archives).
change_log [Topkg_care.Pkg]
change_log p is the first element of change_logs p.
change_log_file_last_entry [Topkg_care.Text]
change_log_file_last_entry file tries to parse the last change log entry of the file file using Topkg_care.Text.flavour_of_fpath and and Topkg_care.Text.change_log_last_entry.
change_log_last_entry [Topkg_care.Text]
change_log_last_version ~flavour text tries to parse the last change log entry of text (i.e.
change_logs [Topkg_care.Pkg]
change_logs p are p's change logs.
change_logs [Topkg.Private.Pkg]
change_logs p is p's change logs.
changes [Topkg.Vcs]
changes r ~after ~until is the list of commits with their one-line message from commit-ish after to commit-ish until (defaults to "HEAD").
checkout [Topkg.Vcs]
checkout r ~branch commit_ish checks out commit_ish.
clean [Topkg_care.Pkg]
clean_cmd [Topkg.Pkg]
clean_cmd os ~build_dir is the default clean command.
clib [Topkg.Pkg]
clib clib installs C stubs described by the OCamlbuild .clib file clib with: dllfield is the field where the C DLL archive gets installed, (defaults to Topkg.Pkg.stublibs), libfield is the field where the C static archive gets installed (defaults to Topkg.Pkg.lib), If cond is false (defaults to true), no move is generated., lib_dst_dir is the destination directory of the library in the libfield field. If unspecified this is the root of the field's directory. This does not affect the dllfield, DLLs are always installed at the root directory of the dllfield.
clone [Topkg.Vcs]
clone r ~dir clones r in directory dir.
cmd [Topkg_care.OCamlfind]
cmd is a command for ocamlfind looked up using Topkg.Conf.tool "ocamlfind" `Host_os.
cmd [Topkg_care.OCamlbuild]
cmd is a command for ocamlbuild looked up using Topkg.Conf.tool "ocamlbuild" `Host_os.
cmd [Topkg_care.Opam]
cmd is a command for opam looked up using Topkg.Conf.tool "opam" `Host_os.
cmd [Topkg.Private.Ipc]
cmd ipc are the command line arguments provided to the child process.
cmd [Topkg.Private.Codec]
cmd codecs command line fragments.
cmd [Topkg.Vcs]
cmd r is the base VCS command to use to act on r.
cmx [Topkg.Exts]
cmx is ext ".cmx".
codec [Topkg.Private.Opam.File]
codec is a codec for OPAM file fields.
codec [Topkg.Private.Ipc]
codec ipc is the codec used to transfer the value.
codec [Topkg.Private.Pkg]
codec is a codec for package descriptions.
commit [Topkg_care.Pp]
commit formats a commit-ish.
commit_files [Topkg.Vcs]
commit_files r ~msg files commits the file files with message msg (if unspecified the VCS should prompt).
commit_id [Topkg.Vcs]
commit_id ~dirty ~commit_ish r is the object name (identifier) of commit_ish (defaults to "HEAD").
commit_ptime_s [Topkg.Vcs]
commit_ptime_s t ~commit_ish is the POSIX time in seconds of commit commit_ish (defaults to "HEAD") of repository r.
compare [Topkg.Cmd]
compare l l' is a total order on command lines.
const [Topkg.Private.Codec]
const v codecs the constant v.
contents [Topkg.OS.Dir]
contents ~dotfiles ~rel dir is the list of directories and filse in dir.
conv [Topkg.Conf]
conv ~docv parse print is a configuration value converter parsing values with parse and printing them with print.
current [Topkg.OS.Dir]
current () is the current working directory.
cut [Topkg.String]
cut ~sep s is either the pair Some (l,r) of the two (possibly empty) substrings of s that are delimited by the first match of the separator character sep or None if sep can't be matched in s.
cuts [Topkg.String]
cuts ~sep s is the list of all substring of s that are delimited by matches of sep.

D
dash [Topkg.OS.File]
dash is "-".
debug [Topkg.Conf]
debug c is the value of a predefined key --debug that indicates if the build should include debugging information in the build artefacts.
debug [Topkg.Log]
err is msg Debug.
debugger_support [Topkg.Conf]
debugger_support c is the value of a predefined key --debugger-support that indicates if build artefacts needed for source level debuggers should be built and installed.
dec [Topkg.Private.Codec]
dec c is c's decoder.
dec_result [Topkg.Private.Codec]
dec c is like Topkg.Private.Codec.dec but doesn't raise.
delegate [Topkg_care.Pkg]
delegate p is p's delegate.
delegate [Topkg.Private.Pkg]
delegate pis p's delegate.
delete [Topkg.OS.File]
delete ~must_exist file deletes file file.
delete_tag [Topkg.Vcs]
delete_tag r t deletes tag t in repo r.
deps [Topkg_care.Opam.File]
deps ~opts fields returns the packages mentioned in the depends: fields, if opts is true (default) those from depopts: are added aswell.
describe [Topkg.Pkg]
describe name install describes a package named name with: delegate, the package delegate command to use. If unspecfied determined by the delegate lookup procedure, see topkg help delegate for more information., readmes are readme files, defaults to [std_file "README.md"]. Automatic install is in the Topkg.Pkg.doc field., licenses are license files, defaults to [std_file "LICENSE.md"]. Automatic install is in the Topkg.Pkg.doc field., change_logs are change logs, defaults to [std_file "CHANGES.md"]. The first file of the list is the one that is acted upon by the topkg log command. Automatic install is in the Topkg.Pkg.doc field., metas the package's ocamlfind META files, defaults to [ meta_file "pkg/META" ]., opams the package's OPAM package files, defaults to [opam_file "opam"]. The default OPAM file used by a package description depends on the package name (which can be overriden from the command line). The OPAM file lookup procedure selects the first path in opams whose filename is (name ^ ".opam") and, failing to do so, it fallbacks to an "opam" file at the root of the distribution., lint_files if Some files, ensures that all files mentioned in readme, license, change_log, metas, opams and files are present in the distribution. Defaults to Some []. If None disables the file existence tests (including readme, change_log, license, metas, opams, metas.), lint_custom defines a custom linting process run with the current directory set at the root of the distribution. Successes and errors in the returned list are reported as such and any error in the list makes the lint fail. Defaults to None., distrib, specifies the distribution process, defaults to Topkg.Pkg.distrib ()., publish, specifies the publication process, defaults to Topkg.Pkg.publish ()., build, specifies the build process, defaults to Topkg.Pkg.build ()., install given a build configuration specifies the install moves. Note that some of standard files are automatically installed and don't need to be specified, see Topkg.Pkg.std_file, Topkg.Pkg.meta_file and Topkg.Pkg.opam_file.
describe [Topkg.Vcs]
describe ~dirty ~commit_ish r identifies commit_ish (defaults to "HEAD") using tags from the repository r.
dir [Topkg.Vcs]
dir r is r's repository directory.
dirname [Topkg.Fpath]
dirname p is p's dirname, p without its last non empty segment.
dirty [Topkg_care.Pp]
dirty formats a "dirty" string.
disable_main [Topkg.Private]
disable_main () disables Topkg's main invoked on Topkg.Pkg.describe.
discovered_key [Topkg.Conf]
discovered_key is like Topkg.Conf.key but the absent value is discovered, if needed, with absent.
distrib [Topkg.Pkg]
distrib ~watermarks ~files_to_watermark ~massage ~exclude_paths ~uri () influences the distribution creation process performed by the topkg tool.
distrib_archive [Topkg_care.Pkg]
distrib_archive p ~keep_dir creates a distribution archive for p and returns its path.
distrib_file [Topkg_care.Pkg]
distrib_file p is p's distribution archive.
distrib_filename [Topkg_care.Pkg]
distrib_filename ~opam p is a distribution filename for p.
distrib_prepare [Topkg.Private.Ipc]
distrib_prepare dist_build_dir name version opam is an IPC to prepare a distribution in directory dist_build_dir.
distrib_uri [Topkg_care.Pkg]
distrib_uri p is p's distribution URI.
distrib_uri [Topkg.Private.Pkg]
distrib_uri p is p's distribution location URI pattern.
doc [Topkg.Pkg]
doc is a field that installs to a package specific doc/ directory
drop_initial_v [Topkg.String]
drop_initial_v s drops a leading 'v' or 'V' from s.
dump [Topkg.Conf.OCaml]
dump ppf c prints an unspecified representation of c on ppf.
dump [Topkg.Conf]
dump ppf c formats an unspecified representation of c on ppf.
dump [Topkg.Cmd]
dump ppf cmd formats an unspecified representation of cmd on ppf.

E
edit_file [Topkg_care.Text]
edit_file f invokes the tool mentioned in the EDITOR environment variable with f and returns the exit code of the program.
empty [Topkg.Private.Pkg]
empty is an empty package description.
empty [Topkg.Cmd]
empty is an empty command line.
enc [Topkg.Private.Codec]
enc c is c's encoder.
ensure_bzip2 [Topkg_care.Archive]
ensure_bzip2 () makes sure the bzip2 utility is available.
ensure_publish [Topkg_care.Opam]
ensure_publish () makes sure opam-publish is in the executable search PATH.
ensure_tar [Topkg_care.Archive]
ensure_tar () makes sure the tar utility is available.
equal [Topkg.Cmd]
equal l l' is true iff l and l' are litterally equal.
err [Topkg.Log]
err is msg Error.
err_count [Topkg.Log]
err_count () is the number of messages logged with level Error.
error_msg [Topkg.R]
error_msg s is Error (`Msg s).
error_msgf [Topkg.R]
error_msgf fmt ... is an error formatted according to fmt.
etc [Topkg.Pkg]
etc is a field that installs to a package specific etc/ directory.
exclude_paths [Topkg.Pkg]
exclude_paths () is the default list of paths to exclude from the distribution archive.
exe [Topkg.Exts]
exe is the extension for executables.
exists [Topkg.OS.Cmd]
exists cmd is true if the executable of cmd can be found in the path and false otherwise.
exists [Topkg.OS.Dir]
exists dir is true if directory dir exists in the file system.
exists [Topkg.OS.File]
exists file is true if file is a regular in the file system and false otherwise.
exists [Topkg.String]
exists p s is true iff there exists an index i of s with p s.[i] = true.
ext [Topkg.Exts]
ext s is s as a list of extensions.
ext_asm [Topkg.Conf.OCaml]
ext_asm is the file extension for assembly files, e.g.
ext_dll [Topkg.Conf.OCaml]
ext_dll is the file extension for C dynamically linked libraries, e.g.
ext_exe [Topkg.Conf.OCaml]
ext_exe is the file extension for binary executables, e.g.
ext_lib [Topkg.Conf.OCaml]
ext_lib is the file extension for C static libraries, e.g.
ext_obj [Topkg.Conf.OCaml]
ext_asm is the file extension for C object files, e.g.
exts [Topkg.Exts]
exts ss is ss as a list of extensions.

F
field_names [Topkg_care.Opam.File]
field_names is the maximal domain of the map returned by Topkg_care.Opam.File.fields, excluding extension fields (not yet supported by opam-lib 1.2.2).
fields [Topkg_care.Opam.File]
fields f returns a simplified model of the fields of the OPAM file f.
fields [Topkg.Private.Opam.File]
fields file are the fields of the OPAM file file which are obtained by calling the topkg topkg executable.
file_is_dirty [Topkg.Vcs]
file_id_dirty r f is Ok true iff f has uncommited changes.
files_to_watermark [Topkg.Pkg]
files_to_watermark () is the default list of files to watermark.
find [Topkg.Conf.OCaml]
find k c looks up key k in configuration c.
find [Topkg.Vcs]
find ~dir () looks for a VCS repository in working directory dir (not the repository directory like .git, default is guessed automatically).
find_pager [Topkg_care.Text]
find ~no_pager is an optional pager command.
flatten [Topkg.Pkg]
flatten installs is the union of all the install moves in installs.
flavour_of_fpath [Topkg_care.Text]
flavour_of_fpath p determines a flavour according to the extension of p as follows: Some `Markdown for .md, Some `Asciidoc for .asciidoc or .adoc, None otherwise
fold [Topkg.OS.File]
fold_files skip f acc paths folds f over the files found in the file hierarchies starting at paths.
for_all [Topkg.String]
for_all p s is true iff for all indices i of s, p s.[i] = true.
fpath [Topkg.Private.Codec]
fpath codecs files paths.
fpath [Topkg.Conf]
fpath is a converter for file paths.

G
get [Topkg.Vcs]
get is like Topkg.Vcs.find but returns an error if no VCS was found.
get_ext [Topkg.Fpath]
get_ext p is p's filename extension (including the '.') or the empty string if there is no extension

H
has_ext [Topkg.Fpath]
has_ext e p is true iff e is a suffix of p.
head [Topkg_care.Text]
head ~flavour text extracts the head of the document text of flavour flavour (defaults to `Markdown).
head [Topkg.Vcs]
head ~dirty r is the HEAD commit identifier of the repository r.
head [Topkg.String]
head s if Some s.[0] if s <> "" and None otherwise.
header_title [Topkg_care.Text]
header_title ~flavour text extract the title of a header text of flavour flavour (defaults to `Markdown).

I
info [Topkg.Log]
err is msg Info.
int [Topkg.Private.Codec]
int codecs integers.
int [Topkg.Conf]
int is a converter for integers.
interface [Topkg.Exts]
interface is exts [".mli"; ".cmi"; ".cmti"].
is_dir_path [Topkg.Fpath]
is_dir_path p is true iff p represents a directory.
is_dirty [Topkg.Vcs]
is_dirty r is Ok true iff the working tree of r has uncommited changes.
is_empty [Topkg.Cmd]
is_empty l is true iff l is empty.
is_file_path [Topkg.Fpath]
is_file_path p is not (is_dir_path true).
is_prefix [Topkg.String]
is_prefix ~affix s is true iff affix.[i] = s.[i] for all indices i of affix.
is_suffix [Topkg.String]
is_suffix ~affix s is true iff affix.[n - i] = s.[m - i] for all indices i of affix with n = String.length affix - 1 and m = String.length s - 1.
issue_close [Topkg_care.Delegate]
issue_close p ~id ~msg closes issue id with message msg.
issue_list [Topkg_care.Delegate]
issue_list p outputs the issue list on stdout.
issue_open [Topkg_care.Delegate]
issue_open p ~title ~body create a new issue with title title and description body body.
issue_show [Topkg_care.Delegate]
issue_show p ~id outputs information about issue id on stdout.

K
key [Topkg.Conf]
key name conv ~absent ~env ~doc ~docv is a configuration key with name name parsed from the command line with conv.
kind [Topkg.Private.Codec]
kind c is c's kind.
kind [Topkg.Vcs]
kind r is r's VCS kind.

L
level [Topkg.Log]
level () is the current reporting level.
level_of_string [Topkg.Log]
level_of_string s parses the representation of Topkg.Log.level_to_string from s.
level_to_string [Topkg.Log]
level_to_string l converts l to an unspecified human-readable US-ASCII string that can be parsed back by Topkg.Log.level_of_string.
lib [Topkg.Pkg]
lib is a field that installs to a package specific lib/ directory.
libexec [Topkg.Pkg]
libexec is a field that installs to a package specific lib/ directory but with the executable bit set.
library [Topkg.Exts]
library is exts [".cma"; ".cmxa"; ".cmxs"] @ c_library
licenses [Topkg_care.Pkg]
licenses p are p's license files.
licenses [Topkg.Private.Pkg]
licenses p is p's license files.
lint [Topkg_care.Pkg]
distrib ~ignore_pkg p ~dir lints performs the lints mentioned in lints in a directory dir on the package p.
lint_all [Topkg_care.Pkg]
lint_all is a list with all lint values.
lint_custom [Topkg.Private.Ipc]
lint_custom () is an IPC to run the custom linting.
lint_custom [Topkg.Private.Pkg]
lint_custom p is p's custom linting function (if any).
lint_files [Topkg.Private.Pkg]
lint_files p are p's files to check for existence.
lint_metas [Topkg.Private.Pkg]
lint_metas p are p's META file to OCamlfind lint.
lint_opams [Topkg.Private.Pkg]
lint_opams p are p's OPAM file OPAM lint and dependency lint.
list [Topkg.Private.Codec]
list el codecs el lists.

M
man [Topkg.Pkg]
man is a field that installs to a common man/ directory.
massage [Topkg.Pkg]
massage is the default distribution massaging function.
meta_file [Topkg.Pkg]
meta_file ~lint ~install p is a META file p expressed relative to the distribution root directory.
misc [Topkg.Pkg]
misc is a field that installs to an arbitrary absolute path, the user is prompted for authorization, see the OPAM manual for details.
mllib [Topkg.Pkg]
mllib ~field ~cond ~api ~dst_dir mllib installs an OCaml library described by the OCamlbuild .mllib file mllib with: field is the field where it gets installed (defaults to Topkg.Pkg.lib)., If cond is false (defaults to true), no move is generated., api is the list of modules that defines the public interface of the library, if None all the modules mentioned in mllib are part of the public interface., dst_dir is the destination directory of the library in the field. If unspecified this is the root of the field's directory.
module_library [Topkg.Exts]
module_library is (api @ library).
msg [Topkg.Private.Codec]
msg codecs error messages.
msg [Topkg.Log]
msg l (fun m -> m fmt ...) logs with level l a message formatted with fmt.
must_exist [Topkg.OS.Cmd]
must_exist cmd is cmd if the executable of cmd can be found in the path and an error otherwise.
must_exist [Topkg.OS.Dir]
must_exist dir is dir if file is a regular file in the file system and an error otherwise.
must_exist [Topkg.OS.File]
must_exist file is file if file is a regular file in the file system and an error otherwise.

N
name [Topkg_care.Pkg]
name p is p's name.
name [Topkg_care.Pp]
name formats a package name.
name [Topkg.Private.Pkg]
name p is p's name.
native [Topkg.Conf.OCaml]
native is true if native compilation (i.e.
native_dynlink [Topkg.Conf.OCaml]
native_dynlink is true if native dynamic linking is available.
not_dirty [Topkg.Vcs]
not_dirty is Ok () iff the working directory of r is not dirty and an error that enjoins to stash or commit otherwise.
nothing [Topkg.Pkg]
nothing is an empty set of install moves.
null [Topkg.OS.File]
null represents a file on the OS that discards all writes and returns end of file on reads.

O
ocaml_base_packages [Topkg_care.Opam]
ocaml_base_packages are the base OPAM packages distributed with OCaml: "base-bigarray", "base-bytes", "base-threads", "base-unix".
ocb_bool_tag [Topkg.Pkg]
ocb_bool_tag c key name is a command fragment adding the ocamlbuild tag name to the default set of tags iff key's value is true.
ocb_bool_tags [Topkg.Pkg]
ocb_bool_tags c assoc is the concatenation of Topkg.Pkg.ocb_bool_tag for all pairs in assoc.
ocb_tag [Topkg.Pkg]
ocb_tag c key name is a command fragment adding the ocamlbuild parameterized tag name with key's value to the default set of tags.
of_list [Topkg.Cmd]
of_list ?slip l is a command line from the list of arguments l.
of_readme [Topkg_care.Opam.Descr]
of_readme r extracts an OPAM description file from a readme r with a certain structure.
of_readme_file [Topkg_care.Opam.Descr]
of_readme_file f extracts an OPAM description file from a readme file f using Topkg_care.Text.flavour_of_fpath and Topkg_care.Opam.Descr.of_readme.
of_string [Topkg_care.Opam.Descr]
of_string s is a description from the string s.
on [Topkg.Cmd]
on bool line is line if bool is true and Topkg.Cmd.empty otherwise.
on_error_msg [Topkg.Log]
on_error_msg ~level r is: v if r = Ok v, use e if r = Error (`Msg e). As a side effect e is logged with level level (defaults to Error).
opam [Topkg_care.Pkg]
opam p is p's OPAM file.
opam [Topkg.Private.Pkg]
opam name p is p's OPAM file for OPAM package name.
opam_descr [Topkg_care.Pkg]
opam_descr p is p's OPAM description.
opam_field [Topkg_care.Pkg]
opam_field p f looks up field f of p's OPAM file.
opam_fields [Topkg_care.Pkg]
opam_fields p are p's OPAM file fields.
opam_file [Topkg.Pkg]
opam_file ~lint ~lint_deps_excluding ~install p is an OPAM file p expressd relative to the distribution root directory such that: If install is true (default), it is automatically installed in the Topkg.Pkg.lib field., If lint is true (default), it is OPAM linted., If lint_deps_excluding is Some excludes, topkg checks that each of the OPAM package dependencies is mentioned as a root package in the OCamlbuild _tags file and vice-versa. The following package names are excluded from this test: The packages names mentioned in excludes., Package names that start with "conf-", Topkg_care.OCamlfind.base_packages, Topkg_care.Opam.ocaml_base_packages If None the dependency check is disabled.
opt_var [Topkg.OS.Env]
opt_var name ~absent is the value of the optionally defined environment variable name, if defined, and absent if undefined.
option [Topkg.Private.Codec]
option el codecs el options.
out_file [Topkg.OS.Cmd]
out_file f o writes the standard output o to file f.
out_lines [Topkg.OS.Cmd]
out_lines ~trim is like Topkg.OS.Cmd.out_string but the result is cut on newlines ('\n').
out_stdout [Topkg.OS.Cmd]
out_stdout o redirects the standard output o to the current process standard output.
out_string [Topkg.OS.Cmd]
out_string ~trim o captures the standard output o as a string.

P
p [Topkg.Cmd]
p is (fun f -> f).
package_tags [Topkg_care.OCamlbuild]
packages ~roots f is the set of packages identifiers mentioned by the package tags of the _tags file f.
pair [Topkg.Private.Codec]
pair c0 c1 codecs c0, c1 pairs.
parse_version [Topkg.String]
parse_version parses version strings of the form:
"[v]major.minor[.patchlevel][+additional-info]"
into (major, minor, patch, additiona_info) tuples.
path [Topkg_care.Pp]
path formats a bold path
pinned [Topkg.Conf]
pinned c is the value of a predefined key --pinned.
pkg [Topkg.Private.Ipc]
pkg () is an IPC to get the package description.
pkg_file [Topkg_care.Pkg]
pkg_file p is p's description file.
pkg_name [Topkg.Conf]
pkg_name c is either the value of the package name as given to Topkg.Pkg.describe or the value of a predefined key --pkg-name which overrides the package name.
pp [Topkg.Vcs]
pp ppf r prints an unspecified representation of r on ppf.
pp_error [Topkg.Private.Codec]
pp_error ppf e prints an unspecified representation of e on ppf.
pp_kind [Topkg.Vcs]
pp_kind ppf k prints an unspecified representation of k on ppf.
profile [Topkg.Conf]
profile c is the value of a predefined key --profile that indicates if the build artefacts include run-time profiling support.
publish [Topkg.Pkg]
publish ~artefacts () influences the distribution publication process performed by the topkg tool: artefacts defines which artefacts are published by an invocation of topkg publish without arguments (defaults to [`Doc;`Distrib]).
publish_alt [Topkg_care.Delegate]
publish_alt p ~kind ~msg ~archive publishes the artefact kind for distribution archive archive of package p with publication message msg.
publish_artefacts [Topkg_care.Pkg]
publish_artefacts p are p's publication artefacts.
publish_artefacts [Topkg.Private.Pkg]
publish_artefacts p is p's distribution publication artefacts.
publish_distrib [Topkg_care.Delegate]
publish_distrib p ~msg ~archive publishes the distribution archive archive of package p with publication message msg.
publish_doc [Topkg_care.Delegate]
publish_distrib p ~msg ~docdir publishes the documentation directory docdir of package p with publication message msg.
publish_in_git_branch [Topkg_care.Delegate]
publish_in_git_branch ~remote ~branch ~name ~version ~docdir ~dir publishes the documentation directory docdir of a package named name at version version by replacing the dir sub-directory of the branch branch of the current working directory git repository (use "." to copy the docdir at the root directory of the branch) and pushes the branch to remote.
publish_msg [Topkg_care.Pkg]
publish_msg p is p's distribution publication message.

R
read [Topkg.Private.Codec]
read f c reads a value with c from f.
read [Topkg.OS.File]
read file is file's contents.
readme [Topkg_care.Pkg]
readme p is the first element of readmes p.
readmes [Topkg_care.Pkg]
readmes p are p's readme files.
readmes [Topkg.Private.Pkg]
readme p is p's readme files.
rem_ext [Topkg.Fpath]
rem_ext p is p without its filename extension.
result [Topkg.Private.Codec]
result ~ok ~error codecs ok, error results.
result_error_msg [Topkg.Private.Codec]
result_error_msg ok codecs ok or error message results.
reword_error [Topkg.R]
reword_error reword r is: r if r = Ok v, Error (reword e) if r = Error e
reword_error_msg [Topkg.R]
reword_error_msg ~replace reword r is like Topkg.R.reword_error except if replace is false (default), the result of reword old_msg is concatened, on a new line to the old message.
run [Topkg.OS.Cmd]
run cmd runs the command cmd.
run_out [Topkg.OS.Cmd]
run_out cmd represents the standard output of the command run cmd.
run_status [Topkg.OS.Cmd]
run_status cmd is like Topkg.OS.Cmd.run, but doesn't error on non-zero exit status.

S
sbin [Topkg.Pkg]
sbin is a field that installs to a common sbin/ directory.
set_current [Topkg.OS.Dir]
set_current dir sets the current working directory to dir.
set_level [Topkg.Log]
set_level l sets the current reporting level to l.
share [Topkg.Pkg]
share is a field that installs to a package specific share/ directory.
share_root [Topkg.Pkg]
share_root is a field that installs to a common share/ directory.
some [Topkg.Conf]
some conv is like conv but wraps the parsed value in Some.
split_uri [Topkg_care.Text]
split_uri uri splits uri into a triple (scheme, host, path).
status [Topkg_care.Pp]
status formats a result status.
std_file [Topkg.Pkg]
std_file ~install p is a standard file p expressed relative to the distribution root directory.
strf [Topkg]
strf is Printf.asprintf.
string [Topkg.Private.Codec]
string codecs strings.
string [Topkg.Conf]
string is a converter for strings.
stublibs [Topkg.Pkg]
stublibs is a field that install to a common lib/stublibs/ directory.
submit [Topkg_care.Opam]
submit ~pkg_dir submits the package pkg_dir with opam-publish and submission message msg (if any) to the OCaml OPAM repository.
success [Topkg.OS.Cmd]
success r is: Ok v if r = Ok (v, (_, `Exited 0)), Error _ otherwise. Non `Exited 0 statuses are turned into an error message.

T
t3 [Topkg.Private.Codec]
t3 is like Topkg.Private.Codec.pair but for triples.
t4 [Topkg.Private.Codec]
t4 is like Topkg.Private.Codec.pair but for quadruples.
t5 [Topkg.Private.Codec]
t5 is like Topkg.Private.Codec.pair but for qintuples.
tag [Topkg.Vcs]
tag r ~force ~sign ~msg ~commit_ish t tags commit_ish with t and message msg (if unspecified the VCS should prompt).
tags [Topkg.Vcs]
tags r is the list of tags in the repo r.
tar [Topkg_care.Archive]
tar dir ~exclude_paths ~root ~mtime is a (us)tar archive that contains the file hierarchy dir except the relative hierarchies present in exclude_paths.
test [Topkg_care.Pkg]
test [Topkg.Pkg]
test is a special executable field: it doesn't install the described executable (as such the dst argument is ignored at the moment).
tmp [Topkg.OS.File]
tmp () creates a temporary file and returns its name.
to_file [Topkg.OS.Cmd]
to_file f o is (out_file f o |> success)
to_lines [Topkg.OS.Cmd]
to_lines ?trim o is (out_string ?trim o |> success).
to_list [Topkg.Cmd]
to_list l is l as a list of strings.
to_string [Topkg_care.Opam.Descr]
to_string d is d as a string.
to_string [Topkg.OS.Cmd]
to_string is (out_string ?trim o |> success).
tool [Topkg.Conf]
tool cmd os is a command cmd which can be run on the build OS which produces output suitable for the OS os.
toplevel [Topkg.Pkg]
toplevel is a field that installs to a common lib/toplevel/ directory.
tracked_files [Topkg.Vcs]
tracked_files ~tree_ish r are the files tracked by the tree object tree_ish (defaults to "HEAD").

U
unit [Topkg.Private.Codec]
unit codecs a ().
untbz [Topkg_care.Archive]
untbz ~clean ar untars the tar bzip2 archive ar in the same directory as ar and returns a base directory for ar.

V
v [Topkg_care.Pkg]
v pkg_file is a package from description file pkg_file which is loaded only if needed.
v [Topkg_care.Opam.Url]
v ~uri ~checksum is an URL file for URI uri with checksum checksum.
v [Topkg.Private.Codec]
v kind enc dec is a codec for value identified as kind using enc to encode and dec to decode.
v [Topkg.Conf.OCaml]
v c os is the configuration of the OCaml system for the OS os obtained by reading the output of tool "ocamlc" os with the -config option.
v [Topkg.Cmd]
v cmd is a new command line (or command line fragment) whose first argument is cmd.
value [Topkg.Conf]
value c k is the value of configuration key k in c.
var [Topkg.OS.Env]
var name is the value of the environment variable name, if defined.
vcs [Topkg.Conf]
vcs c is the value of a predefined key --vcs.
version [Topkg_care.Pkg]
version p is p's version string.
version [Topkg_care.Pp]
version formats a package version.
version [Topkg.Private.Codec]
version num c versions codec c with number num.
version [Topkg.Conf.OCaml]
version is the compiler version string "major.minor[.patchlevel][+additional-info]" parsed into (major, minor, patch, additional-info).
view [Topkg.Private.Codec]
view kind t c views t as c for codecing.

W
warn [Topkg.Log]
err is msg Warning.
warn_count [Topkg.Log]
warn_count () is the number of messages logged with level Warning.
watermarks [Topkg.Pkg]
watermarks is the default list of watermarks.
with_current [Topkg.OS.Dir]
with_current dir f v is f v with the current working directory bound to dir.
with_distrib_file [Topkg_care.Opam.Url]
with_distrib_file ~uri f is an URL file for URI uri with the checksum of file f.
with_index_range [Topkg.String]
with_index_range ~first ~last s are the consecutive bytes of s whose indices exist in the range [first;last].
with_kind [Topkg.Private.Codec]
with_kind k c is c with kind k.
with_pkg [Topkg.Conf]
with_pkg ~default pkg is a boolean configuration key named (strf "with-%s" pkg) to assert existence of OPAM packages.
word_size [Topkg.Conf.OCaml]
word_size is the bit size of one word on the OS that will execute the programs produced by the compiler (i.e.
write [Topkg.Private.Codec]
write f c v encodes value v with c to f.
write [Topkg.OS.File]
write file content writes content to file.
write_subst [Topkg.OS.File]
write_subst file vars content is like Topkg.OS.File.write except any occurence of a string of the form "%%ID%%" in content is replaced by the value of List.assoc "ID" vars, if any.